Jump to

• Request
• Response
• Examples

Retrieve the Audit Diagram of a Process Instance

get

/ic/api/process/v1/processes/{processId}/audit

Retrieves the audit diagram and history of a process instance.

Request

Path Parameters

• processId(required): string
  Value of process ID

Query Parameters

• auditStructure: string
  Gets the audit structure in list or tree format. Default is list. When the query parameter auditStructure has the value of tree, the API returns the audit structure of the process with the activity level payload in the payloadLink attribute.

  Default Value: list
• currentTaskNumber: string
  String value ,relevant only for USER_TASKs, if present indicates the task number to be used when expanding the histor. Default empty.
• filterActivitiesBy: array[string]
  Collection Format: multi

  Comma separated string of activities that the audit history should be filtered by. START_EVENT,USER_TASK or a combination of both are allowed options
• graphicFlag: boolean
  When graphicFlag is set to true, gets a graphical representation of the process in png format. When graphicFlag is set to false, gets the audit history for the process.

  Default Value: true
• includeFutureTasksFlag: boolean
  boolean value , relevant only for USER_TASKs, true if future user tasks should be included in the response, false otherwise. Default behavior false.

  Default Value: false

Back to Top

Response

Supported Media Types

• image/png
• application/json
• text/plain

200 Response

Success

500 Response

Internal Server Error

Back to Top

Examples

Example: Get the Audit History of a Process with the Activity Payload

The following example gets the audit history of process with ID 70105 including the activity payload. Can be used for completed processes.

Send Request:

https://example.com/ic/api/process/<version>/processes/70105/audit?graphicFlag=false&auditStructure=tree 

Where,

• example.com is the host where Oracle Integration is running.

• <version> is the REST API version.

Back to Top