Jump to

• Request
• Response

Retrieve the config element: SD.sip-config

get

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

Retrieve the config element: SD.sip-config

Request

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 config element: SipConfig

Body ()

Root Schema : schema

Type: object

configure signaling and session management

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• add-reason-header: boolean
  add Reason header to CANCEL/BYE
• add-ucid-header: boolean
  enable adding of UCID header to messages
• allow-pani-for-trusted-only: string
  Allowed Values: [ "inherit", "disabled", "enabled" ]
• anonymize-history-for-untrusted: boolean
  If enabled, HistoryInfo and Diversion headers will be anonymized for untrusted peer
• auto-realm-id: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  auto config realm identifier
• create-dynamic-sa: boolean
  creation of dynamic Session Agents for Service-Route
• dialog-transparency: boolean
  preserve Call-IDs and tags
• egress-realm-id: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  default egress realm identifier
• enforcement-profile: string
  Pattern: ^.*$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  Name of enforcement profile
• enum-sag-match: boolean
  state
• extra-enum-stats: boolean
  track enum stats per server address
• extra-method-stats: boolean
  track method stats for more entities
• hist-to-div-for-cause-380: string
  Allowed Values: [ "inherit", "disabled", "enabled" ]
• home-realm-id: string
  Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  home realm identifier
• inactive-dynamic-conn: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  inactive dynamic disconnect value (seconds), 0 to disable
• init-timer: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  initial request retransmission timer (TIMER_T1) (milliseconds)
• initial-inv-trans-expire: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  Transaction expiration time <TIMER_B> for initial INVITE (0 = Fall back to sip-config initial-inv-trans-expire)
• invite-expire: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  INVITE transaction expiration timer (TIMER_C) (seconds)
• max-timer: integer (int64)
  Minimum Value: 0

  Maximum Value: 4294967295

  maximum request retransmission timer (TIMER_T2) (milliseconds)
• nat-mode: string
  Allowed Values: [ "None", "Public", "Private" ]
• operation-mode: string
  Allowed Values: [ "disabled", "stateless", "transaction", "session", "dialog" ]
• options: string
  optional features/parameters
• pass-gruu-contact: boolean
  enable GRUU contact pass through
• proxy-sub-events: array proxy-sub-events
  Unique Items Required: true

  subscription events to do in proxy mode
• refer-reinvite-no-sdp: boolean
  Set this value to enabled for the SBC to not include SDP in the reINVITE to the transfer target. This is used in REFER with Replace scenarios
• refer-src-routing: boolean
  enable refer source realm routing
• registrar-domain: string
  Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\*?)$

  domain name of SIP registrar server
• registrar-host: string
  Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\*?)$

  hostname of SIP registrar server
• registrar-port: integer (int32)
  Minimum Value: 0

  Maximum Value: 65535

  port number of SIP registrar server
• rx-sip-reason-mapping: boolean
  Map Rx disconnect events to SIP reason header
• sa-routes-stats: boolean
  track SA stats for DNS-resolved routes
• sag-lookup-on-redirect: boolean
  enable lookup of SAG name on a redirect
• session-max-life-limit: integer (int64)
  Minimum Value: 1

  Maximum Value: 2073600

  maximum life limit a SIP session can stay active (secs). Range 1-2073600.
• set-disconnect-time-on-bye: boolean
  enable if disconnect time is set on receiving BYE request
• sip-message-len: integer (int64)
  Minimum Value: 0

  Maximum Value: 65535

  max sip message length
• trans-expire: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  transaction expiration timer (TIMER_B,D,F,H,J) (seconds)
• user-agent: string
  user-agent string to be added to SIP User-Agent header

