Jump to

• Request
• Response

Replace the config element: SD.sip-q850-map

put

https://cloud-native-SBC-IP/config/v1/sd/sip-q850-map

Replace the config element: SD.sip-q850-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 sip to q850 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/SipQ850MapEntry"
            },
            "minItems":1,
            "type":"array",
            "uniqueItems":true
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure sip to q850 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 SipQ850MapEntry
  edit response map entry

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

Nested Schema : SipQ850MapEntry

Type: object

edit response map entry

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• q850-cause: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  Q850 cause code
• q850-reason: string
  Q850 cause comment (in quotes)
• sip-status(required): integer (int32)
  Minimum Value: 0

  Maximum Value: 699

  SIP response code

{
    "required":[
        "sip-status"
    ],
    "properties":{
        "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"
        },
        "q850-reason":{
            "description":"Q850 cause comment (in quotes)",
            "type":"string"
        },
        "_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: SipQ850Map

Body ()

Root Schema : schema

Type: object

configure sip to q850 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/SipQ850MapEntry"
            },
            "minItems":1,
            "type":"array",
            "uniqueItems":true
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure sip to q850 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 SipQ850MapEntry
  edit response map entry

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

Nested Schema : SipQ850MapEntry

Type: object

edit response map entry

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• q850-cause: integer (int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  Q850 cause code
• q850-reason: string
  Q850 cause comment (in quotes)
• sip-status(required): integer (int32)
  Minimum Value: 0

  Maximum Value: 699

  SIP response code

{
    "required":[
        "sip-status"
    ],
    "properties":{
        "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"
        },
        "q850-reason":{
            "description":"Q850 cause comment (in quotes)",
            "type":"string"
        },
        "_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