Jump to

• Request
• Response

Retrieve all sub-elements: SD.sip-manipulation.header-rules

get

https://cloud-native-SBC-IP/config/v1/sd/sip-manipulation/{ElementKey}/header-rules

Retrieve all sub-elements: SD.sip-manipulation.header-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 all sub elements: SipHdrRule

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema
  list of header rules

{
    "items":{
        "$ref":"#/components/schemas/SipHdrRule"
    },
    "type":"array"
}

Nested Schema : schema

Type: object

list of header rules

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• action: string
  Allowed Values: [ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
• comparison-type: string
  Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
• element-rules: array element-rules
  list of element-rules
• header-name: string
  Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$

  header name for which rule needs to be applied
• match-value: string
  value to match against the current object. To clear the match-value, enter an empty string
• methods: array methods
  Unique Items Required: true

  specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL
• msg-type: string
  Allowed Values: [ "any", "request", "reply", "out-of-dialog" ]
• name(required): string
  Minimum Length: 1

  Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$

  unique name for rule
• new-value: string
  new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"unique name for rule",
            "minLength":1,
            "pattern":"^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$",
            "type":"string"
        },
        "header-name":{
            "description":"header name for which rule needs to be applied",
            "pattern":"^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\\[(([0-9]+)|([*^]))\\])?$",
            "type":"string"
        },
        "action":{
            "$ref":"#/components/schemas/TopLevelRuleActionConstraintEnum"
        },
        "comparison-type":{
            "$ref":"#/components/schemas/ManipulationCompareEnum"
        },
        "msg-type":{
            "$ref":"#/components/schemas/ManipulationMsgtypeEnum"
        },
        "methods":{
            "description":"specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL",
            "items":{
                "$ref":"#/components/schemas/SipMethodsConstraintEnum"
            },
            "type":"array",
            "uniqueItems":true
        },
        "match-value":{
            "description":"value to match against the current object. To clear the match-value, enter an empty string",
            "type":"string"
        },
        "new-value":{
            "description":"new value for the object. Quoted display names must be escaped within quotes (e.g. '\\\\'My Name\\\\' '). To clear the new-value, enter an empty string",
            "type":"string"
        },
        "element-rules":{
            "description":"list of element-rules",
            "items":{
                "$ref":"#/components/schemas/SipElemRule"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of header rules",
    "type":"object"
}

Nested Schema : element-rules

Type: array

list of element-rules

Show Source

• Array of: object SipElemRule
  list of element-rules

{
    "description":"list of element-rules",
    "items":{
        "$ref":"#/components/schemas/SipElemRule"
    },
    "type":"array"
}

Nested Schema : methods

Type: array

Unique Items Required: true

specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL

Show Source

• Array of: string
  Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]

{
    "description":"specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL",
    "items":{
        "$ref":"#/components/schemas/SipMethodsConstraintEnum"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : SipElemRule

Type: object

list of element-rules

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• action: string
  Allowed Values: [ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete-element", "delete-header", "log", "reject" ]
• comparison-type: string
  Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
• match-val-type: string
  Allowed Values: [ "any", "ip", "fqdn" ]
• match-value: string
  value to match against the current object. To clear the match-value, enter an empty string
• name(required): string
  Minimum Length: 1

  Pattern: ^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$

  unique name for rule
• new-value: string
  new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
• parameter-name: string
  element param name for which rule needs to be applied
• type: string
  Allowed Values: [ "none", "header-value", "header-param", "uri-param", "uri-header", "uri-user", "uri-host", "uri-port", "uri-user-param", "teluri-param", "uri-display", "uri-param-name", "uri-header-name", "header-param-name", "status-code", "reason-phrase", "mime", "uri-user-only", "uri-phone-number-only" ]

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"unique name for rule",
            "minLength":1,
            "pattern":"^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$",
            "type":"string"
        },
        "parameter-name":{
            "description":"element param name for which rule needs to be applied",
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/SipManipElemTypeConstraintEnum"
        },
        "action":{
            "$ref":"#/components/schemas/ElementRuleActionConstraintEnum"
        },
        "match-val-type":{
            "$ref":"#/components/schemas/ManipulationMatchEnum"
        },
        "comparison-type":{
            "$ref":"#/components/schemas/ManipulationCompareEnum"
        },
        "match-value":{
            "description":"value to match against the current object. To clear the match-value, enter an empty string",
            "type":"string"
        },
        "new-value":{
            "description":"new value for the object. Quoted display names must be escaped within quotes (e.g. '\\\\'My Name\\\\' '). To clear the new-value, enter an empty string",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of element-rules",
    "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