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

Retrieve Information about a Batch Registration Request

get

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

Returns information about the specified batch registration request.

Request

Path Parameters
Query Parameters
  • The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
  • The comma-separated list of fields to be shown in response. By default all response object fields will be present.
Back to Top

Response

Supported Media Types
Back to Top

Examples

The following example shows how to view information about a specific batch registration request by submitting a GET request on the REST resource using cURL. Note that in both request and response, iotserver will be replaced by the name and port of your assigned 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 GET http://user:password@iotserver/iot/api/v2/registrations/0-B4?expand=all

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-B4",
  "name" : "batchRegistration-02.12.2016",
  "description" : "Heartrate monitors",
  "status" : "VERIFIED",
  "successCount" : 0,
  "failedCount" : 0,
  "ignoredCount" : 0,
  "registeredCount" : 0,
  "updatedCount" : 0,
  "links" : [ {
    "href" : "iotserver/iot/api/v2/registrations/0-B4?expand=all",
    "rel" : "self"
  }, {
    "href" : "iotserver/iot/api/v2/registrations/0-B4",
    "rel" : "canonical"
  } ],
  "successEntries" : {
    "items" : [ ],
    "links" : [ {
      "href" : "iotserver/iot/api/v2/registrations/0-B4/successEntries",
      "rel" : "canonical"
    } ]
  },
  "ignoredEntries" : {
    "items" : [ ],
    "links" : [ {
      "href" : "iotserver/iot/api/v2/registrations/0-B4/ignoredEntries",
      "rel" : "canonical"
    } ]
  },
  "failedEntries" : {
    "items" : [ ],
    "links" : [ {
      "href" : "iotserver/iot/api/v2/registrations/0-B4/failedEntries",
      "rel" : "canonical"
    } ]
  }
}

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: 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 GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/iot/api/v2/registrations/57448e197a-6624



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