IBM Business Process Manager, Version 8.5.6

REST interface for IBM Process Federation Server resources - Task List Resource - GET Method

Use this method to retrieve a list of task instance entities.

Sample method invocation

GET /rest/bpm/federated/v1/tasks/query/IBM.DEFAULTALLTASKSLIST_75[?systemID={string}][&selectedAttributes={string}][&interactionFilter={string}][&queryFilter={string}][&searchFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}]

Usage Notes

Parameters

Optional parameters
NameValue TypeDescription
systemID string

The ID of a federated IBM BPM system. Use the ID to filter the results for a specific federated system.

systemID is a universally unique identifier (UUID), such as f1436904-793d-4a38-8c64-7634dbdae6f6.

Use the Process Federation Server /federated/v1/systems rest query to retrieve the systemID.

selectedAttributes string

Comma-separated list of attributes that are to be retrieved by the query. Specify attribute names in uppercase letters. If no attributes are specified, then all the attributes that are defined in the query are returned.

If an invalid attribute is passed, it is not included in the task list. The attributeInfo section of the response indicates that the attribute's content and sourceAttribute are not applicable - "n/a".

interactionFilter string

Name of a predefined user interaction filter.

ValueDescription
WORK_ON
Work on tasks. Returns tasks that are claimed by the current user. Tasks in suspended process instances are excluded.
ASSESS_AVAILABLE
Assess available tasks. Returns tasks that can be claimed by the current user. Tasks in suspended process instances are excluded.
ASSESS_AND_WORK_ON
Assess and work on tasks. Returns tasks from the WORK_ON and the ASSESS_AVAILABLE filters.
CHECK_COMPLETED
Completed tasks. Returns tasks which were completed by the current user.
BROWSE_ALL
All tasks that the current user can claim, work on, or completed. Tasks in suspended process instances are included.

This is the default value for the interactionFilter if none is specified.

queryFilter string

A query table condition language expression (WHERE clause) that provides additional filtering on the result set. You can reference any of the attributes that are defined in the query.

searchFilter string

Provide search terms to filter the results. Task fields and business data fields that are available for search will be searched.

Multiple terms can be separated with a space, in which case all of the terms must be found in a task.

Wildcards can be included: ? for single character wildcards, * for variable length wildcards.

To search for terms spelled similarly, use ~ at the end of the term.

For searching within a single field, use a queryFilter expression instead.

For decimal, date, and boolean fields, use a queryFilter expression instead.

processAppName string

Returns tasks that belong to the specified process application.

sortAttributes string

Comma-separated list of sort criteria to apply to the list of returned tasks. Each list entry has the form attribute [ASC|DESC], ascending is the default.

offset integer

Specifies the index (origin 0) of the first entity in the query result set. Offset 0 refers to the first entity in the result set; offset 1 to the second entity, and so on. If this parameter is not specified, the default value of 0 is used.

Use this parameter with the size parameter to provide paging in the task list.

size integer

Specifies the maximum number of entities to be returned. If this parameter is not specified, the default value of 25 is used.

Use this parameter with the offset parameter to provide paging in the task list.

Request content

None

Response content

Task list (Task complexType).

The default content type is application/json.

MIME type: application/json


