Jump to

• Request
• Response

Get Device License Information

get

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

Use this (GET) method to retrieve license information for a device.

Request

Path Parameters

• versionId: string

Query Parameters

• platform(optional): string
• productType(optional): string
• softwareVersion(optional): string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : Entitlements

Type: object

Show Source

• capacities(optional): array capacities
• features(optional): array features
• productTypeKey(optional): string
• productTypeName(optional): string

{
    "type":"object",
    "properties":{
        "productTypeKey":{
            "type":"string"
        },
        "productTypeName":{
            "type":"string"
        },
        "features":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Feature"
            }
        },
        "capacities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Capacity"
            }
        }
    }
}

Nested Schema : capacities

Type: array

Show Source

• Array of: object Capacity

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Capacity"
    }
}

Nested Schema : features

Type: array

Show Source

• Array of: object Feature

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Feature"
    }
}

Nested Schema : Capacity

Type: object

Show Source

• description(optional): string
• inc(optional): integer(int32)
• key(optional): string
• max(optional): integer(int32)
• min(optional): integer(int32)
• value(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "min":{
            "type":"integer",
            "format":"int32"
        },
        "max":{
            "type":"integer",
            "format":"int32"
        },
        "inc":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Feature

Type: object

Show Source

• description(optional): string
• key(optional): string
• value(optional): string
• warning(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "warning":{
            "type":"string"
        }
    }
}

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