Operations with Specific ActivityItem

This resource provides access to the issue activities with the possibility to filter them by various parameters. Basically, this resource lets you get history of operations for specific issue.

Resource	/api/issues/{issueID}/activities/{itemID}
Returned entity	ActivityItem. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a Specific ActivityItem.

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		Single value or the list of values which were removed from a property of the target entity. `Read-only`.
added		Single value or the list of values which were added to a property of the target entity. `Read-only`.
target		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 activity in the specific issue.

Request syntax

GET /api/issues/{issueID}/activities?{fields}

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/issues/2-31/activities/0-0.9-61?fields=id,author(name,login),timestamp,target(id,$type),targetMember,targetSubMember,removed(id,name),added(id,name)
            

Sample response body

{
  "targetMember": "visibility",
  "targetSubMember": "permittedGroups",
  "removed": [],
  "added": [
    {
      "name": "Sample Project Team",
      "id": "3-2",
      "$type": "UserGroup"
    }
  ],
  "author": {
    "login": "john.doe",
    "name": "John Doe",
    "$type": "User"
  },
  "timestamp": 1535649875680,
  "id": "0-0.9-61",
  "target": {
    "id": "2-31",
    "$type": "Issue"
  },
  "$type": "VisibilityGroupActivityItem"
}
            

Last modified: 28 October 2020