Bulk upsert Device Scripts

Prev Next
Post
/device-scripts/bulk-upsert

Create or update multiple device scripts in a single request.

Security
HTTP
Type bearer
Body parameters

Bulk upsert request.

Expand All
object
data
Array of object (DeviceScript) Required
object
id
string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
name
string Required

Name of the object.

Exampleobject
notes
string

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.
tags
Array of string

Array of tags.

Example[ "developer", "api-created" ]
string
filename
string Required

The name of the file to be downloaded as to the client devices.

Exampletest.sh
file
string (byte)

The Device Claim Script binary in Base64 format.

Responses
200

Bulk upsert report.

Expand All
object
created
Array of object (BulkUpsertEntityRef)
object
id
string (uuid)

ID of the entity.

name
string

Name of the entity.

updated
Array of object (BulkUpsertEntityRef)
object
id
string (uuid)

ID of the entity.

name
string

Name of the entity.

unchanged
Array of object (BulkUpsertEntityRef)
object
id
string (uuid)

ID of the entity.

name
string

Name of the entity.

failures
Array of object (BulkUpsertFailure)
object
id
string (uuid) | null

ID from the request item, if available.

name
string | null

Name from the request item, if available.

error
object (ValidationError)

Http 422 error for object validation.

id
string

Machine readable error code.

message
string

Human readable error details.

errors
Array of object

List of fields with validation errors.

object
field
string

Name of the field that failed validation.

Examplename
message
string

Failure reason.

Examplemay not be null
displayField
string

Name of the field that should be displayed in the UI. It's an internal field to be used by the local replication service.

ExampleName
replicationMessage
string

Message to be displayed in the replication UI. It's an internal field to be used by the local replication service.

ExampleName is required.
deleted
Array of object (BulkUpsertEntityRef)

List of deleted entities. It's an internal field to be used by the local replication service.

object
id
string (uuid)

ID of the entity.

name
string

Name of the entity.

400

JSON error. Check the JSON format.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.