Claim Async

Claims a batch of devices for a customer asynchronously

13 variables
11 variables

Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read Long‑running batch operations

Input

This building block consumes 13 input parameters

  = Parameter name
  = Format

partnerId INTEGER Required

Required. The ID of the reseller partner

claims[] OBJECT

Identifies one claim request

claims[].deviceIdentifier OBJECT

Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read Identifiers

claims[].deviceIdentifier.imei STRING

The device’s IMEI number. Validated on input

claims[].deviceIdentifier.meid STRING

The device’s MEID number

claims[].deviceIdentifier.manufacturer STRING

The device manufacturer’s name. Matches the device's built-in value returned from android.os.Build.MANUFACTURER. Allowed values are listed in manufacturers

claims[].deviceIdentifier.serialNumber STRING

The manufacturer's serial number for the device. This value might not be unique across different device models

claims[].deviceIdentifier.model STRING

The device model's name. Matches the device's built-in value returned from android.os.Build.MODEL. Allowed values are listed in models

claims[].deviceMetadata OBJECT

Metadata entries that can be attached to a Device. To learn more, read Device metadata

claims[].deviceMetadata.entries OBJECT

Metadata entries recorded as key-value pairs

claims[].deviceMetadata.entries.customKey.value STRING Required

Metadata entries recorded as key-value pairs

claims[].sectionType ENUMERATION

Required. The section type of the device's provisioning record

claims[].customerId INTEGER

Required. The ID of the customer for whom the device is being claimed

Output

This building block provides 11 output parameters

  = Parameter name
  = Format

name STRING

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}

error OBJECT

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide

error.details[] OBJECT

error.details[].customKey.value ANY

error.code INTEGER

The status code, which should be an enum value of google.rpc.Code

error.message STRING

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client

metadata OBJECT

This field will contain a DevicesLongRunningOperationMetadata object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync

metadata.customKey.value ANY

This field will contain a DevicesLongRunningOperationMetadata object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync

done BOOLEAN

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available

response OBJECT

This field will contain a DevicesLongRunningOperationResponse object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync

response.customKey.value ANY

This field will contain a DevicesLongRunningOperationResponse object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync