Milestone Systems logo
API docs by Redocly

MIP VMS RESTful Bookmarks API (1.0.0)

URL: https://developer.milestonesys.com License: MIT License

Introduction

Video sequences can be tagged with bookmarks. Bookmarks improve the sharing of video sequences because additional information can be added to a tagged sequence. The information in bookmarks can be used when searching for relevant video sequences, helping handle incidents and investigations.

Download OpenAPI specification

Download the OpenAPI specification for the Bookmarks API from https://doc.developer.milestonesys.com/mipvmsapi/api/bookmarks-rest/v1/openapi.yaml.

Bookmarks

A bookmark is a tag on a video sequence. Each bookmark has a number of fields that can be searched for.

  • Note: Bookmarks cannot be retrieved by use a GET .../bookmarks request. Please use one of the search tasks under the POST requests.

Get a bookmark

Get the bookmark identified by {id}.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a bookmark

Update specific fields in the bookmark identified by {id}.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
Request Body schema: application/json
header
string

The header text for the bookmark

description
string

The description text for the bookmark

timeBegin
string <date-time>

Begin time for the bookmark interval

timeEnd
string <date-time>

End time for the bookmark interval

timeTriggered
string <date-time>

Trigger time for the bookmark interval

reference
string

Bookmark ID

required
object (devicePath)

Object containing the type and ID of the device referenced by this bookmark

Responses

Request samples

Content type
application/json
{
  • "header": "string",
  • "description": "string",
  • "timeBegin": "2019-08-24T14:15:22Z",
  • "timeEnd": "2019-08-24T14:15:22Z",
  • "timeTriggered": "2019-08-24T14:15:22Z",
  • "reference": "string",
  • "devicePath": {
    }
}

Response samples

Content type
application/json
{
  • "httpCode": "400",
  • "details": [
    ]
}

Delete a bookmark

Delete the bookmark identified by {id}.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Responses

Bookmark-related tasks

Perform one of 4 tasks:

  • no task parameter: a new bookmark is created from the body
  • newReference: create a new reference and trigger rules
  • searchTime: search based on time and text parameters
  • searchFromBookmark: get bookmarks after the specific one

Notes

  • The newReference task will be used to execute configured rules, to ensure actions like Start-Recording is performed in real time. The newRefernce task does not create the bookmark in the database.
  • When no task is POSTed, the bookmark is created, but the rule system is not triggered.
Authorizations:
bearerAuth
query Parameters
task
string

Name of the task to perform: newReference, searchTime, searchFromBookmark or no task defined

Request Body schema: application/json
One of
header
required
string

The header text for the bookmark

description
string

The description text for the bookmark

timeBegin
string <date-time>

Begin time for the bookmark interval

timeEnd
string <date-time>

End time for the bookmark interval

timeTriggered
string <date-time>

Trigger time for the bookmark interval

reference
string

Bookmark ID

required
object (devicePath)

Object containing the type and ID of the device referenced by this bookmark

Responses

Request samples

Content type
application/json
Example
{
  • "header": "string",
  • "description": "string",
  • "timeBegin": "2019-08-24T14:15:22Z",
  • "timeEnd": "2019-08-24T14:15:22Z",
  • "timeTriggered": "2019-08-24T14:15:22Z",
  • "reference": "string",
  • "devicePath": {
    }
}

Response samples

Content type
application/json
Example
{
  • "array": [
    ]
}