Jump to

• Request
• Response

Replace a config element: SD.session-group

put

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

Replace a config element: SD.session-group

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure session agent groups

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• app-protocol: string
  Allowed Values: [ "SIP" ]
• description: string
  session agent group description
• dest: array dest
  list of destinations for this group
• group-name(required): string
  Minimum Length: 1

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

  session agent group name
• sag-recursion: boolean
  enable sag recursion
• sip-recursion-policy: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  SIP Recursion Policy
• state: boolean
  administrative state
• stop-sag-recurse: string
  Pattern: ^$|^[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[3-5][0-9][0-9]))*$|^[3-5][0-9][0-9]-[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[2-5][0-9][0-9]))*$

  Response codes that stop recursion of SAs in SAG
• strategy: string
  Allowed Values: [ "Hunt", "RoundRobin", "LeastBusy", "PropDist", "LowSusRate" ]
• trunk-group: array trunk-group
  list of trunk groups and their contexts for this group. To use the default context case, omit : and the context

{
    "required":[
        "group-name"
    ],
    "properties":{
        "group-name":{
            "description":"session agent group name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "description":{
            "description":"session agent group description",
            "type":"string"
        },
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "app-protocol":{
            "$ref":"#/components/schemas/LPApplicationProtocolConstraintEnum"
        },
        "strategy":{
            "$ref":"#/components/schemas/StrategySagEnum"
        },
        "dest":{
            "description":"list of destinations for this group",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "trunk-group":{
            "description":"list of trunk groups and their contexts for this group. To use the default context case, omit : and the context",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "sag-recursion":{
            "description":"enable sag recursion",
            "type":"boolean"
        },
        "stop-sag-recurse":{
            "description":"Response codes that stop recursion of SAs in SAG",
            "pattern":"^$|^[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[3-5][0-9][0-9]))*$|^[3-5][0-9][0-9]-[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[2-5][0-9][0-9]))*$",
            "type":"string"
        },
        "sip-recursion-policy":{
            "description":"SIP Recursion Policy",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure session agent groups",
    "type":"object"
}

Nested Schema : dest

Type: array

list of destinations for this group

Show Source

• Array of: string

{
    "description":"list of destinations for this group",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : trunk-group

Type: array

list of trunk groups and their contexts for this group. To use the default context case, omit : and the context

Show Source

• Array of: string

{
    "description":"list of trunk groups and their contexts for this group. To use the default context case, omit : and the context",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: SessionAgentGroup

Body ()

Root Schema : schema

Type: object

configure session agent groups

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• app-protocol: string
  Allowed Values: [ "SIP" ]
• description: string
  session agent group description
• dest: array dest
  list of destinations for this group
• group-name(required): string
  Minimum Length: 1

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

  session agent group name
• sag-recursion: boolean
  enable sag recursion
• sip-recursion-policy: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  SIP Recursion Policy
• state: boolean
  administrative state
• stop-sag-recurse: string
  Pattern: ^$|^[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[3-5][0-9][0-9]))*$|^[3-5][0-9][0-9]-[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[2-5][0-9][0-9]))*$

  Response codes that stop recursion of SAs in SAG
• strategy: string
  Allowed Values: [ "Hunt", "RoundRobin", "LeastBusy", "PropDist", "LowSusRate" ]
• trunk-group: array trunk-group
  list of trunk groups and their contexts for this group. To use the default context case, omit : and the context

{
    "required":[
        "group-name"
    ],
    "properties":{
        "group-name":{
            "description":"session agent group name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "description":{
            "description":"session agent group description",
            "type":"string"
        },
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "app-protocol":{
            "$ref":"#/components/schemas/LPApplicationProtocolConstraintEnum"
        },
        "strategy":{
            "$ref":"#/components/schemas/StrategySagEnum"
        },
        "dest":{
            "description":"list of destinations for this group",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "trunk-group":{
            "description":"list of trunk groups and their contexts for this group. To use the default context case, omit : and the context",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "sag-recursion":{
            "description":"enable sag recursion",
            "type":"boolean"
        },
        "stop-sag-recurse":{
            "description":"Response codes that stop recursion of SAs in SAG",
            "pattern":"^$|^[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[3-5][0-9][0-9]))*$|^[3-5][0-9][0-9]-[3-5][0-9][0-9]((,[3-5][0-9][0-9])|(,[3-5][0-9][0-9]-[2-5][0-9][0-9]))*$",
            "type":"string"
        },
        "sip-recursion-policy":{
            "description":"SIP Recursion Policy",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure session agent groups",
    "type":"object"
}

Nested Schema : dest

Type: array

list of destinations for this group

Show Source

• Array of: string

{
    "description":"list of destinations for this group",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : trunk-group

Type: array

list of trunk groups and their contexts for this group. To use the default context case, omit : and the context

Show Source

• Array of: string

{
    "description":"list of trunk groups and their contexts for this group. To use the default context case, omit : and the context",
    "items":{
        "type":"string"
    },
    "type":"array"
}

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"
}

406 Response

Validation Failure

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