REST interface for federated IBM BPM resources - Task Template Query Attributes Resource - GET Method

Use this method to retrieve a list of attributes of a query for task template data.

Sample method invocation

GET /rest/bpm/federated/htm/v1/taskTemplates/query/{query}/attributes[?domain={string}|systemID={string}][&processAppName={string}]

Parameters

Required Federation Parameter

Name	Value Type	Description
domain	string	Name of the domain containing the IBM Business Process Manager (BPEL runtime environment, BPD runtime, environment, or both) systems that host the distributed resource (mutually exclusive with the systemID parameter).
systemID	string	ID of the IBM Business Process Manager (BPEL runtime environment, BPD runtime, environment, or both) system hosting the resource (mutually exclusive with the domain parameter). If specified then this request is treated like any other request for a resource hosted by a single system, that is, the request and the response are just routed, and no pre/post-processing of parameters and results is performed by the federation layer.

Optional Parameters

Name	Value Type	Description
processAppName	string	Name of the process application, which is used for additional filtering.

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"},
      "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the individual system the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP Status Code returned from this system."
            },
            "errorNumber": {"type": "string", "optional": true,
               "description":"Message ID of the exception."
            },
            "errorMessage": {"type": "string", "optional": true,
               "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."
            }
         }
      ],
      "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":
         [
            "FEDERATED"
         ]
      },
      "authorizationType": {"type": "string",
         "description": "Type of authorization required for performing queries using this query.",
         "enum":
         [
            "INSTANCE_BASED",
            "MIXED"
         ]
      },
      "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."
      },
      "sortAttributes": {
         [  
            {  
               "name": {"type": "string",
                "description": "Sort attribute name."
               },
               "sortOrder": {"type": "string",
                  "description": "Sort order.",
                  "enum":
                  [
                     "ASC",
                     "DESC"
                  ]
               }
            }
         ], "optional": true,
         "description": "Ordered list of default sort attribute names."
      },
      "size": {"type": "integer", "optional": true,
         "description": "Default number of entities that are returned as the result of the 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", "optional": true,
               "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":
   {  "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the individual system the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP Status Code returned from this system."
            },
            "errorNumber": {"type": "string", "optional": true,
               "description": "Message ID of the exception."
            },
            "errorMessage": {"type": "string", "optional": true,
               "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": {"type": "string", "optional": true,
               "description": "Status of the request."
            },
            "exceptionType": {"type": "string", "optional": true,
               "description": "Type of the exception."
            }      
         }
      ], 
      "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": {"type": "string", "optional": true,
         "description": "Status of the request."
      },
      "exceptionType": {"type": "string", "optional": true,
         "description": "Type of the exception."
      }      
   }
}

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Successful completion. The requested data is returned.
404 Not Found	The query does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
409 Conflict	The query federation is not possible due to conflicting attributes returned from different systems.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.
503 Service Unavailable	The federated request could not be delivered to individual federation targets.
504 Gateway Timeout	The federated response has partial content because of missing individual responses.

Change history

The following changes have been applied to this method:

Release	Description
7.5.1	The returned query attribute entries contains new properties: `"isFilterable"` `"isSortable"`
7.5.1	A new parameter has been added to this method to allow additional filtering using a process application name. `"processAppName"`

Available since

7.5

Parent topic: Task Template Query Attributes Resource