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.

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
description
string
timeBegin
string <date-time>
timeEnd
string <date-time>
timeTriggered
string <date-time>
reference
string

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"
}

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
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
string
description
string
timeBegin
string <date-time>
timeEnd
string <date-time>
timeTriggered
string <date-time>
reference
string
user
string
object (devicePath)
object

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",
  • "user": "string",
  • "devicePath": {
    },
  • "relations": {
    }
}

Response samples

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