Jump to

• Request
• Response

Retrieve a Task List

get

/ic/api/process/v1/tasks

Retrieves a task list for the current user.

Request

Query Parameters

• assignment(optional): string
  Task assignees - MY, GROUP, MY_AND_GROUP (default), MY_AND_GROUP_ALL, REPORTEES, OWNER, REVIEWER, PREVIOUS, ALL, ADMIN MY - Tasks assigned exclusively to the context user. This is same as 'My Tasks/Me' in workspace. GROUP - Tasks assigned non-exclusively to the context user. Displays tasks that are assigned to a group of which you are a member. MY_AND_GROUP - All tasks assigned to the context user, exclusively or non exclusively. This is same as 'My Tasks/Me and My Group' in workspace. 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 - All tasks assigned to the context user, exclusively or to all his group based tasks. This is same as 'My Tasks/Me and My Group All' in workspace. 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. This is same as 'Administered by Me' filter in workspace. REVIEWER -Displays tasks for which you are a reviewer. This is same as 'Reviewed by Me' filter in workspace. PREVIOUS - Displays tasks that were previously updated by you. This is same as 'Worked on by Me' filter in workspace. CREATOR - Tasks for which the context user is the creator. This is same as 'Started by Me' filter in workspace. ALL - All tasks (admins only) ADMIN - No filtering (admins only); Displays all tasks regardless of assignment or creator. DEFAULT - based on who the current user is filter is derived and can be either of ADMIN, OWNER or MY_AND_GROUP_ALL

  Default Value: MY_AND_GROUP
• dueDateFrom(optional): string
  Start of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• dueDateTo(optional): string
  End of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• fields(optional): array
  Collection Format: multi

  Displays only the selected task attributes

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"Displays only the selected task attributes",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• fromuser(optional): array
  Collection Format: multi

  Previous task assignee in process

  • [0]: string

  {
      "name":"fromuser",
      "in":"query",
      "description":"Previous task assignee in process",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• identificationKey(optional): string
  identificationKey in Task
• includeOnTrackFlag(optional): boolean
  include ON Track tasks.This flag is used in conjunction with dueDateFrom query parameter.If includeOnTrackFlag is true then set dueDateFrom to 2 days after today.

  Default Value: false
• instanceId(optional): array
  Collection Format: multi

  Displays tasks for the given process-instance-id values

  • [0]: string

  {
      "name":"instanceId",
      "in":"query",
      "description":"Displays tasks for the given process-instance-id values ",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• keyword(optional): string
  Keyword in task title
• limit(optional): integer(int32)
  Maximum number of items per page, default 25

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

  Default Value: false
• offset(optional): integer(int32)
  Index for the first item on a page of list items

  Default Value: 0
• orderBy(optional): string
  Field with which results are to be ordered. Given as orderBy=fieldname:asc/desc, default is asc for ascending.
• pattern(optional): string
  If pattern value is set to 'ToDo' then only ToDo tasks are returned.
• priority(optional): array
  Collection Format: multi

  Task priority from 1 (highest) to 5 (lowest) or Any (default)

  • [0]: string

  {
      "name":"priority",
      "in":"query",
      "description":"Task priority from 1 (highest) to 5 (lowest) or Any (default)",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• process(optional): array
  Collection Format: multi

  Includes only tasks in a given process names

  • [0]: string

  {
      "name":"process",
      "in":"query",
      "description":"Includes only tasks in a given process names",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• processDefId(optional): array
  Collection Format: multi

  Displays tasks for a given process definition id

  • [0]: string

  {
      "name":"processDefId",
      "in":"query",
      "description":"Displays tasks for a given process definition id ",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• showActionFlag(optional): boolean
  Show Action - true or false
• showPermissionFlag(optional): boolean
  Show Permission - true or false
• since(optional): string
  Returned items must be created later than the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• status(optional): array
  Collection Format: multi

  Task status. Default is ASSIGNED. Valid states: ASSIGNED, COMPLETED, SUSPENDED, WITHDRAWN, EXPIRED, ERRORED, ALERTED, INFO_REQUESTED. Task status COMPLETED is valid when used with the following assignments - ADMIN, ALL, PREVIOUS

  • [0]: string
    Default Value: ASSIGNED

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

  {
      "name":"status",
      "in":"query",
      "description":"Task status. \nDefault is ASSIGNED. Valid states: ASSIGNED, COMPLETED, SUSPENDED, WITHDRAWN, EXPIRED, ERRORED, ALERTED, INFO_REQUESTED. Task status COMPLETED is valid when used with the following assignments - ADMIN, ALL, PREVIOUS",
      "required":false,
      "type":"array",
      "items":{
          "type":"string",
          "enum":[
              "ASSIGNED",
              "COMPLETED",
              "SUSPENDED",
              "WITHDRAWN",
              "EXPIRED",
              "ERRORED",
              "ALERTED",
              "INFO_REQUESTED"
          ],
          "default":"ASSIGNED"
      },
      "collectionFormat":"multi"
  }

• taskNumber(optional): array
  Collection Format: multi

  Displays tasks for the given Task number

  • [0]: string

  {
      "name":"taskNumber",
      "in":"query",
      "description":"Displays tasks for the given Task number",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• totalResults(optional): boolean
  Total Result - true or false

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : TaskCollection

Type: object

Show Source

• count(optional): integer(int32)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int32)
• links(optional): array links
• offset(optional): integer(int32)
• totalResult(optional): boolean
• totalResults(optional): integer(int32)
• userLink(optional): object Link

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "userLink":{
            "xml":{
                "name":"user"
            },
            "$ref":"#/definitions/Link"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Task"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "totalResult":{
            "type":"boolean"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object task

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : task

Type: object

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