REST interface for federated IBM BPM resources - Task Template Query Entity List Count Resource - GET Method

Sample method invocation

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
interactionFilter	string	Name of a predefined user interaction. Value Description CREATE Create tasks. This implies the retrieval of task templates permitting the instantiation of corresponding task instances.
queryFilter	string	A query table condition language expression that performs additional filtering on the result set. All attributes defined on the query can be referenced.
processAppName	string	Name of the process application, which is used for additional filtering.
admin	boolean	Administration authorization option specifying whether the request is performed by an administrator. Value Description true The request is performed by an administrator. The user must have administrative rights to perform this request. false (default) The request is performed by a regular user who doesn't have administrative rights.

Request Content

None

Response Content

The default content-type is application/json.

MIME Type: application/json

{  "description": "Query Result Set Count", 
   "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."
            }
         }
      ],
      "count" : {"type": "integer"}
   }
}

Error Response Content

The default content-type is application/json.

MIME Type: application/json

{  "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.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
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	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 Entity List Count Resource