Create artifact

This endpoint allows you to create artifact.

Endpoint: /api/v1/artifacts

Method: POST

Request Body

Media Type: application/json

Body:

{
  "scope": "enum",
  "scopeId": "string",
  "dataTransformerDefinitionId": "string",
  "output": ["string"],
  "metadata": ["object"],
  "creator": "string",
  "size": "integer",
  "pageCount": "integer"
}

scope (required): The scope of the artifact.
scopeId (required): The identifier for the scope.
dataTransformerDefinitionId (required): The identifier for data transformer definition. output (required): The identifiers for artifact definition. metadata (required): Metadata of the data transformer run. creator (required): The creator or owner of the artifact. size (required): The size of document. pageCount (required): The page count of document.

Responses

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

Body:

[{
  "status": "enum",
  "message": "string",
  "metadata": "object",
  "data": {
    "dataTransformerRunId" : "String",
    "artifactId" : "string",
    "preSignUrl": "url",
    "artifactDefinitionIri": "string"
  }
}]

401 (Unauthorized) This response is returned if the request is not authorized.

Body:

{
  "status": "string",
  "message": "string",
  "timestamp": "date",
  "data": "string",
  "version": "string"
}

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

Body:

{
  "status": "enum",
  "message": "string",
  "metadata": "object",
  "data": {
    "error": {
      "Details": "String",
      "Code" : "integer"
    }
  }
}

412 (Precondition Failed) This response is returned if a precondition is not met.

Body:

{
  "status": "enum",
  "message": "string",
  "metadata": "object",
  "data": {
    "error": {
      "Details": "String",
      "Code" : "integer"
    }
  }
}

500 (Internal Server Error) This response is returned if an unexpected internal server error occurs.

Body:

{
  "message": "string",
  "timestamp": "date",
  "data": "string",
  "version": "string"
}