Get a workflow definition variable value
Get the value of a workflow definition variable. To get the value of a workflow definition variable, you must register with SimWorkflow and have a valid Personal Access Token to authenticate requests.
Request syntax
GET /workflow-definitions/${WORKFLOW_DEFINITION_ID}/variables/${VARIABLE_NAME} HTTP/1.1
Host: api.simworkflow.com
Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}
Request headers
|
Authorization |
|
|---|
Response syntax
HTTP/1.1 200 OK
VariableValue
Response elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the body contains the workflow definition variable value.
Errors
See also general errors.
cURL example: get a workflow definition variable value
GET /workflow-definitions/0NRnuLkcXGPHmtV5qLUErk/variables/current_year
curl \
--request "GET" \
--header "Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}" \
--url "https://api.simworkflow.com/workflow-definitions/0NRnuLkcXGPHmtV5qLUErk/variables/current_year"
RESPONSE
HTTP/1.1 200 OK
2024