Jump to

• Request
• Response

Add an associated device to a route set

post

/rest/{versionId}/routeSets/{routeSetId}/devices

Use this (POST) method to add an associated device to a specified route set.User needs to provide route set id as part of resource uri and associated device details (device group id) as part of method body.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• routeSetId: string
  The id of route set to which association needs to be added.
• versionId: string
  The rest api version, it's value is v1.3.

Body ()

The device association information to be added to route set.

Root Schema : associatedDevice

Type: object

Show Source

• deviceGroupId(optional): string
• deviceGroupName(optional): string
• version(optional): string

{
    "properties":{
        "deviceGroupId":{
            "type":"string"
        },
        "deviceGroupName":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"associatedDevice"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

403 Response

There is no permission to access the resources.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

500 Response

Internal server error

Back to Top