REST API for Oracle Cloud Infrastructure Process Automation

Reassign Tasks

post

/process/api/v1/tasks/reassign

Reassign tasks to user(s) and/or role(s).

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Match All

Show Source

object schema

Reassign request object
object properties

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ReassignRequest"
        },
        {
            "required":[
                "taskIds"
            ]
        },
        {
            "properties":{
                "taskIds":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : schema

Type: object

Reassign request object

Show Source

comment: string

comment
identities: array identities

Only the ID of identity input is considered and not name.

{
    "type":"object",
    "properties":{
        "identities":{
            "type":"array",
            "description":"Only the ID of identity input is considered and not name.",
            "items":{
                "$ref":"#/components/schemas/Identity"
            }
        },
        "comment":{
            "type":"string",
            "description":"comment"
        }
    },
    "description":"Reassign request object"
}

Nested Schema : properties

Type: object

Show Source

taskIds: array taskIds

{
    "properties":{
        "taskIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : identities

Type: array

Only the ID of identity input is considered and not name.

Show Source

Array of: Identity

{
    "type":"array",
    "description":"Only the ID of identity input is considered and not name.",
    "items":{
        "$ref":"#/components/schemas/Identity"
    }
}

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

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : BulkReassignResponse

Type: object

Show Source

failedCount: integer
items: array items
sucessCount: integer
totalCount: integer

{
    "type":"object",
    "properties":{
        "totalCount":{
            "type":"integer"
        },
        "sucessCount":{
            "type":"integer"
        },
        "failedCount":{
            "type":"integer"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BulkReassignResponseItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object BulkReassignResponseItem

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

Nested Schema : BulkReassignResponseItem

Type: object

Show Source

errorMessage: string
status: string

Allowed Values: [ "Success", "Failed" ]
taskId: string

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "Success",
                "Failed"
            ]
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

400 Response

Bad request - invalid input

401 Response

Unauthorized

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

Examples

Example: Reassign tasks

The following example shows how to reassign tasks by submitting a POST 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.

curl -X 'POST' \
  'https://oracle.com/process/api/v1/tasks/reassign' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "identities": [
    {
      "id": "string",
      "name": "string",
      "displayName": "string",
      "type": "USER"
    }
  ],
  "comment": "string",
  "taskIds": [
    "string"
  ]
}'

Example Format of 200 Operation Successful Response

{
    "totalCount": 2,
    "sucessCount": 2,
    "failedCount": 0,
    "items": [
        {
            "taskId": "a0a0e129-53f7-11ef-873e-0abcb",
            "status": "Success"
        },
        {
            "taskId": "882c3e21-637c-11ef-873e-0abcb",
            "status": "Success"
        }
    ]
}