Jump to

• Request
• Response

Retrieve a sub-element: SD.sip-manipulation.mime-isup-rules

get

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

Retrieve a sub-element: SD.sip-manipulation.mime-isup-rules

Request

Path Parameters

• ElementKey: string
  Identifier for the element
• ElementKeySE: string
  Identifier for the sub-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 sub element: MimeIsupRule

Body ()

Root Schema : schema

Type: object

list of mime isup 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" ]
• content-type: string
  Pattern: ^[A-Za-z0-9.!%*_+`'~/-]+(;.+)*(\[(([0-9]+)|([*^]))\])?$

  Content-Type header for which rule needs to be applied
• isup-msg-types: array isup-msg-types
  Unique Items Required: true

  specifies a list of isup message types that the mime isup rule applies to (applies to all ISUP messages when none are specified) e.g.: IAM, ACM
• isup-param-rules: array isup-param-rules
  list of isup-param-rules
• isup-spec: string
  Allowed Values: [ "ansi-2000", "itu-99", "gr-317", "etsi-356", "spirou" ]
• 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) e.g.: INVITE,ACK,CANCEL
• mime-header-rules: array mime-header-rules
  list of mime-header-rules
• 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
• rules-order: array rules-order
  list of mime-header and isup-param rules

{
    "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"
        },
        "content-type":{
            "description":"Content-Type header for which rule needs to be applied",
            "pattern":"^[A-Za-z0-9.!%*_+`'~/-]+(;.+)*(\\[(([0-9]+)|([*^]))\\])?$",
            "type":"string"
        },
        "isup-spec":{
            "$ref":"#/components/schemas/IsupBaseEnum"
        },
        "isup-msg-types":{
            "description":"specifies a list of isup message types that the mime isup rule applies to (applies to all ISUP messages when none are specified) e.g.: IAM, ACM",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "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) e.g.: INVITE,ACK,CANCEL",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "action":{
            "$ref":"#/components/schemas/TopLevelRuleActionConstraintEnum"
        },
        "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"
        },
        "mime-header-rules":{
            "description":"list of mime-header-rules",
            "items":{
                "$ref":"#/components/schemas/MimeHeaderRule"
            },
            "type":"array"
        },
        "isup-param-rules":{
            "description":"list of isup-param-rules",
            "items":{
                "$ref":"#/components/schemas/IsupParamRule"
            },
            "type":"array"
        },
        "rules-order":{
            "description":"list of mime-header and isup-param rules",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of mime isup rules",
    "type":"object"
}

Nested Schema : isup-msg-types

Type: array

Unique Items Required: true

specifies a list of isup message types that the mime isup rule applies to (applies to all ISUP messages when none are specified) e.g.: IAM, ACM

Show Source

• Array of: string

{
    "description":"specifies a list of isup message types that the mime isup rule applies to (applies to all ISUP messages when none are specified) e.g.: IAM, ACM",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : isup-param-rules

Type: array

list of isup-param-rules

Show Source

• Array of: object IsupParamRule
  list of isup-param-rules

{
    "description":"list of isup-param-rules",
    "items":{
        "$ref":"#/components/schemas/IsupParamRule"
    },
    "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) e.g.: INVITE,ACK,CANCEL

Show Source

• Array of: string

{
    "description":"specifies list of methods that the rule applies to (applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : mime-header-rules

Type: array

list of mime-header-rules

Show Source

• Array of: object MimeHeaderRule
  list of mime-header-rules

{
    "description":"list of mime-header-rules",
    "items":{
        "$ref":"#/components/schemas/MimeHeaderRule"
    },
    "type":"array"
}

Nested Schema : rules-order

Type: array

list of mime-header and isup-param rules

Show Source

• Array of: string

{
    "description":"list of mime-header and isup-param rules",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : IsupParamRule

Type: object

list of isup-param-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", "log", "monitor", "reject" ]
• comparison-type: string
  Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
• format: string
  Allowed Values: [ "raw-binary", "hex-ascii", "bcd", "binary-ascii", "ascii-string", "number-param" ]
• match-value: string
  value to match against the current object. To clear the match-value, update with 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. To clear the newValue, update with an empty string
• type: string
  Pattern: ^((25[0-5])|(2[0-4][0-9])|(1[0-9][0-9])|([0-9]([0-9])?))(\[([*^]|[0-9]+)\])?$

  parameter type specifying which part of the isup body will be manipulated

{
    "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"
        },
        "type":{
            "description":"parameter type specifying which part of the isup body will be manipulated",
            "pattern":"^((25[0-5])|(2[0-4][0-9])|(1[0-9][0-9])|([0-9]([0-9])?))(\\[([*^]|[0-9]+)\\])?$",
            "type":"string"
        },
        "format":{
            "$ref":"#/components/schemas/IsupEmodeEnum"
        },
        "action":{
            "$ref":"#/components/schemas/ManipulationRuleActionConstraintEnum"
        },
        "comparison-type":{
            "$ref":"#/components/schemas/ManipulationCompareEnum"
        },
        "match-value":{
            "description":"value to match against the current object. To clear the match-value, update with an empty string",
            "type":"string"
        },
        "new-value":{
            "description":"new value for the object. To clear the newValue, update with an empty string",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of isup-param-rules",
    "type":"object"
}

Nested Schema : MimeHeaderRule

Type: object

list of mime-header-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", "log", "monitor", "reject" ]
• comparison-type: string
  Allowed Values: [ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
• match-value: string
  value to match against the current object. To clear the match-value, enter an empty string
• mime-header-name: string
  Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$

  header within mime part for which rule needs to be applied. To change the preamble of a SIP body, use the header name @preamble. To change the epilogue of a SIP body, use the header name @epilogue
• 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"
        },
        "mime-header-name":{
            "description":"header within mime part for which rule needs to be applied. To change the preamble of a SIP body, use the header name @preamble. To change the epilogue of a SIP body, use the header name @epilogue",
            "pattern":"^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\\[(([0-9]+)|([*^]))\\])?$",
            "type":"string"
        },
        "action":{
            "$ref":"#/components/schemas/ManipulationRuleActionConstraintEnum"
        },
        "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 mime-header-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