Jump to

• Request
• Response
• Examples

List Registration Requests

get

/iot/api/v2/registrations

Returns a list of batch registration requests.

Request

Query Parameters

• fields(optional): string
  The comma-separated list of fields to be shown in response. By default all response object fields will be present.
• limit(optional): integer
  The maximum number of entries to return to the end user.
• offset(optional): integer
  The number that the first record of results is starting from.
• q(optional): string
  Query to filter Registrations on the server. (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)
• since(optional): integer
  The starting point of the desired time interval, in milliseconds. The default is 0.
• totalResults(optional): boolean
  The total number of results suiting the request.
• until(optional): integer
  The finishing point of the desired time interval, in milliseconds. The default is 0.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=collection

Back to Top

Examples

The following example shows how to get a list of batch registration requests, by submitting a GET request on the REST resource using cURL. Note that in both the request and response, iotserver will be replaced by the name and port of your assigned IoT cloud server. 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 -k -u [e-mail]:welcome1 -H "Accept: application/json" 'https://iotserver/iot/api/v2/registrations'

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.

{
  "items" : [ {
    "id" : "0-AE",
    "name" : "16.1.5.sample.csv-06.24.2016",
    "description" : "",
    "created" : 1466776518072,
    "createdAsString" : "2016-06-24T13:55:18.072Z",
    "status" : "COMPLETED",
    "resolutionMethod" : "RESOLUTION_IGNORE",
    "completed" : 1466776524461,
    "completedAsString" : "2016-06-24T13:55:24.461Z",
    "successCount" : 1,
    "failedCount" : 0,
    "ignoredCount" : 0,
    "registeredCount" : 1,
    "updatedCount" : 0,
    "links" : [ {
      "href" : "http://iotserver/iot/api/v2/registrations/0-AE",
      "rel" : "self"
    } ],
    "successEntries" : {
      "links" : [ {
        "href" : "http://iotserver/iot/api/v2/registrations/0-AE/successEntries",
        "rel" : "canonical"
      } ]
    },
    "ignoredEntries" : {
      "links" : [ {
        "href" : "http://iotserver/iot/api/v2/registrations/0-AE/ignoredEntries",
        "rel" : "canonical"
      } ]
    },
    "failedEntries" : {
      "links" : [ {
        "href" : "http://iotserver/iot/api/v2/registrations/0-AE/failedEntries",
        "rel" : "canonical"
      } ]
    }
  }, {
    "id" : "0-AI",
    "name" : "16.3.3.sample.csv-06.24.2016",
    "description" : "",
    "created" : 1466776537438,
    "createdAsString" : "2016-06-24T13:55:37.438Z",
    "status" : "COMPLETED",
    "resolutionMethod" : "RESOLUTION_IGNORE",
    "completed" : 1466776543637,
    "completedAsString" : "2016-06-24T13:55:43.637Z",
    "successCount" : 4,
    "failedCount" : 0,
    "ignoredCount" : 0,
    "registeredCount" : 4,
    "updatedCount" : 0,
    "links" : [ {
      "href" : "http://iotserver/iot/api/v2/registrations/0-AI",
      "rel" : "self"
    } ],
    "successEntries" : {
      "links" : [ {
        "href" : "http://iotserver/iot/api/v2/registrations/0-AI/successEntries",
        "rel" : "canonical"
      } ]
    },
    "ignoredEntries" : {
      "links" : [ {
        "href" : "http://iotserver/iot/api/v2/registrations/0-AI/ignoredEntries",
        "rel" : "canonical"
      } ]
    },
    "failedEntries" : {
      "links" : [ {
        "href" : "http://iotserver/iot/api/v2/registrations/0-AI/failedEntries",
        "rel" : "canonical"
      } ]
    }
  } ],
  "links" : [ {
    "href" : "http://iotserver/iot/api/v2/registrations?offset=0&limit=10",
    "rel" : "self"
  }, {
    "href" : "http://iotserver/iot/api/v2/registrations",
    "rel" : "canonical"
  }, {
    "href" : "http://iotserver/iot/api/v2/registrations?offset=0&limit=10",
    "rel" : "first"
  }, {
    "href" : "http://iotserver/iot/api/v2/registrations?offset=0&limit=10",
    "rel" : "last"
  } ],
  "offset" : 0,
  "limit" : 10,
  "count" : 2,
  "hasMore" : false
}

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/iot/api/v2/registrations 

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 

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