STATUS API

• GET health
• GET notifications
• GET project
• GET session
• POST setguimode

GET health

Summary

List all health status for the machines in the network

URL

GET    /api/session/status/health

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "machine": {
        "uid": "",
        "name": "",
        "hostname": ""
      },
      "runningAsMachine": {
        "uid": "",
        "name": "",
        "hostname": ""
      },
      "status": {
        "averageFPS": 0,
        "videoDroppedFrames": 0,
        "videoMissedFrames": 0,
        "states": [
          {
            "name": "",
            "detail": "",
            "category": "",
            "severity": ""
          }
        ]
      }
    }
  ]
}

GET notifications

Summary

List all notifications for the machines in the network

URL

GET    /api/session/status/notifications

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "machine": {
        "uid": "",
        "name": "",
        "hostname": ""
      },
      "notifications": [
        {
          "summary": "",
          "detail": ""
        }
      ]
    }
  ]
}

GET project

Summary

Return the project information

URL

GET    /api/session/status/project

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": {
    "projectPath": "",
    "version": {
      "major": 0,
      "minor": 0,
      "hotfix": 0,
      "revision": 0
    }
  }
}

GET session

Summary

Return the session config

URL

GET    /api/session/status/session

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": {
    "isRunningSolo": false,
    "isDirectorDedicated": false,
    "director": {
      "uid": "",
      "name": "",
      "hostname": "",
      "type": "",
      "guiMode": "",
      "guiVisible": false
    },
    "actors": [
      {
        "uid": "",
        "name": "",
        "hostname": "",
        "type": "",
        "guiMode": "",
        "guiVisible": false
      }
    ],
    "understudies": [
      {
        "uid": "",
        "name": "",
        "hostname": "",
        "type": "",
        "guiMode": "",
        "guiVisible": false
      }
    ]
  }
}

POST setguimode

Summary

undefined

URL

POST    /api/session/status/setguimode

Request

{
  "machine": {
    "uid": "",
    "name": ""
  },
  "mode": ""
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}