Get workflow template

GET 
/WorkflowTemplate/:code

Get workflow template

Request

Path Parameters

code stringrequired

The unique code identifying the workflow template to be retrieved.

Responses

200

OK

application/json

Schema

Schema

id int32required

The unique identifier of this record.

code stringnullablerequired

The unique code identifying this entity.

name stringnullablerequired

The display name of this entity.

trigger int32required

Possible values: [0, 1]

The trigger condition that initiates this workflow.

steps object[]nullable
The list of step templates that compose this workflow.
Array [
id int32required
The unique identifier of this record.
name stringnullablerequired
The display name of this entity.
workflowTemplateId int32required
The identifier of the parent workflow template.
stepOrder int32required
The ordinal position of this step within the workflow sequence.
description stringnullablerequired
A textual description providing additional details.
assignedUserId stringnullablerequired
The identifier of the user assigned to this step.
dueInDays int32required
The number of days allowed for completing this step.
assignedGroups string[]nullablerequired
The list of user group codes assigned to this step template.
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.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
updatedAt date-timenullablerequired
The date and time when this record was last updated.
]
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.

updatedBy stringnullablerequired

The username or identifier of the user who last updated this record.

updatedAt date-timenullablerequired

The date and time when this record was last updated.

Example (from schema)

{
  "id": 0,
  "code": "string",
  "name": "string",
  "trigger": 0,
  "steps": [
    {
      "id": 0,
      "name": "string",
      "workflowTemplateId": 0,
      "stepOrder": 0,
      "description": "string",
      "assignedUserId": "string",
      "dueInDays": 0,
      "assignedGroups": [
        "string"
      ],
      "createdBy": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedBy": "string",
      "updatedAt": "2024-07-29T15:51:28.071Z"
    }
  ],
  "createdBy": "string",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedBy": "string",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}

400

Bad Request

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"
    }
  ]
}

404

Not 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"
    }
  ]
}

500

Internal Server Error

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...