WorkList
Use this resource to retrieve a list of open or closed work items that were started by the user.
Method summary
HTTP Method | Path | Description |
---|---|---|
GET | /scr/api/WorkList | Retrieves a list of open or closed work items that were started by the user. |
GET /scr/api/WorkList
- Description
- Use this method to retrieve a list of open or closed work items that were started by the user.
- Resource information
-
Requirements Description Response format JSON Requires authentication Yes Supports OAuth 2 client credentials Yes using a User Service ID containing Work Management Category Rate limited Not yet
- Parameters
-
Name Location Description Required Type X-On-Behalf-Of Header The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any. Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential. String type Query The type of list to return with the following possible values: open
closed
400
response code is returned.Yes String version Query The version of the requested API. The only allowed value is 20110917
.Yes String limit Query If this parameter is provided, then it sets the maximum number of tasks to return. Otherwise, the default value of 100
is used.No Integer startFrom Query If this parameter is provided, then the returned list starts with the task at this index in the list (zero based). Use this parameter if the number of available tasks is higher than the number of the returned tasks in an earlier call. No Integer
- Response
-
- Example input
-
- Using User Service ID OAuth 2 client credentials with user
context:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/scr/api/WorkList?type=closed&version=20110917"
- Using Service ID OAuth 2 client credentials with user
context:
curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" "https://your_server_url/scr/api/WorkList?type=closed&version=20110917"
- Using User Service ID OAuth 2 client credentials with user
context:
- Example output
-
{ "work": [], "more": false, "apps": [], "type": "closed", "version": "20110917" }
- Response properties
-
- more
- Contains one of the following possible values:
true
if there are more work instances on the server.false
if the work entry includes all of the instances available.
- type
- The type of work instances included in the list with the following possible values:
open
closed
- work
- The array of work instances listed by
dueDate
in reverse chronological order. Items with the samedueDate
are sorted by instance ID. - work.name
- The name given to the work instance when it was started.
- work.id
- The ID of the work instance that the task is a part of.
- work.status
- The status of the work instance contains one of the following possible values:
Active
Completed
Cancelled
Overdue
- work.remainingTasks
- The number of tasks to be completed for the specific work instance.
- work.dueDate
- Optional property. The due date for the task that has the smallest
dueDate
in the instance, that is the task that is due first. If the tasks in the instance don't have due dates, then this field is not present. The value is expressed in milliseconds since epoch, that is 1 January 1970 at midnight Coordinated Universal Time (UTC). - work.appId
- The ID of the related entry in applications array.
- apps
- The array of application instances that list one entry for each unique
appId
value in the work array. - app.id
- The ID of application that the work instance was started from.
- app.type
- The type of application contains one of the following possible values:
Workflow
Checklist
- Response messages
-
HTTP code Reason 200 The request was completed successfully.
400 The required type parameter specification must be provided. 401 The user isn't authorized to make the request.