Skip to main content

Find processes

This endpoint allows you find processes with using filter.

Endpoint: /api/v1/processes/find

Method: POST

Request Body​

Media Type: application/json

Body:

{
  "pageNumber": 0,
  "pageSize": 100,
  "workflowId": "string"
}

pageNumber: (required) Page number. pageSize: (required) Page size workflowId: Workflow id

Responses​

200 (OK) The request was successful, and the server return the filtered and paginated processes

Body:

{
  "message": "string",
  "timestamp": "2024-03-29T13:11:20.238Z",
  "data": {
    "totalPages": 0,
    "totalElements": 0,
    "first": true,
    "last": true,
    "size": 0,
    "content": [
      {
        "creationTimestamp": "2024-03-29T13:11:20.238Z",
        "updatedTimestamp": "2024-03-29T13:11:20.238Z",
        "id": "string",
        "workflowId": "string",
        "steps": [
          {
            "id": "string",
            "delegate": "GATEKEEPER",
            "timeOutInSeconds": 0,
            "processStepStatus": "PENDING",
            "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"
              }
            }
          }
        ]
      }
    ],
    "number": 0,
    "sort": {
      "empty": true,
      "unsorted": true,
      "sorted": true
    },
    "numberOfElements": 0,
    "pageable": {
      "offset": 0,
      "sort": {
        "empty": true,
        "unsorted": true,
        "sorted": true
      },
      "pageSize": 0,
      "pageNumber": 0,
      "paged": true,
      "unpaged": true
    },
    "empty": true
  },
  "version": "string"
}

processId: Started process id. processStepId: Started process step id params: Parameters dictionary

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