Find data transformer run by filter

This endpoint allows you to find data transformer run by filter.

Endpoint: /api/v1/data-transformers-run/search

Method: POST

Request Body

Media Type: application/json

Body:

{
   "type": "enum",
   "scope": "enum",
   "scopeId": "string",
   "artifactIri": "string",
   "artifactDefinitionName": "string",
   "artifactDefinitionIri": "string",
   "dataTransformerDefinitionName": "string",
   "dataTransformerDefinitionIri": "string",
   "dataTransformerDefinitionMetadataKey": "string",
   "dataTransformerDefinitionMetadataValue": "string",
   "taskDefinitionIri": "string",
   "taskDefinitionName": "string",
  "pageSize": "number",
  "pageNumber": "number",
  "sortDirection": "string",
  "sortBy": "string"
}

type : The data transformer type. scope : The scope of the data transformer run. scopeId : The identifier for the scope. artifactIri : IRI of the artifact. artifactDefinitionName : Name of the artifact definition. artifactDefinitionIri : IRI of the artifact definition. dataTransformerDefinitionName : Name of the data transformer definition. dataTransformerDefinitionIri : IRI of the data transformer definition. dataTransformerDefinitionMetadataKey : Key for metadata associated with the data transformer definition. dataTransformerDefinitionMetadataValue : Value for metadata associated with the data transformer definition. taskDefinitionIri : IRI of the task definition. taskDefinitionName : Name 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 data transformer run by filter.

Body:

{
  "message": "Precondition failed",
  "timestamp": "2023-09-28T15:37:14.222Z",
  "data": {
    "totalPages": "integer",
    "totalElements": "integer",
    "pageable": {
      "pageNumber": "integer",
      "pageSize": "integer",
      "sort": {
        "sorted": "boolean",
        "unsorted": "boolean",
        "empty": "boolean"
      },
      "offset": "integer",
      "paged": "boolean",
      "unpaged": "boolean"
    },
    "sort": {
      "sorted": "boolean",
      "unsorted": "boolean",
      "empty": "boolean"
    },
    "first": "boolean",
    "last": "boolean",
    "number": "integer",
    "numberOfElements": "integer",
    "size": "integer",
    "content": [
      {
        "type": "string",
        "artifact": {
          "scopeId": "string",
          "scope": "string",
          "path": "string",
          "artifactDefinition": {
            "name": "string",
            "iri": "string",
            "version": "string",
            "description": "string",
            "dataType": "string"
          }
        },
        "dataTransformerRun": {
          "name": "string",
          "iri": "string",
          "dataTransformerDefinition": {
            "name": "string",
            "iri": "string",
            "taskDefinition": {
              "name": "string",
              "iri": "string",
              "version": "string",
              "description": "string"
            },
            "metadata": [
              {
                "id": "string",
                "key": "string",
                "value": "string"
              },
              {
                "id": "string",
                "key": "string",
                "value": "string"
              }
            ]
          }
        }
      }
    ],
    "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"
}