Jump to

• Request
• Response

Add a sub-element: SD.sip-adv-log-trace.conditions

post

https://cloud-native-SBC-IP/config/v1/sd/sip-adv-log-trace/{ElementKey}/conditions

Add a sub-element: SD.sip-adv-log-trace.conditions

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Configure conditions for matching SIP requests/sessions

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• match-procedure: string
  Allowed Values: [ "exact-match", "regex-match" ]
• match-type(required): string
  Allowed Values: [ "request-type", "recv-agent", "recv-realm", "request-uri-user", "request-uri-host", "to-header-user", "to-header-host", "from-header-user", "from-header-host", "call-id" ]
• match-value: string
  Exact value to match or regular expression format. For match-type = request-type, Valid Values : REGISTER, INVITE, ACK, BYE, CANCEL, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH

{
    "required":[
        "match-type"
    ],
    "properties":{
        "match-type":{
            "$ref":"#/components/schemas/CondLoggingConditionEnum"
        },
        "match-procedure":{
            "$ref":"#/components/schemas/CondLoggingMatchProcedureEnum"
        },
        "match-value":{
            "description":"Exact value to match or regular expression format. For match-type = request-type, Valid Values : REGISTER, INVITE, ACK, BYE, CANCEL, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Configure conditions for matching SIP requests/sessions",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one sub element: SipAdvancedLogCondition

Body ()

Root Schema : schema

Type: object

Configure conditions for matching SIP requests/sessions

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• match-procedure: string
  Allowed Values: [ "exact-match", "regex-match" ]
• match-type(required): string
  Allowed Values: [ "request-type", "recv-agent", "recv-realm", "request-uri-user", "request-uri-host", "to-header-user", "to-header-host", "from-header-user", "from-header-host", "call-id" ]
• match-value: string
  Exact value to match or regular expression format. For match-type = request-type, Valid Values : REGISTER, INVITE, ACK, BYE, CANCEL, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH

{
    "required":[
        "match-type"
    ],
    "properties":{
        "match-type":{
            "$ref":"#/components/schemas/CondLoggingConditionEnum"
        },
        "match-procedure":{
            "$ref":"#/components/schemas/CondLoggingMatchProcedureEnum"
        },
        "match-value":{
            "description":"Exact value to match or regular expression format. For match-type = request-type, Valid Values : REGISTER, INVITE, ACK, BYE, CANCEL, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Configure conditions for matching SIP requests/sessions",
    "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