Jump to

• Request
• Response

Update/Delete Members of an Instance

put

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

Members with MANAGE permission can update and delete members of a process instance.

Request

Path Parameters

• id(required): string
  Process Instance ID

Header Parameters

• oci-original-url:
  Endpoint requested by customer

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• action: string
  Example: addMembers(to add the list of members), updateMembers(to update the list of members), deleteAllMembers(to delete all the members), deleteMembers(to delete the list of members)
• items: array items
• overwrite: string
  Default Value: always

  Allowed Values: [ "always", "never", "upgradeOnly", "downgradeOnly", "upgradeonly", "downgradeonly" ]

  Example: always(always add the member's permission), never (skips updating the already present members in list, updates the others), downgradeOnly (update permission if the existing permission is higher than specified), upgradeOnly (update permission if the existing permission is lower than specified)

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "example":"addMembers(to add the list of members), updateMembers(to update the list of members), deleteAllMembers(to delete all the members), deleteMembers(to delete the list of members)"
        },
        "overwrite":{
            "type":"string",
            "example":"always(always add the member's permission), never (skips updating the already present members in list, updates the others), downgradeOnly (update permission if the existing permission is higher than specified), upgradeOnly (update permission if the existing permission is lower than specified)",
            "enum":[
                "always",
                "never",
                "upgradeOnly",
                "downgradeOnly",
                "upgradeonly",
                "downgradeonly"
            ],
            "default":"always"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Member"
            }
        }
    }
}

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 Update members Delete members Delete all members

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

Member Successfully added

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 Updated Members

400 Response

Bad request

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 badRequestError

401 Response

Unauthorized

404 Response

instanceId not found

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 notFoundError

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

Examples

Select an example internalError

Back to Top