Jump to

• Request
• Response

Replace a config element: SD.session-translation

put

https://cloud-native-SBC-IP/config/v1/sd/session-translation/{ElementKey}

Replace a config element: SD.session-translation

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure translation rules for calling and called numbers

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• id(required): string
  Minimum Length: 1

  identifier/name of the session translation
• rules-asserted-id: array rules-asserted-id
  Manipulates the SIP P-Asserted-Id header
• rules-called: array rules-called
  list of <called translation rule name>
• rules-calling: array rules-calling
  list of <calling translation rule name>
• rules-history-info: array rules-history-info
  Manipulates the SIP History-Info headers
• rules-isup-cdpn: array rules-isup-cdpn
  Manipulates the ISUP Called Party Number parameter
• rules-isup-cgpn: array rules-isup-cgpn
  Manipulates the ISUP Calling Party Number parameter
• rules-isup-gn: array rules-isup-gn
  Manipulates the ISUP Generic Number parameter
• rules-isup-ocn: array rules-isup-ocn
  list of IsupOcn < translation rule name>
• rules-isup-rdn: array rules-isup-rdn
  Manipulates the ISUP Redirecting and Original Called Number parameters
• rules-redirect: array rules-redirect
  Manipulates the SIP Diversion headers

{
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"identifier/name of the session translation",
            "minLength":1,
            "type":"string"
        },
        "rules-calling":{
            "description":"list of <calling translation rule name>",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-called":{
            "description":"list of <called translation rule name>",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-asserted-id":{
            "description":"Manipulates the SIP P-Asserted-Id header",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-redirect":{
            "description":"Manipulates the SIP Diversion headers",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-history-info":{
            "description":"Manipulates the SIP History-Info headers",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-isup-cdpn":{
            "description":"Manipulates the ISUP Called Party Number parameter",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-isup-cgpn":{
            "description":"Manipulates the ISUP Calling Party Number parameter",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-isup-gn":{
            "description":"Manipulates the ISUP Generic Number parameter",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-isup-rdn":{
            "description":"Manipulates the ISUP Redirecting and Original Called Number parameters",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-isup-ocn":{
            "description":"list of IsupOcn < translation rule name>",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure translation rules for calling and called numbers",
    "type":"object"
}

Nested Schema : rules-asserted-id

Type: array

Manipulates the SIP P-Asserted-Id header

Show Source

• Array of: string

