Issue Work Items
Resource that provides access to work items.
Resource | /api/workItems |
Returned entity | IssueWorkItem. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
IssueWorkItem attributes
Represents a work item in an issue.
This table describes attributes of the IssueWorkItem
entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields
.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
---|---|---|
author | User | The user to whom the work is attributed in the work item. |
creator | User | The user who added the work item to the issue. |
text | String | The work item description. |
textPreview | String | Parsed preview of the description. |
type | WorkItemType | The work item type. |
created | Long | The date when the work item was created. |
updated | Long | The date when the work item was last updated. |
duration | DurationValue | The duration of the work item. |
date | Long | The date and time that is assigned to the work item. Stored as a Unix timestamp in UTC. The time part is set to midnight for the current date. |
issue | Issue | Stores attributes of the issue to which the work item is attached. |
usesMarkdown | Boolean | Stores the format of the comment text. When |
Read a List of IssueWorkItems
Get all work items that belong to issues that match a search query. If the query is not provided, all work items from all issues are returned.
Request syntax
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of IssueWorkItem attributes that should be returned in the response. If no field is specified,only the |
$skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
$top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. |
query | String | Issues search query. Read more about search syntax here: Search-and-Command-Attributes |
startDate | Date | The start date of the interval for work items date. |
endDate | Date | The end date of the interval for work items date. |
start | String | The start timestamp of the interval for work items date. |
end | String | The end timestamp of the interval for work items date. |
author | String | Parameter to filter work items by there author. Could specify few values of database id or login or Hub id or 'me' for current logged in user |
creator | String | Parameter to filter work items by there creator. Could specify few values of database id or login or Hub id or 'me' for current logged in user |