Operations with Specific ActivityCursorPage
This resource provides access to the issue activities wrapping it to the page object. The main advantage of the page in comparison to a list of activities is cursors. The page provides boundary marks that allows continuing iteration over the activities from the place the page is finished.
Resource | |
Returned entity | ActivityCursorPage. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
ActivityCursorPage attributes
Represents a page object that wraps a list of issue activities. The main advantage of the page in comparison to a list of activities is cursors. The page provides boundary marks that allow continuous iteration over the activities from the place the page is finished.
Related Resources
Below you can find the list of resources that let you work with this entity.
Attributes
This table describes attributes of the ActivityCursorPage entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The ID of the activity cursor page. |
activities | Array of ActivityItems | The list of activities in the page. |
afterCursor | String | A string value that is required to retrieve the next page of activities. |
beforeCursor | String | A string value that is required to retrieve the previous page of activities. |
hasAfter | Boolean | Indicates if the next page exists. |
hasBefore | Boolean | Indicates if the previous page exists. |
reverse | Boolean | Indicates whether the order of returning activities on the page is from newest to oldest or the opposite. If |
Read a Specific ActivityCursorPage
Read a page of activities in the specific issue.
Request syntax
GET /api/issues/{issueID}/activitiesPage?{fields}&{categories}&{reverse}&{start}&{end}&{author}&{cursor}&{activityId}Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of ActivityCursorPage attributes that should be returned in the response. If no field is specified, only the |
categories | String | Mandatory. Parameter filters returned activities by categories. You must specify at least one category per request. You can specify the
See this table for mapping between available categories and returned types of activity items. |
reverse | Boolean | Indicates whether the order of returning activities is from newest to oldest or the opposite. If |
start | String | The timestamp in milliseconds indicating the start of the time interval the activity timestamp belongs to. Stored as a unix timestamp at UTC. If the parameter is not set, it is considered to be 0. |
end | String | The timestamp in milliseconds indicating the end of the time interval the activity timestamp belongs to. Stored as a unix timestamp at UTC. If the parameter is not set, it is considered as |
author | String | Parameter to filter activities by the author. You can specify one of the following parameters: the database ID, login, Hub ID, or |
cursor | String | The main application for cursors is the pagination of activities. The
If the Use case: Let's consider the following statements as initial conditions for the example:
The following JSON presents the mentioned page (see: ActivityCursorPage): A request to the following endpoint could receive such a page: The real value of the cursor is a complication string. Used notation "A^B" shows that the cursor points to the gap between items A and B. To request nearby pages of activities, we can use the cursors of the received page and request the page starting from the cursor to different directions. The following combinations are possible:
|
activityId | String | ID of the activity that should be included in the page. The activity is allocated to the middle of the page. |
Sample
Sample request
https://example.youtrack.cloud/api/issues/2-31/activitiesPage?fields=id,beforeCursor,afterCursor,activities(id,author(name,login),timestamp)&categories=CommentsCategory,IssueCreatedCategory,SummaryCategory,WorkItemCategory,ProjectCategory,IssueVisibilityCategory,AttachmentsCategorySample response body
{
"afterCursor": "AI.2-31+:CM.4-2+:TT.^+:RH.9-61+:1535649875680",
"beforeCursor": "AI.^+:CM.^+:TT.^+:RH.^+:1533139032010",
"activities": [
{
"id": "2-31.0-0",
"author": {
"login": "john.doe",
"name": "John Doe",
"$type": "User"
},
"timestamp": 1533139032010,
"$type": "IssueCreatedActivityItem"
},
{
"id": "4-0.0-0",
"author": {
"login": "jane.doe",
"name": "Jane Doe",
"$type": "User"
},
"timestamp": 1533214812208,
"$type": "CommentActivityItem"
},
{
"id": "4-2.0-0",
"author": {
"login": "john.doe",
"name": "John Doe",
"$type": "User"
},
"timestamp": 1533221614364,
"$type": "CommentActivityItem"
},
{
"author": {
"login": "john.doe",
"name": "John Doe",
"$type": "User"
},
"timestamp": 1535649875680,
"id": "0-0.9-60",
"$type": "SimpleValueActivityItem"
},
{
"author": {
"login": "john.doe",
"name": "John Doe",
"$type": "User"
},
"timestamp": 1535649875680,
"id": "0-0.9-61",
"$type": "VisibilityGroupActivityItem"
}
],
"id": "AI.^+:CM.^+:TT.^+:RH.^+:1533139032010#AI.2-31+:CM.4-2+:TT.^+:RH.9-61+:1535649875680.d",
"$type": "ActivityCursorPage"
}