Page
139
APPENDIX E: API Documentation
Introduction
This appendix discusses ways to use the Application Program Interface (API) to
allow third party equipment to remotely access options and settings of the iAM-
12G-SDI. It includes specific code examples for commonly used requests. The API
uses JavaScript Object Notation (JSON) as its communication language.
Follow the instructions in the
First Time IP Assignments
section of Chapter 4 to
achieve the required network connection.
API: Presets
1. GET Active Preset
Method: GET
/api/cf/presets/current
Example Response:
{
"serial_number"
:
""
,
"model"
:
"iAM-12G-SDI"
,
"version"
:
1.3
,
"name"
:
"iAM-12G-SDI"
,
"result"
: {
"group"
: {
"Id"
:
1
,
"Name"
:
""
},
"preset"
: {
"Data"
:
null
,
"Favorite"
:
0
,
"Id"
:
1
,
"Name"
:
""
}
}
}
2. GET Preset Configuration
Method: GET
/api/cf/presets/<int:preset ID>
Example Response:
{
Summary of Contents for iAM-12G-SDI
Page 6: ...Page 6 APPENDIX E API Documentation 139 Introduction 139 API Presets 139...
Page 92: ...Page 92 Figure 4 21 Remote Monitor ED2 Single Presentation...
Page 94: ...Page 94 Figure 4 23 Remote Monitor Dolby E DE...
Page 95: ...Page 95 Figure 4 24 Remote Monitor DD with ATMOS...
Page 98: ...Page 98 Figure 4 27 System Setup SFP Information...
Page 151: ...Page 151 channel_number 1...
