REST API - getAttributes

The table summarizes the REST API - getAttributes.

Request

Format 
GET <baseurl>/audit/attributes/get
Query parameters
  • componentid=integer (optional, default=all): The ID of the component for which attributes are to be listed. Omit the parameter to get all attributes (see getAllAttributes ). The ID can be obtained from lookupQueryByTag .
  • 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?componentid=6&requireallextendeddata=true
Response 
{
  "xml-fragment": {
    "definition": [
      {
        "componentId": "6",
        "id": "134",
        "isPrimary": "false",
        "length": "-1",
        "name": "referer",
        "type": "STRING",
        "isFilterable": "false",
        "isSortable": "false"
      },
      {
        "componentId": "6",
        "id": "135",
        "isPrimary": "false",
        "length": "-1",
        "name": "authorization",
        "type": "STRING",
        "isFilterable": "false",
        "isSortable": "false"
      },
      {
        "componentId": "6",
        "id": "136",
        "isPrimary": "false",
        "length": "-1",
        "name": "sessionMaxActiveInterval",
        "type": "STRING",
        "isFilterable": "false",
        "isSortable": "false"
      },
      {
        "componentId": "6",
        "id": "137",
        "isPrimary": "false",
        "length": "-1",
        "name": "sessionId",
        "type": "STRING",
        "isFilterable": "false",
        "isSortable": "false"
      },
           .
           .
           .
           .
      {
        "componentId": "6",
        "id": "143",
        "isPrimary": "false",
        "length": "-1",
        "name": "diagnostic",
        "type": "STRING",
        "isFilterable": "false",
        "isSortable": "false"
      }
    ]
  }
}