Jump to

• Request
• Response

Get All Members of an Adhoc Task

get

/process/api/v1/tasks/{id}/members

User with READ permission or above can get a list of all the members of an adhoc task.

Request

Path Parameters

• id(required): string
  Adhoc Task ID

Query Parameters

• 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
• memberLabel: string
  member label
• memberPermission: string
  member permission (INSPECT, READ, USE or MANAGE).
• 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. label:asc. Multiple ordering is not supported. The supported attributes include: permission and label

Header Parameters

• Accept-Language:
  Accept-Language header in IETF BCP 47
• oci-original-url:
  Endpoint requested by customer

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : UpdateMembersCollection

Match All

Show Source

• object CommonModel
• object UpdateMembersCollection-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "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 : UpdateMembersCollection-allOf[1]

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"
        }
    }
}

Examples

Select an example List of Members

401 Response

Unauthorized

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

Examples

Select an example unauthorizedError

404 Response

Task not found for given ID

429 Response

Too many requests

500 Response

Internal server error

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

503 Response

Too many exceptions or too slow requests

Back to Top