{
    "description":"Manipulates the SIP P-Asserted-Id header",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-called

Type: array

list of <called translation rule name>

Show Source

• Array of: string

{
    "description":"list of <called translation rule name>",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-calling

Type: array

list of <calling translation rule name>

Show Source

• Array of: string

{
    "description":"list of <calling translation rule name>",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-history-info

Type: array

Manipulates the SIP History-Info headers

Show Source

• Array of: string

{
    "description":"Manipulates the SIP History-Info headers",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-isup-cdpn

Type: array

Manipulates the ISUP Called Party Number parameter

Show Source

• Array of: string

{
    "description":"Manipulates the ISUP Called Party Number parameter",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-isup-cgpn

Type: array

Manipulates the ISUP Calling Party Number parameter

Show Source

• Array of: string

{
    "description":"Manipulates the ISUP Calling Party Number parameter",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-isup-gn

Type: array

Manipulates the ISUP Generic Number parameter

Show Source

• Array of: string

{
    "description":"Manipulates the ISUP Generic Number parameter",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-isup-ocn

Type: array

list of IsupOcn < translation rule name>

Show Source

• Array of: string

{
    "description":"list of IsupOcn < translation rule name>",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-isup-rdn

Type: array

Manipulates the ISUP Redirecting and Original Called Number parameters

Show Source

• Array of: string

{
    "description":"Manipulates the ISUP Redirecting and Original Called Number parameters",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-redirect

Type: array

Manipulates the SIP Diversion headers

Show Source

• Array of: string

{
    "description":"Manipulates the SIP Diversion headers",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: SessionTranslation

Body ()

Root Schema : schema

Type: object

configure translation rules for calling and called numbers

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• id(required): string
  Minimum Length: 1

  identifier/name of the session translation
• rules-asserted-id: array rules-asserted-id
  Manipulates the SIP P-Asserted-Id header
• rules-called: array rules-called
  list of <called translation rule name>
• rules-calling: array rules-calling
  list of <calling translation rule name>
• rules-history-info: array rules-history-info
  Manipulates the SIP History-Info headers
• rules-isup-cdpn: array rules-isup-cdpn
  Manipulates the ISUP Called Party Number parameter
• rules-isup-cgpn: array rules-isup-cgpn
  Manipulates the ISUP Calling Party Number parameter
• rules-isup-gn: array rules-isup-gn
  Manipulates the ISUP Generic Number parameter
• rules-isup-ocn: array rules-isup-ocn
  list of IsupOcn < translation rule name>
• rules-isup-rdn: array rules-isup-rdn
  Manipulates the ISUP Redirecting and Original Called Number parameters
• rules-redirect: array rules-redirect
  Manipulates the SIP Diversion headers

{
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"identifier/name of the session translation",
            "minLength":1,
            "type":"string"
        },
        "rules-calling":{
            "description":"list of <calling translation rule name>",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-called":{
            "description":"list of <called translation rule name>",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-asserted-id":{
            "description":"Manipulates the SIP P-Asserted-Id header",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-redirect":{
            "description":"Manipulates the SIP Diversion headers",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-history-info":{
            "description":"Manipulates the SIP History-Info headers",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-isup-cdpn":{
            "description":"Manipulates the ISUP Called Party Number parameter",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-isup-cgpn":{
            "description":"Manipulates the ISUP Calling Party Number parameter",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-isup-gn":{
            "description":"Manipulates the ISUP Generic Number parameter",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-isup-rdn":{
            "description":"Manipulates the ISUP Redirecting and Original Called Number parameters",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "rules-isup-ocn":{
            "description":"list of IsupOcn < translation rule name>",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure translation rules for calling and called numbers",
    "type":"object"
}

Nested Schema : rules-asserted-id

Type: array

Manipulates the SIP P-Asserted-Id header

Show Source

• Array of: string

{
    "description":"Manipulates the SIP P-Asserted-Id header",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-called

Type: array

list of <called translation rule name>

Show Source

• Array of: string

{
    "description":"list of <called translation rule name>",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-calling

Type: array

list of <calling translation rule name>

Show Source

• Array of: string

{
    "description":"list of <calling translation rule name>",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-history-info

Type: array

Manipulates the SIP History-Info headers

Show Source

• Array of: string

{
    "description":"Manipulates the SIP History-Info headers",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-isup-cdpn

Type: array

Manipulates the ISUP Called Party Number parameter

Show Source

• Array of: string

{
    "description":"Manipulates the ISUP Called Party Number parameter",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-isup-cgpn

Type: array

Manipulates the ISUP Calling Party Number parameter

Show Source

• Array of: string

{
    "description":"Manipulates the ISUP Calling Party Number parameter",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-isup-gn

Type: array

Manipulates the ISUP Generic Number parameter

Show Source

• Array of: string

{
    "description":"Manipulates the ISUP Generic Number parameter",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-isup-ocn

Type: array

list of IsupOcn < translation rule name>

Show Source

• Array of: string

{
    "description":"list of IsupOcn < translation rule name>",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-isup-rdn

Type: array

Manipulates the ISUP Redirecting and Original Called Number parameters

Show Source

• Array of: string

{
    "description":"Manipulates the ISUP Redirecting and Original Called Number parameters",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : rules-redirect

Type: array

Manipulates the SIP Diversion headers

Show Source

• Array of: string

{
    "description":"Manipulates the SIP Diversion headers",
    "items":{
        "type":"string"
    },
    "type":"array"
}

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