REST Interface for BPEL-related Task Resources - Work Basket Entity List Count Resource - GET Method

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

Sample method invocation

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

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

Count of work basket 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:
CodeDescription
200 OK
Successful completion. The requested data is returned.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
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.0 Feature Pack

Parent topic: Work Basket Entity List Count Resource