List workflow definitions
Get a list of workflow definitions.
Results are sorted by time, with the most recently created or updated first.
Request syntax
GET /workflow-definitions?next=${NEXT_PAGE_CURSOR}&size=${PAGE_SIZE} HTTP/1.1
Host: api.simworkflow.com
Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}
Request headers
|
Authorization |
|
|---|
URI request parameters
|
next |
If Required: No |
|---|---|
|
size |
The maximum number of items to return per call. You can use Required: No |
Response syntax
HTTP/1.1 200 OK
{
"content": [
{
"id": String,
"version": Integer,
"name": String,
"disabled": Boolean,
"createdOn": Timestamp
}
],
"next": String
}
Response elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
|
Field |
Type |
Description |
|---|---|---|
|
|
Array[JSON Object] |
Array of workflow definition summaries. |
|
|
String |
The next list requests to SimWorkflow can be continued with this |
Errors
See also general errors.
cURL example: get a list of workflow definition summaries
GET /workflow-definitions
curl \
--request "GET" \
--header "Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}" \
--url "https://api.simworkflow.com/workflow-definitions"
RESPONSE
HTTP/1.1 200 OK
{
"content": [
{
"id": "1R2fY29I8yqxLoZFBE7WXW",
"version": null,
"name": "Customer Details",
"disabled": true,
"createdOn": "2023-09-01T15:24:41.972902Z"
}
],
"next": null
}