REST Interface for BPEL-related Task Resources - Business Category Entity List Count Resource - GET Method

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

Sample Method Invocation

GET /rest/bpm/htm/v1/businessCategories/queryCount?queryTableName={string}[&queryFilter={string}][&admin={boolean}]

Parameters

Required Parameters

Name	Value Type	Description
queryTableName	string	Query table name.

Optional Parameters

Name

Value Type

Description

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 available constants, see [BPC DB Views]).

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 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 business category entities.

The default content-type is application/json.

MIME Type: application/json

+ View Schema

{  "description": "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": "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:

Code	Description
200 OK	Successful completion - requested data returned.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred, programmer's details are provided.

Available Since

7.0 Feature Pack

Parent Topic: Business Category Entity List Count Resource