lockEnvironment

This app command allows users to control the state of the environment.

GET

Description:
Get the current state of the environment

Request Body:

{
    command: 'lockEnvironment',
    method: 'get',
    version: '1.0'
}

Response Body:

{
    command: 'lockEnvironment',
    method: 'get',
    version: '1.0',
    status_code: 200,
    error: null,
    state: 'lock'
}

Parameters:

Attribute Name	Attribute Type	Description	Enum	Required (Binary)
command	string	High level command name to interact with Oliver	null	1
method	string	These correspond to create, read, update, and delete (or CRUD) operations	null	1
version	string	The version of the command used	null	1

Description:
Lock/unlock the environment.

Request Body:

{
    command: 'lockEnvironment',
    method: 'post',
    version: '1.0',
    state: 'lock' 
}

Response Body:

{
    command: 'lockEnvironment',
    method: 'post',
    version: '1.0',
    status_code: 200,
    error: null
}

Parameters:

Attribute Name	Attribute Type	Description	Enum	Required (Binary)
command	string	High level command name to interact with Oliver	null	1
method	string	These correspond to create, read, update, and delete (or CRUD) operations	null	1
version	string	The version of the command used	null	1
state	string	State of the environment	'lock', 'unlock'	1