Jump to

• Request
• Response

Retrieve one config element: SD.realm-group

get

https://cloud-native-SBC-IP/config/v1/sd/realm-group/{ElementKey}

Retrieve one config element: SD.realm-group

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: RealmGroup

Body ()

Root Schema : schema

Type: object

configure realm groups

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• destination-realms: string
  List of destination realms
• early-media-allow-direction: string
  Allowed Values: [ "reverse", "both", "none" ]
• name(required): string
  Minimum Length: 1

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

  Identifier of realm group
• source-realms: string
  List of source realms
• state: boolean
  administrative state

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"Identifier of realm group",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "source-realms":{
            "description":"List of source realms",
            "type":"string"
        },
        "destination-realms":{
            "description":"List of destination realms",
            "type":"string"
        },
        "early-media-allow-direction":{
            "$ref":"#/components/schemas/BlockDirEnum"
        },
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure realm groups",
    "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