Workflow automation

Get all workflows

get

Retrieves all workflows

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

requestTypestring · enumOptional

Type of the request

Example: REQUEST_TYPE_EXAMPLEPossible values:

typestring · enumOptional

Type of workflow

Example: AUTOMATEDPossible values:

activebooleanOptional

Whether the workflow is active

Default: trueExample: true

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

HTTPcURLJavaScriptPython

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

post

Creates a new workflow

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

titlestringRequired

External ID for the workflow

Example: external-123

requestTypestring · enumRequired

Type of the request

Example: REQUEST_TYPE_EXAMPLEPossible values:

typestring · enumRequired

Type of workflow

Example: AUTOMATEDPossible values:

attributesanyOptional

Additional attributes in JSON format

externalIdstringOptional

External ID for the workflow

Example: external-123

statusstring · enumOptional

Status of the workflow

Example: ACTIVEPossible values:

Responses

200Success

application/json

Responseany

post

/api/workflow-automation

HTTPcURLJavaScriptPython

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

{
  "title": "external-123",
  "requestType": "REQUEST_TYPE_EXAMPLE",
  "type": "AUTOMATED",
  "attributes": {},
  "externalId": "external-123",
  "tasks": [
    {
      "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
    }
  ],
  "rules": [
    {
      "entityType": "PATIENT",
      "conditionType": "EQUALS",
      "targetField": "PATIENT_ID",
      "targetFieldValue": "123456",
      "logicalOperator": "AND"
    }
  ],
  "status": "ACTIVE",
  "populationTags": []
}

200Success

No content

Get workflow by ID

get

Retrieves a specific workflow

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Responses

200Success

application/json

Responseany

get

/api/workflow-automation/{workflowId}

HTTPcURLJavaScriptPython

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

put

Updates an existing workflow

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

titlestringOptional

External ID for the workflow

Example: external-123

requestTypestring · enumOptional

Type of the request

Example: REQUEST_TYPE_EXAMPLEPossible values:

typestring · enumOptional

Type of workflow

Example: AUTOMATEDPossible values:

attributesanyOptional

Additional attributes in JSON format

externalIdstringOptional

External ID for the workflow

Example: external-123

statusstring · enumOptional

Status of the workflow

Example: ACTIVEPossible values:

populationTagsinteger[]Optional

Population tags ids for the workflow

populationTagsToRemoveinteger[]Optional

Population tags ids to remove for the workflow

Responses

200Success

application/json

Responseany

put

/api/workflow-automation/{workflowId}

HTTPcURLJavaScriptPython

PUT /api/workflow-automation/{workflowId} 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: 325

{
  "title": "external-123",
  "requestType": "REQUEST_TYPE_EXAMPLE",
  "type": "AUTOMATED",
  "attributes": {},
  "externalId": "external-123",
  "status": "ACTIVE",
  "rules": [
    {
      "entityType": "SURVEY",
      "conditionType": "EQUAL",
      "targetField": "SURVEY_ID",
      "targetFieldValue": "123",
      "logicalOperator": "AND"
    }
  ],
  "populationTags": [
    1
  ],
  "populationTagsToRemove": [
    1
  ]
}

200Success

No content

Delete workflow

delete

Deletes an existing workflow

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Responses

200Success

application/json

Responseany

delete

/api/workflow-automation/{workflowId}

HTTPcURLJavaScriptPython

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

200Success

No content