Jump to

• Request
• Response

Retrieve one config element: SD.translation-rules

get

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

Retrieve one config element: SD.translation-rules

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Query Parameters

• revision-id: string
  Integer value of saved revision, or 'latest', 'active' to show the running config, or 'staging' to show complete configuration to be activated

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: TranslationRules

Body ()

Root Schema : schema

Type: object

configure and apply session translation rules to agents and realms

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• add-index: string
  index for the add string. Use $ for appending string at the end of address
• add-string: string
  string to be added
• delete-index: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  index for the delete string
• delete-string: string
  string to be deleted. Use @ for wild character
• id(required): string
  Minimum Length: 1

  identifier/name for the translation rule
• type: string
  Allowed Values: [ "delete", "replace", "add", "none" ]

{
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"identifier/name for the translation rule",
            "minLength":1,
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TranslationRulesTypeConstraintEnum"
        },
        "add-string":{
            "description":"string to be added",
            "type":"string"
        },
        "add-index":{
            "description":"index for the add string. Use $ for appending string at the end of address",
            "type":"string"
        },
        "delete-string":{
            "description":"string to be deleted. Use @ for wild character",
            "type":"string"
        },
        "delete-index":{
            "description":"index for the delete string",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure and apply session translation rules to agents and realms",
    "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"
}

Back to Top