Bookmark - Creates a bookmark for a report
Authorizations
Path parameters
reportIdstring · uuidRequired
Enter ID of an existing report.
Query parameters
versionstringOptionalDefault:
The requested API version
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 · enumOptionalPossible values:
Enum for bookmark type.
Responses
201
Created: Bookmark has been successfully created with the relevant details.
401
Unauthorized: Invalid credentials or missing/invalid authentication token.
403
Forbidden: Access denied to view the report due to insufficient permissions or account restrictions.
404
Not Found: The specified report does not exist, the URL is invalid, or the resource has been deleted.
409
Conflict: A bookmark for this report already exists or there is a duplicate entry issue.
500
Internal Server Error: An unexpected error occurred or a server timeout.
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"
}
PreviousBookmark - Retrieves bookmarks for a specific reportNextBookmark - Retrieves details of a specific bookmark
Last updated