Bookmark - Create a new bookmark of an existing report with the provided details

Creates a new bookmark of an existing report with the provided details

post
Authorizations
Path parameters
reportIdstring · uuidRequired

Expects Id of an existing report

Query parameters
versionstringOptional

The requested API version

Default: 1.0
Header parameters
embedfast-user-idstringOptional

Optional User Id

Body

Class for representing the view of a bookmark.

bookmarkStatestring | nullableOptional

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.

displayNamestring | nullableOptional

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.

typestring · enumOptional

Enum for bookmark type.

Possible values:
Responses
201
Successful creation of bookmark related details with newly created bookmark
post
POST /reports/{reportId}/bookmarks HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 63

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

Last updated