Bookmark - Update existing bookmark-related details

Update existing bookmark related details

PUT/reports/{reportId}/bookmarks/{bookmarkId}

Authorization

Bearer

Path parameters

bookmarkId*string (uuid)

Expects Id of an existing bookmark

reportId*string (uuid)

Expects Id of an existing report

Query parameters

Header parameters

Body

application/jsontext/jsonapplication/*+json

Expected bookmark related details

bookmarkStatenullable string

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.

displayNamenullable string

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.

typeenum

Enum for bookmark type.

personalshared

Response

200401403404500

Acknowledgment for successful bookmark update

Body

text/plainapplication/jsontext/json

reportIdstring (uuid)

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the ReportId property.

modifiedByUserIdnullable string

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 ModifiedByUserId property.

bookmarkStatenullable string

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.

displayNamenullable string

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.

reportBookmarkIdstring (uuid)

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the ReportBookmarkId property.

typeenum

Enum for bookmark type.

personalshared

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/reports/{reportId}/bookmarks/{bookmarkId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401403404500

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