YouTrack Standalone 2020.6 Help

Activity Cursor Page

This resource provides access to the any 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.

Resource

/api/activitiesPage

Returned entity

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

ActivityCursorPage attributes

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 ActivityCursorPage 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

reverse

Boolean

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". Read-only.

beforeCursor

String

A string value that is required to retrieve the previous page of activities. Read-only.

afterCursor

String

A string value that is required to retrieve the next page of activities. Read-only.

hasBefore

Boolean

Indicates if the previous page exists. Read-only.

hasAfter

Boolean

Indicates if the next page exists. Read-only.

activities

Array of ActivityItems

The list of activities in the page. Read-only.

Last modified: 30 March 2021