REST API for Oracle Cloud Native Session Border Controller, Release 1.25.1

Replace a sub-element: SD.sti-response-treatment-config.sti-response-treatment-entries

put

https://cloud-native-SBC-IP/config/v1/sd/sti-response-treatment-config/{ElementKey}/sti-response-treatment-entries/{ElementKeySE}

Replace a sub-element: SD.sti-response-treatment-config.sti-response-treatment-entries

Request

Path Parameters

ElementKey: string

Identifier for the element
ElementKeySE: string

Identifier for the sub-element

Supported Media Types

application/json

Root Schema : schema

Type: object

list of entries of sti responses for STI Verification

Show Source

_elementKey: string

Read Only: true

Identifier for the element or sub-element
reason-code: integer (int32)

Minimum Value: 0

Maximum Value: 599

403/428/436/437/438/custom-code
role: string

Allowed Values: [ "STI-VS" ]
sip-reason-code: integer (int32)

Minimum Value: 0

Maximum Value: 699

reason code should be in range of 4xx-6xx
sip-reason-text: string

sip reason text can be any valid string, that is included in the final response
verstat(required): string

Minimum Length: 1

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

The possible values are 'No-TN-Validation', 'TN-Validation-Passed', 'TN-Validation-Failed' or any custom string.

{
    "required":[
        "verstat"
    ],
    "properties":{
        "verstat":{
            "description":"The possible values are &#39;No-TN-Validation&#39;, &#39;TN-Validation-Passed&#39;, &#39;TN-Validation-Failed&#39; or any custom string.",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "reason-code":{
            "description":"403/428/436/437/438/custom-code",
            "format":"int32",
            "maximum":599,
            "minimum":0,
            "type":"integer"
        },
        "role":{
            "$ref":"#/components/schemas/StirShakenRoleConstraintEnum"
        },
        "sip-reason-code":{
            "description":"reason code should be in range of 4xx-6xx",
            "format":"int32",
            "maximum":699,
            "minimum":0,
            "type":"integer"
        },
        "sip-reason-text":{
            "description":"sip reason text can be any valid string, that is included in the final response",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of entries of sti responses for STI Verification",
    "type":"object"
}

Response

Supported Media Types

application/json

200 Response

return one sub element: StiResponseTreatmentEntries

Root Schema : schema

Type: object

list of entries of sti responses for STI Verification

Show Source

_elementKey: string

Read Only: true

Identifier for the element or sub-element
reason-code: integer (int32)

Minimum Value: 0

Maximum Value: 599

403/428/436/437/438/custom-code
role: string

Allowed Values: [ "STI-VS" ]
sip-reason-code: integer (int32)

Minimum Value: 0

Maximum Value: 699

reason code should be in range of 4xx-6xx
sip-reason-text: string

sip reason text can be any valid string, that is included in the final response
verstat(required): string

Minimum Length: 1

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

The possible values are 'No-TN-Validation', 'TN-Validation-Passed', 'TN-Validation-Failed' or any custom string.

{
    "required":[
        "verstat"
    ],
    "properties":{
        "verstat":{
            "description":"The possible values are &#39;No-TN-Validation&#39;, &#39;TN-Validation-Passed&#39;, &#39;TN-Validation-Failed&#39; or any custom string.",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "reason-code":{
            "description":"403/428/436/437/438/custom-code",
            "format":"int32",
            "maximum":599,
            "minimum":0,
            "type":"integer"
        },
        "role":{
            "$ref":"#/components/schemas/StirShakenRoleConstraintEnum"
        },
        "sip-reason-code":{
            "description":"reason code should be in range of 4xx-6xx",
            "format":"int32",
            "maximum":699,
            "minimum":0,
            "type":"integer"
        },
        "sip-reason-text":{
            "description":"sip reason text can be any valid string, that is included in the final response",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of entries of sti responses for STI Verification",
    "type":"object"
}

404 Response

Not Found

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

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