REST API
A REST API is an architectural style for an application program interface (API) that uses HTTP requests to access and use data. That data can be used to GET, POST, PATCH, and DELETE data types, referring to the reading, updating, creating, changing, and deleting operations concerning resources.
Base URL: Your current RealityHub address and port (ex: http://localhost)
Endpoint: Communication channel that you want to do various processes (/api/rest/v1/engines/1/nodes)
Engine Control
GET /api/rest/v1/engines HTTP/1.1
Host: 127.0.0.1
Accept: */*
[
{
"id": 1,
"name": "ZDHQ-MBAK2",
"ip": "127.0.0.1",
"role": "Broadcast",
"status": "connected",
"cacheDir": "c:\\cache",
"minimumFreeSpace": 209715200,
"usedSpace": 221212139520,
"diskSpace": 255382777856,
"canCook": false,
"displayName": "Local Engine",
"re_enabled": true,
"port": 6666,
"rgraphId": null,
"ownerStudioId": null,
"ustateId": null,
"ue_enabled": true,
"instances": [
{
"id": 1,
"projectTag": null,
"streaming": null,
"status": "Idle",
"pid": null,
"engineHostId": 1,
"engineRoleId": null,
"projectId": null,
"projectMapId": null,
"editorPath": "C:\\Program Files\\Zero Density\\Reality\\4.27\\Engine\\Binaries\\Win64\\UE4Editor.exe",
"cookedProjectId": null,
"cookedMapId": null,
"cookedId": null,
"engineType": null,
"engineVersion": null,
"statusDescription": null
}
]
},
{
"id": 2,
"name": "ZDHQ-HUB",
"ip": "172.16.0.59",
"role": "Broadcast",
"status": "connected",
"cacheDir": "c:\\cache",
"minimumFreeSpace": 209715200,
"usedSpace": 228309753856,
"diskSpace": 239379410944,
"canCook": true,
"displayName": "ZDHQ-HUB",
"re_enabled": true,
"port": 30020,
"rgraphId": null,
"ownerStudioId": 1,
"ustateId": null,
"ue_enabled": true,
"instances": [
{
"id": 3,
"projectTag": null,
"streaming": null,
"status": "Idle",
"pid": null,
"engineHostId": 2,
"engineRoleId": 1,
"projectId": null,
"projectMapId": null,
"editorPath": "C:\\Program Files\\Zero Density\\Reality\\4.26\\Engine\\Binaries\\Win64\\UE4Editor.exe",
"cookedProjectId": null,
"cookedMapId": null,
"cookedId": null,
"engineType": "RE",
"engineVersion": "4.26",
"statusDescription": null
},
{
"id": 2,
"projectTag": null,
"streaming": null,
"status": "Loading",
"pid": "63940",
"engineHostId": 2,
"engineRoleId": 1,
"projectId": 56,
"projectMapId": 281,
"editorPath": "C:\\Program Files\\Zero Density\\Reality\\4.27\\Engine\\Binaries\\Win64\\UE4Editor.exe",
"cookedProjectId": null,
"cookedMapId": null,
"cookedId": null,
"engineType": "RE",
"engineVersion": "4.27",
"statusDescription": null
}
]
}
]
The ID of the engine.
2
GET /api/rest/v1/engines/{engineId} HTTP/1.1
Host: 127.0.0.1
Accept: */*
{
"id": 2,
"name": "ZDHQ-HUB",
"ip": "172.16.0.59",
"role": "Broadcast",
"status": "connected",
"cacheDir": "c:\\cache",
"minimumFreeSpace": 209715200,
"usedSpace": 229055864832,
"diskSpace": 239379410944,
"canCook": true,
"displayName": "ZDHQ-HUB",
"re_enabled": true,
"port": 6666,
"rgraphId": 13,
"ownerStudioId": 1,
"ustateId": null,
"ue_enabled": false,
"instances": [
{
"id": 3,
"projectTag": null,
"streaming": null,
"status": "Idle",
"pid": null,
"engineHostId": 2,
"engineRoleId": 1,
"projectId": null,
"projectMapId": null,
"editorPath": "C:\\Program Files\\Zero Density\\Reality\\4.26\\Engine\\Binaries\\Win64\\UE4Editor.exe",
"cookedProjectId": null,
"cookedMapId": null,
"cookedId": null,
"engineType": "RE",
"engineVersion": "4.26",
"statusDescription": null
},
{
"id": 2,
"projectTag": null,
"streaming": null,
"status": "Loaded",
"pid": "32244",
"engineHostId": 2,
"engineRoleId": 1,
"projectId": 8,
"projectMapId": 29,
"editorPath": "C:\\Program Files\\Zero Density\\Reality\\4.27\\Engine\\Binaries\\Win64\\UE4Editor.exe",
"cookedProjectId": null,
"cookedMapId": null,
"cookedId": null,
"engineType": "RE",
"engineVersion": "4.27",
"statusDescription": null
}
]
}
The ID of the engine.
2
The path of the node. (URL-encoded)
EngineControl
GET /api/rest/v1/engines/{engineId}/nodes/{nodePath} HTTP/1.1
Host: 127.0.0.1
Accept: */*
{
"NodePath": "EngineControl"
}
The ID of the engine.
2
The path of the node. (URL-encoded)
EngineControl
GET /api/rest/v1/engines/{engineId}/nodes/{nodePath}/properties HTTP/1.1
Host: 127.0.0.1
Accept: */*
[
{
"PropertyPath": "Node//NodeName/0",
"Value": "EngineControl"
},
{
"PropertyPath": "Node//Description/0",
"Value": ""
},
{
"PropertyPath": "Debug//EnableDebug/0",
"Value": false
},
{
"PropertyPath": "Debug//DebugInfo/0",
"Value": "TargetFPS: Genlock\nTimecode: No Timecode"
},
{
"PropertyPath": "Clock//TargetFPS/0",
"Value": "Genlock"
},
{
"PropertyPath": "Info//GameFPS/0",
"Value": 60
},
{
"PropertyPath": "Info//TimeCodeInfo/0",
"Value": "No Timecode"
},
{
"PropertyPath": "Info//HasSignal/0",
"Value": false
},
{
"PropertyPath": "Video I/O//UseGPUDirect/0",
"Value": false
},
{
"PropertyPath": "Video I/O//CacheAhead/0",
"Value": 2
},
{
"PropertyPath": "Clock/Sync/ControllerSyncTime/0",
"Value": "0"
},
{
"PropertyPath": "Info//RealityVersion/0",
"Value": "4.27"
},
{
"PropertyPath": "Display//UpdateEveryFrame/0",
"Value": true
},
{
"PropertyPath": "Lighting Pass//RenderLighting/0",
"Value": false
},
{
"PropertyPath": "Lighting Pass//LightingDOF/0",
"Value": false
},
{
"PropertyPath": "Lighting Pass//LightingMotionBlur/0",
"Value": false
},
{
"PropertyPath": "SSR Pass//SSRTemporal/0",
"Value": false
},
{
"PropertyPath": "Additional SSR Pass//RenderSSR/0",
"Value": false
},
{
"PropertyPath": "Additional SSR Pass//SSRDOF/0",
"Value": false
},
{
"PropertyPath": "Additional SSR Pass//SSRMotionBlur/0",
"Value": false
},
{
"PropertyPath": "Bloom Pass//Bloom/0",
"Value": false
},
{
"PropertyPath": "Shadow Pass//RenderShadow/0",
"Value": false
},
{
"PropertyPath": "Shadow Pass//ShadowDOF/0",
"Value": false
},
{
"PropertyPath": "Shadow Pass//ShadowMotionBlur/0",
"Value": false
},
{
"PropertyPath": "Garbage Collector//GCTimeOut/0",
"Value": 61.099998474121094
},
{
"PropertyPath": "Controller//ForwardAxis/0",
"Value": 0
},
{
"PropertyPath": "Controller//RightAxis/0",
"Value": 0
},
{
"PropertyPath": "Controller//UpAxis/0",
"Value": 0
},
{
"PropertyPath": "Controller//LookRightAxis/0",
"Value": 0
},
{
"PropertyPath": "Controller//LookUpAxis/0",
"Value": 0
},
{
"PropertyPath": "Controller//Button0/0",
"Value": false
},
{
"PropertyPath": "Controller//Button1/0",
"Value": false
},
{
"PropertyPath": "Controller//Button2/0",
"Value": false
},
{
"PropertyPath": "Controller//Button3/0",
"Value": false
},
{
"PropertyPath": "Controller//Button4/0",
"Value": false
},
{
"PropertyPath": "Controller//Button5/0",
"Value": false
},
{
"PropertyPath": "Debug//FlushRendering/0",
"Value": false
},
{
"PropertyPath": "Debug//OneFrameThreadLag/0",
"Value": true
},
{
"PropertyPath": "Debug//EnableTrace/0",
"Value": false
},
{
"PropertyPath": "Rendering Settings//GlobalClippingPlane/0",
"Value": false
},
{
"PropertyPath": "Rendering Settings//ForwardShading/0",
"Value": false
},
{
"PropertyPath": "Rendering Settings//StreamingPoolSize/0",
"Value": 0
},
{
"PropertyPath": "Rendering Settings//ReflectionsMaxRayDistance/0",
"Value": -1
},
{
"PropertyPath": "Rendering Settings//TonemapperGamma/0",
"Value": 1
},
{
"PropertyPath": "Rendering Settings//TonemapperSharpen/0",
"Value": 0
},
{
"PropertyPath": "Rendering Settings//ColorGamut/0",
"Value": "Rec709 / sRGB, D65 (default)"
},
{
"PropertyPath": "Rendering Settings//HDRDeviceFormat/0",
"Value": "sRGB (LDR)"
}
]
The ID of the engine.
2
The path of the node. (URL-encoded)
EngineControl
The path of the property. (URL-encoded)
Clock%2F%2FTargetFPS%2F0
GET /api/rest/v1/engines/{engineId}/nodes/{nodePath}/properties/{propertyPath} HTTP/1.1
Host: 127.0.0.1
Accept: */*
{
"PropertyPath": "Clock//TargetFPS/0",
"Value": "Genlock"
}
The ID of the engine.
2
The path of the node. (URL-encoded)
EngineControl
The path of the property. (URL-encoded)
Clock%2F%2FTargetFPS%2F0
PATCH /api/rest/v1/engines/{engineId}/nodes/{nodePath}/properties/{propertyPath} HTTP/1.1
Host: 127.0.0.1
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"Value": "30.00 fps"
}
{
"PropertyPath": "Clock//TargetFPS/0",
"Value": "30.00 fps"
}
The ID of the engine.
2
The path of the node. (URL-encoded)
Mixer_0
GET /api/rest/v1/engines/{engineId}/nodes/{nodePath}/functions HTTP/1.1
Host: 127.0.0.1
Accept: */*
[
{
"FunctionPath": "Default//UpdateCameras/0"
},
{
"FunctionPath": "Default//DoTransition/0"
}
]
The ID of the engine.
2
The path of the node. (URL-encoded)
Mixer_0
The path of the function. (URL-encoded)
Default%2F%2FDoTransition%2F0
GET /api/rest/v1/engines/{engineId}/nodes/{nodePath}/functions/{functionPath} HTTP/1.1
Host: 127.0.0.1
Accept: */*
{
"FunctionPath": "Default//DoTransition/0"
}
The ID of the engine.
2
The path of the node. (URL-encoded)
Mixer_0
The path of the function. (URL-encoded)
Default%2F%2FDoTransition%2F0
POST /api/rest/v1/engines/{engineId}/nodes/{nodePath}/functions/{functionPath} HTTP/1.1
Host: 127.0.0.1
Accept: */*
{
"success": true
}
Playout Control
POST /api/rest/v1/playout/rundowns HTTP/1.1
Host: 127.0.0.1
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"name": "My New Rundown"
}
{
"id": 3,
"name": "My New Rundown"
}
The ID of the rundown to delete.
3
DELETE /api/rest/v1/playout/rundowns/{rundownId} HTTP/1.1
Host: 127.0.0.1
Accept: */*
No content
The ID of the rundown to rename.
3
PATCH /api/rest/v1/playout/rundowns/{rundownId} HTTP/1.1
Host: 127.0.0.1
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"name": "My Renamed Rundown"
}
{
"id": 3,
"name": "My Renamed Rundown"
}
The ID of the rundown.
2
GET /api/rest/v1/playout/rundowns/{rundownId}/items HTTP/1.1
Host: 127.0.0.1
Accept: */*
[
{
"id": 3,
"name": "template-1",
"template": "template-1",
"data": {},
"buttons": [
{
"id": "button2",
"key": "button2",
"label": "Update"
}
]
}
]
The ID of the target rundown.
2
POST /api/rest/v1/playout/rundowns/{rundownId}/items HTTP/1.1
Host: 127.0.0.1
Content-Type: application/json
Accept: */*
Content-Length: 168
{
"name": "My New Rundown Item",
"template": "template-1",
"order": 2,
"data": {
"top_text": "<Name of the person goes here>",
"bottom_text": "<Name of the organization/company>"
}
}
{
"id": 5,
"name": "My New Rundown Item",
"template": "template-1",
"data": {
"top_text": "<Name of the person goes here>",
"bottom_text": "<Name of the organization/company>"
}
}
The ID of the rundown.
2
The ID of the rundown item.
5
GET /api/rest/v1/playout/rundowns/{rundownId}/items/{itemId} HTTP/1.1
Host: 127.0.0.1
Accept: */*
[
{
"id": 5,
"name": "My New Rundown Item",
"template": "template-1",
"data": {
"top_text": "<Name of the person goes here>",
"bottom_text": "<Name of the organization/company>"
},
"buttons": [
{
"id": "button2",
"key": "button2",
"label": "Update"
}
]
}
]
The ID of the rundown.
2
The ID of the rundown item to delete.
5
DELETE /api/rest/v1/playout/rundowns/{rundownId}/items/{itemId} HTTP/1.1
Host: 127.0.0.1
Accept: */*
No content
The ID of the rundown.
2
The ID of the rundown item.
5
PATCH /api/rest/v1/playout/rundowns/{rundownId}/items/{itemId} HTTP/1.1
Host: 127.0.0.1
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"name": "Updated Rundown Item Name",
"order": 0,
"data": {
"top_text": "Jane D.",
"bottom_text": "Example Inc."
}
}
{
"id": 5,
"name": "Updated Rundown Item Name",
"template": "template-1",
"data": {
"top_text": "Jane D.",
"bottom_text": "Example Inc."
}
}
The ID of the rundown.
2
The ID of the rundown item.
3
The form key of the button.
open_lower
POST /api/rest/v1/playout/rundowns/{rundownId}/items/{itemId}/{buttonKey} HTTP/1.1
Host: 127.0.0.1
Accept: */*
{
"success": true
}
Newsroom Control
GET /api/rest/v1/newsroom/rundowns HTTP/1.1
Host: 127.0.0.1
Accept: */*
[
{
"ncsID": "OCTOPUS2",
"roID": "69425946",
"roSlug": "EVENING NEWS 6/4/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-06-02T18:47:21.659Z",
"updatedAt": "2023-06-02T18:47:21.659Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "63356849",
"roSlug": "EVENING NEWS 3/2/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-03-01T11:52:51.083Z",
"updatedAt": "2023-03-01T11:52:51.083Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "63356832",
"roSlug": "BUSINESS NEWS 2/21/2023 20:00",
"status": "MANUAL CTRL",
"createdAt": "2023-02-21T12:04:49.306Z",
"updatedAt": "2023-02-21T12:04:49.306Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "63356823",
"roSlug": "EVENING NEWS 2/17/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-02-17T12:33:07.112Z",
"updatedAt": "2023-02-17T12:33:07.112Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "63356821",
"roSlug": "EVENING NEWS 2/16/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-02-15T09:37:43.704Z",
"updatedAt": "2023-02-15T09:37:43.704Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "63356819",
"roSlug": "EVENING NEWS 2/15/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-02-14T14:19:58.913Z",
"updatedAt": "2023-02-14T14:19:58.913Z"
},
{
"ncsID": "2016ENPS9VM001",
"roID": "2016ENPS9VM001;P_ENPSNEWS\\W;38387985-142E-409A-AD00-A500F856B3C3",
"roSlug": "Phltest0910",
"status": "MANUAL CTRL",
"createdAt": "2023-02-09T14:13:01.344Z",
"updatedAt": "2023-02-09T14:13:01.344Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "60424189",
"roSlug": "EVENING NEWS 1/31/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-01-30T16:16:39.591Z",
"updatedAt": "2023-01-30T16:16:39.591Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "60424171",
"roSlug": "Mehmet Test RO",
"status": "MANUAL CTRL",
"createdAt": "2023-01-19T16:15:10.443Z",
"updatedAt": "2023-01-19T16:15:10.443Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "60424164",
"roSlug": "EVENING NEWS 1/19/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-01-18T16:29:04.036Z",
"updatedAt": "2023-01-18T16:29:04.036Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "68843309",
"roSlug": "BUSINESS NEWS 8/28/2022 20:00",
"status": "MANUAL CTRL",
"createdAt": "2022-08-26T13:33:54.268Z",
"updatedAt": "2022-08-26T13:33:54.268Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "68843304",
"roSlug": "EVENING NEWS 8/26/2022 19:00",
"status": "MANUAL CTRL",
"createdAt": "2022-08-26T13:31:49.157Z",
"updatedAt": "2022-08-26T13:31:49.157Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "68843306",
"roSlug": "EVENING NEWS 8/27/2022 19:00",
"status": "MANUAL CTRL",
"createdAt": "2022-08-26T13:31:49.088Z",
"updatedAt": "2022-08-26T13:31:49.088Z"
},
{
"ncsID": "2012R2ENPS8VM",
"roID": "2012R2ENPS8VM;P_SYSTEM\\W;91A93EBA-08C8-40B0-83ABA5A255DD6C7D",
"roSlug": "rundown 2",
"status": "MANUAL CTRL",
"createdAt": "2022-07-29T07:14:39.959Z",
"updatedAt": "2022-07-29T07:14:39.959Z"
},
{
"ncsID": "2012R2ENPS8VM",
"roID": "2012R2ENPS8VM;P_SYSTEM\\W;B2AA0459-16AD-4BEA-990F10EBFEE70DB3",
"roSlug": "ro-1",
"status": "MANUAL CTRL",
"createdAt": "2022-07-29T06:52:44.384Z",
"updatedAt": "2022-07-29T06:52:44.384Z"
}
]
The Device ID of the NCS (can be found in Configuration -> MOS Module -> Configuration)
OCTOPUS2
GET /api/rest/v1/newsroom/rundowns/{ncsID} HTTP/1.1
Host: 127.0.0.1
Accept: */*
[
{
"ncsID": "OCTOPUS2",
"roID": "69425946",
"roSlug": "EVENING NEWS 6/4/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-06-02T18:47:21.659Z",
"updatedAt": "2023-06-02T18:47:21.659Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "63356849",
"roSlug": "EVENING NEWS 3/2/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-03-01T11:52:51.083Z",
"updatedAt": "2023-03-01T11:52:51.083Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "63356832",
"roSlug": "BUSINESS NEWS 2/21/2023 20:00",
"status": "MANUAL CTRL",
"createdAt": "2023-02-21T12:04:49.306Z",
"updatedAt": "2023-02-21T12:04:49.306Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "63356823",
"roSlug": "EVENING NEWS 2/17/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-02-17T12:33:07.112Z",
"updatedAt": "2023-02-17T12:33:07.112Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "63356821",
"roSlug": "EVENING NEWS 2/16/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-02-15T09:37:43.704Z",
"updatedAt": "2023-02-15T09:37:43.704Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "63356819",
"roSlug": "EVENING NEWS 2/15/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-02-14T14:19:58.913Z",
"updatedAt": "2023-02-14T14:19:58.913Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "60424189",
"roSlug": "EVENING NEWS 1/31/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-01-30T16:16:39.591Z",
"updatedAt": "2023-01-30T16:16:39.591Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "60424171",
"roSlug": "Mehmet Test RO",
"status": "MANUAL CTRL",
"createdAt": "2023-01-19T16:15:10.443Z",
"updatedAt": "2023-01-19T16:15:10.443Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "60424164",
"roSlug": "EVENING NEWS 1/19/2023 19:00",
"status": "MANUAL CTRL",
"createdAt": "2023-01-18T16:29:04.036Z",
"updatedAt": "2023-01-18T16:29:04.036Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "68843309",
"roSlug": "BUSINESS NEWS 8/28/2022 20:00",
"status": "MANUAL CTRL",
"createdAt": "2022-08-26T13:33:54.268Z",
"updatedAt": "2022-08-26T13:33:54.268Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "68843304",
"roSlug": "EVENING NEWS 8/26/2022 19:00",
"status": "MANUAL CTRL",
"createdAt": "2022-08-26T13:31:49.157Z",
"updatedAt": "2022-08-26T13:31:49.157Z"
},
{
"ncsID": "OCTOPUS2",
"roID": "68843306",
"roSlug": "EVENING NEWS 8/27/2022 19:00",
"status": "MANUAL CTRL",
"createdAt": "2022-08-26T13:31:49.088Z",
"updatedAt": "2022-08-26T13:31:49.088Z"
}
]
The Device ID of the NCS (can be found in Configuration -> MOS Module -> Configuration)
OCTOPUS2
Rundown ID (given by the NCS Device)
69425946
GET /api/rest/v1/newsroom/rundowns/{ncsID}/{roID} HTTP/1.1
Host: 127.0.0.1
Accept: */*
{
"ncsID": "OCTOPUS2",
"roID": "69425946",
"roSlug": "EVENING NEWS 6/4/2023 19:00",
"roChannel": "OCTOPUS NEWS",
"roEdStart": "2023-06-04T16:00:00.000Z",
"roEdDur": "00:06:03",
"roTrigger": "TIMED",
"macroIn": null,
"macroOut": null,
"mosExternalMetadata": "[{\"mosScope\":\"PLAYLIST\",\"mosSchema\":\"octopus://PLAYLIST/EXTRA\",\"mosPayload\":\"<mosPayload>\\n\\t<octext_payloadPlaylistExtra>\\n\\t\\t<cols />\\n\\t</octext_payloadPlaylistExtra>\\n</mosPayload>\\n\"}]",
"readyToAir": true,
"status": "MANUAL CTRL",
"updatedAt": "2023-06-02T18:47:21.659Z",
"createdAt": "2023-06-02T18:47:21.659Z",
"items": [
{
"storyID": "71755601",
"itemID": "2-1",
"storySlug": "8 die in Japan snowstorm",
"itemSlug": "Newsroom REST - Test 1",
"mosObject": {
"objID": "048c0b52-0c5c-47a6-9f23-b375ea6d9feb",
"objSlug": "Newsroom REST - Test 1",
"mosAbstract": "Newsroom REST - Test 1",
"objGroup": null,
"objTB": "50",
"objRev": 1,
"objDur": 0,
"status": "NEW",
"objAir": "READY",
"objPaths": null,
"mosExternalMetadata": null,
"createdBy": "mehmet",
"created": "2023-06-02T18:47:00.612Z",
"changedBy": "hub.newsroom",
"changed": "2023-06-02T18:47:00.612Z",
"description": "",
"objType": "VIDEO",
"template": "Newsroom REST - Test 1",
"data": {
"realityarray1": [
"Deneme 1000",
"Deneme 2000",
"Deneme 3000",
"Deneme 4000"
],
"button1": ""
},
"buttons": [
{
"id": "button1",
"key": "button1",
"label": "Button"
}
]
}
}
]
}
The ID of the MOS object to update.
048c0b52-0c5c-47a6-9f23-b375ea6d9feb
PATCH /api/rest/v1/newsroom/mosObjects/{objID} HTTP/1.1
Host: 127.0.0.1
Content-Type: application/json
Accept: */*
Content-Length: 91
{
"description": "Updated description",
"data": {
"realityarray1": [
"Test 1",
"Test 2",
"Test 3"
]
}
}
{
"objID": "048c0b52-0c5c-47a6-9f23-b375ea6d9feb",
"objSlug": "Newsroom REST - Test 1",
"mosAbstract": "Newsroom REST - Test 1",
"objGroup": null,
"objTB": "50",
"objRev": 1,
"objDur": 0,
"status": "NEW",
"objAir": "READY",
"objPaths": null,
"mosExternalMetadata": null,
"createdBy": "mehmet",
"created": "2023-06-02T18:47:00.612Z",
"changedBy": "REST API",
"changed": "2023-06-02T18:47:00.612Z",
"description": "Updated description",
"objType": "VIDEO",
"template": "Newsroom REST - Test 1",
"data": {
"realityarray1": [
"Test 1",
"Test 2",
"Test 3"
]
}
}
The Device ID of the NCS (can be found in Configuration -> MOS Module -> Configuration)
OCTOPUS2
Rundown ID
69425946
Story ID
71755601
Item ID
2-1
The key of the button to be triggered.
button1
POST /api/rest/v1/newsroom/rundowns/{ncsID}/{roID}/{storyID}/{itemID}/{buttonKey} HTTP/1.1
Host: 127.0.0.1
Accept: */*
{
"success": true
}
Last updated