1. REST API for Oracle Internet of Things Cloud Service
  2. Tasks
  3. Registration

Start the Registration Process

post

/iot/api/v2/registrations/{registration-id}

Starts the registration process, after the batch registration file has been uploaded, using the registration identifier returned by the Upload a Registration File API.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types
Back to Top

Examples

The following example shows how to start the registration process by submitting a POST request on the REST resource using cURL. Note that both in request and response, iotserver will be replaced by name and port of your assigned Oracle IoT Cloud Service instance. The format of the Cloud Service instance is, myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443. For more information about cURL, see Use cURL. 

curl -X POST -k -u username@example.com:welcome1 -H "Accept: application/json" -H "Content-Type: application/json" -d '{"conflictResolution":"RESOLUTION_APPEND_UPDATE_METADATA"}' https://iotserver/iot/api/v2/registrations/0-AI

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "id" : "0-AI",
  "name" : "batchRegistration-02.01.2016",
  "description" : "example",
  "status" : "COMPLETED",
  "resolutionMethod" : "RESOLUTION_APPEND_UPDATE_METADATA",
  "successCount" : 3,
  "failedCount" : 0,
  "ignoredCount" : 0,
  "registeredCount" : 3,
  "updatedCount" : 0,
  "links" : [ {
    "href" : "https://iotserver/iot/api/v2/registrations/0-AI",
    "rel" : "self"
  }, {
    "href" : "https://iotserver/iot/api/v2/registrations/0-AI",
    "rel" : "canonical"
  } ],
  "successEntries" : {
    "links" : [ {
      "href" : "https://iotserver/iot/api/v2/registrations/0-AI/successEntries",
      "rel" : "canonical"
    } ]
  },
  "ignoredEntries" : {
    "links" : [ {
      "href" : "https://iotserver/iot/api/v2/registrations/0-AI/ignoredEntries",
      "rel" : "canonical"
    } ]
  },
  "failedEntries" : {
    "links" : [ {
      "href" : "https://iotserver/iot/api/v2/registrations/0-AI/failedEntries",
      "rel" : "canonical"
    } ]
  }
}
curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   https://iotserver/iot/api/v2/registrations/{registration-id}




Complete cURL Example

The following example shows a complete cURL command that you can use to perform the described operation:

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   -d '{"conflictResolution":"RESOLUTION_APPEND_UPDATE_METADATA"}'
   https://iotserver/iot/api/v2/registrations/555f17445e3a-76cd



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.
Back to Top