Bookmark - Updates a bookmark's details
Authorizations
Path parameters
bookmarkIdstring · uuidRequired
Enter ID of an existing bookmark.
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 updating the properties of bookmark.
bookmarkStatestring | nullableOptional
A public property of type nullable 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 nullable 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
200
Success: Bookmark details successfully updated.
401
Unauthorized: Invalid credentials or missing/invalid authentication token.
403
Forbidden: Access denied for updating this bookmark due to insufficient permissions or account restrictions.
404
Not Found: The specified bookmark or report does not exist, the URL is invalid, or the resource has been deleted.
409
Conflict: The update request could not be completed due to a conflict with the current state of the bookmark, such as attempting to modify a bookmark that has been changed or deleted by another process.
500
Internal Server Error: An unexpected error occurred or a server timeout.
put
PUT /reports/{reportId}/bookmarks/{bookmarkId} 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 details of a specific bookmarkNextBookmark - Deletes a bookmark for a report
Last updated