Skip to main content

Create task definition

This endpoint allows you to create task definition.

Endpoint: /api/v1/task-definitions

Method: POST

Request Body​

Media Type: application/json

Body:

{
  "name": "string",
  "description": "string",
  "version": "string",
  "iri": "string"
}

name (required): The name of the task definition.
description (required): Brief description of the task definition.
version (required): Version of the task definition.
iri (required): IRI of the task definition.

Responses​

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

Body:

{
  "message": "Success",
  "timestamp": "date",
  "data": {
    "id" : "string",
    "name": "string",
    "description": "string",
    "iri": "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"
}

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