Skip to main content

Create Workflow

This endpoint allows you to create a new workflow.

Endpoint: /api/v1/workflows

Method: POST

Request Body​

Media Type: application/json

Body:

{
  "name": "string",
  "steps": [
    {
      "delegate": "enum",
      "timeOutInSeconds": 20,
      "params": {
        "additionalProp1": {
          "strValue": "string",
          "longValue": "number",
          "doubleValue": "number",
          "type": "enum"
        },
        "additionalProp2": {
          "strValue": "string",
          "longValue": "number",
          "doubleValue": "number",
          "type": "enum"
        },
        "additionalProp3": {
          "strValue": "string",
          "longValue": "number",
          "doubleValue": "number",
          "type": "enum"
        }
      }
    }
  ]
}
info

In params user should specify workflow mandatory params for step

name (required): The name of workflow. steps: not empty delegate: this parameter means workflow step types timeOutInSeconds: Timeout when the started process step will become failed id no one changes the status to complete params: Parameters dictionary

Responses​

200 (OK) The request was successful, and the server has created the workflow.

Body:

{
  "message": "string",
  "timestamp": "2024-03-29T11:55:21.936Z",
  "data": {
    "name": "string",
    "steps": [
      {
        "delegate": "GATEKEEPER",
        "timeOutInSeconds": 0,
        "params": {
          "additionalProp1": {
            "strValue": "string",
            "longValue": "number",
            "doubleValue": "number",
            "type": "enum"
          },
          "additionalProp2": {
            "strValue": "string",
            "longValue": "number",
            "doubleValue": "number",
            "type": "enum"
          },
          "additionalProp3": {
            "strValue": "string",
            "longValue": "number",
            "doubleValue": "number",
            "type": "enum"
          }
        }
      }
    ],
    "id": "string"
  },
  "version": "string"
}

401 (Unauthorized) This response is returned if the request is not authorized.

Body:

{
  "message": "Unauthorized request",
  "timestamp": "2023-09-28T15:37:14.222Z",
  "data": "string",
  "version": "string"
}

412 (Precondition Failed) This response is returned if a precondition is not met.

Body:

{
  "message": "Precondition failed",
  "timestamp": "2023-09-28T15:37:14.222Z",
  "data": {
    "additionalProp1": {},
    "additionalProp2": {},
    "additionalProp3": {}
  },
  "version": "string"
}

500 (Internal Server Error) This response is returned if an unexpected internal server error occurs.

Body:

{
  "message": "Internal Server Error",
  "timestamp": "2023-09-28T15:37:14.223Z",
  "data": "string",
  "version": "string"
}