Jump to

• Request
• Response

Replace a sub-element: SD.session-agent.match-identifier

put

https://cloud-native-SBC-IP/config/v1/sd/session-agent/{ElementKey}/match-identifier/{ElementKeySE}

Replace a sub-element: SD.session-agent.match-identifier

Request

Path Parameters

• ElementKey: string
  Identifier for the element
• ElementKeySE: string
  Identifier for the sub-element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Identification criteria to match this agent

Show Source

• _elementKey: string
  Read Only: true

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

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

  specify the session-agent-identifier-rule which will be used to identify this agent if not matching by IP Address
• match-value(required): string
  Minimum Length: 1

  Pattern: ^.*$

  value to match in sip header field which identifies this Session Agent

{
    "required":[
        "identifier-rule",
        "match-value"
    ],
    "properties":{
        "identifier-rule":{
            "description":"specify the session-agent-identifier-rule which will be used to identify this agent if not matching by IP Address",
            "minLength":1,
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "match-value":{
            "description":"value to match in sip header field which identifies this Session Agent",
            "minLength":1,
            "pattern":"^.*$",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Identification criteria to match this agent",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one sub element: SessionAgentIdentifier

Body ()

Root Schema : schema

Type: object

Identification criteria to match this agent

Show Source

• _elementKey: string
  Read Only: true

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

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

  specify the session-agent-identifier-rule which will be used to identify this agent if not matching by IP Address
• match-value(required): string
  Minimum Length: 1

  Pattern: ^.*$

  value to match in sip header field which identifies this Session Agent

{
    "required":[
        "identifier-rule",
        "match-value"
    ],
    "properties":{
        "identifier-rule":{
            "description":"specify the session-agent-identifier-rule which will be used to identify this agent if not matching by IP Address",
            "minLength":1,
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "match-value":{
            "description":"value to match in sip header field which identifies this Session Agent",
            "minLength":1,
            "pattern":"^.*$",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Identification criteria to match this agent",
    "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"
}

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