Device Logger data models
reportStatusDeviceLogRequest — request
Request body for Report Status of Device Log Request.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
status | string | Yes | one of: failure, nologs | Log request status to be reported. |
reportStatusDeviceLogRequest — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
reportStatusDeviceLogRequest — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
reportStatusDeviceLogRequest — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUploadSession — request
Request body for Initiate Upload Session.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
contentType | string | Yes | MIME type of file to upload. | |
filename | string | No | Filename of file to upload. | |
size | integer | Yes | Size of the whole file to upload. |
initiateUploadSession — 201 response
Upload session initiated. The response contains the information needed for the file upload, and the session ID needed to commit the session after the upload is done.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
numOfParts | integer | No | Number of parts the log file should be split into. | |
partSize | integer | No | Size of a single part except for the last part. The last part must contain the remaining bytes of the log file. | |
uploadId | string | No | A unique ID for the upload session. Needed for the API endpoint to commit the session when the upload in finished. | |
urls | array<string> | No | URLs for uploading the parts, one for each part of the log file. |
initiateUploadSession — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUploadSession — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUploadSession — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getUploadSessionStatus — 200 response
Status of upload session is returned.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
index | integer | No | Index of the upload part. | |
size | integer | No | Number of bytes uploaded for the part. |
getUploadSessionStatus — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getUploadSessionStatus — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getUploadSessionStatus — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
commitUploadSession — 200 response
Device log file has been successfully saved.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
index | integer | No | Index of the upload part. | |
size | integer | No | Number of bytes uploaded for the part. |
commitUploadSession — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
commitUploadSession — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
commitUploadSession — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |