REST API Method: POST /rest/spmmessagetable/{identifier}/spmheaderrule/{identifier}

Modifies a Header Rule Table Entry given a specific Table Entry ID in a given Message Table. Upon modifying a Header Rule, all the attributes containing Element Descriptors need to be first set to empty value. Then, current associated element descriptors need to be deleted, and new ones created according to the modified resource, which are then passed in the POST.

URL:

https://192.168.0.111/rest/spmmessagetable/{identifier}/spmheaderrule/{identifier}

HTTP Method

POST

Requires Authentication:

true

spmheaderrule - REST API Methods

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionNoNostringnone64 - Max Length Description of Header Rule
ConditionExpressionNoNostringnone255 - Max Length Logical expression, including Condition Rule references, the logical operators && and ||, and parenthesis grouping. If the condition evaluates true then this header rule will be applied, otherwise it will not. Condition rule references are of the form ${n}, where 'n' is the row ID of the condition rule. If no logical expression is provided then the expression is evaluated as 'true'.
ResultTypeYesNoEnum1Possible values:
  • 0 - eRtMandatory
  • 1 - eRtOptional
Specifies the result type of the current rule to go on to the next rule. If eRtMandatory, and this rule fails, all other rules in this message table will be dropped. If eRtOptional, then continue to the next rule unconditionally.
HeaderNameYesNo The SIP header name.
HeaderOrdinalYesNoint1Possible values:
  • -20 - Minimum
  • 20 - Maximum
Where a message contains multiple headers of the same name, this specifies the ordinal position of the header being referred to by the rule. 0 indicates the rule applies to all headers of the same name. A positive number indicates the ordinal position of the header from the front, for example 2 means the second header of that name. A negative number indicates the ordinal position of the header from the back, for example -3 means the third-from-last header of that name.
HeaderActionYesNoEnum1Possible values:
  • 0 - eSPRAction_AddModify
  • 1 - eSPRAction_Add
  • 2 - eSPRAction_Modify
  • 3 - eSPRAction_Drop
  • 4 - eSPRAction_CopyValue
  • 5 - eSPRAction_Ignore
  • 6 - eSPRAction_DrillDown
Indicates the action to take on the header as a whole. Supported values and their meaning are: Add - if the header is present then it is passed-through, otherwise it is added. Modify - if the header is present then it is modified, otherwise no action is taken. Remove - if the header is present then it is removed, otherwise no action is taken. The values of "CopyValue", "Ignore", and "DrillDown" don't apply at the header identification level.
HeaderElementDescriptorListNoNostringnone300 - Max Length This is a comma-separated list of the element descriptor row IDs which are part of this header rule. There is a maximum of 50 members. There is no significance to the sequence of IDs in this list.
HeaderParameterElementDescriptorListNoNostringnone60 - Max Length This is a comma-separated list of the element descriptor row IDs which are header parameters associated with this header rule. There is a maximum of 5 members. The sequence of this list is significant.
URIParameterElementDescriptorListNoNostringnone60 - Max Length This is a comma-separated list of the element descriptor row IDs which are URI parameters associated with this header rule. There is a maximum of 5 members. The sequence of this list is significant.
URIUserParameterElementDescriptorListNoNostringnone60 - Max Length This is a comma-separated list of the element descriptor row IDs which are URI User parameters associated with this header rule. There is a maximum of 5 members. The sequence of this list is significant.

Helpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

  • No labels