Prepares the cache for delivery based on the provided request.

POST 
/delivery/prepareDelivery

Prepares the delivery cache for components based on the provided request and returns the preparation status.

Request

application/json

Body

required

catalogId stringrequired
deviceId stringrequired
itemType ItemTyperequired

Possible values: [software, map, cache]

Responses

200

application/json

Schema

Schema

artifacts

object[]

nullable

Array [

arguments stringnullable

artifactType stringnullable

catalogId stringrequired

downloadDuration int32nullable

downloadEta int32nullable

downloadId int32nullable

hash stringnullable

isExecutable booleannullable

itemKey stringrequired

metaData stringnullable

path stringnullable

progress floatrequired

signature stringnullable

size int64required

status DeliveryStatusEnumrequired

Possible values: [Start, InProgress, Done, Pause, Cancel, Error]

url stringrequired

]

catalogId stringrequired
error stringnullable
progress doublenullable
size doublenullable
status PrepareStatusrequired

Possible values: [start, inProgress, done, error, delete]

url stringnullable

Example (from schema)

{
  "artifacts": [
    {
      "arguments": "string",
      "artifactType": "string",
      "catalogId": "string",
      "downloadDuration": 0,
      "downloadEta": 0,
      "downloadId": 0,
      "hash": "string",
      "isExecutable": true,
      "itemKey": "string",
      "metaData": "string",
      "path": "string",
      "progress": 0,
      "signature": "string",
      "size": 0,
      "status": "Start",
      "url": "string"
    }
  ],
  "catalogId": "string",
  "error": "string",
  "progress": 0,
  "size": 0,
  "status": "start",
  "url": "string"
}

500

application/json

Schema

Schema

message stringrequired
name stringrequired
statusCode int32required

Example (from schema)

{
  "message": "string",
  "name": "string",
  "statusCode": 0
}

Loading...