{
    "properties":{
        "operation-mode":{
            "$ref":"#/components/schemas/SipOpModeEnum"
        },
        "dialog-transparency":{
            "description":"preserve Call-IDs and tags",
            "type":"boolean"
        },
        "home-realm-id":{
            "description":"home realm identifier",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "egress-realm-id":{
            "description":"default egress realm identifier",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "auto-realm-id":{
            "description":"auto config realm identifier",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "nat-mode":{
            "$ref":"#/components/schemas/SipNatModeEnum"
        },
        "registrar-domain":{
            "description":"domain name of SIP registrar server",
            "pattern":"^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\\*?)$",
            "type":"string"
        },
        "registrar-host":{
            "description":"hostname of SIP registrar server",
            "pattern":"^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\\*?)$",
            "type":"string"
        },
        "registrar-port":{
            "description":"port number of SIP registrar server",
            "format":"int32",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "init-timer":{
            "description":"initial request retransmission timer (TIMER_T1) (milliseconds)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "max-timer":{
            "description":"maximum request retransmission timer (TIMER_T2) (milliseconds)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "trans-expire":{
            "description":"transaction expiration timer (TIMER_B,D,F,H,J) (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "initial-inv-trans-expire":{
            "description":"Transaction expiration time <TIMER_B> for initial INVITE (0 = Fall back to sip-config initial-inv-trans-expire)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "invite-expire":{
            "description":"INVITE transaction expiration timer (TIMER_C) (seconds)",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "session-max-life-limit":{
            "description":"maximum life limit a SIP session can stay active (secs). Range 1-2073600.",
            "format":"int64",
            "maximum":2073600,
            "minimum":1,
            "type":"integer"
        },
        "inactive-dynamic-conn":{
            "description":"inactive dynamic disconnect value (seconds), 0 to disable",
            "format":"int64",
            "maximum":"4294967295",
            "minimum":0,
            "type":"integer"
        },
        "enforcement-profile":{
            "description":"Name of enforcement profile",
            "pattern":"^.*$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "options":{
            "description":"optional features/parameters",
            "type":"string"
        },
        "add-reason-header":{
            "description":"add Reason header to CANCEL/BYE",
            "type":"boolean"
        },
        "sip-message-len":{
            "description":"max sip message length",
            "format":"int64",
            "maximum":65535,
            "minimum":0,
            "type":"integer"
        },
        "enum-sag-match":{
            "description":"state",
            "type":"boolean"
        },
        "extra-method-stats":{
            "description":"track method stats for more entities",
            "type":"boolean"
        },
        "extra-enum-stats":{
            "description":"track enum stats per server address",
            "type":"boolean"
        },
        "refer-src-routing":{
            "description":"enable refer source realm routing",
            "type":"boolean"
        },
        "add-ucid-header":{
            "description":"enable adding of UCID header to messages",
            "type":"boolean"
        },
        "proxy-sub-events":{
            "description":"subscription events to do in proxy mode",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "allow-pani-for-trusted-only":{
            "$ref":"#/components/schemas/NpliFeatureConfigModeEnum"
        },
        "pass-gruu-contact":{
            "description":"enable GRUU contact pass through",
            "type":"boolean"
        },
        "sag-lookup-on-redirect":{
            "description":"enable lookup of SAG name on a redirect",
            "type":"boolean"
        },
        "set-disconnect-time-on-bye":{
            "description":"enable if disconnect time is set on receiving BYE request",
            "type":"boolean"
        },
        "refer-reinvite-no-sdp":{
            "description":"Set this value to enabled for the SBC to not include SDP in the reINVITE to the transfer target. This is used in REFER with Replace scenarios",
            "type":"boolean"
        },
        "create-dynamic-sa":{
            "description":"creation of dynamic Session Agents for Service-Route",
            "type":"boolean"
        },
        "sa-routes-stats":{
            "description":"track SA stats for DNS-resolved routes",
            "type":"boolean"
        },
        "rx-sip-reason-mapping":{
            "description":"Map Rx disconnect events to SIP reason header",
            "type":"boolean"
        },
        "hist-to-div-for-cause-380":{
            "$ref":"#/components/schemas/HIDivFeatureConfigModeEnum"
        },
        "anonymize-history-for-untrusted":{
            "description":"If enabled, HistoryInfo and Diversion headers will be anonymized for untrusted peer",
            "type":"boolean"
        },
        "user-agent":{
            "description":"user-agent string to be added to SIP User-Agent header",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure signaling and session management",
    "type":"object"
}

Nested Schema : proxy-sub-events

Type: array

Unique Items Required: true

subscription events to do in proxy mode

Show Source

• Array of: string

{
    "description":"subscription events to do in proxy mode",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

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