Jump to

• Request
• Response

Retrieve one config element: SD.session-timer-profile

get

https://cloud-native-SBC-IP/config/v1/sd/session-timer-profile/{ElementKey}

Retrieve one config element: SD.session-timer-profile

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Query Parameters

• revision-id: string
  Integer value of saved revision, or 'latest', 'active' to show the running config, or 'staging' to show complete configuration to be activated

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: SessionTimerProfile

Body ()

Root Schema : schema

Type: object

configure session timer profile

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• force-reinvite: boolean
  always use re-INVITE for refreshes
• min-se: integer (int64)
  Minimum Value: 64

  Maximum Value: 999999999

  min-se value (in seconds)
• name(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the session timer profile
• request-refresher: string
  Allowed Values: [ "none", "uac", "uas" ]
• response-refresher: string
  Allowed Values: [ "none", "uac", "uas" ]
• session-expires: integer (int64)
  Minimum Value: 64

  Maximum Value: 999999999

  session duration (in seconds)

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of the session timer profile",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "session-expires":{
            "description":"session duration (in seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":64,
            "type":"integer"
        },
        "min-se":{
            "description":"min-se value (in seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":64,
            "type":"integer"
        },
        "force-reinvite":{
            "description":"always use re-INVITE for refreshes",
            "type":"boolean"
        },
        "request-refresher":{
            "$ref":"#/components/schemas/SessionTimerRefresherEnum"
        },
        "response-refresher":{
            "$ref":"#/components/schemas/SessionTimerRefresherEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure session timer profile",
    "type":"object"
}

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