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

Retrieve Information in a Registration File Format

get

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

Returns the comma-separated values (CSV) that contain information about the endpoints that were registered or updated.

Request

Path Parameters
Query Parameters
  • Specifies the registration information to be returned. Valid values are 'added' and 'updated'. If 'type' is not specified, the default value is 'added'. Optional. Example: ?type=added,updated
Back to Top

Response

Supported Media Types
Back to Top

Examples

The following example shows how to view the comma-separated values (CSV) that contain information about registered devices 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 -K -u username@example.com:welcome1 -H "Accept: text/plain" https://iotserver/iot/api/v2/registrations/0-AI/registrationFile?type=added,updated

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Content-Type: text/plain

Example of Response Body

The following example shows the contents of the response body in JSON format. Note that only CSV values for devices that have been both uploaded and successfully registered will appear in the list.

1,Manufacturer,ModelNumber,SerialNumber,0-AQ,Device-UID,SharedSecret
2,Omron,XXS,SOP-123-6565,0-AU,0-AU-Omron-XXS-SOP-123-6565,vqru1gfi2oii
3,Manufacturer,Model-Abc,Serial-123,0-AY,OEG-12345,60okqu28fqdt2
curl -X GET 
   -u <username>:<password> 
   https://iotserver/iot/api/v2/registrations/{registration-id}/registrationFile




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> 
   https://iotserver/iot/api/v2/registrations/611f2c4f102b-5fb8/registrationFile



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