Jump to

• Request
• Response

Retrieve a Custom Task List

get

/ic/api/process/v1/tasks/views/{viewname}

Retrieves a custom task list by name.

Request

Path Parameters

• viewname(required): string
  View Name

Query Parameters

• action: boolean
  Action
• assignment: string
  Task assignees - MY, GROUP, MY_AND_GROUP (default), MY_AND_GROUP_ALL, REPORTEES, OWNER, REVIEWER, PREVIOUS, ALL, ADMIN

  Default Value: MY_AND_GROUP
• 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
• fromuser: array[string]
  Collection Format: multi

  Previous task assignee in process
• groupBy: string
  Groups tasks by the selected task attribute
• includeOnTrackFlag: 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: array[string]
  Collection Format: multi

  Displays tasks for the given instance id values
• keyword: string
  Keyword in task title
• limit: integer(int32)
  Maximum number of items per page, between 1 and 100, default 25

  Default Value: 25
• metadataFlag: boolean
  Metadata - true or false(default)

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

  Default Value: 0
• pattern: string
  Includes only to-do tasks if set to ToDo
• priority: array[string]
  Collection Format: multi

  Task priority from 1 (highest) to 5 (lowest) or Any (default)
• process: array[string]
  Collection Format: multi

  Includes only tasks in a given process
• processDefId: array[string]
  Collection Format: multi

  Displays tasks for a given process definition id
• showPermission: boolean
  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]
  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

  • Default Value: ASSIGNED

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

• taskNumber: array[string]
  Collection Format: multi

  Displays tasks for the given Task number
• totalResults: boolean
  Total Result - true (default) 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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : TaskCollection

Type: object

Show Source

• count: integer(int32)
• hasMore: boolean
• items: array items
• limit: integer(int32)
• links: array links
• offset: integer(int32)
• totalResult: boolean
• totalResults: integer(int32)
• userLink: 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: string
• mediaType: string
• rel: string

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

Nested Schema : task

Type: object

400 Response

Bad request

401 Response

Unauthorized

404 Response

Task List not found for view

500 Response

Internal Server Error

Back to Top