Jump to

• Request
• Response

Retrieve the entitlement lists with full details

get

https://cloud-native-SBC-IP/config/v1/license/entitlement

Retrieve the entitlement lists with full details

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieve the entitlement lists with full details

Body ()

Root Schema : EntitlementDetails

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• defaultValue: string
  default Value of entitlement can be 0 or false
• description: string
  entitlement description
• entitlementName: string
  entitlement description
• key: string
  key name of capacities/features that user can use to modify the values
• type: string type
  type of entitlement can be int or boolean
• value: string
  current configured value of entitlement

{
    "properties":{
        "key":{
            "description":"key name of capacities/features that user can use to modify the values",
            "type":"string"
        },
        "entitlementName":{
            "description":"entitlement description",
            "type":"string"
        },
        "description":{
            "description":"entitlement description",
            "type":"string"
        },
        "type":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/EntitlementTypeEnum"
                }
            ],
            "description":"type of entitlement can be int or boolean",
            "type":"string"
        },
        "defaultValue":{
            "description":"default Value of entitlement can be 0 or false",
            "type":"string"
        },
        "value":{
            "description":"current configured value of entitlement",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : type

type of entitlement can be int or boolean

Match All

type of entitlement can be int or boolean

Show Source

• string
  Allowed Values: [ "INTEGER", "BOOLEAN" ]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/EntitlementTypeEnum"
        }
    ],
    "description":"type of entitlement can be int or boolean",
    "type":"string"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top