Retrieve all custom field configurations (GET)
The GET command views the XML representation of all custom fields.
Command overview
Method — GET
Resource — customfields
Parameters
Parameter | Description | Example |
|---|---|---|
usr 1 | A valid system user name (case sensitive) | usr=myUsername |
pwd 1 | The password that corresponds to the usr (user name) parameter (case sensitive) | pwd=myPassword |
tid | The transaction identifier. You must specify the tid for all stateful operations. Do not include it in stateless operations. | tid=5456 |
1 This parameter is required.
Sample request
https://10.0.0.1/rest/configurationapi/customfieldapi/1.0/customfields?usr=jdoe&pwd=pa55w0rd!&tid=4738
Sample response
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status result="success"></status>
<result>
<customField id="12" active="true" entity="object" srcEntity="object" type="string"
policy="first-non-null" export="x-custom-gzip" grammar="custom_gzip">
<name><![CDATA[Text Compression]]></name>
<description><![CDATA[Tracking all gzip text compression]]></description>
<extractions>
<extraction>
<name><![CDATA[Text Objects]]></name>
<expression><![CDATA[(mime_type contains "text" ignorecase)]]></expression>
<source>
<sourceHTTPHeader origin="response" index="0" indexType="all"
characterLimit="50">
<key><![CDATA[Content-Encoding]]></key>
</sourceHTTPHeader>
</source>
<transformations/>
</extraction>
</extractions>
</customField>
</result>
</response>
<response>
<status result="success"></status>
<result>
<customField id="12" active="true" entity="object" srcEntity="object" type="string"
policy="first-non-null" export="x-custom-gzip" grammar="custom_gzip">
<name><![CDATA[Text Compression]]></name>
<description><![CDATA[Tracking all gzip text compression]]></description>
<extractions>
<extraction>
<name><![CDATA[Text Objects]]></name>
<expression><![CDATA[(mime_type contains "text" ignorecase)]]></expression>
<source>
<sourceHTTPHeader origin="response" index="0" indexType="all"
characterLimit="50">
<key><![CDATA[Content-Encoding]]></key>
</sourceHTTPHeader>
</source>
<transformations/>
</extraction>
</extractions>
</customField>
</result>
</response>
Related topic
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*