Jump to

• Request
• Response
• Examples

Retrieve Open activities for a Process Instance

get

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

Retrieves a process instance's open activities. To retrieve the outcome of all activities, use the API /processes//approval.

Request

Path Parameters

• processId: string
  value of instance Id

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : OpenActivityResponse

Type: object

Show Source

• levels(optional): integer(int32)
• links(optional): array links
• openActivities(optional): array openActivities
• title(optional): string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "openActivities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SimpleOpenActivityInfo"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : openActivities

Type: array

Show Source

• Array of: object SimpleOpenActivityInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SimpleOpenActivityInfo"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : SimpleOpenActivityInfo

Type: object

Show Source

• activityType(optional): string
• displayName(optional): string
• id(optional): string
• processId(optional): string
• taskNumber(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "activityType":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "processId":{
            "type":"string"
        },
        "taskNumber":{
            "type":"integer",
            "format":"int32"
        }
    }
}

400 Response

Bad Request.

401 Response

Unauthorized

404 Response

Not Found

500 Response

Internal Server Error

Back to Top

Examples

The following example shows how to retrieve open activities by submitting a GET request on the REST resource:

Send Request

https://example.com/ic/api/process/v1/processes/{processId}/activities

where

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

• <version> is the REST API version.

• <Process ID> is the ID of the process.

  For example, 1. You can get the <Process ID> using Retrieves Process Instance List.

Example of Response Header

Status Code: 200 OK

Example of Response Body

{
    "levels": 0,
    "openActivities": [
        {
            "id": "ACT4b60e9aa3d738847e732c6ab8a9c7adc",
            "displayName": "User task",
            "processId": "1",
            "taskNumber": 200002
        }
    ],
    "links": [
        {
            "length": 0,
            "rel": "canonical",
            "href": "http://example.com/ic/api/process/v1/processes/1/activities"
        },
        {
            "length": 0,
            "rel": "parent",
            "href": "http://example.com/ic/api/process/v1/processes/1"
        },
        {
            "length": 0,
            "rel": "self",
            "href": "http://example.com/ic/api/process/v1/processes/1/activities"
        }
    ]
} 

Back to Top