REST API - getAllAttributes

The table summarizes the REST API - getAllAttributes.

Request

Format 
GET <baseurl>/audit/attributes/get
Query parameters
  • componentid=integer (optional, default=all): You can restrict the scope of this operation by specifying a component ID (see getAttributes ); to get all attributes, omit the parameter.
  • requireallextendeddata=boolean (optional, default=false): Displays all the extended data options for the attributes.
  • requiredextendeddata=enumeration (optional): Specifies one or more specific items of extended data (separated by semi-colons) to display. Possible values are IS_FILTERABLE; IS_SORTABLE.

Response

JSON Returns a JSON representation of the content of an AttributeDefinition element.
XML Returns the content of an AttributeDefinition element (from the EventCollectorQueryService schema) for each attribute.

Example

Request 
GET <baseurl>/audit/attributes/get?requiredextendeddata=IS_FILTERABLE
Response 
<?xml version="1.0" encoding="UTF-8"?>
<xml-fragment>
  <definition>
    <category>message</category>
    <componentId>21</componentId>
    <id>1</id>
    <isPrimary>true</isPrimary>
    <length>256</length>
    <name>messageId</name>
    <type>STRING</type>
    <isFilterable>true</isFilterable>
  </definition>
  <definition>
    <category>environment</category>
    <componentId>1</componentId>
    <id>2</id>
    <isPrimary>false</isPrimary>
    <length>-1</length>
    <name>environmentName</name>
    <type>STRING</type>
    <isFilterable>false</isFilterable>
 </definition>
...
...
  </definition>
</xml-fragment>