REST Interface for BPEL-related Task Resources - Escalation Query Attributes Resource - GET Method

Use this method to retrieve a list of attributes for a specified query containing task escalation data.

Sample method invocation

GET /rest/bpm/htm/v1/escalations/query/{query}/attributes

Parameters

None

Request Content

None

Response Content

List of query attributes.

The default content-type is application/json.

MIME Type: application/json


Schema
{  "description": "Query Attribute List", 
   "type": "object",
   "properties":
   {  "identifier" : {"type": "string"},
      "query": {"type": "string",
         "description": "Query name."
      },
      "displayName": {"type": "string",
         "description": "Query display name (localized)."
      },
      "description": {"type": "string",
         "description": "Query description (localized)."
      },
      "kind": {"type": "string",
         "description": "Query kind.", 
         "enum":
         [
            "PREDEFINED",
            "COMPOSITE",
            "SUPPLEMENTAL"
         ]
      },
      "authorizationType": {"type": "string",
         "description": "Type of authorization required for performing queries using this query.",
         "enum":
         [
            "NONE",
            "INSTANCE_BASED",
            "ROLE_BASED"
         ]
      },
      "entityTypeName": {"type": "string",
         "description": "Type of entities that are returned as the result of the query."
      },
      "keyAttribute": {"type": "string",
         "description": "Name of the attribute uniquely identifying an entity."
      },
      "locales": {"type": ["string"],
         "description": "List of locales defined for the display names and descriptions of this query."
      },
      "items": 
      [
         {  "name": {"type": "string",
               "description": "Attribute name."
            },
            "displayName": {"type": "string",
               "description": "Attribute display name (localized)."
            },
            "description": {"type": "string",
               "description": "Attribute description (localized)."
            },
            "type": {"type": "string",
               "description": "Attribute type."
            },
            "isArray": {"type": "boolean",
               "description": "Specifies whether the attribute has an array of values."
            },
            "isFilterable": {"type": "boolean", "optional": true,
               "description": "Specifies whether the attribute can be used as a filter attribute (default: true)."
            },
            "isSortable": {"type": "boolean", "optional": true,
               "description": "Specifies whether the attribute can be used as a sort attribute (default: true)."
            },
            "content": {"type": "string",
               "description": "A string that identifies attributes with a well-known value range."
            },
            "sourceAttribute": {"type": "string",
               "description": "The related query and attribute which provides this attributes' information."
            },
            "sourceQueryTableIdentifier": {"type": "string",
               "description": "The ID of the source attribute's table, as defined in the query table definition."
            }
         }
      ]
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


Schema
{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
} 

Status codes

The method returns one of the following status codes:
CodeDescription
200 OK
Successful completion. The requested data is returned.
404 Not Found
The query table does not exist.
406 Not AcceptableThe requested content type or content encoding is not supported.
500 Internal Server ErrorA severe problem has occurred. Programmer's details are provided.

Available since

7.5.1

Parent topic: Escalation Query Attributes Resource