DFS v26.1
Loading
API docs by Redocly

DFS Workflow Services API (latest)

Download OpenAPI specification:

Contains functionality around Workflows.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

Workflows

Retrieve the most up-to-date status of a workflow instance

Retrieves the most up-to-date information of the status of a workflow instance (e.g. the state of the workflow if applicable and other data useful to the consumer in relation to the workflow type).

Authorizations:
Bearer
path Parameters
workflowName
required
string

The name of the workflow.

workflowInstanceId
required
string <uuid>

The workflow instance ID to get the status for.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "isCancelable": true,
  • "isActive": true,
  • "stateCompletion": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "workflowName": "string",
  • "workflowInstanceId": "c4b36556-b63b-45ee-af4c-7613e202edc3",
  • "state": "string",
  • "cancellationReason": "string",
  • "errors": [
    ],
  • "data": null
}

Retrieve the schema of the requested workflow

Retrieves the full payload JSON schema of a workflow type (workflowName). It includes the aggregated payload structure that supports various calls and use-cases (e.g. workflow/start, workflow/update, etc.). Refer to the documentation for the exact payload per use-case.

Authorizations:
Bearer
path Parameters
workflowName
required
string

The name of the workflow.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
null

Retrieve the workflow history of an entity

Retrieves information of all inactive workflows based on the input of the entityType and entityId (e.g. entityType = contact and entityId = x). The information includes the workflow instance id and name.

Authorizations:
Bearer
path Parameters
entityType
required
string

Type of the Entity.

entityId
required
string

Id of the Entity.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "workflowEntityHistory": [
    ]
}

Retrieve information related to a specific entity

Retrieves information (a JSON object, previously stored through the workflow/start API) associated with a specific entity (e.g. contact, portfolio, etc.). The API returns NULL, if there was no data passed through the workflow/start. Currently, storage supported only through contact-onboarding workflow/start.

Authorizations:
Bearer
path Parameters
entityType
required
string
entityId
required
string
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "data": null
}

Update a workflow instance by reaching a milestone

Updates a workflow instance by reaching the next milestone. The payload varies depending on the workflow type. Use the /schema api to find out the payload structure, and refer to the documentation for the exact payload per use-case

Authorizations:
Bearer
path Parameters
workflowName
required
string

The name of the workflow.

workflowInstanceId
required
string <uuid>

The workflow instance ID to update.

milestoneName
required
string

The name of the milestone.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The request payload.

payload
required
any

Responses

Request samples

Content type
{
  • "payload": null
}

Response samples

Content type
application/json
{
  • "isCancelable": true,
  • "isActive": true,
  • "stateCompletion": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "workflowName": "string",
  • "workflowInstanceId": "c4b36556-b63b-45ee-af4c-7613e202edc3",
  • "state": "string",
  • "cancellationReason": "string",
  • "errors": [
    ],
  • "data": null
}

Start a new workflow instance of a specified workflow

Starts a new workflow instance of a specified workflow type (workflowName). The payload varies depending on the workflow type. Use the /schema api to find out the payload structure, and refer to the documentation for the exact payload per use-case.

Authorizations:
Bearer
path Parameters
workflowName
required
string

The name of the workflow.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The request payload.

payload
required
any
entityData
any or null
reCaptchaToken
string or null

Responses

Request samples

Content type
{
  • "payload": null,
  • "entityData": null,
  • "reCaptchaToken": "string"
}

Response samples

Content type
application/json
{
  • "isCancelable": true,
  • "isActive": true,
  • "stateCompletion": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "workflowName": "string",
  • "workflowInstanceId": "c4b36556-b63b-45ee-af4c-7613e202edc3",
  • "state": "string",
  • "cancellationReason": "string",
  • "errors": [
    ],
  • "data": null
}

Query to retrieve various workflow-related data or for generic workflow calculations

This endpoint has a multi-functional purpose. Depending on the workflow type (workflowName) it offers methods to retrieve workflow-related data, as well as generic workflow-specific calculations. Refer to the documentation for the list of available query types, request and response bodies.

Authorizations:
Bearer
path Parameters
workflowName
required
string

The name of the workflow.

queryName
required
string

The name of the query.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The request payload.

payload
any or null
workflowInstanceId
string or null <uuid>

Responses

Request samples

Content type
{
  • "payload": null,
  • "workflowInstanceId": "c4b36556-b63b-45ee-af4c-7613e202edc3"
}

Response samples

Content type
application/json
{
  • "data": null
}

Create a new workflow entity

Creates a new workflow entity in the system. This functionality is an internal method to keep track of a new workflow and store all the relevant data and it is not meant to be used by a consumer.

Authorizations:
Bearer
path Parameters
workflowInstanceId
required
string <uuid>

The workflowInstanceId of the workflow.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The request payload.

entityType
string or null
entityId
string or null
workflowName
string or null
workflowLabel
string or null
parentWorkflowInstanceId
string or null <uuid>
Array of objects or null (WorkflowAssociation)

Responses

Request samples

Content type
{
  • "entityType": "string",
  • "entityId": "string",
  • "workflowName": "string",
  • "workflowLabel": "string",
  • "parentWorkflowInstanceId": "c4cac4e6-3f01-4270-99bf-a02a388bbc94",
  • "associations": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Complete an active workflow instance

Completes an active workflow entity. This functionality is an internal method to clean-up all the relevant data and the system, and it is not meant to be used by a consumer.

Authorizations:
Bearer
path Parameters
workflowName
required
string

Name of the workflow

workflowInstanceId
required
string <uuid>

The workflowInstanceId of the workflow.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The request payload.

status
string (WorkflowStatus)
Enum: "Completed" "Abandoned" "Rejected" "Failed"
data
any or null
object or null

Responses

Request samples

Content type
{
  • "status": "Completed",
  • "data": null,
  • "stateCompletion": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Retrieve a list of active workflow entities

Retrieves information of one or more active workflows based on the input of the entityType and entityId(s) (e.g. entityType = contact and entityId = x). The information includes the workflow instance id and name.

Authorizations:
Bearer
path Parameters
entityType
required
string

Type of the Entity

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

List of EntityIds

entityIds
Array of strings or null

Responses

Request samples

Content type
{
  • "entityIds": [
    ]
}

Response samples

Content type
application/json
{
  • "activeWorkflowEntities": [
    ]
}

Cancel an active workflow instance

Cancels an active workflow instance. Depending on the workflow type (workflowName) this functionality may be limited (e.g. only available in certain state or states)

Authorizations:
Bearer
path Parameters
workflowName
required
string

Name of the workflow

workflowInstanceId
required
string <uuid>

The workflowInstanceId of the workflow

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The request payload

cancellationReason
string or null

Responses

Request samples

Content type
{
  • "cancellationReason": "string"
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

/v1.0/workflows/search

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
Array of objects or null (WorkflowAssociation)
workflowNames
Array of strings or null

Responses

Request samples

Content type
{
  • "associations": [
    ],
  • "workflowNames": [
    ]
}

Response samples

Content type
application/json
{
  • "workflows": [
    ]
}