+ View schema
{  "description": "Query Result Set", 
   "type": "object",
   "properties":
   {  "identifier" : {"type": "string",
         "description": "Name of the query result set attribute that identifies an entity."
      },
      "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the IBM BPM system that the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP status code that was returned from this IBM BPM system."
            },
            "taskCompletionUrlPrefix": {"type": "string",
               "description":"The prefix to use for services in this federated IBM BPM system (BPM only)."
            },
            "restUrlPrefix": {"type": "string",
               "description":"The prefix to use for processes in this federated IBM BPM system (BPM only)."
            },
            "systemType": {"type": ["string"],
               "description":"The type of this federated IBM BPM system, either "SYSTEM_TYPE_WLE", or "SYSTEM_TYPE_WPS"."
            },
            "version": {"type": "object",
               "description":"The product version on this federated IBM BPM system."
            }
         }
      ],
      "query": {"type": "string",
         "description": "Name of the query that is associated with this query result set."
      },
      "entityTypeName": {"type": "string",
         "description": "Type of entities that are returned as the result of the query."
      },
      "totalCount": {"type": "integer",
         "description": "The number of items in the entire result set."
      },
      "size": {"type": "integer",
         "description": "The number of items returned in the query."
      },
      "requestedSize": {"type": "integer",
         "description": "The number of items requested to be returned in the query."
      },
      "offset": {"type": "integer",
         "description": "The offset into the entire result set where this query response should begin."
      },
      "attributeInfo": 
      [  {  "name": {"type": "string",
               "description": "Attribute name."
            },
            "type": {"type": "string",
               "description": "Attribute type."
            },
            "isArray": {"type": "boolean",
               "description": "Specifies whether the attribute has an array of values."
            },
            "content": {"type": "string",
               "description": "A string that identifies attributes with a well-known value range."
            },
            "sourceAttribute": {"type": "string",
               "description": "The related query table and attribute that provides information about this attributes."
            },
            "sourceQueryTableIdentifier": {"type": "string", "optional": true,
               "description": "The ID of the source attribute's table, as defined in the query table definition."
            }
         }
      ],
      "items": 
      [  {  "type": "object",
            "description": "Entities contained in this query result set; the system ID of the system hosting the entity, a list of attribute names and values as selected by selectedAttributes, and the entities' key (using its source attribute name)."
         }
      ]
   }
}
+ View example content
{
    "entityTypeName": "TASK",
    "federationResult": [
        {
            "indexRefreshInterval": 5000,
            "statusCode": 200,
            "taskCompletionUrlPrefix": "http://server1.com:9080/teamworks",
            "restUrlPrefix": "http://server1.com:9080/rest/service",
            "systemType": "SYSTEM_TYPE_WPS",
            "systemID": "_PK:9023014a.7bc3bec0.94078ff6.2ad30002",
            "version": "8.5.6.0"
        },
        {
            "indexRefreshInterval": 5000,
            "statusCode": 200,
            "taskCompletionUrlPrefix": "http://server2.com:9088\/teamworks",
            "restUrlPrefix": "http://server2.com:9086\/rest\/bpm\/wle",
            "systemType": "SYSTEM_TYPE_WLE",
            "systemID": "ca920a9e-f809-4076-9485-a05b6877f5cb",
            "version": "8.5.6.0"
        },
        {
            "indexRefreshInterval": 5000,
            "statusCode": 200,
            "taskCompletionUrlPrefix": "http://server3.com:9080/teamworks",
            "restUrlPrefix": "http://server3.com:9080/rest/service",
            "systemType": "SYSTEM_TYPE_WPS",
            "systemID": "_PK:9023014a.34687eb0.f14991f6.e4560002",
            "version": "8.0.1.3"
        }
    ],
    "totalCount": 6,
    "items": [
        {
            "STATE": "STATE_READY",
            "INVOKED_INSTANCE_ID": null,
            "SNAPSHOT_NAME": null,
            "APPLIC_NAME": "TestBpelTaskModuleApp",
            "IS_TRANSFERRED_TO_WORK_BASK": false,
            "BC_BCID": null,
            "SNAPSHOT_ID": null,
            "DUE": null,
            "PI_DISPLAY_NAME": null,
            "OWNER": null,
            "IS_READ": false,
            "IS_WAIT_FOR_SUB_TK": false,
            "PI_PIID": null,
            "TAD_DESCRIPTION": null,
            "PI_NAME": null,
            "SUSPENDED": false,
            "ORIGINATOR": "admin",
            "PROCESS_APP_ACRONYM": null,
            "TASK.TKIID": "_TKI:a01b014a.9c4cee19.f14991f6.70af34ee",
            "KIND": "KIND_PARTICIPATING",
            "PT_PTID": null,
            "TYPE": null,
            "WORK_BASKET": null,
            "TAD_DISPLAY_NAME": "StandAloneParticipantTask",
            "EXPIRED": null,
            "NAME": "StandAloneParticipantTask",
            "PRIORITY": 5,
            "STARTER": null,
            "CONTAINMENT_CTX_ID": "_ACO:a01c014a.34687ea5.f14991f6.e4560001",
            "IS_ESCALATED": false,
            "RESUMES": null,
            "TKIID": "_TKI:a01b014a.9c4cee19.f14991f6.70af34ee",
            "TAT_TKTID": "_TKT:a01a014a.71f808de.f14991f6.70af06ae",
            "SUPPORT_CLAIM_SUSP": false,
            "systemID": "_PK:9023014a.34687eb0.f14991f6.e4560002",
            "ACTIVATED": "2014-12-30T17:44:55Z",
            "WORK_BASKET_ID": null
        },
        {
            "STATE": "STATE_READY",
            "INVOKED_INSTANCE_ID": null,
            "SNAPSHOT_NAME": null,
            "APPLIC_NAME": "TestBpelTaskModuleApp",
            "IS_TRANSFERRED_TO_WORK_BASK": false,
            "BC_BCID": null,
            "SNAPSHOT_ID": null,
            "DUE": null,
            "PI_DISPLAY_NAME": null,
            "OWNER": null,
            "IS_READ": false,
            "IS_WAIT_FOR_SUB_TK": false,
            "PI_PIID": "_PI:9003014a.9c8136a4.c9078ff6.e8b134bb",
            "TAD_DESCRIPTION": null,
            "PI_NAME": "_PI:9003014a.9c8136a4.c9078ff6.e8b134bb",
            "SUSPENDED": false,
            "ORIGINATOR": "DeAdmin",
            "PROCESS_APP_ACRONYM": null,
            "TASK.TKIID": "_TKI:a01b014a.9c8136ed.c9078ff6.e8b13588",
            "KIND": "KIND_PARTICIPATING",
            "PT_PTID": "_PT:9001014a.7c4157dc.c9078ff6.ba89005d",
            "TYPE": null,
            "WORK_BASKET": null,
            "TAD_DISPLAY_NAME": "Everybody",
            "EXPIRED": null,
            "NAME": "LoopProcess$Everybody",
            "PRIORITY": 5,
            "STARTER": null,
            "CONTAINMENT_CTX_ID": "_PI:9003014a.9c8136a4.c9078ff6.e8b134bb",
            "IS_ESCALATED": false,
            "RESUMES": null,
            "TKIID": "_TKI:a01b014a.9c8136ed.c9078ff6.e8b13588",
            "TAT_TKTID": "_TKT:a01a014a.7c4157fe.c9078ff6.ba890081",
            "SUPPORT_CLAIM_SUSP": false,
            "systemID": "_PK:9023014a.7bc3bec0.94078ff6.2ad30002",
            "ACTIVATED": "2014-12-30T18:42:01Z",
            "WORK_BASKET_ID": null
        },
        {
            "STATE": "STATE_CLAIMED",
            "SNAPSHOT_NAME": "Standard Hiring Sample v8560",
            "SNAPSHOT_ID": "2064.5327bc35-5faa-4052-9317-d2a4b6e96a28",
            "DUE": "2015-01-13T21:09:05Z",
            "PI_DISPLAY_NAME": "Standard Employee Requisition for  (Standard HR Open New Position)",
            "STATUS": "Received",
            "OWNER": 1,
            "PI_PIID": 3,
            "TAD_DESCRIPTION": "Task: Submit requisition",
            "PI_NAME": "Standard Employee Requisition for  (Standard HR Open New Position)",
            "ORIGINATOR": "celladmin",
            "PROCESS_APP_ACRONYM": "HSS",
            "IS_AT_RISK": true,
            "TASK.TKIID": "3",
            "KIND": "KIND_PARTICIPATING",
            "COMPLETED": null,
            "PT_PTID": "25.c904b3b1-afc1-4698-bf5a-a20892c20275",
            "TAD_DISPLAY_NAME": "Task: Submit requisition",
            "AT_RISK_TIME": "2015-01-13T21:03:05Z",
            "GROUP_ID": null,
            "NAME": "Submit job requisition",
            "USER_ID": 1,
            "PRIORITY": 30,
            "CONTAINMENT_CTX_ID": 3,
            "PROCESS_INSTANCE.PIID": 3,
            "TKIID": "3",
            "systemID": "ca920a9e-f809-4076-9485-a05b6877f5cb",
            "ACTIVATED": "2015-01-13T20:09:05Z",
            "ASSIGNED_TO_ROLE_DISPLAY_NAME": null
        },
        {
            "STATE": "STATE_CLAIMED",
            "SNAPSHOT_NAME": "Standard Hiring Sample v8560",
            "SNAPSHOT_ID": "2064.5327bc35-5faa-4052-9317-d2a4b6e96a28",
            "DUE": "2015-01-13T21:09:08Z",
            "PI_DISPLAY_NAME": "Standard Employee Requisition for  (Standard HR Open New Position)",
            "STATUS": "Received",
            "OWNER": 1,
            "PI_PIID": 4,
            "TAD_DESCRIPTION": "Task: Submit requisition",
            "PI_NAME": "Standard Employee Requisition for  (Standard HR Open New Position)",
            "ORIGINATOR": "celladmin",
            "PROCESS_APP_ACRONYM": "HSS",
            "IS_AT_RISK": true,
            "TASK.TKIID": "4",
            "KIND": "KIND_PARTICIPATING",
            "COMPLETED": null,
            "PT_PTID": "25.c904b3b1-afc1-4698-bf5a-a20892c20275",
            "TAD_DISPLAY_NAME": "Task: Submit requisition",
            "AT_RISK_TIME": "2015-01-13T21:03:08Z",
            "GROUP_ID": null,
            "NAME": "Submit job requisition",
            "USER_ID": 1,
            "PRIORITY": 30,
            "CONTAINMENT_CTX_ID": 4,
            "PROCESS_INSTANCE.PIID": 4,
            "TKIID": "4",
            "systemID": "ca920a9e-f809-4076-9485-a05b6877f5cb",
            "ACTIVATED": "2015-01-13T20:09:08Z",
            "ASSIGNED_TO_ROLE_DISPLAY_NAME": null
        },		
        {
            "STATE": "STATE_READY",
            "INVOKED_INSTANCE_ID": null,
            "SNAPSHOT_NAME": null,
            "APPLIC_NAME": "TestBpelTaskModuleApp",
            "IS_TRANSFERRED_TO_WORK_BASK": false,
            "BC_BCID": null,
            "SNAPSHOT_ID": null,
            "DUE": null,
            "PI_DISPLAY_NAME": null,
            "OWNER": null,
            "IS_READ": false,
            "IS_WAIT_FOR_SUB_TK": false,
            "PI_PIID": "_PI:9003014a.9c81367f.c9078ff6.e8b13494",
            "TAD_DESCRIPTION": null,
            "PI_NAME": "_PI:9003014a.9c81367f.c9078ff6.e8b13494",
            "SUSPENDED": false,
            "ORIGINATOR": "DeAdmin",
            "PROCESS_APP_ACRONYM": null,
            "TASK.TKIID": "_TKI:a01b014a.9c8136bd.c9078ff6.e8b134fb",
            "KIND": "KIND_PARTICIPATING",
            "PT_PTID": "_PT:9001014a.7c4157dc.c9078ff6.ba89005d",
            "TYPE": null,
            "WORK_BASKET": null,
            "TAD_DISPLAY_NAME": "Everybody",
            "EXPIRED": null,
            "NAME": "LoopProcess$Everybody",
            "PRIORITY": 5,
            "STARTER": null,
            "CONTAINMENT_CTX_ID": "_PI:9003014a.9c81367f.c9078ff6.e8b13494",
            "IS_ESCALATED": false,
            "RESUMES": null,
            "TKIID": "_TKI:a01b014a.9c8136bd.c9078ff6.e8b134fb",
            "TAT_TKTID": "_TKT:a01a014a.7c4157fe.c9078ff6.ba890081",
            "SUPPORT_CLAIM_SUSP": false,
            "systemID": "_PK:9023014a.7bc3bec0.94078ff6.2ad30002",
            "ACTIVATED": "2014-12-30T18:42:01Z",
            "WORK_BASKET_ID": null
        },
        {
            "STATE": "STATE_READY",
            "INVOKED_INSTANCE_ID": null,
            "SNAPSHOT_NAME": null,
            "APPLIC_NAME": "TestBpelTaskModuleApp",
            "IS_TRANSFERRED_TO_WORK_BASK": false,
            "BC_BCID": null,
            "SNAPSHOT_ID": null,
            "DUE": null,
            "PI_DISPLAY_NAME": null,
            "OWNER": null,
            "IS_READ": false,
            "IS_WAIT_FOR_SUB_TK": false,
            "PI_PIID": "_PI:9003014a.9c4cdf28.f14991f6.70af2ca5",
            "TAD_DESCRIPTION": null,
            "PI_NAME": "_PI:9003014a.9c4cdf28.f14991f6.70af2ca5",
            "SUSPENDED": false,
            "ORIGINATOR": "admin",
            "PROCESS_APP_ACRONYM": null,
            "TASK.TKIID": "_TKI:a01b014a.9c4ce111.f14991f6.70af2d75",
            "KIND": "KIND_PARTICIPATING",
            "PT_PTID": "_PT:9001014a.71f80085.f14991f6.70af064d",
            "TYPE": null,
            "WORK_BASKET": null,
            "TAD_DISPLAY_NAME": "Group4AllRoles",
            "EXPIRED": null,
            "NAME": "LoopProcess$GroupforAllRoles",
            "PRIORITY": 5,
            "STARTER": null,
            "CONTAINMENT_CTX_ID": "_PI:9003014a.9c4cdf28.f14991f6.70af2ca5",
            "IS_ESCALATED": false,
            "RESUMES": null,
            "TKIID": "_TKI:a01b014a.9c4ce111.f14991f6.70af2d75",
            "TAT_TKTID": "_TKT:a01a014a.71f80684.f14991f6.70af0682",
            "SUPPORT_CLAIM_SUSP": false,
            "systemID": "_PK:9023014a.34687eb0.f14991f6.e4560002",
            "ACTIVATED": "2014-12-30T17:44:51Z",
            "WORK_BASKET_ID": null
        }
    ],
    "query": "IBM.DEFAULTALLTASKSLIST_75",
    "attributeInfo": [
        {
            "content": "task.state.key",
            "sourceAttribute": "task.state.key",
            "name": "STATE",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.invokedinstanceid.key",
            "sourceAttribute": "task.invokedinstanceid.key",
            "name": "INVOKED_INSTANCE_ID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "instance.snapshotname.string",
            "sourceAttribute": "instance.snapshotname.string",
            "name": "SNAPSHOT_NAME",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.applicationname.string",
            "sourceAttribute": "task.applicationname.string",
            "name": "APPLIC_NAME",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.istransferredtoworkbasket.boolean",
            "sourceAttribute": "task.istransferredtoworkbasket.boolean",
            "name": "IS_TRANSFERRED_TO_WORK_BASK",
            "sourceQueryTableIdentifier": "n/a",
            "type": "boolean",
            "isArray": false
        },
        {
            "content": "task.bcid.key",
            "sourceAttribute": "task.bcid.key",
            "name": "BC_BCID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "instance.snapshotid.key",
            "sourceAttribute": "instance.snapshotid.key",
            "name": "SNAPSHOT_ID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.duetime.date",
            "sourceAttribute": "task.duetime.date",
            "name": "DUE",
            "sourceQueryTableIdentifier": "n/a",
            "type": "date",
            "isArray": false
        },
        {
            "content": "instance.processinstancedisplayname.string",
            "sourceAttribute": "instance.processinstancedisplayname.string",
            "name": "PI_DISPLAY_NAME",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.status.key",
            "sourceAttribute": "task.status.key",
            "name": "STATUS",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.userid.key",
            "sourceAttribute": "task.userid.key",
            "name": "OWNER",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.isread.boolean",
            "sourceAttribute": "task.isread.boolean",
            "name": "IS_READ",
            "sourceQueryTableIdentifier": "n/a",
            "type": "boolean",
            "isArray": false
        },
        {
            "content": "task.iswaitforsubtask.boolean",
            "sourceAttribute": "task.iswaitforsubtask.boolean",
            "name": "IS_WAIT_FOR_SUB_TK",
            "sourceQueryTableIdentifier": "n/a",
            "type": "boolean",
            "isArray": false
        },
        {
            "content": "instance.piid.key",
            "sourceAttribute": "instance.piid.key",
            "name": "PI_PIID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.description.string",
            "sourceAttribute": "task.description.string",
            "name": "TAD_DESCRIPTION",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "instance.processinstancename.string",
            "sourceAttribute": "instance.processinstancename.string",
            "name": "PI_NAME",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.suspended.boolean",
            "sourceAttribute": "task.suspended.boolean",
            "name": "SUSPENDED",
            "sourceQueryTableIdentifier": "n/a",
            "type": "boolean",
            "isArray": false
        },
        {
            "content": "task.originator.key",
            "sourceAttribute": "task.originator.key",
            "name": "ORIGINATOR",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.isatrisk.boolean",
            "sourceAttribute": "task.isatrisk.boolean",
            "name": "IS_AT_RISK",
            "sourceQueryTableIdentifier": "n/a",
            "type": "boolean",
            "isArray": false
        },
        {
            "content": "process.processappacronym.string",
            "sourceAttribute": "process.processappacronym.string",
            "name": "PROCESS_APP_ACRONYM",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": null,
            "sourceAttribute": null,
            "name": "TASK.TKIID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.completiontime.date",
            "sourceAttribute": "task.completiontime.date",
            "name": "COMPLETED",
            "sourceQueryTableIdentifier": "n/a",
            "type": "date",
            "isArray": false
        },
        {
            "content": "task.kind.key",
            "sourceAttribute": "task.kind.key",
            "name": "KIND",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "process.processtemplateid.key",
            "sourceAttribute": "process.processtemplateid.key",
            "name": "PT_PTID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.type.string",
            "sourceAttribute": "task.type.string",
            "name": "TYPE",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.displayname.string",
            "sourceAttribute": "task.displayname.string",
            "name": "TAD_DISPLAY_NAME",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.workbasket.string",
            "sourceAttribute": "task.workbasket.string",
            "name": "WORK_BASKET",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.expired.date",
            "sourceAttribute": "task.expired.date",
            "name": "EXPIRED",
            "sourceQueryTableIdentifier": "n/a",
            "type": "date",
            "isArray": false
        },
        {
            "content": "task.atrisktime.date",
            "sourceAttribute": "task.atrisktime.date",
            "name": "AT_RISK_TIME",
            "sourceQueryTableIdentifier": "n/a",
            "type": "date",
            "isArray": false
        },
        {
            "content": "task.groupid.key",
            "sourceAttribute": "task.groupid.key",
            "name": "GROUP_ID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "number",
            "isArray": false
        },
        {
            "content": "task.name.string",
            "sourceAttribute": "task.name.string",
            "name": "NAME",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.userid.key",
            "sourceAttribute": "task.userid.key",
            "name": "USER_ID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "number",
            "isArray": false
        },
        {
            "content": "task.priority.key",
            "sourceAttribute": "task.priority.key",
            "name": "PRIORITY",
            "sourceQueryTableIdentifier": "n/a",
            "type": "number",
            "isArray": false
        },
        {
            "content": "task.starter.key",
            "sourceAttribute": "task.starter.key",
            "name": "STARTER",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.containmentcontextid.key",
            "sourceAttribute": "task.containmentcontextid.key",
            "name": "CONTAINMENT_CTX_ID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": null,
            "sourceAttribute": null,
            "name": "PROCESS_INSTANCE.PIID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.isescalated.boolean",
            "sourceAttribute": "task.isescalated.boolean",
            "name": "IS_ESCALATED",
            "sourceQueryTableIdentifier": "n/a",
            "type": "boolean",
            "isArray": false
        },
        {
            "content": "task.tkiid.key",
            "sourceAttribute": "task.tkiid.key",
            "name": "TKIID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.resumedtime.date",
            "sourceAttribute": "task.resumedtime.date",
            "name": "RESUMES",
            "sourceQueryTableIdentifier": "n/a",
            "type": "date",
            "isArray": false
        },
        {
            "content": "task.tktid.key",
            "sourceAttribute": "task.tktid.key",
            "name": "TAT_TKTID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.supportclaimsusp.boolean",
            "sourceAttribute": "task.supportclaimsusp.boolean",
            "name": "SUPPORT_CLAIM_SUSP",
            "sourceQueryTableIdentifier": "n/a",
            "type": "boolean",
            "isArray": false
        },
        {
            "content": "task.activationtime.date ",
            "sourceAttribute": "task.activationtime.date ",
            "name": "ACTIVATED",
            "sourceQueryTableIdentifier": "n/a",
            "type": "date",
            "isArray": false
        },
        {
            "content": "task.workbasketid.key",
            "sourceAttribute": "task.workbasketid.key",
            "name": "WORK_BASKET_ID",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        },
        {
            "content": "task.assignedtoroledisplayname.string",
            "sourceAttribute": "task.assignedtoroledisplayname.string",
            "name": "ASSIGNED_TO_ROLE_DISPLAY_NAME",
            "sourceQueryTableIdentifier": "n/a",
            "type": "string",
            "isArray": false
        }
    ],
    "requestedSize": 20,
    "offset": 0,
    "identifier": "TASK.TKIID",
    "size": 6
}

Status codes

The method returns one of the following status codes:
CodeDescription
200 OKThe request completed successfully.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
404 Not Found
The service model does not exist.
406 Not AcceptableThe requested content type or content encoding is not supported.
500 Internal Server ErrorA severe problem occurred.
503 Service UnavailableThe federated request could not be delivered to individual federation targets.
504 Gateway TimeoutThe federated response has partial content because of missing individual responses.

Available since

8.5.6

Parent Topic: Task List Resource