Jump to

• Request
• Response

Perform Action on Task

put

/bpm/api/4.0/tasks/{id}

Performs the action on a specific task identifier, based on the payload. The following actions are available and the actions depend on the application: APPROVE, REJECT, REASSIGN, DELEGATE, WITHDRAW, SUSPEND, RESUME, DELETE, PURGE, ACQUIRE, RELEASE, PUSHBACK, ERROR, ADHOC_ROUTE, INFO_REQUEST, INFO_SUBMIT, SKIP_CURRENT_ASSIGNMENT, SAVE and ESCALATE. Custom Actions depend on the task definition.

Request

Path Parameters

• id(required): string
  Task ID

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• action: object action
• comment: object comment
• comments: string
• defaultActionForGroupVote: string
  applicable only when routingType is Parallel
• priority: integer (int32)
• routingAction: string
  Only applicable for ADHOC_ROUTE. Accepts the custom action to be performed before routing the task.
• routingType: string
  Only applicable for ADHOC_ROUTE.Accepts the type of routing to be performed. Allowed values are Simple,Sequential and Parallel
• votersPercentage: integer
  applicable only when routingType is Parallel.Default value is 0

{
    "type":"object",
    "properties":{
        "action":{
            "$ref":"#/components/schemas/Action"
        },
        "comment":{
            "$ref":"#/components/schemas/Comment"
        },
        "comments":{
            "type":"string"
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        },
        "routingAction":{
            "type":"string",
            "description":"Only applicable for ADHOC_ROUTE. Accepts the custom action to be performed before routing the task."
        },
        "routingType":{
            "type":"string",
            "description":"Only applicable for ADHOC_ROUTE.Accepts the type of routing to be performed. Allowed values are Simple,Sequential and Parallel"
        },
        "votersPercentage":{
            "type":"integer",
            "description":"applicable only when routingType is Parallel.Default value is 0"
        },
        "defaultActionForGroupVote":{
            "type":"string",
            "description":"applicable only when routingType is Parallel"
        }
    },
    "xml":{
        "name":"payload",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : action

Type: object

Show Source

• assignees: array assignees
• id: string
• type: string

{
    "type":"object",
    "properties":{
        "assignees":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Identity"
            }
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    },
    "xml":{
        "name":"action",
        "namespace":"http://xmlns.oracle.com/bpm/rest/processdef"
    }
}

Nested Schema : comment

Type: object

Show Source

• commentStr: string

{
    "type":"object",
    "properties":{
        "commentStr":{
            "type":"string"
        }
    },
    "xml":{
        "name":"comment",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : assignees

Type: array

Show Source

• Array of: object identity

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

Nested Schema : identity

Type: object

Show Source

• email: string
• firstName: string
• id: string
• identity: object Link
• lastName: string
• middleName: string
• mobile: string
• type: string
• workPhone: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "email":{
            "type":"string"
        },
        "identity":{
            "$ref":"#/components/schemas/Link"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "middleName":{
            "type":"string"
        },
        "mobile":{
            "type":"string"
        },
        "workPhone":{
            "type":"string"
        }
    },
    "xml":{
        "name":"identity",
        "namespace":"http://xmlns.oracle.com/bpm/rest/identities"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(required): string
• rel(required): string
  Allowed Values: [ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "enum":[
                "self",
                "cancel",
                "forceCancel",
                "hold",
                "release",
                "subscribe",
                "permissions",
                "executionStatus"
            ]
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success . In case of PURGE, a title specifying task id successfully purged will be returned.

Body ()

Root Schema : Task

Type: object

Show Source

• artifacts: array artifacts
• contextId: string
• final: boolean
  Indicates whether the task update is the final update.
• history: array history
• id: string
• kind: string
  Default Value: task
• metadata: object metadata
  Additional Properties Allowed: true
• status: object TaskStatus

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "contextId":{
            "type":"string"
        },
        "status":{
            "$ref":"#/components/schemas/TaskStatus"
        },
        "artifacts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Artifact"
            }
        },
        "history":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Message"
            }
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "kind":{
            "type":"string",
            "default":"task"
        },
        "final":{
            "type":"boolean",
            "description":"Indicates whether the task update is the final update."
        }
    }
}

Nested Schema : artifacts

Type: array

Show Source

• Array of: object Artifact

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

Nested Schema : history

Type: array

Show Source

• Array of: object Message

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

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : TaskStatus

Type: object

Show Source

• message: object Message
• state: string
  Allowed Values: [ "submitted", "working", "input-required", "completed", "canceled", "failed", "unknown" ]
• timestamp: string
  UTC timestamp string.

{
    "type":"object",
    "properties":{
        "state":{
            "$ref":"#/components/schemas/TaskState"
        },
        "message":{
            "$ref":"#/components/schemas/Message"
        },
        "timestamp":{
            "type":"string",
            "description":"UTC timestamp string."
        }
    }
}

Nested Schema : Artifact

Type: object

Show Source

• append: boolean
• artifactId: string
• description: string
• lastChunk: boolean
• metadata: object metadata
  Additional Properties Allowed: true
• name: string
• parts: array parts

{
    "type":"object",
    "properties":{
        "artifactId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "parts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TextPart"
            }
        },
        "append":{
            "type":"boolean"
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "lastChunk":{
            "type":"boolean"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : parts

Type: array

Show Source

• Array of: object TextPart

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

Nested Schema : TextPart

Type: object

Show Source

• kind: string
  Default Value: text
• metadata: object metadata
  Additional Properties Allowed: true
• text: string
  Text content.
• type: string
  Part type.

  Example: text

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Part type.",
            "example":"text"
        },
        "text":{
            "type":"string",
            "description":"Text content."
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "kind":{
            "type":"string",
            "default":"text"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : Message

Type: object

Show Source

• contextId: string
  Conversation identifier. For `message/stream`, this must be nested under `params.message`.
• kind: string
  Default Value: message
• messageId: string
• metadata: object metadata
  Additional Properties Allowed: true
• parts: array parts
• role: string
  Allowed Values: [ "user", "agent" ]
• taskId: string
  Optional task identifier used for resumed or task-associated message flows.

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "enum":[
                "user",
                "agent"
            ]
        },
        "parts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TextPart"
            }
        },
        "metadata":{
            "type":"object",
            "additionalProperties":true
        },
        "messageId":{
            "type":"string"
        },
        "contextId":{
            "type":"string",
            "description":"Conversation identifier. For `message/stream`, this must be nested under `params.message`."
        },
        "taskId":{
            "type":"string",
            "description":"Optional task identifier used for resumed or task-associated message flows."
        },
        "kind":{
            "type":"string",
            "default":"message"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed: true

Nested Schema : parts

Type: array

Show Source

• Array of: object TextPart

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

400 Response

The tasknumber is invalid.No action will be performed.

401 Response

Unauthorized

404 Response

Task not found.

409 Response

Conflict.

500 Response

Internal Server Error

Back to Top