Jump to

• Request
• Response

Add a sub-element: SD.sip-manipulation.mime-sdp-rules

post

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

Add a sub-element: SD.sip-manipulation.mime-sdp-rules

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

list of mime sdp 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" ]
• 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 ,sdp-session and sdp-media rules
• sdp-media-rules: array sdp-media-rules
  list of sdp-media-rules
• sdp-session-rules: array sdp-session-rules
  list of sdp-session-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"
        },
        "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"
        },
        "sdp-session-rules":{
            "description":"list of sdp-session-rules",
            "items":{
                "$ref":"#/components/schemas/SdpSessionRule"
            },
            "type":"array"
        },
        "sdp-media-rules":{
            "description":"list of sdp-media-rules",
            "items":{
                "$ref":"#/components/schemas/SdpMediaRule"
            },
            "type":"array"
        },
        "rules-order":{
            "description":"list of mime-header ,sdp-session and sdp-media rules",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of mime sdp rules",
    "type":"object"
}

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 ,sdp-session and sdp-media rules

Show Source

• Array of: string

{
    "description":"list of mime-header ,sdp-session and sdp-media rules",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : sdp-media-rules

Type: array

list of sdp-media-rules

Show Source

• Array of: object SdpMediaRule
  list of sdp-media-rules

{
    "description":"list of sdp-media-rules",
    "items":{
        "$ref":"#/components/schemas/SdpMediaRule"
    },
    "type":"array"
}

Nested Schema : sdp-session-rules

Type: array

list of sdp-session-rules

Show Source

• Array of: object SdpSessionRule
  list of sdp-session-rules

{
    "description":"list of sdp-session-rules",
    "items":{
        "$ref":"#/components/schemas/SdpSessionRule"
    },
    "type":"array"
}

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"
}

Nested Schema : SdpMediaRule

Type: object

list of sdp-media-rules

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• action: string
  Allowed Values: [ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "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
• media-type: string
  Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$

  media type to manipulate (e.g. audio, video, etc.)
• 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
• sdp-line-rules: array sdp-line-rules
  list of sdp-line-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"
        },
        "media-type":{
            "description":"media type to manipulate (e.g. audio, video, etc.)",
            "pattern":"^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\\[(([0-9]+)|([*^]))\\])?$",
            "type":"string"
        },
        "action":{
            "$ref":"#/components/schemas/SdpMediaRuleActionConstraintEnum"
        },
        "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"
        },
        "sdp-line-rules":{
            "description":"list of sdp-line-rules",
            "items":{
                "$ref":"#/components/schemas/SdpLineRule"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of sdp-media-rules",
    "type":"object"
}

Nested Schema : sdp-line-rules

Type: array

list of sdp-line-rules

Show Source

• Array of: object SdpLineRule
  list of sdp-line-rules

{
    "description":"list of sdp-line-rules",
    "items":{
        "$ref":"#/components/schemas/SdpLineRule"
    },
    "type":"array"
}

Nested Schema : SdpLineRule

Type: object

list of sdp-line-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
• 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
• type: string
  Pattern: ^[A-Za-z](\[(([0-9]+)|([*^]))\])?$

  descriptor type specifying which line of the sdp 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":"descriptor type specifying which line of the sdp will be manipulated",
            "pattern":"^[A-Za-z](\\[(([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 sdp-line-rules",
    "type":"object"
}

Nested Schema : SdpSessionRule

Type: object

