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

Creates a new bookmark associated with a specific report.

post

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

reportIdstring · uuidRequired

Enter ID of an existing report.

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Body

application/jsontext/jsonapplication/*+json

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

Created: Bookmark has been successfully created with the relevant details.

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

403

Forbidden: Access denied to view the report due to insufficient permissions or account restrictions.

text/plainapplication/jsontext/json

404

Not Found: The specified report does not exist, the URL is invalid, or the resource has been deleted.

text/plainapplication/jsontext/json

409

Conflict: A bookmark for this report already exists or there is a duplicate entry issue.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

post

/reports/{reportId}/bookmarks

HTTPcURLJavaScriptPython

POST /reports/{reportId}/bookmarks HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "bookmarkState": "text",
  "displayName": "text",
  "type": "personal"
}

application/jsontext/jsonapplication/*+json

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