REST API for Oracle Cloud Infrastructure Process Automation

All REST Endpoints

Applications

All DesignTime APIs

Activate an Application: Method: put
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/activate
Clone an Application: Method: put
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/clone
Create or Import an Application: Method: post
Path: /process/api/v1/design/applications
Deactivate an Application: Method: put
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/deactivate
Delete All Versions of an Application: Method: delete
Path: /process/api/v1/design/applications/{applicationName}
Delete an Application by Name and Version: Method: delete
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}
Export an Application: Method: get
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/export
Get an Application: Method: get
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}
List Applications: Method: get
Path: /process/api/v1/design/applications
List Applications by Name: Method: get
Path: /process/api/v1/design/applications/{applicationName}
Set an Activated Application as Default: Method: put
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/default
Version an Application: Method: put
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/version

Applications/Connectors

The operations from the Applications/Connectors category.

Associate a Global Credential With the Connector: Method: patch
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/connectors/{connectorId}/credentials/global/associate
Get a Connector: Method: get
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/connectors/{connectorId}
Get Associated Global Credential With the Connector: Method: get
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/connectors/{connectorId}/credentials/global/associate
Get List of Global Credentials for the Connector: Method: get
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/connectors/{connectorId}/credentials/global
List all Connectors: Method: get
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/connectors
Update the Base URL for a Connector: Method: patch
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/connectors/{connectorId}

Applications/Snapshots

The operations from the Applications/Snapshots category.

Create a Snapshot: Method: post
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/snapshots
Delete a Snapshot: Method: delete
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/snapshots/{snapshotId}
Delete Snapshots: Method: delete
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/snapshots
Get a Snapshot: Method: get
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/snapshots/{snapshotId}
List Snapshots: Method: get
Path: /process/api/v1/design/applications/{applicationName}/versions/{version}/snapshots

Credentials

All Credential APIs

Create a New Credential: Method: post
Path: /process/api/v1/credentials/maps/{param2}/keys/{param3}
Delete a Credential Key: Method: delete
Path: /process/api/v1/credentials/maps/{param2}/keys/{param3}
Get Credential Details: Method: get
Path: /process/api/v1/credentials/maps/{param2}/keys/{param3}
Update a Credential Key and Map: Method: put
Path: /process/api/v1/credentials/maps/{param2}/keys/{param3}

Dynamic Processes

All Dynamic Processes APIs

Get Process Execution: Method: get
Path: /process/api/v1/dp-executions/{id}
List Process Executions: Method: get
Path: /process/api/v1/dp-executions
Perform Action on a Process Execution: Method: put
Path: /process/api/v1/dp-executions/{id}

Processes/Dynamic Process Resources

The operations from the Processes/Dynamic Process Resources category.

Get a Process Resource by Name: Method: get
Path: /process/api/v1/dp-resources/{name}
List Process Resources: Method: get
Path: /process/api/v1/dp-resources

Processes/Instances

The operations from the Processes/Instances category.

Create a Process Instance: Method: post
Path: /process/api/v1/instances
Get a Process Instance: Method: get
Path: /process/api/v1/instances/{id}
List Process Instances: Method: get
Path: /process/api/v1/instances
Perform an Action on Process Instance: Method: put
Path: /process/api/v1/instances/{id}

Processes/Instances/Alter Flow (Structured Process)

The operations from the Processes/Instances/Alter Flow (Structured Process) category.

List Active Activity IDs of an Instance: Method: get
Path: /process/api/v1/instances/{instanceId}/activities
List Target Activities of an Instance: Method: get
Path: /process/api/v1/instances/{instanceId}/target-activities

Processes/Instances/Attributes

The operations from the Processes/Instances/Attributes category.

List Attribute Values of an Instance: Method: get
Path: /process/api/v1/instances/{instanceId}/attributes/{attr_name}
List Attributes of an Instance: Method: get
Path: /process/api/v1/instances/{instanceId}/attributes
Update Attribute Values of an Instance: Method: put
Path: /process/api/v1/instances/{instanceId}/attributes/{attr_name}

Processes/Instances/Data Objects

The operations from the Processes/Instances/Data Objects category.

