Jump to

• Request
• Response

Retrieve all config elements: SD.session-agent-id-rule

get

https://cloud-native-SBC-IP/config/v1/sd/session-agent-id-rule

Retrieve all config elements: SD.session-agent-id-rule

Request

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 all config elements: SessionAgentIdentifierRule

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema
  configure alternative session-agent identification rules

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

Nested Schema : schema

Type: object

configure alternative session-agent identification rules

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• match-header(required): string
  Minimum Length: 1

  Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  sip header used to identify the Session Agent
• match-parameter: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  parameter within the specified sip header field to be used to identify the Session Agent
• name(required): string
  Minimum Length: 1

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

  name of the identification scenario
• uri-type: string
  Allowed Values: [ "none", "uri-param", "uri-header", "uri-user", "uri-host", "uri-port", "uri-user-param", "uri-display", "uri-user-only", "uri-phone-number-only" ]

{
    "required":[
        "name",
        "match-header"
    ],
    "properties":{
        "name":{
            "description":"name of the identification scenario",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "match-header":{
            "description":"sip header used to identify the Session Agent",
            "minLength":1,
            "pattern":"^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\\[(([0-9]+)|([*^]))\\])?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "match-parameter":{
            "description":"parameter within the specified sip header field to be used to identify the Session Agent",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "uri-type":{
            "$ref":"#/components/schemas/IdURITypeConstraintEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure alternative session-agent identification rules",
    "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