REST interface for BPEL-related process resources - Process instance entity list Resource - GET Method

Sample method invocation

Parameters

Required Parameters

Name	Value Type	Description
queryTableName	string	The name of the query table that is queried. For predefined query tables, this is the name of the predefined query table. For composite and supplemental query tables, this is prefix.name.

Optional Parameters

Name	Value Type	Description
selectedAttributes	string	Comma-separated list of attributes, in uppercase letters, which specifies the attributes that are retrieved by the query. If instance-based authorization is required, such as on predefined query tables which contain instance data, work item information, which is prefixed with 'WI.', for example, WI.REASON, can be retrieved in addition to the defined attributes. If no selected attributes are specified, all the attributes that are defined on the query table are returned and no work item information is returned.
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_RUNNING (for available constants, see [BPC DB Views]). If instance-based authorization is required, columns that are defined on the WORK_ITEM query table can be also referenced using the prefix 'WI.', for example, WI.REASON=REASON_POTENTIAL_OWNER.
sortAttributes	string	Comma-separated list of sort criteria applied to the list of returned process instance entities. Each list entry is in the form attribute [ASC|DESC] where ascending is the default.
offset	integer	Specifies the number of entities to be skipped in the result set.
size	integer	Limits the number of entities returned. The threshold setting might not be accurate.
everybody	boolean	Authorization option specifying that everybody work items (which is the staff verb everybody) are taken into account if instance-based authorization is enabled on the query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
individual	boolean	Authorization option specifying that individual work items, for example, the staff verb "Users", are considered if enabled on the query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
group	boolean	Authorization option specifying that group work items, for example, the staff verb "Group", are taken into account if instance-based authorization is enabled on the query table and if enabled on the Human Task Container. This parameter has no default. If it is omitted then the settings of the query table definition apply.
inherited	boolean	Authorization option specifying that inherited work items are considered, for instance, the administrator of a process instance might then see participating human task instances created for that process instance if it executes a query against that query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
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 to perform this request. If the onBehalfUser parameter is specified as well then the request is performed as if the specified user had sent the request, otherwise, the request runs as administrator. false (default) The request is performed by a regular user who doesn't have administrative rights.
onBehalfUser	string	Administration authorization option specifying that the query is run under the authority of the specified user, and the objects in the query table are checked against the work items for this user if instance-based authorization is used. This parameter is only valid if the admin parameter has been specified with a value true. If admin is set true and this parameter is not used then the request runs as administrator.

Request Content

None

Response Content

The default content-type is application/json.

MIME Type: application/json

{  "description": "Entity Result Set", 
   "type": "object",
   "properties":
   {  "identifier" : {"type": "string",
         "description": "Name of query table attribute identifying an entity."
      },
      "queryTableName": {"type": "string",
         "description": "Name of the query table that is associated with this query result."
      },
      "entityTypeName": {"type": "string",
         "description": "Type of entities that are returned as the result of the query."
      },
      "attributeInfo": 
      [  {  "name": {"type": "string",
               "description": "Attribute name."
            },
            "type": {"type": "string",
               "description": "Attribute type."
            },
            "isArray": {"type": "boolean",
               "description": "Specifies whether the attribute has an array of values."
            },
            "content": {"type": "string",
               "description": "A string that identifies attributes with a well-known value range."
            },
            "sourceAttribute": {"type": "string",
               "description": "The related query table and attribute which provides this attributes' information. Notation: queryTableName.attributeName."
            },
            "sourceQueryTableIdentifier": {"type": "string",
               "description": "The ID of the source attribute's table, as defined in the query table definition."
            }
         }
      ],
      "items": 
      [  {  "type": "object",
            "description": "Entities contained in this result set; list of attribute names and values, as selected by selectedAttributes, plus the entities' key (using its source attribute name)."
         }
      ]
   }
}

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. The requested data is returned. Note that the list might be empty.
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.

Change history

The following changes have been applied to this method:

Release	Description
7.5	The returned query table attribute info contains a new property: "content"

Available since

6.2.0.1

Parent topic: Process instance entity list Resource