Get a Process Instance Data Object's Value: Method: get
Path: /process/api/v1/instances/{id}/data-objects/{name}
Get Data Object Value of a Sub-process: Method: get
Path: /process/api/v1/instances/{instanceId}/activities/{act_inst_id}/data-objects/{name}
List Data Objects of Sub-process Activity: Method: get
Path: /process/api/v1/instances/{instanceId}/activities/{act_inst_id}/data-objects
List Process Instance Data Objects: Method: get
Path: /process/api/v1/instances/{id}/data-objects
Update Data Object of a Sub-process Activity: Method: put
Path: /process/api/v1/instances/{instanceId}/activities/{act_inst_id}/data-objects/{name}
Update Data Object of Instance: Method: put
Path: /process/api/v1/instances/{id}/data-objects/{name}

Processes/Instances/Instance Comments

The operations from the Processes/Instances/Instance Comments category.

Add a Process Instance Comment: Method: post
Path: /process/api/v1/instances/{id}/comments
Get Process Instance Comment by Comment Id: Method: get
Path: /process/api/v1/instances/{id}/comments/{commentId}
List Process Instance Comments: Method: get
Path: /process/api/v1/instances/{id}/comments

Processes/Instances/Instance Documents

The operations from the Processes/Instances/Instance Documents category.

Delete a Process Document: Method: delete
Path: /process/api/v1/instances/{id}/documents/files/{documentId}
Download a Process Document: Method: get
Path: /process/api/v1/instances/{id}/documents/files/{documentId}/data
List Process Instance Documents: Method: get
Path: /process/api/v1/instances/{id}/documents
Upload Process Document to Storage: Method: post
Path: /process/api/v1/instances/{id}/documents/files/data

Processes/Instances/Members

The operations from the Processes/Instances/Members category.

Add Members to an Instance: Method: post
Path: /process/api/v1/instances/{id}/members
Delete a Member of an Instance: Method: delete
Path: /process/api/v1/instances/{id}/members/{identityId}
Get Member Details of an Instance and IdentityId: Method: get
Path: /process/api/v1/instances/{id}/members/{identityId}
Get Members of an Instance: Method: get
Path: /process/api/v1/instances/{id}/members
Update/Delete Members of an Instance: Method: put
Path: /process/api/v1/instances/{id}/members

Processes/Messages

The operations from the Processes/Messages category.

Send Message to Process Instance: Method: post
Path: /process/api/v1/messages

Processes/Process Executions

The operations from the Processes/Process Executions category.

Get a Process Execution: Method: get
Path: /process/api/v1/process-executions/{id}
List Process Executions: Method: get
Path: /process/api/v1/process-executions
Perform an Action on a Process Execution: Method: put
Path: /process/api/v1/process-executions/{id}

Processes/Process Instances (Structured Process)

The operations from the Processes/Process Instances (Structured Process) category.

Get a Process Instance Incident: Method: get
Path: /process/api/v1/process-instances/{id}/incidents/{incidentId}
Get a Process Instance Job: Method: get
Path: /process/api/v1/process-instances/{id}/jobs/{jobId}
Get the Process Instance History: Method: get
Path: /process/api/v1/process-instances/{id}/history
List Process Instance Incidents: Method: get
Path: /process/api/v1/process-instances/{id}/incidents
List Process Instance Jobs: Method: get
Path: /process/api/v1/process-instances/{id}/jobs
Resubmit a Process Instance Job: Method: post
Path: /process/api/v1/process-instances/{id}/jobs/{jobId}

Processes/Process Interfaces

The operations from the Processes/Process Interfaces category.

Get a Process Interface: Method: get
Path: /process/api/v1/process-interfaces/{id}
Get a Process Interface Schema: Method: get
Path: /process/api/v1/process-interfaces/{id}/schemas/{name}
List Process Interfaces: Method: get
Path: /process/api/v1/process-interfaces

Roles

All Roles APIs

Create a Role: Method: post
Path: /process/api/v1/data-access/roles
Delete Role by Id: Method: delete
Path: /process/api/v1/data-access/roles/{id}
Get a Role by Id: Method: get
Path: /process/api/v1/data-access/roles/{id}
List Roles: Method: get
Path: /process/api/v1/data-access/roles

Roles/Role Members

The operations from the Roles/Role Members category.

