Retrieve a Task View

get

/tasks/views/{viewname}

Retrieves a task view by name.

• Request
• Response

Request

Query Parameters

assignment

Task assignees - MY, GROUP, MY_AND_GROUP (default), MY_AND_GROUP_ALL, REPORTEES, OWNER, REVIEWER, PREVIOUS, ALL, ADMIN

columns

Displays only the selected task attributes

dueDateFrom

Start of due date range in the format yyyy-mm-dd hh:mm:ss

dueDateTo

End of due date range in the format yyyy-mm-dd hh:mm:ss

fromuser

Previous task assignee in process

groupBy

Groups tasks by the selected task attribute

keyword

Keyword in task title

limit

Type: integer

Maximum number of items per page, between 1 and 100, default 25

offset

Type: integer

Index for the first item on a page of list items, default 1

pattern

Includes only to-do tasks if set to ToDo

priority

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

process

Includes only tasks in a given process

showAcion

Type: boolean

Displays permissible task actions

showPermission

Type: boolean

Displays task permissions

status

Task status - ASSIGNED (default), SUSPENDED, WITHDRAWN, EXPIRED, ERROR, ALERTED, NEED_INFORMATION

Response

Supported Media Types

• application/json
• application/xml

200 Response

Lists the selected view name.

Body

Root Schema : /paths/~1tasks~1views~1{viewname}/get/responses/200/schema

Example application/json

{
    "totalResult":true,
    "user":{
        "rel":"user",
        "href":"http://example.com/bpm/api/3.0/identities/user/jcooper"
    },
    "count":2,
    "hasMore":false,
    "items":[
        {
            "processName":"HelpDeskRequestProcess",
            "updatedDate":"2015-06-03 01:26:16",
            "priority":3,
            "assignedDate":"2015-06-03 01:26:20",
            "createdDate":"2015-06-03 01:26:16",
            "href":"http://example.com/bpm/api/3.0/tasks/200000",
            "assignees":{
                "totalResult":false,
                "hasMore":false,
                "items":[
                ]
            },
            "number":200000,
            "hasSubTasks":false,
            "title":"Help Desk Request for JuneTask1",
            "rel":"self",
            "type":"task",
            "state":"ASSIGNED"
        }
    ],
    "links":[
        {
            "rel":"back",
            "href":"http://example.com/bpm/api/3.0/"
        },
        {
            "rel":"self",
            "href":"http://example.com/bpm/api/3.0/tasks/views/6a3f7491-a040-425a-90c1-5859aec353ec?status=ASSIGNED&priority=Any&assignment=MY_AND_GROUP&keyword=&limit=25&offset=0"
        }
    ]
}