provisionRequest Data Type

ProvisionRequest is a object that represent all information of a provision request for a device.

A provision request is owned by the target account even if the device will connect to the provision broker using a user that belong to the provision account.

A ProvisionRequest object contains a nested ProvisionJob that represent the background job that will be triggered upon device request to be provisioned. The nested ProvisionJob will contain information the provisioning process of a device, its retry counter and general status.

Namespace
http://eurotech.com/edc/2.0
Schema
edc.xsd
Properties
name data type type namespace min/max occurs constraints description
id long element edc 1/1 required  
accountId long element edc 1/1 required  
createdOn dateTime element edc 0/1    
createdBy long element edc 1/1 required  
modifiedOn dateTime element edc 0/1    
modifiedBy long element edc 1/1 required  
activatesOn dateTime element edc 0/1    
expiresOn dateTime element edc 0/1    
status provisionRequestStatus element edc 0/1    
clientId string element edc 0/1    
activationKey string element edc 0/1    
provisionUserId long element edc 1/1 required  
provisionJob provisionJob element edc 0/1    
optlock int element edc 1/1 required The optlock field is used to detect that this entity has not been modified by someone else. When updating an entity, first do a find to get the latest version of the entity and note the value of the optlock. Then in the update operation, set the optlock value to match the value that you found. If someone else has updated the entity between your find and update operations, the update will fail and the db/server will return an error.

See this stackoverflow question for more information on optimistic locking.

provisionSecureURL boolean element edc 1/1 required  
provisionedCredentialsTight deviceCredentialsTight element edc 0/1    

Example

<provisionRequest xmlns="http://eurotech.com/edc/2.0">
  <id>...</id>
  <accountId>...</accountId>
  <createdOn>...</createdOn>
  <createdBy>...</createdBy>
  <modifiedOn>...</modifiedOn>
  <modifiedBy>...</modifiedBy>
  <activatesOn>...</activatesOn>
  <expiresOn>...</expiresOn>
  <status>...</status>
  <clientId>...</clientId>
  <activationKey>...</activationKey>
  <provisionUserId>...</provisionUserId>
  <provisionJob>
    <status>...</status>
    <id>...</id>
    <accountId>...</accountId>
    <jobType>...</jobType>
    <displayName>...</displayName>
    <jobProperties>...</jobProperties>
    <createdOn>...</createdOn>
    <createdBy>...</createdBy>
    <startOn>...</startOn>
    <retryMaxAttempts>...</retryMaxAttempts>
    <retryCount>...</retryCount>
    <optlock>...</optlock>
  </provisionJob>
  <optlock>...</optlock>
  <provisionSecureURL>...</provisionSecureURL>
  <provisionedCredentialsTight>...</provisionedCredentialsTight>
</provisionRequest>