Jump to

• Request
• Response

Get Device Configuration Management Summary Information

get

/rest/{versionId}/configuration/devices/{deviceId}

Use this (GET) method to retrieve a summary of the targeted device information such as software version, platform, provisioning status, management IP address, if there are any configuration modifications pending, and so on.

Request

Path Parameters

• deviceId: string
• versionId: string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root 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
• lastOperation(optional): string
• loadedConfigVersion(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
• pendingChanges(optional): string
• platformInfo(optional): object platformInfo
• softwareInfo(optional): object softwareInfo
• status(optional): string
• statusChangeTime(optional): string

{
    "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"
            }
        },
        "loadedConfigVersion":{
            "type":"string"
        },
        "lastOperation":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "statusChangeTime":{
            "type":"string"
        },
        "pendingChanges":{
            "type":"string"
        },
        "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