REST Interface for BPEL-related Task Resources - Work Basket Query Tables Resource - GET Method

Use this method to retrieve a list of query tables containing work basket data.

Sample method invocation

GET /rest/bpm/htm/v1/workBaskets/queryTables[?sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}]

Parameters

Optional Parameters

Name

Value Type

Description

sourceAttributes

string

Specifies a comma-separated list of source attributes; only query tables with the specified source attributes are returned. The format of a source attribute is queryTableName.attributeName in uppercase letters.

userParametersAllowed

boolean

Specifies whether query tables with user parameters are returned. User parameters can be used in filters of query tables. Note that the $LOCALE parameter is a system parameter.

Value	Description
true (default)	All query tables are returned.
false	Only query tables without user parameters are returned.

authorizationType

string

Specifies that only query tables requiring this authorization type are returned.

Value	Description
NONE	Only query tables requiring no authorization are returned.
INSTANCE_BASED	Only query tables requiring instance-based authorization are returned.
ROLE_BASED	Only query tables requiring role-based authorization are returned.

kind

string

Specifies that only query tables of this kind are returned.

Value	Description
PREDEFINED	Only predefined query tables are returned.
COMPOSITE	Only composite query tables are returned.
SUPPLEMENTAL	Only supplemental query tables are returned.

Request Content

None

Response Content

List of query tables containing work basket data.

The default content-type is application/json.

MIME Type: application/json

+ View Schema

{  "description": "Query Table List", 
   "type": "object",
   "properties":
   {  "identifier" : {"type": "string"},
      "items": 
      [
         {  "name": {"type": "string",
               "description": "Query table name."
            },
            "displayName": {"type": "string",
               "description": "Query table display name (localized)."
            },
            "description": {"type": "string",
               "description": "Query table description (localized)."
            },
            "kind": {"type": "string",
               "description": "Query table kind.", 
               "enum":
               [
                  "PREDEFINED",
                  "COMPOSITE",
                  "SUPPLEMENTAL"
               ]
            },
            "authorizationType": {"type": "string",
               "description": "Type of authorization required for performing queries using this query table.",
               "enum":
               [
                  "NONE",
                  "INSTANCE_BASED",
                  "ROLE_BASED"
               ]
            },
            "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 table."
            }
         }
      ]
   }
}

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. The requested data is returned. Note that the list might be empty.
400 Bad Request	The parameters are not valid or they are missing.
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: Work Basket Query Tables Resource