REST interface for BPD-related resources - Team Tasks Resource - PUT Method

Use this method to run a query on the tasks of a team managed by the calling user.

Sample method invocation

PUT /rest/bpm/wle/v2/dashboards/teamtasks/{teamId}[?offset={integer}][&size={integer}][&alphabeticalSort={boolean}]

Parameters

Optional parameters

Name	Value Type	Description
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, 0 is used as the default value. 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, 100 is used as the default value. Use this parameter with the offset parameter to provide paging in the task list.
alphabeticalSort	boolean	By default, this parameter is set to false: the values that result from a sorted query on string business data fields are case-sensitive (lexicographical sorting order). For example, in ascending order: "Alan", "Zoe", "bernard". Set this parameter to true if you want the query result values to be case-insensitive (alphabetical sorting order). For example, in ascending order: "Alan", "bernard", "Zoe".

Request content

A search query.

The default content type is application/json.

MIME type: application/json

Example content

{
    "datasource": {
      "datatype": "TASKS",
      "systemTypes": [
        "Process",
        "BPEL"
      ]
    },
    "population": {
      "target": "SELF"
    },
    "filters": {
      "interaction": "all",
      "v1_conditions": []
    },
    "output": {
      "includeAllBusinessData": false,
      "usersFullName": true,
      "sort": [
        {
          "field": "taskDueDate",
          "order": "ASC"
        },
        {
          "field": "taskPriority",
          "order": "DESC"
        }
      ],
      "alphabeticalSort": false,
      "size": 25,
      "stats": {
        "type": "Basic"
      }
    }
  }

Response content

Task list (Task complexType).

The default content type is application/json.

MIME type: application/json

Schema

