Jump to

• Request
• Response

Replace the config element: SD.local-response-map

put

https://cloud-native-SBC-IP/config/v1/sd/local-response-map

Replace the config element: SD.local-response-map

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure Local SIP response maps

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• entries(required): array entries
  Minimum Number of Items: 1

  Unique Items Required: true

  add response map entry

{
    "required":[
        "entries"
    ],
    "properties":{
        "entries":{
            "description":"add response map entry",
            "items":{
                "$ref":"#/components/schemas/SipLocalMapEntry"
            },
            "minItems":1,
            "type":"array",
            "uniqueItems":true
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure Local SIP response maps",
    "type":"object"
}

Nested Schema : entries

Type: array

Minimum Number of Items: 1

Unique Items Required: true

add response map entry

Show Source

• Array of: object SipLocalMapEntry
  edit response map entry

{
    "description":"add response map entry",
    "items":{
        "$ref":"#/components/schemas/SipLocalMapEntry"
    },
    "minItems":1,
    "type":"array",
    "uniqueItems":true
}

Nested Schema : SipLocalMapEntry

Type: object

edit response map entry

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• local-error(required): string
  Allowed Values: [ "unknown-error", "invalid-message", "cpu-overload", "media-released", "media-not-allocated", "enum-void-route", "monthly-minutes-exceed", "next-hop-sa-oos", "recv-sa-exc-constraints", "recv-sip-int-exc-constraints", "next-hop-sa-exc-constraints", "next-hop-sip-int-exc-constraints", "realm-bw-exc-poly-serv-reject", "no-steering-pool-ports-available", "no-media-flow-found", "no-media-interface-found-for-realm", "media-recording-failure", "allow-anonymous-rejection", "sdp-address-mismatch", "request-method-throttled", "reg-cache-full", "per-user-cac-exc-sessions", "per-user-nsep-exc-rate", "recv-conditional-cac-reject", "ldap-unavailable", "allowed-elements-profile-rejection", "recording-required", "hss-lir-timeout", "hss-lir-failure", "transcoding-licensed-session-capacity-reached", "dsp-resource-limit-reached", "licensed-session-capacity-reached", "fraud-protection-reject-call", "rx-rar-loss-of-bearer", "rx-rar-release-of-bearer", "rx-rar-out-of-credit", "rx-rar-failed-resources-allocation", "rx-rar-access-network-info-reporting_failure", "rx-asr-bearer-released", "rx-asr-insufficient-server-resources", "rx-asr-insufficient-bearer-resources", "rx-asr-ps-to-cs-handover", "rx-asr-sponsored-data-connectivity-disallowed" ]
• method: string
  Allowed Values: [ "REGISTER" ]
• q850-cause: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  Q850 cause code
• q850-reason: string
  Q850 cause comment
• register-response-expires: integer (int32)
  Minimum Value: 0

  Maximum Value: 999999999

  register response expires (seconds)
• sip-reason: string
  SIP response comment(in quotes)
• sip-status: integer (int32)
  Minimum Value: 0

  Maximum Value: 699

  SIP response code

{
    "required":[
        "local-error"
    ],
    "properties":{
        "local-error":{
            "$ref":"#/components/schemas/SipLocalErrorEnum"
        },
        "sip-status":{
            "description":"SIP response code",
            "format":"int32",
            "maximum":699,
            "minimum":0,
            "type":"integer"
        },
        "q850-cause":{
            "description":"Q850 cause code",
            "format":"int32",
            "maximum":2147483647,
            "minimum":0,
            "type":"integer"
        },
        "sip-reason":{
            "description":"SIP response comment(in quotes)",
            "type":"string"
        },
        "q850-reason":{
            "description":"Q850 cause comment",
            "type":"string"
        },
        "method":{
            "$ref":"#/components/schemas/LocalMapMethodConstraintEnum"
        },
        "register-response-expires":{
            "description":"register response expires (seconds)",
            "format":"int32",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"edit response map entry",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return config element: SipLocalMap

Body ()

Root Schema : schema

Type: object

configure Local SIP response maps

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• entries(required): array entries
  Minimum Number of Items: 1

  Unique Items Required: true

  add response map entry

{
    "required":[
        "entries"
    ],
    "properties":{
        "entries":{
            "description":"add response map entry",
            "items":{
                "$ref":"#/components/schemas/SipLocalMapEntry"
            },
            "minItems":1,
            "type":"array",
            "uniqueItems":true
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure Local SIP response maps",
    "type":"object"
}

Nested Schema : entries

Type: array

Minimum Number of Items: 1

Unique Items Required: true

add response map entry

Show Source

• Array of: object SipLocalMapEntry
  edit response map entry

{
    "description":"add response map entry",
    "items":{
        "$ref":"#/components/schemas/SipLocalMapEntry"
    },
    "minItems":1,
    "type":"array",
    "uniqueItems":true
}

Nested Schema : SipLocalMapEntry

Type: object

edit response map entry

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• local-error(required): string
  Allowed Values: [ "unknown-error", "invalid-message", "cpu-overload", "media-released", "media-not-allocated", "enum-void-route", "monthly-minutes-exceed", "next-hop-sa-oos", "recv-sa-exc-constraints", "recv-sip-int-exc-constraints", "next-hop-sa-exc-constraints", "next-hop-sip-int-exc-constraints", "realm-bw-exc-poly-serv-reject", "no-steering-pool-ports-available", "no-media-flow-found", "no-media-interface-found-for-realm", "media-recording-failure", "allow-anonymous-rejection", "sdp-address-mismatch", "request-method-throttled", "reg-cache-full", "per-user-cac-exc-sessions", "per-user-nsep-exc-rate", "recv-conditional-cac-reject", "ldap-unavailable", "allowed-elements-profile-rejection", "recording-required", "hss-lir-timeout", "hss-lir-failure", "transcoding-licensed-session-capacity-reached", "dsp-resource-limit-reached", "licensed-session-capacity-reached", "fraud-protection-reject-call", "rx-rar-loss-of-bearer", "rx-rar-release-of-bearer", "rx-rar-out-of-credit", "rx-rar-failed-resources-allocation", "rx-rar-access-network-info-reporting_failure", "rx-asr-bearer-released", "rx-asr-insufficient-server-resources", "rx-asr-insufficient-bearer-resources", "rx-asr-ps-to-cs-handover", "rx-asr-sponsored-data-connectivity-disallowed" ]
• method: string
  Allowed Values: [ "REGISTER" ]
• q850-cause: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  Q850 cause code
• q850-reason: string
  Q850 cause comment
• register-response-expires: integer (int32)
  Minimum Value: 0

  Maximum Value: 999999999

  register response expires (seconds)
• sip-reason: string
  SIP response comment(in quotes)
• sip-status: integer (int32)
  Minimum Value: 0

  Maximum Value: 699

  SIP response code

{
    "required":[
        "local-error"
    ],
    "properties":{
        "local-error":{
            "$ref":"#/components/schemas/SipLocalErrorEnum"
        },
        "sip-status":{
            "description":"SIP response code",
            "format":"int32",
            "maximum":699,
            "minimum":0,
            "type":"integer"
        },
        "q850-cause":{
            "description":"Q850 cause code",
            "format":"int32",
            "maximum":2147483647,
            "minimum":0,
            "type":"integer"
        },
        "sip-reason":{
            "description":"SIP response comment(in quotes)",
            "type":"string"
        },
        "q850-reason":{
            "description":"Q850 cause comment",
            "type":"string"
        },
        "method":{
            "$ref":"#/components/schemas/LocalMapMethodConstraintEnum"
        },
        "register-response-expires":{
            "description":"register response expires (seconds)",
            "format":"int32",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"edit response map entry",
    "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