REST API for Oracle Internet of Things Cloud Service

Retrieve the Default Device Selection Group

get

/iot/api/v2/apps/{app-id}/deviceSelectionGroups/default

Retrieve default device selection group

Request

Path Parameters

app-id: string

Application id

Response

Supported Media Types

application/json
application/vnd.oracle.resource+json;type=singular

200 Response

Successfully processed.

Root Schema : DeviceSelectionGroupImpl_receive_list

Type: object

Show Source

count: integer(int32)
hasMore: boolean
items: array items
limit: integer(int32)
links: array links

The set of API navigation links.
offset: integer(int32)

{
    "properties":{
        "count":{
            "format":"int32",
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "items":{
                "properties":{
                    "description":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "membership":{
                        "$ref":"#/definitions/Membership_receive"
                    },
                    "name":{
                        "description":"Property description was not set",
                        "type":"string"
                    }
                },
                "required":[
                    "membership",
                    "name",
                    "description"
                ],
                "type":"object"
            },
            "type":"array"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "links":{
            "description":"The set of API navigation links.",
            "items":{
                "properties":{
                    "href":{
                        "description":"The target resource URI",
                        "example":"https://iotserver/iot/api/vX/some/API/path",
                        "type":"string"
                    },
                    "rel":{
                        "description":"Relation type",
                        "example":"canonical",
                        "type":"string"
                    }
                },
                "type":"object"
            },
            "type":"array"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        }
    },
    "required":[
        "items",
        "links",
        "limit",
        "offset",
        "count",
        "hasMore"
    ],
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "items":{
        "properties":{
            "description":{
                "description":"Property description was not set",
                "type":"string"
            },
            "membership":{
                "$ref":"#/definitions/Membership_receive"
            },
            "name":{
                "description":"Property description was not set",
                "type":"string"
            }
        },
        "required":[
            "membership",
            "name",
            "description"
        ],
        "type":"object"
    },
    "type":"array"
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

Array of: object items

{
    "description":"The set of API navigation links.",
    "items":{
        "properties":{
            "href":{
                "description":"The target resource URI",
                "example":"https://iotserver/iot/api/vX/some/API/path",
                "type":"string"
            },
            "rel":{
                "description":"Relation type",
                "example":"canonical",
                "type":"string"
            }
        },
        "type":"object"
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

description: string

Property description was not set
membership: object Membership_receive
name: string

Property description was not set

{
    "properties":{
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "membership":{
            "$ref":"#/definitions/Membership_receive"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "membership",
        "name",
        "description"
    ],
    "type":"object"
}

Nested Schema : Membership_receive

Type: object

Show Source

filter: string

Property description was not set
selectionMode: string

One of [ALL, NONE, FILTER, NULL, UNKNOWN].

{
    "properties":{
        "filter":{
            "description":"Property description was not set",
            "type":"string"
        },
        "selectionMode":{
            "description":"One of [ALL, NONE, FILTER, NULL, UNKNOWN].",
            "type":"string"
        }
    },
    "required":[
        "selectionMode",
        "filter"
    ],
    "type":"object"
}

Nested Schema : items

Type: object

Show Source

href(optional): string

The target resource URI

Example: https://iotserver/iot/api/vX/some/API/path
rel(optional): string

Relation type

Example: canonical

{
    "properties":{
        "href":{
            "description":"The target resource URI",
            "example":"https://iotserver/iot/api/vX/some/API/path",
            "type":"string"
        },
        "rel":{
            "description":"Relation type",
            "example":"canonical",
            "type":"string"
        }
    },
    "type":"object"
}

401 Response

Unauthorized. The request requires user authentication.

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

Examples

The following example shows how to view the default device selection group of an application with app_id 1bf92a6056b5-2ad8 of an IoT Cloud Service instance by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Note:

In the 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.

curl -X GET -k -H 'Accept: application/json' -u 'username@example.com:password' http://iotserver/iot/api/v2/apps/1bf92a6056b5-2ad8/deviceSelectionGroups/default

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.

{
   "offset":0,
   "count":2,
   "limit":10,
   "hasMore":false,
   "links":[
      {
         "rel":"self",
         "href":"http://iotserver/iot/api/version/resource/path"
      },
      {
         "rel":"canonical",
         "href":"http://iotserver/iot/api/version/resource/path"
      }
   ],
   "items":[
      {
         "name":"String with group name",
         "description":"String with group description",
         "links":[
            {
               "rel":"self",
               "href":"http://iotserver/iot/api/version/resource/path"
            },
            {
               "rel":"canonical",
               "href":"http://iotserver/iot/api/version/resource/path"
            }
         ],
         "membership":{
            "filter":"String with query parameter for current group",
            "links":[
               {
                  "rel":"self",
                  "href":"http://iotserver/iot/api/version/resource/path"
               },
               {
                  "rel":"canonical",
                  "href":"http://iotserver/iot/api/version/resource/path"
               }
            ],
            "selectionMode":"ALL"
         }
      },
      {
         "name":"String with group name",
         "description":"String with group description",
         "links":[
            {
               "rel":"self",
               "href":"http://iotserver/iot/api/version/resource/path"
            },
            {
               "rel":"canonical",
               "href":"http://iotserver/iot/api/version/resource/path"
            }
         ],
         "membership":{

         }
      }
   ]
}