list of sdp-session-rules

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• action: string
  Allowed Values: [ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "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
• 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
• sdp-line-rules: array sdp-line-rules
  list of sdp-line-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"
        },
        "action":{
            "$ref":"#/components/schemas/SdpSessionRuleActionConstraintEnum"
        },
        "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"
        },
        "sdp-line-rules":{
            "description":"list of sdp-line-rules",
            "items":{
                "$ref":"#/components/schemas/SdpLineRule"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of sdp-session-rules",
    "type":"object"
}

Nested Schema : sdp-line-rules

Type: array

list of sdp-line-rules

Show Source

• Array of: object SdpLineRule
  list of sdp-line-rules

{
    "description":"list of sdp-line-rules",
    "items":{
        "$ref":"#/components/schemas/SdpLineRule"
    },
    "type":"array"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one sub element: MimeSdpRule

Body ()

Root Schema : schema

Type: object

list of mime sdp 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" ]
• 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 ,sdp-session and sdp-media rules
• sdp-media-rules: array sdp-media-rules
  list of sdp-media-rules
• sdp-session-rules: array sdp-session-rules
  list of sdp-session-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"
        },
        "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"
        },
        "sdp-session-rules":{
            "description":"list of sdp-session-rules",
            "items":{
                "$ref":"#/components/schemas/SdpSessionRule"
            },
            "type":"array"
        },
        "sdp-media-rules":{
            "description":"list of sdp-media-rules",
            "items":{
                "$ref":"#/components/schemas/SdpMediaRule"
            },
            "type":"array"
        },
        "rules-order":{
            "description":"list of mime-header ,sdp-session and sdp-media rules",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of mime sdp rules",
    "type":"object"
}

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 ,sdp-session and sdp-media rules

Show Source

• Array of: string

{
    "description":"list of mime-header ,sdp-session and sdp-media rules",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : sdp-media-rules

Type: array

list of sdp-media-rules

Show Source

• Array of: object SdpMediaRule
  list of sdp-media-rules

{
    "description":"list of sdp-media-rules",
    "items":{
        "$ref":"#/components/schemas/SdpMediaRule"
    },
    "type":"array"
}

Nested Schema : sdp-session-rules

Type: array

list of sdp-session-rules

Show Source

• Array of: object SdpSessionRule
  list of sdp-session-rules

{
    "description":"list of sdp-session-rules",
    "items":{
        "$ref":"#/components/schemas/SdpSessionRule"
    },
    "type":"array"
}

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"
}

Nested Schema : SdpMediaRule

Type: object

list of sdp-media-rules

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• action: string
  Allowed Values: [ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "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
• media-type: string
  Pattern: ^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$

  media type to manipulate (e.g. audio, video, etc.)
• 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
• sdp-line-rules: array sdp-line-rules
  list of sdp-line-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"
        },
        "media-type":{
            "description":"media type to manipulate (e.g. audio, video, etc.)",
            "pattern":"^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\\[(([0-9]+)|([*^]))\\])?$",
            "type":"string"
        },
        "action":{
            "$ref":"#/components/schemas/SdpMediaRuleActionConstraintEnum"
        },
        "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"
        },
        "sdp-line-rules":{
            "description":"list of sdp-line-rules",
            "items":{
                "$ref":"#/components/schemas/SdpLineRule"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of sdp-media-rules",
    "type":"object"
}

Nested Schema : sdp-line-rules

Type: array

list of sdp-line-rules

Show Source

• Array of: object SdpLineRule
  list of sdp-line-rules

{
    "description":"list of sdp-line-rules",
    "items":{
        "$ref":"#/components/schemas/SdpLineRule"
    },
    "type":"array"
}

Nested Schema : SdpLineRule

Type: object

list of sdp-line-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
• 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
• type: string
  Pattern: ^[A-Za-z](\[(([0-9]+)|([*^]))\])?$

  descriptor type specifying which line of the sdp 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":"descriptor type specifying which line of the sdp will be manipulated",
            "pattern":"^[A-Za-z](\\[(([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 sdp-line-rules",
    "type":"object"
}

Nested Schema : SdpSessionRule

Type: object

list of sdp-session-rules

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• action: string
  Allowed Values: [ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "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
• 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
• sdp-line-rules: array sdp-line-rules
  list of sdp-line-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"
        },
        "action":{
            "$ref":"#/components/schemas/SdpSessionRuleActionConstraintEnum"
        },
        "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"
        },
        "sdp-line-rules":{
            "description":"list of sdp-line-rules",
            "items":{
                "$ref":"#/components/schemas/SdpLineRule"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of sdp-session-rules",
    "type":"object"
}

Nested Schema : sdp-line-rules

Type: array

list of sdp-line-rules

Show Source

• Array of: object SdpLineRule
  list of sdp-line-rules

{
    "description":"list of sdp-line-rules",
    "items":{
        "$ref":"#/components/schemas/SdpLineRule"
    },
    "type":"array"
}

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"
}

406 Response

Validation Failure

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