Jump to

• Request
• Response

Replace a config element: SD.sip-profile

put

https://cloud-native-SBC-IP/config/v1/sd/sip-profile/{ElementKey}

Replace a config element: SD.sip-profile

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 profile

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• cnam-lookup-dir: string
  Allowed Values: [ "ingress", "egress" ]
• cnam-lookup-server: string
  name of enum-config
• cnam-unavailable-ptype: string
  Pattern: ^.{0,15}$

  cname unavailable=p reason. A string of up to 15 ASCII characters
• cnam-unavailable-utype: string
  Pattern: ^.{0,15}$

  cname unavailable=u reason. A string of up to 15 ASCII characters
• egress-conditional-cac-admit: string
  Allowed Values: [ "inherit", "disabled", "enabled" ]
• forked-cac-bw: string
  Allowed Values: [ "inherit", "per-session", "shared" ]
• ingress-conditional-cac-admit: string
  Allowed Values: [ "inherit", "disabled", "enabled" ]
• name(required): string
  Minimum Length: 1

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

  name of the sip profile
• redirection: string
  Allowed Values: [ "inherit", "none", "isup", "diversion", "history-info" ]
• replace-dialogs: string
  Allowed Values: [ "inherit", "disabled", "enabled" ]

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of the sip profile",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "redirection":{
            "$ref":"#/components/schemas/RedirectionModeEnum"
        },
        "ingress-conditional-cac-admit":{
            "$ref":"#/components/schemas/CondCacAdmitEnum"
        },
        "egress-conditional-cac-admit":{
            "$ref":"#/components/schemas/CondCacAdmitEnum"
        },
        "forked-cac-bw":{
            "$ref":"#/components/schemas/ForkedCacBwEnum"
        },
        "cnam-lookup-server":{
            "description":"name of enum-config",
            "type":"string"
        },
        "cnam-lookup-dir":{
            "$ref":"#/components/schemas/CnamLookupDirEnum"
        },
        "cnam-unavailable-ptype":{
            "description":"cname unavailable=p reason. A string of up to 15 ASCII characters",
            "pattern":"^.{0,15}$",
            "type":"string"
        },
        "cnam-unavailable-utype":{
            "description":"cname unavailable=u reason. A string of up to 15 ASCII characters",
            "pattern":"^.{0,15}$",
            "type":"string"
        },
        "replace-dialogs":{
            "$ref":"#/components/schemas/ConfigModeEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure sip profile",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: SipProfile

Body ()

Root Schema : schema

Type: object

configure sip profile

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• cnam-lookup-dir: string
  Allowed Values: [ "ingress", "egress" ]
• cnam-lookup-server: string
  name of enum-config
• cnam-unavailable-ptype: string
  Pattern: ^.{0,15}$

  cname unavailable=p reason. A string of up to 15 ASCII characters
• cnam-unavailable-utype: string
  Pattern: ^.{0,15}$

  cname unavailable=u reason. A string of up to 15 ASCII characters
• egress-conditional-cac-admit: string
  Allowed Values: [ "inherit", "disabled", "enabled" ]
• forked-cac-bw: string
  Allowed Values: [ "inherit", "per-session", "shared" ]
• ingress-conditional-cac-admit: string
  Allowed Values: [ "inherit", "disabled", "enabled" ]
• name(required): string
  Minimum Length: 1

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

  name of the sip profile
• redirection: string
  Allowed Values: [ "inherit", "none", "isup", "diversion", "history-info" ]
• replace-dialogs: string
  Allowed Values: [ "inherit", "disabled", "enabled" ]

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of the sip profile",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "redirection":{
            "$ref":"#/components/schemas/RedirectionModeEnum"
        },
        "ingress-conditional-cac-admit":{
            "$ref":"#/components/schemas/CondCacAdmitEnum"
        },
        "egress-conditional-cac-admit":{
            "$ref":"#/components/schemas/CondCacAdmitEnum"
        },
        "forked-cac-bw":{
            "$ref":"#/components/schemas/ForkedCacBwEnum"
        },
        "cnam-lookup-server":{
            "description":"name of enum-config",
            "type":"string"
        },
        "cnam-lookup-dir":{
            "$ref":"#/components/schemas/CnamLookupDirEnum"
        },
        "cnam-unavailable-ptype":{
            "description":"cname unavailable=p reason. A string of up to 15 ASCII characters",
            "pattern":"^.{0,15}$",
            "type":"string"
        },
        "cnam-unavailable-utype":{
            "description":"cname unavailable=u reason. A string of up to 15 ASCII characters",
            "pattern":"^.{0,15}$",
            "type":"string"
        },
        "replace-dialogs":{
            "$ref":"#/components/schemas/ConfigModeEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure sip profile",
    "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