SYSTEM API

• GET detectsystems
• GET gpuoutputs
• GET networkadapters
• GET projects
• GET vfcs

GET detectsystems

Summary

List all remote machines and local machine system info

URL

GET    /api/service/system/detectsystems

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "hostname": "",
      "type": "",
      "version": {
        "major": 0,
        "minor": 0,
        "hotfix": 0,
        "revision": 0
      },
      "runningProject": "",
      "ipAddress": "",
      "isDesignerRunning": false,
      "isServiceRunning": false,
      "isManagerRunning": false,
      "isNotchHostRunning": false
    }
  ]
}

GET gpuoutputs

Summary

List all GPU Output (only works on d3 machine)

URL

GET    /api/service/system/gpuoutputs

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "hostname": "",
      "genlock": {
        "frequency": 0
      },
      "gpuOutputs": [
        {
          "gpuPort": 0,
          "genlockState": "",
          "emulated": false,
          "resolution": {
            "width": 0,
            "height": 0
          },
          "refreshRate": 0,
          "bitDepth": 0,
          "colourFormat": ""
        }
      ]
    }
  ]
}

GET networkadapters

Summary

List all Network Adapters

URL

GET    /api/service/system/networkadapters

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "hostname": "",
      "netAdapters": [
        {
          "name": "",
          "mac": "",
          "enabled": false,
          "dhcp": false,
          "status": "",
          "addresses": [
            {
              "address": "",
              "subnet": "",
              "family": "",
              "gateway": ""
            }
          ]
        }
      ]
    }
  ]
}

GET projects

Summary

List all projects

URL

GET    /api/service/system/projects

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "hostname": "",
      "lastProject": "",
      "projects": [
        {
          "path": "",
          "lastModified": "",
          "version": {
            "major": 0,
            "minor": 0,
            "hotfix": 0,
            "revision": 0
          }
        }
      ]
    }
  ]
}

GET vfcs

Summary

List all VFC Cards

URL

GET    /api/service/system/vfcs

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "hostname": "",
      "backplaneVersion": "",
      "cards": [
        {
          "slot": 0,
          "type": "",
          "firmwareVersion": "",
          "fpgaVersion": "",
          "splitMode": "",
          "generation": "",
          "ports": {
            "a": {
              "resolution": {
                "width": 0,
                "height": 0
              },
              "RefreshRate": 0,
              "name": ""
            },
            "b": {
              "resolution": {
                "width": 0,
                "height": 0
              },
              "RefreshRate": 0,
              "name": ""
            },
            "c": {
              "resolution": {
                "width": 0,
                "height": 0
              },
              "RefreshRate": 0,
              "name": ""
            },
            "d": {
              "resolution": {
                "width": 0,
                "height": 0
              },
              "RefreshRate": 0,
              "name": ""
            }
          }
        }
      ]
    }
  ]
}