Welcome to docs.opsview.com

REST API: Notes

URL: /rest/notes/OBJECTTYPE/ID

Requires authentication.

The object types are:

  • Host
  • Business service
  • Component

Access control

Access control is based on the object types:

  • host - Requires VIEWALL or VIEWSOME with this object to view. Requires ACTIONSOME to edit. ID is based on the opsview host ID.
  • bsmservice - Requires view access based on BSM permissions to view. Requires edit access to edit.
  • bsmcomponent - Requires view access based on BSM permissions to view. Requires edit access to edit.
Example GET
Request URL /rest/notes/bsmservice/1
Response
{
    "id": 1,
    "note": "<p>This is the text for the note</p>",
    "writeable": true
}

For business service and components, the note can contain HTML. For host, it will be in wiki format.

Example PUT
Request URL /rest/notes/bsmservice/1
Request data
{
    "note": "<p>This is updated text for the note</p>"
}

You can pass the note information either as input data, as in the example above, or as a GET/POST parameter with the name “note”.

To clear a note, set “note” to an empty string.

There will be an error if no note parameter is set.

Navigation
Print/export
Toolbox