| REST Method | Description |
|---|
| GET .../v1/taskTemplates/filter[?whereClause={string}][&orderByClause={string}][&size={integer}] |
Use this method to retrieve a list of task templates that match specified filter criteria.
|
| GET .../v1/taskTemplates/queries[?processAppName={string}][&sourceAttributes={string}][&content={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of queries for task template data.
|
| GET .../v1/taskTemplates/query/{query}/attributes[?processAppName={string}] |
Use this method to retrieve a list of attributes of a query for task template data.
|
| GET .../v1/taskTemplates/query/{query}[?interactionFilter={string}][&selectedAttributes={string}][&queryFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}] |
Use this method to retrieve a list of task template entities via a query.
|
| GET .../v1/taskTemplates/query/{query}/count[?interactionFilter={string}][&queryFilter={string}][&processAppName={string}][&admin={boolean}] |
Use this method to retrieve the number of task template entities in a query matching specified criteria.
|
| GET .../v1/taskTemplates/queryTables[?sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of query tables containing task template data.
|
| GET .../v1/taskTemplates/queryTable/{queryTable}/attributes |
Use this method to retrieve a list of attributes for a specified query table containing task template data.
|
| GET .../v1/taskTemplates/query?queryTableName={string}[&selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}] |
Use this method to retrieve a list of task template entities via a query table.
|
| GET .../v1/taskTemplates/queryCount?queryTableName={string}[&queryFilter={string}][&admin={boolean}] |
Use this method to retrieve the number of task template entities in a query table matching specified criteria.
|
| GET .../v1/taskTemplate/{tktid} |
Use this method to retrieve a specific human task template.
|
| GET .../v1/taskTemplate/{tktid}/input |
Use this method to retrieve an "empty" input for a task. This is useful when an input is prepared for a subsequent "create and start" scenario.
|
| GET .../v1/taskTemplate/{tktid}/clientSettings/{type} |
Use this method to retrieve client settings for a human task template.
|
| GET .../v1/taskTemplate/{tktid}/resource?clientType={string}&resourceName={string} |
Use this method to retrieve a client resource for a specified human task template.
|
| GET .../v1/tasks/filter[?whereClause={string}][&orderByClause={string}][&offset={integer}][&size={integer}] |
Use this method to retrieve a list of human task instances.
|
| GET .../v1/tasks/queries[?processAppName={string}][&sourceAttributes={string}][&content={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of queries for task instance data.
|
| GET .../v1/tasks/query/{query}/attributes[?processAppName={string}] |
Use this method to retrieve a list of attributes of a specified query for containing task instance data.
|
| GET .../v1/tasks/query/{query}[?selectedAttributes={string}][&interactionFilter={string}][&queryFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve a list of task instance entities via a query.
|
| GET .../v1/tasks/query/{query}/count[?interactionFilter={string}][&queryFilter={string}][&processAppName={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve the number of task instance entities in a query matching specified criteria.
|
| GET .../v1/tasks/queryTables[?sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of query tables containing task instance data.
|
| GET .../v1/tasks/queryTable/{queryTable}/attributes |
Use this method to retrieve a list of attributes of a specified query table containing task instance data.
|
| GET .../v1/tasks/query?queryTableName={string}[&selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve a list of task instance entities via a query table.
|
| GET .../v1/tasks/queryCount?queryTableName={string}[&queryFilter={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve the number of task instance entities in a query table matching specified criteria.
|
| POST .../v1/task?taskTemplateID={string}[&mode={string}][&relation={string}][&parentTaskID={string}] |
Use this method to create a new instance of a human task.
|
| POST .../v1/task?action={string} |
Use this method to create an instance of a lean task.
|
| PUT .../v1/task?action={string}&query={string}&queryTableName={string}[&queryFilter={string}][&sortAttributes={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}][&maxRetryCount={integer}] |
Use this method to claim the next task, selected based on filter criteria.
|
| PUT .../v1/task?action={string}&query={string}[&queryFilter={string}][&sortAttributes={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}][&maxRetryCount={integer}] |
Use this method to claim the next task, selected based on filter criteria. If a task exists that are already claimed then this task is returned.
|
| PUT .../v1/task?action={string} |
Use this method to update the task properties, for example, the priority, category, or a custom property, for multiple task instances.
|
| PUT .../v1/task?action={string} |
Use this method to claim responsibility for multiple task instances.
|
| PUT .../v1/task?action={string} |
Use this method to release multiple claimed task instances.
|
| PUT .../v1/task?action={string}[&deadline={string}][&duration={string}] |
Use this method to suspend multiple task instances.
|
| PUT .../v1/task?action={string}&keepTaskData={boolean}[&deadline={string}][&duration={string}] |
Use this method to suspend one or more claimed tasks until a specified point in time or for a specified time period, and cancel the claim when the tasks are automatically resumed.
|
| PUT .../v1/task?action={string} |
Use this method to resume multiple suspended task instances.
|
| GET .../v1/task/actions?taskIDs={string}[&actions={string}] |
Use this method to retrieve available actions for human tasks.
|
| PUT .../v1/task/role/{role}?action={string}[&toUser={string}][&fromUser={string}][&toGroup={string}][&fromGroup={string}] |
Use this method to transfer multiple task instances.
|
| GET .../v1/task/{tkiid} |
Use this method to retrieve details of a specified human task.
|
| PUT .../v1/task/{tkiid}?action={string} |
Use this method to update the properties of a task, for example, the priority, category, or a custom property.
|
| PUT .../v1/task/{tkiid}?action={string}&mode={string}[&relation={string}][&parentTaskID={string}] |
Use this method to start a new task using a synchronous (call) or asynchronous (start) operation.
|
| PUT .../v1/task/{tkiid}?action={string} |
Use this method to claim the responsibility for a task.
|
| PUT .../v1/task/{tkiid}?action={string} |
Use this method to release a claimed task.
|
| PUT .../v1/task/{tkiid}?action={string}[&faultName={string}] |
Use this method to complete a task with output or fault data.
|
| PUT .../v1/task/{tkiid}?action={string}[&deadline={string}][&duration={string}] |
Use this method to suspend a task until a specified point in time, for a specified time period, or indefinitely.
|
| PUT .../v1/task/{tkiid}?action={string}&keepTaskData={boolean}[&deadline={string}][&duration={string}] |
Use this method to suspend a claimed task until a specified point in time or for a specified time period, and cancel the claim when the task is automatically resumed.
|
| PUT .../v1/task/{tkiid}?action={string} |
Use this method to resume the processing of a suspended task.
|
| PUT .../v1/task/{tkiid}?action={string} |
Use this method to terminate a task instance.
|
| DELETE .../v1/task/{tkiid} |
Use this method to delete a task instance.
|
| GET .../v1/task/{tkiid}/input[?new={boolean}] |
Use this method to retrieve the input for a task.
|
| PUT .../v1/task/{tkiid}/input |
Use this method to set the input for a task.
|
| GET .../v1/task/{tkiid}/output[?new={boolean}] |
Use this method to retrieve a task's output.
|
| PUT .../v1/task/{tkiid}/output |
Use this method to set the output for a task. Note that this operation deletes any output or fault data that was previously set.
|
| GET .../v1/task/{tkiid}/fault?faultName={string}[&new={boolean}] |
Use this method to retrieve a task's fault data.
|
| PUT .../v1/task/{tkiid}/fault?faultName={string} |
Use this method to set the fault data for a task. Note that this operation deletes any output or fault data that was previously set.
|
| GET .../v1/task/{tkiid}/subtasks |
Use this method to retrieve a list of subtasks.
|
| POST .../v1/task/{tkiid}/binaryCustomProperty/{name}[?type={string}][&query={string}][&allowUpdate={boolean}] |
Use this method to create a new binary custom property for a specified task.
|
| GET .../v1/task/{tkiid}/binaryCustomProperty/{name} |
Use this method to retrieve the value of a binary custom property of a task.
|
| PUT .../v1/task/{tkiid}/binaryCustomProperty/{name}[?type={string}][&query={string}][&allowCreate={boolean}] |
Use this method to set the value of a binary custom property of a task.
|
| GET .../v1/task/{tkiid}/binaryCustomProperty/{name}/metadata |
Use this method to retrieve the metadata information of a binary custom property of a task.
|
| GET .../v1/task/{tkiid}/role/{role} |
Use this method to retrieve user(s) or group(s) associated with a task's role.
|
| PUT .../v1/task/{tkiid}/role/{role}?action={string}[&toUser={string}][&fromUser={string}][&toGroup={string}][&fromGroup={string}] |
Use this method to transfer a task to another user or group.
|
| PUT .../v1/task/{tkiid}/role/{role}?action={string}&newUser={string} |
Use this method to assign a new user to a task role.
|
| GET .../v1/task/{tkiid}/clientSettings/{type} |
Use this method to retrieve client settings for a human task instance.
|
| GET .../v1/task/{tkiid}/history[?newEventType={boolean}] |
Use this method to retrieve the history of a human task instance.
|
| GET .../v1/task/{tkiid}/escalationInfo |
Use this method to retrieve escalation information for a human task instance.
|
| GET .../v1/escalations/queries[?processAppName={string}][&sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of queries containing task escalation data.
|
| GET .../v1/escalations/query/{query}/attributes |
Use this method to retrieve a list of attributes for a specified query containing task escalation data.
|
| GET .../v1/escalations/query/{query}[?selectedAttributes={string}][&interactionFilter={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}] |
Use this method to retrieve a list of task escalation entities via a query.
|
| GET .../v1/escalations/query/{query}/count[?queryFilter={string}][&admin={boolean}] |
Use this method to retrieve the number of task escalation entities in a query matching specified criteria.
|
| GET .../v1/escalations/queryTables[?sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of query tables containing task escalation data.
|
| GET .../v1/escalations/queryTable/{queryTable}/attributes |
Use this method to retrieve a list of attributes for a specified query table containing task escalation data.
|
| GET .../v1/escalations/query?queryTableName={string}[&selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}] |
Use this method to retrieve a list of task escalation entities via a query table.
|
| GET .../v1/escalations/queryCount?queryTableName={string}[&queryFilter={string}][&admin={boolean}] |
Use this method to retrieve the number of task escalation entities in a query table matching specified criteria.
|
| GET .../v1/escalation/{esiid} |
Use this method to retrieve an escalation of a human task instance.
|
| PUT .../v1/escalation/{esiid}?action={string} |
Use this method to trigger an escalation instance for a task.
|
| PUT .../v1/escalation/{esiid}?action={string} |
Use this method to update the properties of an escalation.
|
| GET .../v1/escalation/actions?taskIDs={string}[&actions={string}] |
Use this method to retrieve available actions for escalations.
|
| GET .../v1/workBaskets/queries[?processAppName={string}][&sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of queries containing work basket data.
|
| GET .../v1/workBaskets/query/{query}/attributes |
Use this method to retrieve a list of attributes for a specified query containing work basket data.
|
| GET .../v1/workBaskets/query/{query}[?selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}] |
Use this method to retrieve a list of work basket entities via a query.
|
| GET .../v1/workBaskets/query/{query}/count[?queryFilter={string}][&admin={boolean}] |
Use this method to retrieve the number of work basket entities in a query matching specified criteria.
|
| GET .../v1/workBaskets/queryTables[?sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of query tables containing work basket data.
|
| GET .../v1/workBaskets/queryTable/{queryTable}/attributes |
Use this method to retrieve a list of attributes for a specified query table containing work basket data.
|
| GET .../v1/workBaskets/query?queryTableName={string}[&selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}] |
Use this method to retrieve a list of work basket entities via a query table.
|
| GET .../v1/workBaskets/queryCount?queryTableName={string}[&queryFilter={string}][&admin={boolean}] |
Use this method to retrieve the number of work basket entities in a query table matching specified criteria.
|
| POST .../v1/workBasket[?locale={string}] |
Use this method to create a new work basket.
|
| GET .../v1/workBasket/{wbid}[?getDefinition={boolean}][&locale={string}] |
Use this method to retrieve details of a specified work basket.
|
| PUT .../v1/workBasket/{wbid}?action={string} |
Use this method to remove a work basket as distribution target.
|
| PUT .../v1/workBasket/{wbid}?action={string}[&locale={string}] |
Use this method to update the properties of a work basket.
|
| PUT .../v1/workBasket/{wbid}?action={string}[&taskID={string}][&cancelClaimIfNeeded={boolean}] |
Use this method to transfer one or more task instances to a specified work basket.
|
| PUT .../v1/workBasket/{wbid}?action={string}[&taskID={string}] |
Use this method to distribute one or more task instances to a specified work basket.
|
| DELETE .../v1/workBasket/{wbid} |
Use this method to delete a work basket.
|
| GET .../v1/workBasket/{wbid}/distributionTargets[?locale={string}] |
Use this method to retrieve the distribution targets of a specified work basket.
|
| GET .../v1/businessCategories/queries[?processAppName={string}][&sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of queries containing business category data.
|
| GET .../v1/businessCategories/query/{query}/attributes |
Use this method to retrieve a list of attributes for a specified query containing business category data.
|
| GET .../v1/businessCategories/query/{query}[?selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}] |
Use this method to retrieve a list of business category entities via a query.
|
| GET .../v1/businessCategories/query/{query}/count[?queryFilter={string}][&admin={boolean}] |
Use this method to retrieve the number of business category entities in a query matching specified criteria.
|
| GET .../v1/businessCategories/queryTables[?sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of query tables containing business category data.
|
| GET .../v1/businessCategories/queryTable/{queryTable}/attributes |
Use this method to retrieve a list of attributes for a specified query table containing business category data.
|
| GET .../v1/businessCategories/query?queryTableName={string}[&selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}] |
Use this method to retrieve a list of business category entities via a query table.
|
| GET .../v1/businessCategories/queryCount?queryTableName={string}[&queryFilter={string}][&admin={boolean}] |
Use this method to retrieve the number of business category entities in a query table matching specified criteria.
|
| POST .../v1/businessCategory[?parentBusinessCategory={string}][&locale={string}] |
Use this method to create a new business category.
|
| PUT .../v1/businessCategory?action={string}[&priority={integer}] |
Use this method to set the priority for multiple business categories.
|
| GET .../v1/businessCategory/{bcid}[?getDefinition={boolean}][&locale={string}] |
Use this method to retrieve details of a specified business category.
|
| PUT .../v1/businessCategory/{bcid}?action={string}[&locale={string}] |
Use this method to update the properties of a business category.
|
| PUT .../v1/businessCategory/{bcid}?action={string}[&parentBusinessCategory={string}] |
Use this method to set the parent business category for a business category.
|
| DELETE .../v1/businessCategory/{bcid}[?recursive={string}] |
Use this method to delete a business category.
|
| GET .../v1/processApps |
Use this method to retrieve the process applications that are installed in the system.
|
| GET .../v1/systems |
Use this method to retrieve metadata about one or more WebSphere Process Server installations (single server or cluster).
|