Skip to main content

Find data

This endpoint allows you to find data images, ocr etc.

Endpoint: /api/v1/artifacts/{documentId}

Method: GET

Path Parameters​

documentId: ID of the scope.

Request Parameters​

artifactDefinitionId: ID of the artifact definition. dataTransformerId: ID of the data transformer definition. indices: The indices type of getting data

200 (OK) The request was successful, and the server has returned pre sign urls.

Body:

[{
  "status": "enum",
  "message": "string",
  "metadata": "object",
  "data": {
    "preSignedUrls": "object",
    "count" : "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"
}