WebSphere Process Server, Version 6.2.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS


Business Flow Manager REST Interface - Process Template Entity List Count Resource - GET Method

Use this method to retrieve the number of process template entities in a query table matching specified criteria.

Resource URI

GET /v1/processTemplates/queryCount?{parameters}

Parameters

Required Parameters
NameValue TypeDescription
queryTableName string
Query table name.
Optional Parameters
NameValue TypeDescription
queryFilter string
A query table condition language expression that performs additional filtering on the result set. All attributes defined on the query table can be referenced. Constants are available for some attributes of predefined query tables, for example, STATE_STARTED is available for attribute STATE on query table PROCESS_TEMPLATE (for available constants, see Database views for Business Process Choreographer).
admin boolean
Administration authorization option specifying whether the request is performed by an administrator.
ValueDescription
true
The request is performed by an administrator. The user must have administrative rights in order to perform this request.
false (default)
The request is performed by a regular user without administrative rights.

Request Content

None.

Response Content

Count of process template entities.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "BFM Entity Result Set Count", 
   "type": "object",
   "properties":
   {  "count" : {"type": "integer"}
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "BFM Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description":"Message text 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 - requested data returned.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2.0.1

Parent Topic: Process Template Entity List Count Resource