Skip to main content

Find task definition by filter

This endpoint allows you to find task definition by filter.

Endpoint: /api/v1/task-definitions/search

Method: POST

Request Body​

Media Type: application/json

Body:

{
  "name": "string",
  "iri": "string",
  "pageSize": "number",
  "pageNumber": "number",
  "sortDirection": "string",
  "sortBy": "string"
}

name (required): The name of the task definition. iri (required): IRI of the task definition. pageSize : (optional, default 20)Number of the items per page. pageNumber : (optional, default 0)Page number to get items. sortDirection : (optional, DESC)Direction to sort the returned items. sortBy : (optional, default creationDate)Object property to sort the items by.

Responses​

200 (OK) The request was successful, and the server has returned task definition by filter.

Body:

{
  "message": "Success",
  "timestamp": "date",
  "data": {
    "totalPages": "integer",
    "totalElements": "integer",
    "pageable": {
      "pageNumber": "integer",
      "pageSize": "integer",
      "sort": {
        "sorted": "boolean",
        "unsorted": "boolean",
        "empty": "boolean"
      },
      "offset": "integer",
      "paged": "boolean",
      "unpaged": "boolean"
    },
    "size": "integer",
    "content": [
      {
        "id": "string",
        "iri": "string",
        "name": "string",
        "description": "string"
      }
    ],
    "number": "integer",
    "sort": {
      "sorted": "boolean",
      "unsorted": "boolean",
      "empty": "boolean"
    },
    "first": "boolean",
    "last": "boolean",
    "numberOfElements": "integer",
    "empty": "boolean"
  },
  "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"
}

404 (Not Found) This response is returned if the required resources are not found.

Body:

{
  "message": "Not Found",
  "timestamp": "2023-09-28T15:37:14.222Z",
  "data": {
    "errors": [
      "string"
    ],
    "fieldErrors": [
      "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"
}