Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Get if the given business report is bookmarked. A user bookmarks a report to move it pinned to the top of the list.

Note that pinning is remembered individually per user. 

URL

(GET) /api/businessreports/reports/{id}/bookmarkpin

PARAMETERS

URL parameters are:

id

The unique ID of the report.

A default report is prefixed "S" such as in "S500".

A custom report is prefixed with "C" such as in "C1002"

string, Mandatory

RESULTS

The API method returns a boolean:

  • true: Report is bookmarkedpinned
  • false: Report is not bookmarkedpinned