YouTrack Standalone 2019.2 Help

Operations with Specific ActivityItem

This resource provides access to the activities with the possibility to filter them by various parameters.

Resource

/api/activities/{itemID}

Returned entity

ActivityItem. For the description of the entity attributes, see Supported Fields section.

Supported methods

ActivityItem attributes

Represents a change in an issue or in its related entities. In the UI, you see these changes as the Activity stream. It shows a feed of all updates of the issue: issue history, comments, attachments, VCS changes, work items, and so on.

This table describes attributes of the ActivityItem 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 who performed the action. Read-only.

timestamp

Long

The timestamp of the activity. Read-only.

removed

Type is specified in the descendent Entities

Single value or the list of values which were removed from a property of the target entity. Read-only.

added

Type is specified in the descendent Entities

Single value or the list of values which were added to a property of the target entity. Read-only.

target

Type is specified in the descendent Entities

The entity that is the target of the performed action. Read-only.

targetMember

String

The name of the property of the target entity, which was modified. Read-only. Can be null.

field

FilterField

The filter field. It contains the additional information about the modified property in the target entity. For example, the information about a link type, or the type of the modified custom field or bundle, and so on. Read-only. Can be null.

category

ActivityCategory

The category of the activity. Read-only.

Read a Specific ActivityItem

Get information about the specific operation (activity item).

Request syntax

GET /api/activities/{itemID}?{fields}

{itemID}

Activity ID.

Request parameters

Parameter

Type

Description

fields

String

A list of ActivityItem attributes that should be returned in the response. If no field is specified,only the entityID is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/activities/4-3.0-0?fields=id,author(id,login,name),timestamp,added(id,idreadable),target(id,idReadable)

Sample response body

{ "added": [ { "id": "4-3", "$type": "IssueComment" } ], "id": "4-3.0-0", "author": { "login": "john.doe", "name": "John Doe", "id": "1-2", "$type": "User" }, "timestamp": 1535547095738, "target": { "id": "4-3", "$type": "IssueComment" }, "$type": "CommentActivityItem" }
Last modified: 22 October 2019