Add a Role Member to the Role: Method: post
Path: /process/api/v1/data-access/roles/{id}/members
Delete Role Member of the Role by Role Member ID: Method: delete
Path: /process/api/v1/data-access/roles/{id}/members/{identityId}
Get Members of a Role: Method: get
Path: /process/api/v1/data-access/roles/{id}/members
Get Role Member of the Role by ID: Method: get
Path: /process/api/v1/data-access/roles/{id}/members/{identityId}

User Configurations/Out Of Office

The operations from the User Configurations/Out Of Office category.

Creates Out Of Office Record: Method: post
Path: /process/api/v1/user-configurations/out-of-office
Deletes Out Of Office Record: Method: delete
Path: /process/api/v1/user-configurations/out-of-office/{id}
Get Out Of Office record: Method: get
Path: /process/api/v1/user-configurations/out-of-office/{id}
List Out Of Office Records: Method: get
Path: /process/api/v1/user-configurations/out-of-office
Update Out of Office Record: Method: put
Path: /process/api/v1/user-configurations/out-of-office/{id}

User Tasks

All Task APIs

Claim a Task: Method: post
Path: /process/api/v1/tasks/{id}/claim
Complete a Task: Method: post
Path: /process/api/v1/tasks/{id}/complete
Complete Tasks: Method: post
Path: /process/api/v1/tasks/complete
Escalate a Task: Method: post
Path: /process/api/v1/tasks/{id}/escalate
Get a Task: Method: get
Path: /process/api/v1/tasks/{id}
List Task Actions: Method: post
Path: /process/api/v1/tasks/actions
List Task Metrics: Method: get
Path: /process/api/v1/tasks/metrics
List Tasks: Method: get
Path: /process/api/v1/tasks
Reassign a Task: Method: post
Path: /process/api/v1/tasks/{id}/reassign
Reassign Tasks: Method: post
Path: /process/api/v1/tasks/reassign
Release a Task: Method: post
Path: /process/api/v1/tasks/{id}/release
Request Information on Task: Method: post
Path: /process/api/v1/tasks/{id}/request-for-info
Submit Information on Task: Method: post
Path: /process/api/v1/tasks/{id}/submit-info
Update a Task: Method: put
Path: /process/api/v1/tasks/{id}
Withdraw a Task: Method: post
Path: /process/api/v1/tasks/{id}/withdraw
Withdraw Tasks: Method: post
Path: /process/api/v1/tasks/withdraw

User Tasks/Adhoc Tasks

The operations from the User Tasks/Adhoc Tasks category.

Create an Adhoc Task: Method: post
Path: /process/api/v1/tasks

User Tasks/Adhoc Tasks/Members

The operations from the User Tasks/Adhoc Tasks/Members category.

Add Members to an Adhoc Task: Method: post
Path: /process/api/v1/tasks/{id}/members
Delete Member: Method: delete
Path: /process/api/v1/tasks/{id}/members/{identityId}
Fetches Member details for a given Adhoc Task id and given identityId: Method: get
Path: /process/api/v1/tasks/{id}/members/{identityId}
Get All Members of an Adhoc Task: Method: get
Path: /process/api/v1/tasks/{id}/members
Update/Delete Members of an Adhoc Task: Method: put
Path: /process/api/v1/tasks/{id}/members

User Tasks/Comments

The operations from the User Tasks/Comments category.

Add a Task Comment: Method: post
Path: /process/api/v1/tasks/{id}/comments
Get a Task Comment: Method: get
Path: /process/api/v1/tasks/{id}/comments/{commentId}
List Task Comments: Method: get
Path: /process/api/v1/tasks/{id}/comments

User Tasks/Documents

The operations from the User Tasks/Documents category.

Delete Task Document: Method: delete
Path: /process/api/v1/tasks/{id}/documents/files/{documentId}
Download a Task Document: Method: get
Path: /process/api/v1/tasks/{id}/documents/files/{documentId}/data
List Task Documents: Method: get
Path: /process/api/v1/tasks/{id}/documents
Upload a Task Document: Method: post
Path: /process/api/v1/tasks/{id}/documents/files/data

User Tasks/Payloads

The operations from the User Tasks/Payloads category.

Get a Task Payload: Method: get
Path: /process/api/v1/tasks/{id}/payload
Update Task Payload: Method: put
Path: /process/api/v1/tasks/{id}/payload