URIs for Accessing BPM Task Data
This topic lists the available uniform resource identifiers (URI) you can use to access BPM task data or perform an operation on the task. It also describes how the BPM OData service handles IDs used in BPM to identify different artifacts.
| Action | URI | Description |
|---|---|---|
|
Get task input data |
GET /bpmodata/taskdata.svc/<task-instance-id>/InputData?$expand=<wrapper-type> GET /bpmodata/taskdata.svc/<task-instance-id>/InputData('<task-instance-id>')?$expand=<wrapper-type> GET /bpmodata/taskdata.svc/<task-instance-id>/$metadata |
The response body provides the task input data. |
|
Get specific task input collection data |
GET /bpmodata/taskdata.svc/<task-instance-id>/InputData('<task-instance-id>')/<navigation-property-name>/<collection-name>?$skip=<skip-index>&$top=<top-index>&$inlinecount=<allpages|none> |
The response body provides the task input data of the given collection. Note
If the allpages value for the $inlinecount query option is specified, the response body also contains the number of collection items, regardless of whether the $skip or $top query option is set or not. |
|
Get task output data |
GET /bpmodata/taskdata.svc/<task-instance-id>/OutputData?$expand=<wrapper-type> GET /bpmodata/taskdata.svc/<task-instance-id>/OutputData('<task-instance-id>')?$expand=<wrapper-type> GET /bpmodata/taskdata.svc/<task-instance-id>/$metadata |
The response body provides the task output data. |
|
Get task faults |
GET /bpmodata/taskdata.svc/<task-instance-id>/FaultData?$expand=<wrapper-type> GET /bpmodata/taskdata.svc/<task-instance-id>/FaultData(‘<task-instance-id>’)?$expand=<wrapper-type> GET /bpmodata/taskdata.svc/<task-instance-id>/$metadata |
The response body provides the task faults and the related data. |
|
Get task fault data |
GET /bpmodata/taskdata.svc/<task-instance-id>/<fault-name>?$expand=<wrapper-type> GET /bpmodata/taskdata.svc/<task-instance-id>/<fault-name>(‘<task-instance-id>’)?$expand=<wrapper-type> GET /bpmodata/taskdata.svc/<task-instance-id>/$metadata |
The response body provides the task fault data. |
|
Get task data property |
GET /bpmodata/taskdata.svc/<task-instance-id>/<task-data>(<task-instance-id>)/<property-name> GET /bpmodata/taskdata.svc/<task-instance-id>/<task-data>(<task-instance-id>)/<property-name>/<nested-property-name> |
The response body provides the property with the specified property name. Note
<task-data> can be InputData, OutputData, FaultData, or <fault-name>. |
|
Get simple property value |
GET /bpmodata/taskdata.svc/<task-instance-id>/<task-data>(<task-instance-id>)/<simple-property-name>/$value GET /bpmodata/taskdata.svc/<task-instance-id>/<task-data>(<task-instance-id>)/<navigation-property-name>/<simple-property-name>/$value |
The response body provides the value of the simple property with the specified <simple-property-name> property name. Note
<task-data> can be InputData, OutputData, FaultData, or <fault-name>. |
|
Get element of a collection that represents a navigation property |
GET /bpmodata/taskdata.svc/<task-instance-id>/<task-data>(<task-instance-id>)/<collection-name>('<entity-key>') GET /bpmodata/taskdata.svc/<task-instance-id>/ <task-data> (<task-instance-id>)/<navigation-property-name>/<collection-name>('<entity-key>') |
The response body provides an element (entity) identified by the <entity-key> key in the collection with the <collection-name> name. Note
<task-data> can be InputData, OutputData, FaultData, or <fault-name>. |
|
Complete a task |
POST /bpmodata/taskdata.svc/<task-instance-id>/OutputData |
* The request body provides the task output data as values of the corresponding primitive properties and the data structure (EDM entities resolved) of the modeled OutputData. The response body for the POST request contains the OutputData of the completed task. The HTTP status code is 201. |
|
Complete a task with a fault |
POST /bpmodata/taskdata.svc/<task-instance-id>/<fault-name> |
The request body provides the task fault data as values of the corresponding primitive properties and the data structure (EDM entities resolved) of the modeled TaskFaultData. The response body for the POST request contains the task fault data of the completed task. The HTTP status code is 201. |
* To protect modifying requests such as POST against Cross-Site Request Forgery (CSRF) attacks, a valid CSRF token is required. Therefore, before using the POST request you need to request a CSRF token with a GET request containing the header 'X-CSRF-Token' with value 'Fetch'. Modifying requests without a valid CSRF token are rejected.
There is limited support for $batch processing. A $batch request allows at most one modifying POST request. The number of GET requests within the $batch request is not limited.
In addition, for GET data requests, the $format option is allowed. No other additional OData parameters are supported.
Only GET and POST requests that are mentioned in the table above are supported by the OData service for BPM task data.
