Jump to

• Request
• Response

Retrieve one config element: SD.sip-recursion-policy

get

https://cloud-native-SBC-IP/config/v1/sd/sip-recursion-policy/{ElementKey}

Retrieve one config element: SD.sip-recursion-policy

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: SipRecursionPolicy

Body ()

Root Schema : schema

Type: object

configure SIP recursion policy

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• description: string
  brief description of recursion policy usage
• global-count: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  global count for number of total count for the configured response codes
• mode: string
  Allowed Values: [ "consecutive", "absolute" ]
• name(required): string
  Minimum Length: 1

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

  sip-recursion-policy list name
• sip-resp-code-attempts: array sip-resp-code-attempts
  list of SIP response code attempts

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"sip-recursion-policy list name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "description":{
            "description":"brief description of recursion policy usage",
            "type":"string"
        },
        "global-count":{
            "description":"global count for number of total count for the configured response codes",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "mode":{
            "$ref":"#/components/schemas/RecursionPolicyModeEnum"
        },
        "sip-resp-code-attempts":{
            "description":"list of SIP response code attempts",
            "items":{
                "$ref":"#/components/schemas/SipRespCodeAttempts"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure SIP recursion policy",
    "type":"object"
}

Nested Schema : sip-resp-code-attempts

Type: array

list of SIP response code attempts

Show Source

• Array of: object SipRespCodeAttempts
  list of SIP response code settings

{
    "description":"list of SIP response code attempts",
    "items":{
        "$ref":"#/components/schemas/SipRespCodeAttempts"
    },
    "type":"array"
}

Nested Schema : SipRespCodeAttempts

Type: object

list of SIP response code settings

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attempts: integer (int64)
  Minimum Value: 1

  Maximum Value: 1000

  Number for attempts to make
• response-code(required): integer (int64)
  Minimum Value: 300

  Maximum Value: 599

  SIP Response Code. For e.g. 301/488/503

{
    "required":[
        "response-code"
    ],
    "properties":{
        "response-code":{
            "description":"SIP Response Code. For e.g. 301/488/503",
            "format":"int64",
            "maximum":599,
            "minimum":300,
            "type":"integer"
        },
        "attempts":{
            "description":"Number for attempts to make",
            "format":"int64",
            "maximum":1000,
            "minimum":1,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of SIP response code settings",
    "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