List assigned steps

POST 
/Step

List assigned steps

Request

application/json

Body

The request with contains the user id, the user groups and the step status.

pageOptions object

The pagination and sorting options for the request.

page int32required

Possible values: >= 1 and <= 2147483647

The current page number in the paginated result set.

count int32required

Possible values: >= 1 and <= 50

The number of items returned on this page.

sortByProperty stringnullablerequired

The sort by property.

sortByAscending booleanrequired

The sort by ascending.

searchValues objectnullable

The search values.

property name* stringrequired

findCodeToIncludeInPage stringnullablerequired

The find code to include in page.

searchHistoricData booleanrequired

The search historic data.

userGroupsThatTheUserIsPartOf string[]nullablerequired

The list of user group codes that the requesting user belongs to.

startDate date-timenullablerequired

The start date for filtering results.

endDate date-timenullablerequired

The end date for filtering results.

Responses

200

Steps were found based on the search criteria.

application/json

Schema

Schema

• Array [
id int32required

The unique identifier of this record.

name stringnullablerequired

The display name of this entity.

amlTransId uuidnullablerequired

The unique AML transaction identifier (UUID).

description stringnullablerequired

A textual description providing additional details.

stepOrder int32required

The ordinal position of this step within the workflow sequence.

assignedUserId stringnullablerequired

The identifier of the user assigned to this step.

assignedUserGroupCodes string[]nullablerequired

The list of user group codes assigned to this step.

assignedUserGroupsDisplay stringnullablerequired

A display-friendly representation of the assigned user groups.

status int32required

Possible values: [0, 1, 2, 3]

The current status of this entity.

alertPriority int32required

Possible values: [0, 1, 2, 3]

The priority level of the associated alert.

createdAt date-timenullablerequired

The date and time when this record was created.

closedAt date-timenullablerequired

The date and time when this step was closed.

dueDate date-timenullablerequired

The due date for completing this step.

previousStepId int32nullablerequired

The identifier of the previous step in the workflow sequence.

nextStepId int32nullablerequired

The identifier of the next step in the workflow sequence.

comments object[]nullable
The list of comments associated with this record.
Array [
id int32required
The unique identifier of this record.
text stringnullablerequired
The text content.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
createdAt date-timenullablerequired
The date and time when this record was created.
]
alertId int32required

The unique identifier of the alert.

alert object
The alert associated with this workflow step.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
createdAt date-timenullablerequired
The date and time when this record was created.
updatedAt date-timenullablerequired
The date and time when this record was last updated.
id int32required
The unique identifier of this record.
alertType int32required
Possible values: [0, 1, 2]
The type classification of the alert.
transactionCode stringnullablerequired
The code of the transaction that triggered this alert.
customerCode stringnullablerequired
The unique code identifying the customer.
description stringnullablerequired
A textual description providing additional details.
alertName stringnullablerequired
The display name of the alert.
priority int32required
Possible values: [0, 1, 2, 3]
The priority level assigned to the alert or action.
status int32required
Possible values: [0, 1, 2, 3, 4, 5]
The current status of this entity.
userGroupCode stringnullablerequired
The code of the user group assigned to handle this alert.
totalStepsCount int32required
The total number of workflow steps associated with this alert.
completedStepsCount int32required
The number of workflow steps that have been completed.
stepCompletion stringnullablerequired
A textual representation of step completion progress (e.g., '2/5').
comments object[]nullable
The list of comments associated with this record.
Array [
id int32required
The unique identifier of this record.
text stringnullablerequired
The text content.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
createdAt date-timenullablerequired
The date and time when this record was created.
]
• ]

Example (from schema)

[
  {
    "id": 0,
    "name": "string",
    "amlTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "description": "string",
    "stepOrder": 0,
    "assignedUserId": "string",
    "assignedUserGroupCodes": [
      "string"
    ],
    "assignedUserGroupsDisplay": "string",
    "status": 0,
    "alertPriority": 0,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "closedAt": "2024-07-29T15:51:28.071Z",
    "dueDate": "2024-07-29T15:51:28.071Z",
    "previousStepId": 0,
    "nextStepId": 0,
    "comments": [
      {
        "id": 0,
        "text": "string",
        "createdBy": "string",
        "createdAt": "2024-07-29T15:51:28.071Z"
      }
    ],
    "alertId": 0,
    "alert": {
      "createdBy": "string",
      "updatedBy": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "id": 0,
      "alertType": 0,
      "transactionCode": "string",
      "customerCode": "string",
      "description": "string",
      "alertName": "string",
      "priority": 0,
      "status": 0,
      "userGroupCode": "string",
      "totalStepsCount": 0,
      "completedStepsCount": 0,
      "stepCompletion": "string",
      "comments": [
        {
          "id": 0,
          "text": "string",
          "createdBy": "string",
          "createdAt": "2024-07-29T15:51:28.071Z"
        }
      ]
    }
  }
]

404

No steps were found.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...