Jump to

• Request
• Response
• Examples

Update Default Device Selection Group

post

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

Updated default device selection group

Request

Supported Media Types

• application/json

Path Parameters

• app-id: string
  Application id

Header Parameters

• X-HTTP-Method-Override: string
  To perform a partial update of the device selection group, POST request should be orchestrated with method override set to PATCH

Body ()

Root Schema : DeviceSelectionGroupImpl_update

Type: object

Show Source

• description(optional): string
  Property description was not set
• membership(optional): object Membership_update
• name(optional): string
  Property description was not set

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

Nested Schema : Membership_update

Type: object

Show Source

• filter(optional): string
  Property description was not set
• selectionMode(optional): 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"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

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

200 Response

Successfully processed.

Body ()

Root Schema : DeviceSelectionGroupImpl_receive

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"
}

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Response

Unauthorized. The request requires user authentication.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

405 Response

Method Not Allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

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.

415 Response

Unsupported Media Type. The request entity has a media type which the server or resource does not support.

Back to Top

Examples

The following example shows how to update default device selection group of an application with app-id 63b36d2e204b-5c4 of the IoT Cloud Service instance by submitting a POST 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 POST -k -H 'Accept: application/json' -H "X-HTTP-Method-Override: PATCH {
   "name":"String with group name",
   "description":"String with group description",
   "membership":{
      "filter":"String with query parameter for current group",
      "selectionMode":"ALL"
   }
}" -u '[e-mail]:password' http://iotserver/iot/api/v2/apps/63b36d2e204b-5c4/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.

{
   "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"
   }
}

Back to Top