Jump to

• Request
• Response

Retrieve a Task List

get

/bpm/api/4.0/tasks

Retrieves a task list for the current user.

Request

Query Parameters

• assignment: string
  Task assignees - MY, GROUP, MY_AND_GROUP (default), MY_AND_GROUP_ALL, REPORTEES, OWNER, REVIEWER, PREVIOUS, ALL, ADMIN. MY - Displays tasks that are assigned exclusively to you. GROUP - Displays tasks that are assigned to a group of which you are a member. MY_AND_GROUP -Displays tasks that are assigned to anyone, including you, in the groups you belongs to.This will not fetch tasks that are acquired by some other user in the groups you belong to. MY_AND_GROUP_ALL -Displays tasks that are assigned to anyone, including you, in the groups you belongs to.This will even fetch tasks that are acquired by some other user in the groups you belong to. REPORTEES - Displays tasks that are assigned to reportees of you OWNER - Displays tasks in which you are task owner. REVIEWER -Displays tasks for which you are a reviewer PREVIOUS - Displays tasks that were previously updated by you ALL - No filtering; Displays all tasks regardless of assignment or creator. ADMIN - No filtering; Displays all tasks regardless of assignment or creator.

  Default Value: MY_AND_GROUP
• createdBy: string
  if provided, only tasks created by the given user are returned
• dueDateFrom: string
  Start of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• dueDateTo: string
  End of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• fields: array[string]
  Displays only the selected task attributes, which can include createdDate, creator, updatedDate, fromUser, tasknumber, priority,ownerUser, state, approvalDuration,taskDefinitionName, taskNameSpace, taskId, category,assignedDate, dueDate,outcome,ecid, identificationKey
• fromuser: array[string]
  Previous task assignee
• identificationKey: string
  if provided, only tasks with the given task identification key are returned
• keyword: string
  Keyword in task title
• limit: integer(int32)
  Maximum number of items per page, preferably between 1 and 100, default 25. Zero or negative value will render the parameter inapplicable and all results will be returned in single page

  Default Value: 25
• metadataFlag: boolean
  metadataFlag - true or false. if metadataFlag is true, then task details URL is populated.

  Default Value: false
• offset: integer(int32)
  Index for the first item on a page of list items. Negative value will render the parameter inapplicable

  Default Value: 0
• orderBy: string
  Field with which results are to be ordered. Given as orderBy=fieldname:asc/desc, default is asc for ascending.Field Names supported are createdDate, creator, updatedDate, fromUser, tasknumber, priority,ownerUser, state, approvalDuration,taskDefinitionName, taskNameSpace, taskId, category,assignedDate, dueDate,outcome,ecid, identificationKey
• outcome: string
  if provided, only tasks with the given task outcome value are returned
• pattern: string
  If pattern value is set to 'ToDo' then only ToDo tasks are returned.
• priority: array[string]
  Task priority from 1 (highest) to 5 (lowest) or Any (default)
• showActionFlag: boolean
  Show Action - true or false
• showPermissionFlag: boolean
  Show Permission - true or false
• since: string
  Returned items must be created later than the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• status: array[string]
  Task status (Task status COMPLETED is valid when used with following assignments - ADMIN, ALL, PREVIOUS)

  • Default Value: ASSIGNED

    Allowed Values: [ "ASSIGNED", "COMPLETED", "SUSPENDED", "WITHDRAWN", "EXPIRED", "ERRORED", "ALERTED" ]

  [
      "ASSIGNED",
      "COMPLETED",
      "SUSPENDED",
      "WITHDRAWN",
      "EXPIRED",
      "ERRORED",
      "ALERTED"
  ]

• totalResults: boolean
  Total Result - true or false

  Default Value: true
• until: string
  Returned items must be created before the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : Collection

Type: object

Show Source

• count: integer (int32)
• hasMore: boolean
  Default Value: false
• items: array items
• limit: integer (int32)
• links: array links
• offset: integer (int32)
• totalResult: boolean
  Default Value: false
• totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "totalResult":{
            "type":"boolean",
            "default":false
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Task"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        }
    },
    "xml":{
        "name":"Collection",
        "namespace":"http://xmlns.oracle.com/bpm/rest/v3/common/"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Task

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

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

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

206 Response

Partial Content

400 Response

Bad request

401 Response

Unauthorized

404 Response

Task list not found

500 Response

Internal Server Error

Back to Top