Jump to

• Request
• Response
• Examples

Get Device Management Summary Information

get

/rest/{versionId}/inventory/deviceMgmt/devices

Use this (GET) method to retrieve the summary device information for all devices that the user has privileges to view in Device Manager. The user can filter the query request using the query parameters provided in the request.

Request

Path Parameters

• versionId: string

Query Parameters

• immediateChildren(optional): string
• parentGroupId(optional): string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : devices

Type: object

Show Source

• devices(optional): array device

{
    "type":"object",
    "properties":{
        "devices":{
            "type":"array",
            "xml":{
                "name":"device"
            },
            "items":{
                "$ref":"#/definitions/RestDevice"
            }
        }
    },
    "xml":{
        "name":"devices"
    }
}

Nested Schema : device

Type: array

Show Source

• Array of: object device

{
    "type":"array",
    "xml":{
        "name":"device"
    },
    "items":{
        "$ref":"#/definitions/RestDevice"
    }
}

Nested Schema : device

Type: object

Show Source

• bootstrapState(optional): string
• connectivityStatus(optional): boolean
  Default Value: false
• description(optional): string
• groupParameters(optional): array groupParameter
• id(optional): string
• ip(optional): string
• key(optional): string
• manageable(optional): boolean
  Default Value: false
• name(optional): string
• nfId(optional): string
• nfName(optional): string
• parameters(optional): array parameter
  parameters
• parentGroupId(optional): string
• platformInfo(optional): object platformInfo
• softwareInfo(optional): object softwareInfo

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "key":{
            "type":"string"
        },
        "ip":{
            "type":"string"
        },
        "parentGroupId":{
            "type":"string"
        },
        "nfId":{
            "type":"string"
        },
        "nfName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "connectivityStatus":{
            "type":"boolean",
            "default":false
        },
        "bootstrapState":{
            "type":"string"
        },
        "softwareInfo":{
            "$ref":"#/definitions/RestDeviceSoftwareInfo"
        },
        "platformInfo":{
            "$ref":"#/definitions/RestDevicePlatformInfo"
        },
        "parameters":{
            "type":"array",
            "xml":{
                "name":"parameter",
                "wrapped":true
            },
            "description":"parameters",
            "items":{
                "$ref":"#/definitions/RestParameter"
            }
        },
        "groupParameters":{
            "type":"array",
            "xml":{
                "name":"groupParameter",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestParameter"
            }
        },
        "manageable":{
            "type":"boolean",
            "default":false
        }
    },
    "xml":{
        "name":"device"
    }
}

Nested Schema : groupParameter

Type: array

Show Source

• Array of: object parameter

{
    "type":"array",
    "xml":{
        "name":"groupParameter",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/RestParameter"
    }
}

Nested Schema : parameter

Type: array

parameters

Show Source

• Array of: object parameter

{
    "type":"array",
    "xml":{
        "name":"parameter",
        "wrapped":true
    },
    "description":"parameters",
    "items":{
        "$ref":"#/definitions/RestParameter"
    }
}

Nested Schema : platformInfo

Type: object

Show Source

• platform(optional): string
• serialNumber(optional): string
• timeZoneInfo(optional): object timeZoneInfo

{
    "type":"object",
    "properties":{
        "platform":{
            "type":"string"
        },
        "serialNumber":{
            "type":"string"
        },
        "timeZoneInfo":{
            "$ref":"#/definitions/RestDeviceTimeZoneInfo"
        }
    },
    "xml":{
        "name":"platformInfo"
    }
}

Nested Schema : softwareInfo

Type: object

Show Source

• configVersion(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string"
        },
        "configVersion":{
            "type":"string"
        }
    },
    "xml":{
        "name":"softwareInfo"
    }
}

Nested Schema : parameter

Type: object

Show Source

• description(optional): string
• label(optional): string
• maxValue(optional): integer(int64)
• minValue(optional): integer(int64)
• name(optional): string
• readOnly(optional): boolean
  Default Value: false
• validValues(optional): array validValue
• value(optional): string
• valueList(optional): array validLists
• valueType(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "valueType":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "valueList":{
            "type":"array",
            "xml":{
                "name":"validLists",
                "wrapped":true
            },
            "items":{
                "type":"string"
            }
        },
        "validValues":{
            "type":"array",
            "xml":{
                "name":"validValue",
                "wrapped":true
            },
            "items":{
                "type":"string"
            }
        },
        "label":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "minValue":{
            "type":"integer",
            "format":"int64"
        },
        "maxValue":{
            "type":"integer",
            "format":"int64"
        },
        "readOnly":{
            "type":"boolean",
            "default":false
        }
    },
    "xml":{
        "name":"parameter"
    }
}

Nested Schema : validValue

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "xml":{
        "name":"validValue",
        "wrapped":true
    },
    "items":{
        "type":"string"
    }
}

Nested Schema : validLists

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "xml":{
        "name":"validLists",
        "wrapped":true
    },
    "items":{
        "type":"string"
    }
}

Nested Schema : timeZoneInfo

Type: object

Show Source

• daySaveTimeEnd(optional): string
• daySaveTimeStart(optional): string
• minFromUTC(optional): string

{
    "type":"object",
    "properties":{
        "minFromUTC":{
            "type":"string"
        },
        "daySaveTimeStart":{
            "type":"string"
        },
        "daySaveTimeEnd":{
            "type":"string"
        }
    },
    "xml":{
        "name":"timeZoneInfo"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

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

Back to Top

Examples

The following example shows how to display existing devices by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

Example of cURL Data

The following shows an example of cURL data sent with the request.

curl -v -s -b sessionid.txt -X GET -H"Content-Type: application/xml" -H"Accept: application/xml" http://example.com:8080/rest/v1.1/inventory/deviceMgmt/devices

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Fri, 24 Feb 2017 19:39:17 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
Content-Length: 914
Vary: Accept-Encoding
Content-Type: application/xml

Example of Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<devices>
  <device>
    <connectivityStatus>true</connectivityStatus>
    <id>ID1</id>
    <ip>10.0.0.23</ip>
    <key>PLATO_10.0.0.23</key>
    <manageable>true</manageable>
    <name>PLATO</name>
    <nfId>ID4</nfId>
    <nfName>sd0</nfName>
    <parentGroupId>ID4</parentGroupId>
    <platformInfo>
      <platform>NNOSVM</platform>
      <serialNumber>--</serialNumber>
    </platformInfo>
    <softwareInfo>
      <configVersion>7</configVersion>
      <version>SCZ740m1</version>
    </softwareInfo>
  </device>
  <device>
    <connectivityStatus>true</connectivityStatus>
    <id>ID2</id>
    <ip>10.0.0.24</ip>
    <key>ARISTOTLE_10.0.0.24</key>
    <manageable>true</manageable>
    <name>ARISTOTLE</name>
    <nfId>ID6</nfId>
    <nfName>sd1</nfName>
    <parentGroupId>ID6</parentGroupId>
    <platformInfo>
      <platform>NNOSVM</platform>
      <serialNumber>--</serialNumber>
    </platformInfo>
    <softwareInfo>
      <configVersion>5</configVersion>
      <version>SCZ740m1</version>
    </softwareInfo>
  </device>
</devices>

Back to Top