Bookmark - Retrieves bookmarks for a specific report

Retrieves bookmarks associated with a specific report, identified by the provided report ID.

GET/reports/{reportId}/bookmarks

Authorization

Bearer

Path parameters

reportId*string (uuid)

Enter unique ID of the report for which bookmarks are requested.

Query parameters

Header parameters

Response

200400401403404500

Success: Successfully retrieved the list of all available bookmarks.

Body

text/plainapplication/jsontext/json

reportIdstring (uuid)

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the ReportId property.

modifiedByUserIdnullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the ModifiedByUserId property.

bookmarkStatenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the BookmarkState property.

displayNamenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the DisplayName property.

reportBookmarkIdstring (uuid)

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the ReportBookmarkId property.

typeenum

Enum for bookmark type.

personalshared

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/reports/{reportId}/bookmarks', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403404500

[
  {
    "reportId": "123e4567-e89b-12d3-a456-426614174000",
    "modifiedByUserId": "text",
    "bookmarkState": "text",
    "displayName": "text",
    "reportBookmarkId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "personal"
  }
]