ProvisionRequests

The following resources are applicable:

/provisionRequests

Mount Point: /v2/provisionRequests

POST

Creates a new ProvisionRequest based on the information provided in the ProvisionRequestCreator parameter.

Request Body

element: provisionRequestCreator
media types: application/xml
application/json

Provides the information for the new ProvisionRequest to be created.

Response Body

element: provisionRequest
media types: application/xml
application/json

The newly created ProvisionRequest object.

GET

Returns the list of all the ProvisionRequest associated with the currently connected user with specified offset and limit query parameters. Is it possible to filter result for:

These three ways are mutually exclusive and are listed in order of priority. Pagination is available for each of the three filtering type.

Parameters

name description type default
clientIDs (no documentation provided) query
statuses (no documentation provided) query
startDate (no documentation provided) query 0
endDate (no documentation provided) query 0
offset (no documentation provided) query 0
limit (no documentation provided) query 50

Response Body

element: provisionRequestsResult
media types: application/xml
application/json

The list of ProvisionRequest object.

/provisionRequests/{provisionRequestId}

Mount Point: /v2/provisionRequests/{provisionRequestId}

The following operations are supported on this resource:

PUT

Updates the ProvisionRequest specified by the "provisionRequestId" path parameter based on the information provided in the ProvisionRequest parameter.
Only certain fields are editable after a provision request has been created.
The editable fields are:

Parameters

name description type default
provisionRequestId The id of the ProvisionRequest to be updated. path

Request Body

element: provisionRequest
media types: application/xml
application/json

The modified ProvisionRequest whose attribute need to be updated.

Response Body

element: provisionRequest
media types: application/xml
application/json

The updated provision request.

GET

Returns the ProvisionRequest and its associated ProvisionJob, specified by the provisionRequestId path parameter.

Parameters

name description type default
provisionRequestId The id of the ProvisionRequest requested. path

Response Body

element: provisionRequest
media types: application/xml
application/json

The requested ProvisionRequest object.

DELETE

Deletes the ProvisionRequest specified by the "provisionRequestId" path parameter.
When deleting a provisionRequest the associated provisionJob and all related attachment will also be deleted.

Parameters

name description type default
provisionRequestId The id of the ProvisionRequest to be deleted. path

/provisionRequests/{provisionRequestId}/executions

Mount Point: /v2/provisionRequests/{provisionRequestId}/executions

GET

Return the list of the executions for the specified Provision Request

Parameters

name description type default
provisionRequestId (no documentation provided) path

Response Body

element: provisionRequestExecutionsResult
media types: application/xml
application/json

(no documentation provided)

/provisionRequests/{provisionRequestId}/executions/{ProvisionJobExecutionId}/sendStopSignal

Mount Point: /v2/provisionRequests/{provisionRequestId}/executions/{ProvisionJobExecutionId}/sendStopSignal

POST

Send a stop signal to the provisioning execution. The stop signal will be captured only at next step, so is not possible to stop the device job during the current step processing.

Be careful that stopping a provision request can be harmful for the target device.

Parameters

name description type default
provisionRequestId (no documentation provided) path
ProvisionJobExecutionId (no documentation provided) path

/provisionRequests/count

Mount Point: /v2/provisionRequests/count

GET

Return the number of provision request used by this account. Remember that the account resources may be shared with sub-accounts of this account.

Response Body

element: result
media types: application/xml
application/json

the number of provision request associated with this account.