{
	"attributeInfo": [
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "SNAPSHOT_NAME",
			"isArray": false,
			"type": "STRING",
			"sourceAttribute": "instanceSnapshot",
			"content": "instance.snapshotname.string"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "gmApproval",
			"isArray": false,
			"type": "UNKNOWN",
			"sourceAttribute": "gmApproval",
			"content": "gmApproval"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "PRIORITY",
			"isArray": false,
			"type": "NUMBER",
			"sourceAttribute": "taskPriority",
			"content": "task.priority.long"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "hiringManager",
			"isArray": false,
			"type": "UNKNOWN",
			"sourceAttribute": "hiringManager",
			"content": "hiringManager"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "PROCESS_INSTANCE.PIID",
			"isArray": false,
			"type": "ID",
			"sourceAttribute": null,
			"content": "instance.piid.key"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "PT_NAME",
			"isArray": false,
			"type": "STRING",
			"sourceAttribute": "bpdName",
			"content": "process.processtemplatename.string"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "TKIID",
			"isArray": false,
			"type": "ID",
			"sourceAttribute": "taskId",
			"content": "task.tkiid.key"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "NAME",
			"isArray": false,
			"type": "STRING",
			"sourceAttribute": "taskActivityName",
			"content": "task.name.string"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "TAD_DISPLAY_NAME",
			"isArray": false,
			"type": "STRING",
			"sourceAttribute": "taskSubject",
			"content": "task.displayname.string"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "PI_STATUS",
			"isArray": false,
			"type": "STRING",
			"sourceAttribute": "instanceStatus",
			"content": "instance.status.key"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "STATUS",
			"isArray": false,
			"type": "STRING",
			"sourceAttribute": "taskStatus",
			"content": "task.status.key"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "COMPLETED",
			"isArray": false,
			"type": "TIMESTAMP",
			"sourceAttribute": "taskClosedDate",
			"content": "task.completiontime.date"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "OWNER",
			"isArray": false,
			"type": "ID",
			"sourceAttribute": "assignedToUser",
			"content": "task.owner.key"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "PI_NAME",
			"isArray": false,
			"type": "STRING",
			"sourceAttribute": "instanceName",
			"content": "instance.processinstancename.string"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "TASK.TKIID",
			"isArray": false,
			"type": "ID",
			"sourceAttribute": null,
			"content": "task.tkiid.key"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "DUE",
			"isArray": false,
			"type": "TIMESTAMP",
			"sourceAttribute": "taskDueDate",
			"content": "task.duetime.date"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "IS_AT_RISK",
			"isArray": false,
			"type": "BOOLEAN",
			"sourceAttribute": "taskIsAtRisk",
			"content": "task.isatrisk.boolean"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "location",
			"isArray": false,
			"type": "UNKNOWN",
			"sourceAttribute": "location",
			"content": "location"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "AT_RISK_TIME",
			"isArray": false,
			"type": "TIMESTAMP",
			"sourceAttribute": "taskAtRiskTime",
			"content": "task.atrisktime.date"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "PROCESS_APP_ACRONYM",
			"isArray": false,
			"type": "STRING",
			"sourceAttribute": "instanceProcessApp",
			"content": "process.processappacronym.string"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "department",
			"isArray": false,
			"type": "UNKNOWN",
			"sourceAttribute": "department",
			"content": "department"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "ASSIGNED_TO_ROLE_DISPLAY_NAME",
			"isArray": false,
			"type": "STRING",
			"sourceAttribute": "assignedToRoleDisplayName",
			"content": "task.assignedtoroledisplayname.string"
		},
		{
			"sourceQueryTableIdentifier": "n/a",
			"name": "PI_PIID",
			"isArray": false,
			"type": "ID",
			"sourceAttribute": "instanceId",
			"content": "instance.piid.key"
		}
	],
	"requestedSize": 2,
	"identifier": "TASK.TKIID",
	"federationResult": [
		{
			"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
			"systemID": "_PK:9023014f.49a7767.66f3d6f6.f4850002",
			"displayName": "bpel7",
			"systemType": "SYSTEM_TYPE_WPS",
			"id": "bpel7",
			"taskCompletionUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
			"version": "8.5.7.0",
			"indexRefreshInterval": 2000,
			"statusCode": "200"
		},
		{
			"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
			"systemID": "aec95102-c84f-49d1-85e5-d8793a127a3f",
			"displayName": "Display name for system 5",
			"systemType": "SYSTEM_TYPE_WLE",
			"id": "System_5",
			"taskCompletionUrlPrefix": "https://9.41.12.67:9443/rest/bpm",
			"version": "8.5.7.0",
			"indexRefreshInterval": 1000,
			"statusCode": "200"
		}
	],
	"offset": 0,
	"size": 2,
	"riskStateSummary": {
		"DueTomorrow": 0,
		"DueThisWeek": 0,
		"AtRisk": 2,
		"DueLater": 0,
		"OnTrack": 0,
		"DueToday": 0,
		"Overdue": 10
	},
	"query": "MySavedSearch",
	"queryExecuteTime": "2016-02-25T18:52:02Z",
	"entityTypeName": "TASK",
	"totalCount": 12,
	"items": [
		{
			"SNAPSHOT_NAME": "07/20/15 Advanced Hiring Sample 8570",
			"systemID": "aec95102-c84f-49d1-85e5-d8793a127a3f",
			"gmApproval": null,
			"PRIORITY": 30,
			"hiringManager": null,
			"PROCESS_INSTANCE.PIID": "3",
			"PT_NAME": "Advanced HR Open New Position",
			"TKIID": "4",
			"NAME": "Review new position request",
			"TAD_DISPLAY_NAME": "Step: Review new position request",
			"PI_STATUS": "Active",
			"STATUS": "Received",
			"COMPLETED": null,
			"OWNER": null,
			"PI_NAME": "Advanced Employee Requisition NG (List) for Tom Miller (3)",
			"TASK.TKIID": "4",
			"DUE": "2015-10-02T14:52:36.994Z",
			"IS_AT_RISK": true,
			"location": null,
			"AT_RISK_TIME": "2015-10-02T14:46:36.994Z",
			"PROCESS_APP_ACRONYM": "HSAV1",
			"department": null,
			"ASSIGNED_TO_ROLE_DISPLAY_NAME": "General Managers",
			"PI_PIID": "3"
		},
		{
			"SNAPSHOT_NAME": "BPM Task Search V8.5.5.0 v1",
			"systemID": "aec95102-c84f-49d1-85e5-d8793a127a3f",
			"gmApproval": null,
			"PRIORITY": 30,
			"hiringManager": null,
			"PROCESS_INSTANCE.PIID": "869",
			"PT_NAME": "Task Search Test",
			"TKIID": "870",
			"NAME": "Test",
			"TAD_DISPLAY_NAME": "Step: Test",
			"PI_STATUS": "Active",
			"STATUS": "Received",
			"COMPLETED": null,
			"OWNER": null,
			"PI_NAME": "Task Search Test:869",
			"TASK.TKIID": "870",
			"DUE": "2015-10-07T17:41:17.210Z",
			"IS_AT_RISK": true,
			"location": null,
			"AT_RISK_TIME": "2015-10-07T17:35:17.210Z",
			"PROCESS_APP_ACRONYM": "TSKSCRH",
			"department": null,
			"ASSIGNED_TO_ROLE_DISPLAY_NAME": "All Users",
			"PI_PIID": "869"
		}
	]
}

Error Response content

None

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Successful operation.
401 Unauthorized	Unauthorized. The caller is not authorized for this request.
403 Forbidden	Forbidden. The caller is not allowed to complete this request.
406 Not Acceptable	The requested content type or content encoding is not supported.
415 Unsupported Media Type	The content type or content encoding of the request is not supported.
500 Internal Server Error	Internal Server Error. See the details provided.

Available since

24.0.0.1

Parent Topic: Team Tasks Resource