Operations with Specific ActivityCursorPage

fields

String

A list of ActivityCursorPage attributes that should be returned in the response. If no field is specified,only the entityID is returned

reverse

Boolean

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

end

String

End timestamp of the time interval the activity timestamp belongs to. If the parameter is not set, it is considered as Long.MAX_VALUE.

cursor

String

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:

1. Request a page using one of the "activitiesPage" resources.

2. Take one of cursors from the returned activity page.

3. Put this value as the "cursor" parameter for the request of the next page.

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).

Use case:

Let's consider the following statements as initial conditions for the example:

• a collection of 4 activity items: A, B, C, D

• a request that returned the page containing only 1 item: [B]

Mentioned page can be presented by the following JSON (see: ActivityCursorPage):

{
    "activities": [B]
    "cursorBefore": "A^B" // the value differs from the real one and only used for the demonstration
    "cursorAfter": "B^C" // the value differs from the real one and only used for the demonstration
    "hasBefore": true
    "hasAfter": true
    "reverse": false
}

Such page could be received by a request to the following endpoint:

/api/activitiesPage?activityId=B&$top=1

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:

• Request /api/activitiesPage?$top=100&cursor=A^B&reverse=false returns page with [B, C, D] items.

• Request /api/activitiesPage?$top=100&cursor=A^B&reverse=true returns page with [A] item.

• Request /api/activitiesPage?$top=100&cursor=B^C&reverse=false returns page with [C, D] items.

• Request /api/activitiesPage?$top=100&cursor=B^C&reverse=true returns page with [B, A] items.