REST API for Oracle Cloud Infrastructure Process Automation

List Process Instance Members

get

/process/api/v1/audit/instances/{instanceId}/member-history

Retieves the list of members involved in the process instance.

Request

Path Parameters

instanceId(required): string

The id that identifies the process.

Query Parameters

createdAfter: string

Restrict to member actions that were created the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000Z or 2013-01-23T14:42:45.000Z+0200
createdBefore: string

Restrict to member actions that were created before the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000Z or 2013-01-23T14:42:45.000Z+0200
limit: integer

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
offset: integer

0 based index. The number of items to skip before starting to collect the result set. to return.
orderBy: string

This parameter specifies the order by clause. The value must follow the format of fieldName[:(asc/desc)][,fieldName[:(asc/desc)]]*. e.g. updatedDate:asc. Multiple ordering is not supported. The supported attributes include: updatedDate and updatedBy
totalResults: boolean

If true return total count of records for given query with filters

Default Value: false

Header Parameters

oci-original-url:

Actual endpoint which customer requested

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : MemberAuditCollection

A collection of member for a process instance.

Match All

A collection of member for a process instance.

Show Source

object CommonModel
object ListPagination

A common structure for helping a client with pagination
object MemberAuditCollection-allOf[2]

{
    "description":"A collection of member for a process instance.",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "$ref":"#/components/schemas/ListPagination"
        },
        {
            "type":"object",
            "properties":{
                "adhocTaskId":{
                    "type":"string",
                    "description":"The identifier for the adhoc task."
                },
                "instanceId":{
                    "type":"string",
                    "description":"The identifier for hte process instance."
                },
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/MemberAuditResponse"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : ListPagination

Type: object

A common structure for helping a client with pagination

Show Source

count: integer

The count of elements that are returned in the current this will be equal to or less than the "limit" parameter
limit: integer

The maximum number of elements to be returned. This will correspond to the "limit" query parameter
offset: integer

The index number of the first element for the list. This will correspond to the "offset" query parameter value
totalResults: integer (int64)

The total number of elements in the list for the applied filters - not including the "limit" parameter

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The total number of elements in the list for the applied filters - not including the \"limit\" parameter",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "description":"The index number of the first element for the list. This will correspond to the \"offset\" query parameter value"
        },
        "limit":{
            "type":"integer",
            "description":"The maximum number of elements to be returned. This will correspond to the \"limit\" query parameter"
        },
        "count":{
            "type":"integer",
            "description":"The count of elements that are returned in the current this will be equal to or less than the \"limit\" parameter"
        }
    },
    "description":"A common structure for helping a client with pagination"
}

Nested Schema : MemberAuditCollection-allOf[2]

Type: object

Show Source

adhocTaskId: string

The identifier for the adhoc task.
instanceId: string

The identifier for hte process instance.
items: array items

{
    "type":"object",
    "properties":{
        "adhocTaskId":{
            "type":"string",
            "description":"The identifier for the adhoc task."
        },
        "instanceId":{
            "type":"string",
            "description":"The identifier for hte process instance."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MemberAuditResponse"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Defines Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Defines Link

Show Source

code: integer

Minimum Value: 100

Maximum Value: 600
href(required): string
hreflang: string
length: integer (int32)
mediaType: string
message: string
rel(required): string
title: string
type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":"100",
            "maximum":"600"
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object MemberAuditResponse

The information for a member.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MemberAuditResponse"
    }
}

Nested Schema : MemberAuditResponse

Type: object

The information for a member.

Show Source

adhocTaskId: string

The Adhoc Task ID.
id: string

The identifier for the member audit
instanceId: string

The process instance ID
payload: object payload

Additional Properties Allowed: additionalProperties

The payload of the create/update request.
updatedBy: AuditUser
updatedDate: string (date)

The date and time at which the document was lat updated with the format yyyy-MM-dd'T'HH:mm:ss.

{
    "description":"The information for a member.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier for the member audit"
        },
        "adhocTaskId":{
            "type":"string",
            "description":"The Adhoc Task ID."
        },
        "instanceId":{
            "type":"string",
            "description":"The process instance ID"
        },
        "updatedBy":{
            "$ref":"#/components/schemas/AuditUser"
        },
        "updatedDate":{
            "type":"string",
            "description":"The date and time at which the document was lat updated with the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "payload":{
            "type":"object",
            "additionalProperties":{
            },
            "description":"The payload of the create/update request."
        }
    }
}

Nested Schema : payload

Type: object

Additional Properties Allowed

Show Source

{
    "type":"object",
    "additionalProperties":{
    },
    "description":"The payload of the create/update request."
}

The payload of the create/update request.

Nested Schema : AuditUser

Match All

Show Source

allOf Identity
object AuditUser-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Identity"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Identity

Match All

Show Source

object IdentityCommon
object Identity-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        },
        {
            "type":"object",
            "properties":{
                "type":{
                    "type":"string",
                    "enum":[
                        "USER",
                        "GROUP",
                        "ROLE"
                    ]
                }
            }
        }
    ]
}

Nested Schema : IdentityCommon

Type: object

Show Source

displayName: string
id: string
name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : Identity-allOf[1]

Type: object

Show Source

type: string

Allowed Values: [ "USER", "GROUP", "ROLE" ]

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "GROUP",
                "ROLE"
            ]
        }
    }
}

Nested Schema : AuditUser-allOf[1]

Type: object

201 Response

There are no members for the process instance id

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 the request are too slow