Milestone Systems logo
API docs by Redocly

MIP VMS RESTful Evidence Locks API (1.0.0)

Introduction

Video sequences can be tagged with evidence locks. Evidence locks protect the tagged video sequence from being deleted for a defined duration.

Download OpenAPI specification

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

Evidence locks

Video sequences can be tagged with evidence locks

Get an evidenceLock

Get the evidenceLock identified by {id}.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Update an evidenceLock

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

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
Request Body schema: application/json
description
string
startTime
string <date-time>
tagTime
string <date-time>
endTime
string <date-time>
header
string
reference
string
retentionExpire
string <date-time>
object
Array of objects (devicePath)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "tagTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "header": "string",
  • "reference": "string",
  • "retentionExpire": "2019-08-24T14:15:22Z",
  • "retentionOption": {
    },
  • "devicePaths": [
    ]
}

Response samples

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

Delete an evidenceLock

Delete the evidenceLock identified by {id}.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

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

Create an evidenceLock-related task

Perform one of 3 tasks:

  • no task parameter: a new evidenceLock entry is created from the body
  • newReference: create a new reference and trigger rules
  • searchTime: search based on time and text parameters
Authorizations:
bearerAuth
query Parameters
task
string

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

Request Body schema: application/json
One of
Array of objects (devicePath)
searchText
string
searchUser
boolean

Defines if search should match on user names

searchHeader
boolean

Defines if search should match on header text

searchDescription
boolean

Defines if search should match on description text

searchReference
boolean

Defines if search should match on the reference id

users
Array of strings
headerContains
string

Text to search for in headers

descriptionContains
string

Text to search for in descriptions

createdFromTime
string <date-time>
createdToTime
string <date-time>
fromTime
string <date-time>
toTime
string <date-time>
tagFromTime
string <date-time>
tagToTime
string <date-time>
expireFromTime
string <date-time>
expireToTime
string <date-time>
sortOrder
string

The order to retrieve the evidence locks. The content should be a field name in camel-case, one of: Header, Description, StartTime, TagTime, EndTime, CreateTime, UserName, Size, RetentionExpireTime

sortAscending
boolean
page
integer

The page of evidence locks to retrieve, the page-size is defined in size

size
integer

The number of evidence locks to retrieve in each search request, e.g. the page size

time
string <UTC time>
resourceTypes
Array of strings

Can be one or all of cameras, microphones, speakers

timeLimit
string

Defines a timespan to search within, compared to the time. Like 00:30:00 for half an hour. Default is 60 minutes.

countLimit
integer

The max evidenceLocks to return

Responses

Request samples

Content type
application/json
Example
{
  • "devicePaths": [
    ],
  • "searchText": "string",
  • "searchUser": true,
  • "searchHeader": true,
  • "searchDescription": true,
  • "searchReference": true,
  • "users": [
    ],
  • "headerContains": "string",
  • "descriptionContains": "string",
  • "createdFromTime": "2019-08-24T14:15:22Z",
  • "createdToTime": "2019-08-24T14:15:22Z",
  • "fromTime": "2019-08-24T14:15:22Z",
  • "toTime": "2019-08-24T14:15:22Z",
  • "tagFromTime": "2019-08-24T14:15:22Z",
  • "tagToTime": "2019-08-24T14:15:22Z",
  • "expireFromTime": "2019-08-24T14:15:22Z",
  • "expireToTime": "2019-08-24T14:15:22Z",
  • "sortOrder": "string",
  • "sortAscending": true,
  • "page": 0,
  • "size": 0,
  • "time": "string",
  • "resourceTypes": [
    ],
  • "timeLimit": "string",
  • "countLimit": 0
}

Response samples

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