Bookmark - Creates a shared bookmark for a report

Creates a new shared bookmark with a specific user, associated with a specific report.

post
Authorizations
Path parameters
reportIdstringRequired
Query parameters
versionstringOptional

The requested API version

Default: 1.0
Header parameters
embedfast-user-idstringOptional

Optional User Id

Body

Class for representing the view of a SharedBookmark.

reportBookmarkIdstring | 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.

reportIdstring | 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.

shareWithUsersstring[] | 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 Type property.

Responses
201
Created: Bookmark has been successfully created with the relevant details.
post
POST /reports/{reportId}/bookmarks/shareWithSpecificUsers HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "reportBookmarkId": "text",
  "reportId": "text",
  "shareWithUsers": [
    "text"
  ]
}
{
  "reportBookmarkId": "123e4567-e89b-12d3-a456-426614174000",
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "shareWithUser": "text",
  "modifiedByUserId": "text",
  "successStatus": "text"
}

Last updated