Jump to

• Request
• Response

GET all associated device from a perticular route set

get

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

Use this method (GET) to get all associated devices to a specified route set.User needs to provide route set id as part of resource uri. API returns list of associated devices for the route set.

Request

Path Parameters

• routeSetId: string
  The route set id from which we need device associations.
• versionId: string
  The rest api version, it's value is v1.3.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : associatedDevices

Type: object

Show Source

• assocDevices(optional): array associatedDevice

{
    "properties":{
        "assocDevices":{
            "items":{
                "$ref":"#/definitions/RestAssociatedDevice",
                "xml":{
                    "name":"associatedDevice"
                }
            },
            "type":"array",
            "xml":{
                "name":"associatedDevice"
            }
        }
    },
    "type":"object",
    "xml":{
        "name":"associatedDevices"
    }
}

Nested Schema : associatedDevice

Type: array

Show Source

• Array of: object associatedDevice

{
    "items":{
        "$ref":"#/definitions/RestAssociatedDevice",
        "xml":{
            "name":"associatedDevice"
        }
    },
    "type":"array",
    "xml":{
        "name":"associatedDevice"
    }
}

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

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