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 comparision 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.
Represents a page object that wraps a list of issue activities. The main advantage of the page in comparision 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."
This table describes attributes of the
To receive an attribute in the response from server, specify it explicitly in the request parameter
To update an attribute, provide it in the body of a POST request.
Indicates whether the order of returning activities on the page is from newest to oldest or the opposite. If "false", then the oldest activity item that matches a selected filter is returned first.If "true", then the newest activity is returned first. By default, "false".
A string value that is required to retrieve the previous page of activities.
A string value that is required to retrieve the next page of activities.
Indicates if the previous page exists.
Indicates if the next page exists.
Array of TODO provide documentation for type
The list of activities in the page.
Read a Specific ActivityCursorPage
A list of ActivityCursorPage attributes that should be returned in the response. If no field is specified, only the
Mandatory. Parameter filters returned activities by categories.You must specify at least one category per request.
You can specify the
This table describes available categories and matching returned types of activity items.
Indicates whether the order of returning activities is from newest to oldest or the opposite.If "false", then the oldest activity item that matches a selected filter is returned first.If "true", then the newest activity is returned first. By default, "false".
Start timestamp of the time interval the activity timestamp belongs to. If the parameter is not set, it is considered to be 0.
End timestamp of the time interval the activity timestamp belongs to.If the parameter is not set, it is considered as Long.MAX_VALUE. }
Parameter to filter activities by the author. The database id or login, or Hub id, or 'me' for the current logged in user could be specified.
The main application for the cursor is the pagination of activities. The Activities is a frequently changing collection, and new activities might be created between two requests. In this case, the general approach to pagination using "top" and "skip" parameters does not work. Instead, use the following pagination approach:
If the "cursor" is not specified in the request, then the response page starts either from the oldest activity or from the newest one depending on the requested order (direct or reverse).
Let's consider the following statements as initial conditions for the example:
and such page could be received by a request to the following endpoint:
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.
In order to request nearby pages of activities we can use the cursors of received page and request the page starting from the cursor to different directions. The following combinations a possible:
ID of the activity that should be included in the page. The activity is allocated to the middle of the page.