The ‘Qx Network & Automation’ window contains all the information on the Qx that is needed in order to
send it a REST request. ‘IP Address’ (or ‘mDNS Hostname’ if your client’s host supports it) should be used as
the recipient of the request, and ‘REST API Port’ is the port that requests will need to be directed towards.
Note: The mDNS Hostname is composed of qx-<serial number>.local e.g. qx-123456.local and is case
insensitive.
The REST API supports four HTTP methods: GET, PUT, DELETE, and POST.
GET requests can be used to retrieve Qx information and navigate the submenus. PUT requests can be
used to modify and control Qx behavior and actions.
A web browser can be used to retrieve Information from the Qx with GET requests.
Any HTTP/1.1 compliant application can be used to control the Qx with both GET and PUT requests.
PUT, GET, DELETE, and POST requests can be scripted for automated testing.
REST API Requests
For the following REST API request examples, an example IP address (192.168.0.142) and default REST API
Port (8080) are used. The base resource to aim requests at is "/api". The base URL for requests (GET) will be
in the format: http://192.168.0.142:8080/api or http://qx-020094.local:8080/api
REST API requests can be used to:
l Report the current analyzed standard (GET): http://192.168.0.142:8080/api/v1/analyser/status
l Report the currently generated standard (GET): http://192.168.0.142:8080/api/v1/generator/status
l Navigate through list of available generator standards (GET): http://192.168.0.142:8080/api/v1/
generator/standards. Select required URL from tree and GET again to drill down to appropriate
color format, bit depth, level, SDR or HDR format, and test pattern.
l Generate a standard (PUT): http://192.168.0.142:8080/api/v1/generator/ standards/
1920x1080p60/YCbCr%3A422%3A10/3G_A_Rec.709/100%25%20Bars
A pathological overlay, its type and number of pairs can be added by including a raw payload of, for
example, {"action":"start","pathological":{"type":"CheckField","pairs":100}}
l Report the currently generated audio standard (GET): http://192.168.0.142:8080/api/v1/generator/
audio
l Audio generation (PUT): http://192.168.0.39:8080/api/v1/generator/audio. Including a raw payload for
Quick config, of the structure, for example, {"mode":"Fixed Tone","quickConfig":{"gainType":"Fixed Levels",
"gain":-10,"pitch":"E 3"}}. For Custom config raw payload structure, refer to the GET request output structure.
l View instantaneous Eye readings (GET): http://192.168.0.142:8080/api/v1/eye/status
l View instantaneous Jitter readings (GET): http://192.168.0.142:8080/api/v1/jitter/status
l Retrieve the event logs (GET): http://192.168.0.142:8080/api/v1/eventlog/logs
l Report current CRC analysis status (GET): http://192.168.0.142:8080/api/v1/analyser/crcSummary
l Manage the event logs (PUT): http://192.168.0.142:8080/api/v1/eventlog/config/restApi with a raw pay-
load of {"action":"enable"} in this example, to enable REST API event logging.
Specifically in IP Mode, REST API requests can be used to:
l Report the currently active multicast request (GET): http://192.168.0.142:8080/api/v1/ipReceive/
multicastRequests
l Request a new multicast (PUT): http://192.168.0.142:8080/api/v1/ipReceive/multicastRequests with a
raw payload of the form {"action":"request","destinationIpAddress":"230.0.0.15"} in this example, to
join a multicast group of destination IP address 230.0.0.15
PHABRIX Qx User Manual Page 57
To Next Page
Loading...