Skip to main content

Update artifact status

This endpoint allows you to update artifact status.

Endpoint: /api/v1/artifacts

Method: PUT

Request Body​

Media Type: application/json

{
  "id": "string",
  "status": "enum"
}

id (required): The identifier of the artifact.
status (required): The status of the artifact.

Responses​

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

Body:

[{
  "status": "enum",
  "message": "string",
  "metadata": "object",
  "data": {
    "id" : "string",
    "fileDetailId": "string",
    "scopeId": "string",
    "scope": "enum",
    "status": "enum",
    "path": "string",
    "preSignUrl": "url",
    "name": "string",
    "creator": "string",
    "creationDate" : "instant",
    "size" : "integer",
    "pageCount": "integer"
  }
}]

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