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	`GET`: Read a Specific ActivityItem.

ActivityItem attributes

Represents a change in an issue or in its related entities. In the YouTrack UI, you see these changes in the activity stream. It shows a list of all changes related to this issue: the issue history, comments, attachments, VCS changes, work items, and so on.

Related Resources

Below you can find the list of resources that let you work with this entity.

Attributes

This table describes attributes of the ActivityItem entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
id	String	The ID of the activity item. `Read-only`.
added		Single value or the list of values which were added to a property of the target entity. `Read-only`.
author	User	The user who performed the action. `Read-only`.
category	ActivityCategory	The category of the activity. `Read-only`.
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`.
removed		Single value or the list of values which were removed from 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`.
timestamp	Long	The timestamp of the activity event. Stored as a unix timestamp at UTC. `Read-only`.

Read a Specific ActivityItem

Get information about the specific 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

                https://example.youtrack.cloud/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: 7 November 2024