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

Modifies a Request Line Rule Table Entry given a specific Table Entry ID in a given Message Table. Upon modifying a Request Line 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}/spmrequestlinerule/{identifier}

HTTP Method

POST

Requires Authentication:

true

spmrequestlinerule - REST API Methods

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionNoNostringnone64 - Max Length Description of the Request Line Rule
ConditionExpressionNoNostringnone255 - Max Length Logical expression, including Condition Rule references, the logical operators && and ||, and parenthesis grouping. If the condition evaluates true then this 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.
ElementDescriptorListNoNostringnone66 - Max Length This is a comma-separated list of the element descriptor row IDs which are part of this request line rule. To act upon the entire request line payload there should be one descriptor of class eSPRClass_HeaderAndPayloadValue. To act upon the elements of a request line, descriptors may be added of class eSPRClass_Method, eSPRClass_SIPVersion, or any of the eSPRClass_URI* classes.
URIParameterElementDescriptorListNoNostringnone60 - Max Length This is a comma-separated list of the element descriptor row IDs which are URI parameters associated with this request line 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 request line 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