Tasks

Get all workflow tasks

get

Retrieves all workflow tasks

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

taskstringOptional

Type of the task

Example: task1

serviceProviderIdintegerOptional

ID of the service provider

Example: 1

schedulerAppointmentTypeIdintegerOptional

ID of the scheduler appointment type

Example: 1

workflowAutomationIdintegerOptional

ID of the work flow automation

Example: 1

activebooleanOptional

Whether the task is active

Default: trueExample: true

userTypestring · enumOptional

Type of the user

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

HTTPcURLJavaScriptPython

GET /api/workflow-automation/tasks 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
}

Create workflow task

post

Creates a new workflow task

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

taskstring · enumRequired

Type of the task

Example: task1Possible values:

serviceProviderIdintegerOptional

ID of the service provider

Example: 1

schedulerAppointmentTypeIdintegerOptional

ID of the scheduler appointment type

Example: 1

typestring · enumRequired

Type of workflow

Example: AUTOMATEDPossible values:

workflowAutomationIdintegerOptional

ID of the work flow automation

Example: 1

surveyIdintegerOptional

ID of the survey

Example: 1

slaintegerRequired

Service Level Agreement time

Example: 60

slaDateTimeone ofOptional

Service Level Agreement date and time

Example: 2023-10-01T12:00:00Z

string · dateOptional

or

string · date-timeOptional

attributesanyOptional

Additional attributes in JSON format

activebooleanOptional

Whether the task is active

Default: trueExample: true

namestringOptional

Name of the task

Default: Appointment reminder taskExample: 123

userTypestring · enumOptional

Type of the user

Example: CONSUMERPossible values:

Responses

200Success

application/json

Responseany

post

/api/workflow-automation/tasks

HTTPcURLJavaScriptPython

POST /api/workflow-automation/tasks 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: 257

{
  "task": "task1",
  "serviceProviderId": 1,
  "schedulerAppointmentTypeId": 1,
  "type": "AUTOMATED",
  "workflowAutomationId": 1,
  "surveyId": 1,
  "sla": 60,
  "slaDateTime": "2023-10-01T12:00:00Z",
  "attributes": {},
  "active": true,
  "name": "123",
  "userType": "CONSUMER",
  "rewardAmount": null
}

200Success

No content

Get workflow task by ID

get

Retrieves a specific workflow task

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Responses

200Success

application/json

Responseany

get

/api/workflow-automation/tasks/{taskId}

HTTPcURLJavaScriptPython

GET /api/workflow-automation/tasks/{taskId} 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

put

Updates an existing workflow task

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

namestringOptional

Name of the task

Example: Task 1

taskstringOptional

Type of the task

Example: task1

serviceProviderIdintegerOptional

ID of the service provider

Example: 1

typestring · enumOptional

Type of workflow

Example: AUTOMATEDPossible values:

schedulerAppointmentTypeIdintegerOptional

ID of the scheduler appointment type

Example: 1

workflowAutomationIdintegerOptional

ID of the work flow automation

Example: 1

slaintegerOptional

Service Level Agreement time

Example: 60

slaDateTimeone ofOptional

Service Level Agreement date and time

Example: 2023-10-01T12:00:00Z

string · dateOptional

or

string · date-timeOptional

attributesanyOptional

Additional attributes in JSON format

activebooleanOptional

Whether the task is active

Default: trueExample: true

userTypestring · enumOptional

Type of the user

Example: CONSUMERPossible values:

Responses

200Success

application/json

Responseany

put

/api/workflow-automation/tasks/{taskId}

HTTPcURLJavaScriptPython

PUT /api/workflow-automation/tasks/{taskId} 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: 247

{
  "name": "Task 1",
  "task": "task1",
  "serviceProviderId": 1,
  "type": "AUTOMATED",
  "schedulerAppointmentTypeId": 1,
  "workflowAutomationId": 1,
  "sla": 60,
  "slaDateTime": "2023-10-01T12:00:00Z",
  "attributes": {},
  "active": true,
  "userType": "CONSUMER",
  "rewardAmount": null
}

200Success

No content

Delete workflow task

delete

Deletes an existing workflow task

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Responses

200Success

application/json

Responseany

delete

/api/workflow-automation/tasks/{taskId}

HTTPcURLJavaScriptPython

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

200Success

No content