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

Sample Method Invocation

Parameters

Optional Parameters

Name	Value Type	Description
processAppName	string	Name of the process application, used for additional filtering.
sourceAttributes	string	Specifies a comma-separated list of source attributes; only queries with the specified source attributes are returned. The format of a source attribute is queryTableName.attributeName in uppercase letters.
userParametersAllowed	boolean	Specifies whether queries with user parameters are returned. User parameters can be used in filters of queries. Note that the $LOCALE parameter is a system parameter. Value Description true (default) All queries are returned. false Only queries without user parameters are returned.
authorizationType	string	Specifies that only queries requiring this authorization type are returned. Value Description NONE Only queries requiring no authorization are returned. INSTANCE_BASED Only queries requiring instance-based authorization are returned. ROLE_BASED Only queries requiring role-based authorization are returned.
kind	string	Specifies that only queries of this kind are returned. Value Description PREDEFINED Only predefined queries are returned. COMPOSITE Only composite queries are returned. SUPPLEMENTAL Only supplemental queries are returned.

Request Content

None.

Response Content

The default content-type is application/json.

MIME Type: application/json

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

Error Response Content

The default content-type is application/json.

MIME Type: application/json

{  "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. Note that the list may 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.5.1

Parent Topic: Work Basket Queries Resource