Bookmark - Creates a shared bookmark for a report

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

post

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

reportIdstringRequired

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

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

403

Forbidden: Access denied to view the report due to insufficient permissions or account restrictions.

text/plainapplication/jsontext/json

404

Not Found: The specified report does not exist, the URL is invalid, or the resource has been deleted.

text/plainapplication/jsontext/json

409

Conflict: A bookmark for this report already exists or there is a duplicate entry issue.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

post

/reports/{reportId}/bookmarks/shareWithSpecificUsers

HTTPcURLJavaScriptPython

POST /reports/{reportId}/bookmarks/shareWithSpecificUsers HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "reportBookmarkId": "text",
  "reportId": "text",
  "shareWithUsers": [
    "text"
  ]
}

application/jsontext/jsonapplication/*+json

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