About this Resource

Modified: for 2.2.0

Defines a Protocol Repair Element Descriptor to be used in a Header Rule, a Request Line Rule, or a Status Line Rule. Each of these resources defines an action to be made in a rule to a particular component of the rule.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ElementClassYesNoEnum0Possible values:
  • 0 - eSPRClass_HeaderAndPayloadValue
  • 1 - eSPRClass_DisplayName
  • 2 - eSPRClass_URI
  • 3 - eSPRClass_URI_Scheme
  • 4 - eSPRClass_URI_Host
  • 5 - eSPRClass_URI_UserInfo
  • 6 - eSPRClass_URI_UserInfo_User
  • 7 - eSPRClass_URI_UserInfo_Password
  • 8 - eSPRClass_URI_Port
  • 9 - eSPRClass_Parameter
  • 10 - eSPRClass_Method
  • 11 - eSPRClass_SIPVersion
  • 12 - eSPRClass_StatusCode
  • 13 - eSPRClass_Host
  • 14 - eSPRClass_Port
  • 15 - eSPRClass_Transport
This identifies the protocol manipulation element class (e.g.: HeaderAndPayloadValue, DisplayName, URI-UserInfo-Port, etc.)
ActionYesNoEnum5Possible values:
  • 0 - eSPRAction_AddModify
  • 1 - eSPRAction_Add
  • 2 - eSPRAction_Modify
  • 3 - eSPRAction_Drop
  • 4 - eSPRAction_CopyValue
  • 5 - eSPRAction_Ignore
  • 6 - eSPRAction_DrillDown
This identifies the protocol manipulation action associated with this protocol manipulation element.
NameYesNostringnone128 - Max Length This is the 'Name' to be applied for this protocol manipulation element, as interpreted by the Action and Type attributes. This attribute is relevant only if the element class is Parameter.
TypeYesNoEnum0Possible values:
  • 0 - eValue_Literal
  • 1 - eValue_Token
  • 2 - eValue_Regex
This indicates how the protocol manipulation elment 'Value' is to be interpreted, either as a literal string, a regular expression, or as a tree token.
ValueYesNostringnone1024 - Max Length This is the 'Value' to be applied for this protocol manipulation element, as interpreted by the Action and Type attributes. If the Action is CopyValue then this is a SGUser1 through SGUser5 user variable token and the value is copied from the element to the user variable, in all other cases values go from here into the element. In the case of Type being Regex, this holds the 'Match' Regex and the RegexReplace field must be provided.
RegexReplaceYesNostringnone1024 - Max Length If the Type attribute is Regex then this is the 'Replace' regex string, otherwise this field is ignored.
PrefixNoNostringnone128 - Max Length If this attribute is non-empty then the contents of this attribute, interpreted as a literal string, are prefixed to the protocol manipulation element.
SuffixNoNostringnone128 - Max Length If this attribute is non-empty then the contents of this attribute, interpreted as a literal string, are appended to the protocol manipulation element.