YouTrack Standalone 2020.3 Help

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. Can be null.

creator

User

The user who added the work item to the issue. Read-only. Can be null.

text

String

The work item description. Can be null.

textPreview

String

Parsed preview of the description. Read-only.

type

WorkItemType

The work item type. Can be null.

created

Long

The date when the work item was created. Can be null.

updated

Long

The date when the work item was last updated. Can be null.

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. Read-only.

usesMarkdown

Boolean

Stores the format of the comment text. When true, the comment is processed as Markdown formatted text. Otherwise, the comment is processed as YouTrack Wiki formatted.

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

GET /api/workItems?{fields}&{$top}&{$skip}&{query}&{startDate}&{endDate}&{start}&{end}&{createdStart}&{createdEnd}&{updatedStart}&{updatedEnd}&{author}&{creator}

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 entityID is returned

$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

Integer

The start timestamp of the interval for work items date.

end

Integer

The end timestamp of the interval for work items date.

createdStart

Integer

The start timestamp of the interval for work items created date.

createdEnd

Integer

The end timestamp of the interval for work items created date.

updatedStart

Integer

The start timestamp of the interval for work items updated date.

updatedEnd

Integer

The end timestamp of the interval for work items updated 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

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/workItems?$top=3&fields=created,duration(presentation,minutes),author(name),creator(name),date,id

Sample response body

[ { "duration": { "minutes": 300, "presentation": "5h", "$type": "DurationValue" }, "date": 1536278400000, "created": 1536278263415, "creator": { "name": "John Smith", "$type": "User" }, "author": { "name": "John Smith", "$type": "User" }, "id": "115-0", "$type": "IssueWorkItem" }, { "duration": { "minutes": 60, "presentation": "1h", "$type": "DurationValue" }, "date": 1538956800000, "created": 1539088817836, "creator": { "name": "John Doe", "$type": "User" }, "author": { "name": "Jane Doe", "$type": "User" }, "id": "115-2", "$type": "IssueWorkItem" }, { "duration": { "minutes": 120, "presentation": "2h", "$type": "DurationValue" }, "date": 1538956800000, "created": 1539089914788, "creator": { "name": "John Doe", "$type": "User" }, "author": { "name": "John Doe", "$type": "User" }, "id": "115-5", "$type": "IssueWorkItem" } ]
Last modified: 28 October 2020