1. REST API for Oracle Cloud Infrastructure Process Automation
  2. Tasks
  3. Audit
  4. Instances
  5. Documents

List Process Documents

get

/process/api/v1/audit/instances/{instanceId}/documents

Retrieves the documents that were involved in a process instance.

Request

Path Parameters
Query Parameters
  • The number of items to return. If parameter is omitted default value 25 is set. If limit <=0 or limit> 50 then upto 50 records are returned.
    Default Value: 25
  • 0 based index. The number of items to skip before starting to collect the result set. to return.
  • This parameter specifies the order by clause. The value must follow the format of fieldName[:(asc/desc)][,fieldName[:(asc/desc)]]*. e.g. documentId:asc. Multiple ordering is not supported. The supported attributes include: documentId, documentName and createdDate
  • If true return total count of records for given query with filters
    Default Value: false
Header Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : AuditInstanceDocuments
Match All
Show Source
Nested Schema : ProcessInstance
Type: object
Match All
Show Source
Nested Schema : BaseInstance
Type: object
Match All
Show Source
Nested Schema : CommonModel
Type: object
Show Source
Nested Schema : BaseInstance-allOf[1]
Type: object
Show Source
Nested Schema : ProcessInstance-allOf[1]
Type: object
Show Source
Nested Schema : ListPagination
Type: object
A common structure for helping a client with pagination
Show Source
  • The count of elements that are returned in the current this will be equal to or less than the "limit" parameter
  • The maximum number of elements to be returned. This will correspond to the "limit" query parameter
  • The index number of the first element for the list. This will correspond to the "offset" query parameter value
  • The total number of elements in the list for the applied filters - not including the "limit" parameter
Nested Schema : AuditInstanceDocuments-allOf[2]
Type: object
Show Source
Nested Schema : availableActions
Type: array
Show Source
Nested Schema : UserOrAppClient
Match All
Show Source
Nested Schema : Discriminator: type
Type: object
Show Source
Nested Schema : IdentityCommon
Type: object
Show Source
Nested Schema : availableActions
Type: array
Show Source
Nested Schema : availablePermissions
Type: array
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : AuditDocument
Match All
Show Source
Nested Schema : AuditDocument-allOf[1]
Type: object
Show Source
Nested Schema : AuditUser
Match All
Show Source
Nested Schema : Identity
Match All
Show Source
Nested Schema : Identity-allOf[1]
Type: object
Show Source
Nested Schema : AuditUser-allOf[1]
Type: object

201 Response

There are no documents for the BPMN Process ID

400 Response

Bad Request. There is an error in the URL

401 Response

Unauthorized

404 Response

The process instance does not exist

429 Response

Too Many Requests

500 Response

internal server error

503 Response

Too Many Exceptions or Too Slow Requests
Back to Top

Examples

Example: Get the list of documents for a process instance

The following example shows how to get the list of documents involved in a process instance by submitting a GET request on the REST resource using cURL. For more information about cURL, see cURL Access. For more information about endpoint URL structure, see Send Requests.

Retrieve the list of documents for the process instance 3fa85f64-5717-4562-b3fc-2c963f66afa6 in ascending order and limit the results to 25 documents.

curl -X 'GET' \
      'https://<OIC URL>/process/api/v1/audit/instances/3fa85f64-5717-4562-b3fc-2c963f66afa6/documents?orderBy=asc&limit=25&totalResults=false'
      \   -H 'accept: application/json' \   -H 'oci-original-url:
    www.oracle.com'

Example: Format of 200 Operation Successful response

{
  "links": [
    {
      "href": "string",
      "hreflang": "string",
      "length": 0,
      "rel": "string",
      "title": "string",
      "type": "string",
      "mediaType": "string",
      "message": "string",
      "code": 600
    }
  ],
  "id": "string",
  "processName": "string",
  "title": "string",
  "description": "string",
  "processDefinitionName": "string",
  "processDefinitionKey": "string",
  "processDefinitionVersion": 0,
  "processDefinitionId": "string",
  "businessKey": "string",
  "applicationName": "string",
  "applicationTitle": "string",
  "applicationDescription": "string",
  "createTime": "string",
  "updateTime": "string",
  "endTime": "string",
  "durationInMillis": 0,
  "startActivityId": "string",
  "state": "ACTIVE",
  "availableActions": [
    "string"
  ],
  "createdBy": {
    "id": "string",
    "name": "string",
    "displayName": "string",
    "type": "USER"
  },
  "closeTime": "string",
  "userId": "string",
  "createUserId": "string",
  "parentProcessInstanceId": "string",
  "superProcessInstanceId": "string",
  "superCaseInstanceId": "string",
  "caseInstanceId": "string",
  "version": "string",
  "startUserId": "string",
  "availablePermissions": [
    "string"
  ],
  "totalResults": 0,
  "offset": 0,
  "limit": 0,
  "count": 0,
  "items": [
    {
      "links": [
        {
          "href": "string",
          "hreflang": "string",
          "length": 0,
          "rel": "string",
          "title": "string",
          "type": "string",
          "mediaType": "string",
          "message": "string",
          "code": 600
        }
      ],
      "documentId": "string",
      "processInstanceId": "string",
      "dpInstanceId": "string",
      "fileName": "string",
      "href": "string",
      "createdBy": {
        "id": "string",
        "name": "string",
        "displayName": "string",
        "type": "USER"
      },
      "createdDate": "2024-08-12",
      "lastUpdatedBy": {
        "id": "string",
        "name": "string",
        "displayName": "string",
        "type": "USER"
      },
      "lastUpdatedDate": "2024-08-12"
    }
  ]
}
Back to Top