Skip to main content

Create data transformer definition

This endpoint allows you to create data transformer definition.

Endpoint: /api/v1/task-definitions/data-transformer-definitions

Method: POST

Request Body

Media Type: application/json

Body:

{
"name": "string",
"iri": "string",
"taskDefinitionIri" : "string",
"input" : ["string"],
"output" : ["string"],
"metadata": [{"string": "string"}],
"creator": "string"
}

name (required): The name of the data transformer definition. iri (required): IRI of the data transformer definition. taskDefinitionIri (required): The IRI of task definition. input (required): List of input artifacts IDs. output (required): List of output artifacts IDs. metadata (required): Metadata of the data transformer definition. creator (required): The creator or owner of the data transformer definition.

Responses

200 (OK) The request was successful, and the server has created data transformer definitions.

Body:

{
"message": "Success",
"timestamp": "date",
"data": {
"id": "string",
"name": "string",
"iri": "string",
"taskDefinition": [
{
"name": "string",
"iri": "string",
"descriptions": "string"
}
],
"artifactDefinition": [
{
"name": "string",
"iri": "string",
"descriptions": "string",
"dataType": "enum"
}
],
"metadata": [
{
"id": "string",
"key": "string",
"value": "string"
}
],
"creator": "string",
"creationDate": "date"
},
"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"
}