Executions

Get workflow task executions

get

Retrieves executions for the provided filter

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

workflowAutomationTaskIdintegerOptional

ID of the workflow task

Example: 123

consumerIdintegerOptional

ID of the consumer

Example: 1

consumerUuidstringOptional

UUID of the consumer

Example: 123

taskTypestring · enumOptional

Task type

Example: APPOINTMENTPossible values:

appointmentIdintegerOptional

Appointment ID

Example: 123

slaintegerOptional

Service Level Agreement time

Example: 60

serviceProviderIdstringOptional

Service provider ID

Example: 123

startDateTimestringOptional

Start date for filtering

Example: 2023-01-01

endDateTimestringOptional

End date for filtering

Example: 2023-12-31

namestringOptional

Search by task execution name

Example: Appointment Reminder Task

activebooleanOptional

userTypestring · enumOptional

User type

Example: CONSUMERPossible values:

sortFieldstringOptional

Sort field

Example: name

sortOrderstring · enumOptional

Sort order

Example: ASCPossible values:

pageNumberinteger · min: 1Optional

Page number

Example: 1

pageSizeinteger · min: 1Optional

Page size

Example: 10

searchKeystringOptional

Search key

Example: search

Responses

200Success

application/json

get

/api/workflow-automation/tasks/executions

HTTPcURLJavaScriptPython

GET /api/workflow-automation/tasks/executions HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [],
  "totalCount": 100,
  "pageNumber": 1,
  "pageSize": 50
}

Get workflow task execution

get

Gets an existing workflow task execution

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

executionIdnumberRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

Responseany

get

/api/workflow-automation/tasks/executions/{executionId}

HTTPcURLJavaScriptPython

GET /api/workflow-automation/tasks/executions/{executionId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

No content

Update workflow task execution

put

Updates an existing workflow task execution

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

executionIdnumberRequiredPattern: [^\/#\?]+?

Body

application/json

statusstring · enumOptional

Status of the task execution

Default: SCHEDULEDExample: SCHEDULEDPossible values:

attributesanyOptional

Additional attributes in JSON format

serviceProviderIdstringOptional

Service provider ID

Example: 123

consumerIdintegerOptional

Consumer ID

Example: 123

financialEntryIdintegerOptional

Financial Entry ID

Example: 123

activebooleanOptional

userTypestring · enumOptional

User type

Example: CONSUMERPossible values:

Responses

200Success

application/json

Responseany

put

/api/workflow-automation/tasks/executions/{executionId}

HTTPcURLJavaScriptPython

PUT /api/workflow-automation/tasks/executions/{executionId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "status": "SCHEDULED",
  "attributes": {},
  "serviceProviderId": "123",
  "consumerId": 123,
  "financialEntryId": 123,
  "active": true,
  "userType": "CONSUMER"
}

200Success

No content