REST API for Oracle Cloud Infrastructure Process Automation

List Current State of Process Instance Members

get

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

Retrieves the list of members as determined by replaying the member audit.

Request

Path Parameters

instanceId(required): string

The id that identifies the process.

Query Parameters

cutoffDate: string

Restrict to the member state as at a particular point in time. 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

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 : MemberAuditNetPermission

Match All

Show Source

object CommonModel
object ListPagination

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "$ref":"#/components/schemas/ListPagination"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Member"
                    }
                }
            }
        }
    ]
}

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 : MemberAuditNetPermission-allOf[2]

Type: object

Show Source

items: array items

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

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 Member

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

Nested Schema : Member

Type: object

Show Source

identityId: string

The identity ID of the member
identityName: string

The identity name of the member
identityType: string

The identity type of the member
label: string

The label of the member
level: string

Allowed Values: [ "INSPECT", "READ", "USE", "MANAGE" ]

The permission level of the member

{
    "type":"object",
    "properties":{
        "identityId":{
            "type":"string",
            "description":"The identity ID of the member"
        },
        "level":{
            "type":"string",
            "enum":[
                "INSPECT",
                "READ",
                "USE",
                "MANAGE"
            ],
            "description":"The permission level of the member"
        },
        "label":{
            "type":"string",
            "description":"The label of the member"
        },
        "identityType":{
            "type":"string",
            "description":"The identity type of the member"
        },
        "identityName":{
            "type":"string",
            "description":"The identity name of the member"
        }
    }
}

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

Examples

Example: Get the current state of members of a process instance

The following example shows how to get the current state of the process instance members 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 current state of all the members of a process instance 3fa85f64-5717-4562-b3fc-2c963f66afa6 on date 2024-01-23 and customer end point of www.oracle.com.

curl -X 'GET' \
  'https://<OIC URL>/process/api/v1/audit/instances/3fa85f64-5717-4562-b3fc-2c963f66afa6/members?cutoffDate=2024-01-23' \
  -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
    }
  ],
  "totalResults": 0,
  "offset": 0,
  "limit": 0,
  "count": 0,
  "items": [
    {
      "identityId": "string",
      "level": "INSPECT",
      "label": "string",
      "identityType": "string",
      "identityName": "string"
    }
  ]
}