API Behavior Control

You can query and control Command 360 Behaviors from an external system via an API call.

Note

Before continuing, please note:

• To invoke Behaviors via API call, you must first create an API integration. See Integrations for more information.
• For Behaviors to be invoked, they must first be created and have assigned Xref values. For help creating behaviors, see Adding Behaviors.

Query All Behaviors

Command Structure

The API command structure is as follows:

Invoke-WebRequest -Method GET -Headers @{ "x-haivision-api-token" = "<TOKEN>" } https://<DOMAIN>/Haivision/NetworkManager/Manager/Behaviors/ -SkipCertificateCheck | Select-Object -ExpandProperty Content | ConvertFrom-Json

Where:

• <TOKEN> is the token generated when completing the task outlined in Adding Integration Accounts.
• <DOMAIN> is the domain of your Command 360 system.

Start/Stop Behaviors

Command Structure

The API command structure is as follows:

Invoke-WebRequest -Method POST -Headers @{ "x-haivision-api-token"="<TOKEN>" } https://<DOMAIN>/Haivision/NetworkManager/RoomService/Public/BehaviorByXref/<XREF>/<COMMAND>

Where:

• <TOKEN> is the token generated when completing the task outlined in Adding Integration Accounts.
• <DOMAIN> is the domain of your Command 360 system.
• <XREF> is the Xref value assigned when creating the behavior during the task outlined in Adding Behaviors.
• <COMMAND> is one of four behavior control commands:
  • Start
  • Stop
  • Pause
  • Resume