Bookmark - Update existing bookmark-related details

Update existing bookmark related details

put

Authorizations

Path parameters

bookmarkIdstring · uuidRequired

Expects Id of an existing bookmark

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

application/jsontext/jsonapplication/*+json

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 · enumOptional

Enum for bookmark type.

Possible values:

Responses

200

Acknowledgment for successful bookmark update

text/plainapplication/jsontext/json

401

Un-authorized request

text/plainapplication/jsontext/json

403

Indicates user do not have access to update this bookmark

text/plainapplication/jsontext/json

404

Indicates bookmark does not exist

text/plainapplication/jsontext/json

500

Server related error

text/plainapplication/jsontext/json

put

HTTPcURLJavaScriptPython

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"
}

application/jsontext/jsonapplication/*+json

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