Get workflow definition variables

Get workflow definition variables. To get workflow definition variables, you must register with SimWorkflow and have a valid Personal Access Token to authenticate requests.

Request syntax

GET /workflow-definitions/${WORKFLOW_DEFINITION_ID}/variables HTTP/1.1
Host: api.simworkflow.com
Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}

Request headers

Response syntax

HTTP/1.1 200 OK
{}

Response elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the body contains the workflow definition variables JSON.

Errors

See also general errors.

cURL example: get workflow definition variables

curl \
--request "GET" \
--header "Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}" \
--url "https://api.simworkflow.com/workflow-definitions/0NRnuLkcXGPHmtV5qLUErk/variables"

HTTP/1.1 200 OK
{
  "current_year": 2024
}