IBM Business Process Manager, Version 8.5.5
Use the following resources in this IBM Business Process Manager resource set to develop client applications that you can use to work with business processes and tasks. These business processes and tasks are hosted by the business process definition (BPD) runtime environment.
7.5.0
| REST Method | Description |
|---|---|
| GET .../v1/processApps | Use this method to retrieve the process applications that are installed in the system.
|
| POST .../v1/processApps[?genAIS={boolean}] | Use this method to create a new process application from a BPMN 2.0 archive.
|
| GET .../v1/toolkit | Use this method to retrieve the toolkits that are installed in the system.
|
| POST .../v1/toolkit[?genAIS={boolean}] | Use this method to create a new toolkit from a BPMN 2.0 archive.
|
| GET .../v1/processModel/{bpdId}[?snapshotId={string}][&branchId={string}][&processAppId={string}][&parts={string}] | Use this method to retrieve a Business Process Definition (BPD) model.
|
| POST .../v1/process?action={string}&bpdId={string}[&snapshotId={string}][&branchId={string}][&processAppId={string}][¶ms={string}][&parts={string}] | Use this method to start a BPD instance.
|
| GET .../v1/process?action={string}&instanceIds={string}[&parts={string}] | Use this method to retrieve information for a set of instances.
|
| POST .../v1/process?action={string}&message={string} | Use this method to post a message to the Event Manager for asynchronous processing.
|
| GET .../v1/process/{instanceId}[?parts={string}][&taskLimit={integer}][&taskOffset={integer}] | Use this method to retrieve details of a process instance.
|
| PUT .../v1/process/{instanceId}?action={string}[&parts={string}] | Use this method to perform one of the following actions on a process instance: suspend, resume, terminate, retry.
|
| PUT .../v1/process/{instanceId}?action={string}&dueDate={string}[&parts={string}] | Use this method to update the due date of a process instance.
|
| DELETE .../v1/process/{instanceId}?action={string} | Use this method to delete a process instance that is currently in one of the following states:
"failed", "suspended", "terminated", or "completed".
|
| POST .../v1/process/{instanceId}?action={string}&docType={string}&name={string}[&data={string}][&docUrl={string}][&parts={string}] | Use this method to add a new document to a process instance.
|
| PUT .../v1/process/{instanceId}?action={string}&docId={string}[&data={string}][&docUrl={string}][&parts={string}] | Use this method to update an existing document associated with a process instance.
|
| DELETE .../v1/process/{instanceId}?action={string}&docId={string}[&parts={string}] | Use this method to delete a document associated with a process instance.
|
| PUT .../v1/process/{instanceId}?action={string}&step={string}[&parts={string}] | This function is deprecated. Use ad hoc activities and the respective activity REST resource instead.
Use this method to run an adhoc event associated with a process instance.
|
| PUT .../v1/process/{instanceId}?action={string}&script={string} |
Use this method to execute a javascript expression and return the resulting process instance details.
|
| POST .../v1/process/{instanceId}?action={string}&comment={string}[&origCommentId={string}][&parts={string}] | Use this method to add a comment to a process instance.
It can also be used to post a comment to an existing comment (a threaded comment) in a given process instance
|
| POST .../v1/process/{instanceId}?action={string}&timerTokenId={string}[&parts={string}] | Use this method to manually fire an inline or attached timer.
|
| POST .../v1/process/{instanceId}?action={string}&tokenId={string}&target={string}[&parts={string}][&resume={boolean}] | Use this method to move a token to a different step within the process.
|
| POST .../v1/process/{instanceId}?action={string}&tokenId={string}[&parts={string}][&resume={boolean}] | Use this method to delete a token.
|
| PUT .../v1/process/bulk?instanceIds={string}&action={string}[&parts={string}] | Use this method to perform an operation on multiple process instances.
|
| PUT .../v1/process/errors?instanceIds={string} | Use this method to retrieve runtime error information associated with one or more process instances.
|
| GET .../v1/processes/queries[?processAppName={string}][&kind={string}][&content={string}][&includeTaskData={boolean}] | Use this method to retrieve a list of queries for process instance data.
|
| GET .../v1/processes/query/{queryName}/attributes[?processAppName={string}][&includeTaskData={boolean}] | Use this method to retrieve a list of attributes of a query for process instance data.
|
| GET .../v1/processes/query/{queryName}[?selectedAttributes={string}][&interactionFilter={string}][&queryFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&filterByCurrentUser={boolean}][&includeTaskData={boolean}] | Use this method to retrieve a list of process instance entities via a query.
|
| GET .../v1/processes/query/{queryName}/count[?interactionFilter={string}][&queryFilter={string}][&processAppName={string}][&filterByCurrentUser={boolean}] | Use this method to retrieve the number of process instance entities in a query matching specified criteria.
|
| GET .../v1/process/{instanceId}/actions | Use this method to retrieve a list of actions (adhoc events or standard actions) that are available to the current user for the specified process instance.
|
| GET .../v1/process/actions?instanceIds={string}[&actions={string}] | Retrieve available actions for processes.
|
| GET .../v1/process/{instanceId}/adHocActivities | Use this method to retrieve a list of ad hoc activities that are available to the current user for the specified process instance.
|
| GET .../v1/activity/{instanceId} | Use this method to retrieve details about the activity.
|
| PUT .../v1/activity/{instanceId}?action={string} | Use this method to perform actions on the activity.
|
| GET .../v1/activity/{instanceId}/availableActions | Use this method to retrieve the available actions for the activity instance and the current user.
|
| GET .../v1/activity/{instanceId}/tasks | Use this method to retrieve the current tasks related to the activity instance and the current user.
|
| GET .../v1/serviceModel/{serviceId}[?parts={string}][&snapshotId={string}][&processAppId={string}] | Use this method to retrieve a Service model.
|
| POST .../v1/service/{instanceId}?action={string}[&createTask={boolean}][&parts={string}][¶ms={string}][&snapshotId={string}][&callerTaskId={string}] | Use this method to start a service.
|
| GET .../v1/service/{instanceId} | Use this method to retrieve the list of currently running services.
|
| GET .../v1/service/{instanceId}?action={string}[&field={string}][&fields={string}][&failureMode={string}][&parts={string}] |
Use this method to retrieve one or more variables within a running service.
|
| PUT .../v1/service/{instanceId}?action={string} | Use this method to stop a running service.
|
| PUT .../v1/service/{instanceId}?action={string}[&parts={string}] | Use this method to resume a stopped service.
|
| PUT .../v1/service/{instanceId}?action={string}&script={string} | Use this method to evaluate a javascript code fragment in the context of a running service instance.
|
| PUT .../v1/service/{instanceId}?action={string}[&field={string}][&value={string}][¶ms={string}][&failureMode={string}] |
Use this method to set one or more variables within a running service.
|
| GET .../v1/taskTemplate/{templateId} | Use this method to retrieve a specific human task template.
|
| GET .../v1/taskTemplate/{templateId}/clientSettings/{type} | Use this method to retrieve client settings for a human task template.
|
| GET .../v1/taskTemplates/queries[?processAppName={string}][&kind={string}][&content={string}] | Use this method to retrieve a list of queries for task template data.
|
| GET .../v1/taskTemplates/query/{queryName}/attributes[?processAppName={string}] | Use this method to retrieve a list of attributes of a query for task template data.
|
| GET .../v1/taskTemplates/query/{queryName}[?selectedAttributes={string}][&interactionFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}] | Use this method to retrieve a list of task template entities via a query.
|
| GET .../v1/taskTemplates/query/{queryName}/count[?interactionFilter={string}][&processAppName={string}] | Use this method to retrieve the number of task template entities in a query matching specified criteria.
|
| GET .../v1/externalactivity/{externalActivityId}/model[?parts={string}][&authoring={boolean}][&snapshotId={string}][&branchId={string}] | Use this method to retrieve the model information for an
external activity.
|
| GET .../v1/task?action={string}&taskIDs={string}[&parts={string}] | Use this method to retrieve information for a set of tasks.
|
| PUT .../v1/task?action={string}[&taskIDs={string}] | Use this method to claim responsibility for multiple task instances.
|
| PUT .../v1/task?action={string}[&taskIDs={string}] | Use this method to release multiple claimed task instances.
|
| PUT .../v1/task?action={string}&query={string}[&queryFilter={string}][&sortAttributes={string}] | Use this method to claim the next task, selected based on filter criteria.
|
| GET .../v1/task/actions?taskIDs={string}[&actions={string}] | Retrieve available actions for human tasks.
|
| GET .../v1/task/{taskId}[?parts={string}] | Use this method to retrieve details of a specified human task.
|
| GET .../v1/task/{taskId}?action={string}&fields={string}[&failureMode={string}][&parts={string}] |
Use this method to retrieve one or more variables within a running task.
|
| POST .../v1/task/{taskId}?action={string}&user={string}[&message={string}] | Use this method to invite a user for task collaboration.
|
| PUT .../v1/task/{taskId}?action={string} | Use this method to start a task. The input variables defined on the task will be set according to the definitions in
the associated business process instance. The task will proceed until the first coach is encountered.
|
| PUT .../v1/task/{taskId}?action={string}[&toMe={boolean}][&back={boolean}][&toUser={string}][&toGroup={string}][&parts={string}] | Use this method to assign a task to a user or group.
|
| PUT .../v1/task/{taskId}?action={string}[&dueDate={string}][&priority={string}][&parts={string}] | Use this method to update a task's due date or priority.
|
| PUT .../v1/task/{taskId}?action={string}[&parts={string}][¶ms={string}] | Use this method to finish (complete) a task.
|
| PUT .../v1/task/{taskId}?action={string} | Use this method to claim a task.
|
| PUT .../v1/task/{taskId}?action={string} | Use this method to cancel a task.
|
| PUT .../v1/task/{taskId}?action={string}¶ms={string}[&failureMode={string}] |
Use this method to set one or more variables within a running task.
|
| GET .../v1/task/{taskId}/clientSettings/{type}[?relativeURL={boolean}] | Use this method to retrieve client settings for a human task instance.
|
| GET .../v1/tasks/queries[?processAppName={string}][&kind={string}][&content={string}] | Use this method to retrieve a list of queries for task instance data.
|
| GET .../v1/tasks/query/{queryName}/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/{queryName}[?selectedAttributes={string}][&interactionFilter={string}][&queryFilter={string}][&searchFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&filterByCurrentUser={boolean}] | Use this method to retrieve a list of task instance entities via a query.
|
| GET .../v1/tasks/query/{queryName}/count[?interactionFilter={string}][&queryFilter={string}][&searchFilter={string}][&processAppName={string}][&filterByCurrentUser={boolean}] | Use this method to retrieve the number of task instance entities in a query matching specified criteria.
|
| GET .../v1/exposed[?includeServiceSubtypes={string}] | Use this method to retrieve items that are exposed to an end user.
|
| GET .../v1/exposed/{type}[?includeServiceSubtypes={string}] | Use this method to retrieve items of a specific type that are exposed to an end user.
|
| GET .../v1/search/meta/{type} | Use this method to retrieve the metadata of the requested type via the type path parameter.
|
| PUT .../v1/search/query[?columns={string}][&condition={string}][&sort={string}][&secondSort={string}][&organization={string}][&size={integer}][&offset={integer}][&saveAsName={string}][&run={String}][&shared={boolean}][&filterByCurrentUser={String}] | Use this method to perform a custom search.
|
| POST .../v1/bulk?command={string} | Use this method to run a series of commands. The response contains the data responses for each of the commands that was executed.
If an individual command fails, processing is halted. The subsequent commands are not executed. A failing command does not cause a transactional rollback of the prior commands.
|
| GET .../v1/performance/query?filter={string}[&columns={string}][&condition={string}][&sort={string}][&secondSort={string}][&onlyRollup={string}][&rollupRule={string}] | Use this method to perform a custom search against the performance server.
|
| GET .../v1/performance/instance/{piid} | Use this method to retrieve the history information for a process instance.
|
| GET .../v1/users[?filter={string}][&maxresult={integer}][&assignTaskidFilter={string}][&collabTaskidFilter={string}][&includeTaskExperts={boolean}][&sort={boolean}][&includeInternalMemberships={boolean}][&namesonly={boolean}][&parts={string}][&refreshUser={boolean}] | Retrieve information about users that have been defined to the IBM BPM installation.
|
| GET .../v1/user/{userNameOrID}[?includeInternalMemberships={boolean}][&parts={string}][&refreshUser={boolean}] | Retrieve information about a user that has been defined to the IBM BPM installation.
|
| PUT .../v1/user/{userNameOrID}?action={string}&key={string}&value={string} | Update the user preferences associated with a user. Non-privileged users are able to update self-manageable attributes of the current user, but no attribute of other users. Users authorized in ACTION_MANAGE_ANY_USERATTRIBUTE can update any attribute of any user.
|
| GET .../v1/user[?userID={string}][&userName={string}][&includeInternalMemberships={boolean}][&parts={string}][&refreshUser={boolean}] | Retrieve information about a user that has been defined to the IBM BPM installation. To retrieve details about the current user, omit both the userName and userID parameters.
|
| GET .../v1/groups[?filter={string}][&parts={string}] | Retrieve information about groups that have been defined to the IBM BPM installation.
|
| GET .../v1/group/{groupNameOrID}[?parts={string}] | Retrieve information about a group that has been defined to the IBM BPM installation.
|
| PUT .../v1/group/{groupNameOrID}?action={string}&user={string}&group={string}[&parts={string}] | Update the membership for a group that has been defined to the IBM BPM installation.
|
| GET .../v1/systems | Retrieve metadata about one or more IBM BPM installations (single server or cluster).
|
| GET .../v1/assets[?snapshotId={string}][&branchId={string}] | Use this method to retrieve a list of the assets created in IBM Process Designer that can be viewed or printed using the process documentation tools.
|
| GET .../v1/assets/compare?srcSnapshotId={string}&destBranchId={string} | Use this method to retrieve a list of comparison information of assets created in IBM Process Designer that can be copied into a tip of same Process App or Toolkit using the process documentation tools.
|
| POST .../v1/assets/copy?srcSnapshotId={string}&destBranchId={string} | Use this method to copy assets from a snapshot to a track tip using the process documentation tools.
|
| GET .../v1/branch/{branchId}/snapshots[?namedSnapshot={boolean}][&numberOfSnapshots={integer}] | Use this method to list the snapshots in a branch.
|
| GET .../v1/project/{projectId}/snapshots | Use this method to list the named snapshots in a project.
|
| GET .../v1/project/{projectId}/branches | Use this method to list the branches in a project.
|
| GET .../v1/snapshot/{snapshotId}/changehistory | Use this method to retrieve the change histories that occurred between the current snapshot (passed in the URL) and the previous named snapshot.
|
| GET .../v1/snapshot/comparehistory?snapshotId1={string}&snapshotId2={string}[&branchId1={string}][&branchId2={string}] | Use this method to retrieve the change histories that occurred between two snapshots (passed in the URL).
|
| GET .../v1/processAppSettings[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the project application settings for both process applications and toolkits, including project dependencies and environment variables.
|
| GET .../v1/visual/processModel/{bpdId}[?snapshotId={string}][&branchId={string}][&projectId={string}][&image={boolean}] | Use this method to retrieve a visual model (json, xml or image) for a business process definition.
|
| GET .../v1/visual/processModel/instances?instanceIds={string}[&bpdId={string}][&snapshotId={string}][&branchId={string}][&showCurrentActivites={boolean}][&showNote={boolean}][&showColor={boolean}][&image={boolean}] | Use this method to retrieve a business process definition (BPD) visual model (json, xml or image) for multiple BPD instances.
|
| GET .../v1/visual/serviceModel/{serviceId}[?snapshotId={string}][&branchId={string}][&projectId={string}][&image={boolean}] | Use this method to retrieve the visual model (json, xml or image) for a service diagram.
|
| GET .../v1/SCAServiceModel/{serviceId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the advanced integration service.
|
| GET .../v1/businessobject/{boId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the details of a business object.
|
| GET .../v1/participantGroup/{participantGroupId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the details of a participant group.
|
| GET .../v1/team/{teamId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the details of a team, which is identified by its ID.
|
| GET .../v1/team[?snapshotId={string}][&branchId={string}][&name={string}] | Use this method to retrieve the details of a team, which is identified by its name.
|
| GET .../v1/epv/{epvId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the detailed information related to an exposed process value.
|
| GET .../v1/trackinggroup/{tgId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the detailed information related to a tracking group.
|
| GET .../v1/timinginterval/{timingIntervalId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the detailed information related to a timing interval.
|
| GET .../v1/uca/{ucaId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the detailed information related to an undercover agent.
|
| GET .../v1/webservice/{wsId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the detailed information related to a web service.
|
| GET .../v1/sla/{slaId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the detailed information related to a service level agreement.
|
| GET .../v1/social/task/{taskId}/experts[?parts={string}] | Retrieve information about the expert users that have been identified for a task and defined to the IBM BPM installation.
|
| GET .../v1/social/instances/following | Use this method to retrieve the list of currently followed instances.
|
| GET .../v1/social/instances/mentions[?page={integer}][&pageSize={integer}][&since={string}][&sort={string}] | Retrieves the current list of items which mention the currently logged in user.
|
| GET .../v1/social/instance/{instanceId}/stream[?page={integer}][&pageSize={integer}][&since={string}][&sort={string}] | Retrieves an activity stream for the given process instance.
|
| GET .../v1/social/task/{taskId}/stream[?page={integer}][&pageSize={integer}][&since={string}][&sort={string}] | Retrieves an activity stream for the a process instance, as looked up by the given task ID.
|
| GET .../v1/social/instance/{instanceId}/following | Use this method to find if the currently logged in user is following the given process instance.
|
| POST .../v1/social/instance/{instanceId}/following | Use this method to start following a specific process instance
|
| DELETE .../v1/social/instance/{instanceId}/following | Use this method to stop following a specific process instance
|
| GET .../v1/social/task/{taskId}/following | Use this method to find if the currently logged in user is following the given process instance, as looked up by the task ID.
|
| POST .../v1/social/task/{taskId}/following | Use this method to start following a specific process instance, as looked up by the task ID.
|
| DELETE .../v1/social/task/{taskId}/following | Use this method to stop following a specific process instance, as looked up by the task ID.
|
| POST .../v1/social/task/{taskId}/comment[?message={string}] | Allows posting a threaded comment to an existing comment. The task ID passed in is the task ID of the comment for which the response is intended.
|
| DELETE .../v1/social/task/{taskId}/mentions | Deletes the identified mentions item.
|
| DELETE .../v1/social/task/mentions/all | Deletes all of the users mentions items.
|
| GET .../v1/social/task/{taskId}/userdata?username={string} | Retrieves the statistical data for a single user on a given task.
|
| GET .../v1/system/rep/ |
If no path paramter (providerName) is provided, then the service will return a list of all resource environment providers on the system.
|
| GET .../v1/system/rep/{providerName}[?properties={string}] |
If no properties query parameter is specified, then the service will return a list of properties available on the specified provider, if it exists.
If a properties query parameter is specified then the service will resolve the value of the requested properties from the provider and return those in key value pairs
|
| GET .../v1/system/env/variable?bpdShortname={string}&name={string} | Retrieves the given environment variable from the process project.
|
| GET .../v1/social/system/integrations | Retrieves the given environment variable from the process project.
|
| GET .../v1/avatar/{userNameOrID} | Retrieves a user's avatar or profile image. The retrieved image is a base64 encoded string packaged in a JSON structure.
Use /avatar/{userNameOrID} to retrieve any user's avatar or use /avatar/current for the avatar of current logged in user.
|
| POST .../v1/avatar/{userNameOrID}?avatar={string} | Update the user avatar associated with a user.
|
| DELETE .../v1/avatar/{userNameOrID} | Removes the user preferences associated with a user.
|
| GET .../v1/bpddata/{bpdId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the inputs, outputs, private variables, and activities with their data mappings for a business process definition.
|
| GET .../v1/bpdtaggroup/{bpdId}[?snapshotId={string}][&branchId={string}] | Use this method to retrieve the tag groups and all their tags for a business process definition.
|
| POST .../v1/event/ecm?eventSourceId={string}&objectTypeId={string}&eventType={string}&objectId={string} | Use this method to send an ECM event to IBM Business Process Manager. When this method is invoked, the BPM server must have a connection to the ECM system identified by the eventSourceId parameter.
|
The following subtopics describe the REST resources that are defined for this resource set:
Parent Topic: IBM Business Process Manager REST Interface