Download full document:

policypatset_pattern_binding

Binding object showing the pattern that can be bound to policypatset.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
String	<String>	Read-write	String of characters that constitutes a pattern. For more information about the characters that can be used, refer to the character set parameter. Note: Minimum length for pattern sets used in rewrite actions of type REPLACE_ALL, DELETE_ALL, INSERT_AFTER_ALL, and INSERT_BEFORE_ALL, is three characters.
builtin	<String[]>	Read-write	Indicates that a variable is a built-in (SYSTEM INTERNAL) type.<br>Possible values = MODIFIABLE, DELETABLE, IMMUTABLE
name	<String>	Read-write	Name of the pattern set to which to bind the string.<br>Minimum length = 1
charset	<String>	Read-write	Character set associated with the characters in the string. Note: UTF-8 characters can be entered directly (if the UI supports it) or can be encoded as a sequence of hexadecimal bytes \\xNN. For example, the UTF-8 character ? can be encoded as \\xC3\\xBC.<br>Possible values = ASCII, UTF_8
index	<Double>	Read-write	The index of the string associated with the patset.
__count	<Double>	Read-write	count parameter

Operations

(click to see Properties)

ADD: | DELETE: | GET | COUNT

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER:<username>
X-NITRO-PASS:<password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add:

URL: http://NS_IP/nitro/v1/config

HTTP Method: PUT

Request Payload:

{
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
sessionid":"##sessionid","policypatset_pattern_binding":{
      "name":<String_value>,
      "String":<String_value>,
                  "index":<Double_value>,
                  "charset":<String_value>,

}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete:

URL: http://<NS_IP>/nitro/v1/config/policypatset_pattern_binding/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/policypatset_pattern_binding/name_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get

URL: http://<NS_IP>/nitro/v1/config/policypatset_pattern_binding/name_value<String>

Query-parameters:

filter

http://<NS_IP>/nitro/v1/config/policypatset_pattern_binding/name_value<String>?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of policypatset_pattern_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/policypatset_pattern_binding/name_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the policypatset_pattern_binding resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/policypatset_pattern_binding?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "policypatset_pattern_binding": [ {
      "String":<String_value>,
      "builtin":<String[]_value>,
      "name":<String_value>,
      "charset":<String_value>,
      "index":<Double_value>,

}]}

count

URL: http://<NS_IP>/nitro/v1/config/policypatset_pattern_binding/name_value<String>?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",policypatset_pattern_binding: [ { "__count": "#no"} ] }