Jump to

• Request
• Response

Replace a config element: SD.response-map

put

https://cloud-native-SBC-IP/config/v1/sd/response-map/{ElementKey}

Replace a config element: SD.response-map

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure SIP response maps

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• entries: array entries
  Unique Items Required: true

  add response map entry
• name(required): string
  Minimum Length: 1

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

  name of response map

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of response map",
            "minLength":1,
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "entries":{
            "description":"add response map entry",
            "items":{
                "$ref":"#/components/schemas/ResponseMapEntry"
            },
            "type":"array",
            "uniqueItems":true
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure SIP response maps",
    "type":"object"
}

Nested Schema : entries

Type: array

Unique Items Required: true

add response map entry

Show Source

• Array of: object ResponseMapEntry
  edit response map entry

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

Nested Schema : ResponseMapEntry

Type: object

edit response map entry

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• method: string
  Allowed Values: [ "REGISTER" ]
• reason: string
  translated response comment to send (in quotes)
• recv-code(required): integer (int32)
  Minimum Value: 0

  Maximum Value: 699

  1-699: received response code
• xmit-code: integer (int32)
  Minimum Value: 0

  Maximum Value: 699

  1-699: translated SIP response code to send

{
    "required":[
        "recv-code"
    ],
    "properties":{
        "recv-code":{
            "description":"1-699: received response code",
            "format":"int32",
            "maximum":699,
            "minimum":0,
            "type":"integer"
        },
        "xmit-code":{
            "description":"1-699: translated SIP response code to send",
            "format":"int32",
            "maximum":699,
            "minimum":0,
            "type":"integer"
        },
        "reason":{
            "description":"translated response comment to send (in quotes)",
            "type":"string"
        },
        "method":{
            "$ref":"#/components/schemas/RespMapMethodConstraintEnum"
        },
        "_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 one config element: ResponseMap

Body ()

Root Schema : schema

Type: object

configure SIP response maps

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• entries: array entries
  Unique Items Required: true

  add response map entry
• name(required): string
  Minimum Length: 1

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

  name of response map

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of response map",
            "minLength":1,
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "entries":{
            "description":"add response map entry",
            "items":{
                "$ref":"#/components/schemas/ResponseMapEntry"
            },
            "type":"array",
            "uniqueItems":true
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure SIP response maps",
    "type":"object"
}

Nested Schema : entries

Type: array

Unique Items Required: true

add response map entry

Show Source

• Array of: object ResponseMapEntry
  edit response map entry

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

Nested Schema : ResponseMapEntry

Type: object

edit response map entry

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• method: string
  Allowed Values: [ "REGISTER" ]
• reason: string
  translated response comment to send (in quotes)
• recv-code(required): integer (int32)
  Minimum Value: 0

  Maximum Value: 699

  1-699: received response code
• xmit-code: integer (int32)
  Minimum Value: 0

  Maximum Value: 699

  1-699: translated SIP response code to send

{
    "required":[
        "recv-code"
    ],
    "properties":{
        "recv-code":{
            "description":"1-699: received response code",
            "format":"int32",
            "maximum":699,
            "minimum":0,
            "type":"integer"
        },
        "xmit-code":{
            "description":"1-699: translated SIP response code to send",
            "format":"int32",
            "maximum":699,
            "minimum":0,
            "type":"integer"
        },
        "reason":{
            "description":"translated response comment to send (in quotes)",
            "type":"string"
        },
        "method":{
            "$ref":"#/components/schemas/RespMapMethodConstraintEnum"
        },
        "_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