UC Search for all Recordings within a Timeframe

Motivation

In some cases, e.g. showing a timeframe with all recordings or pre-checking for collisions, it is necessary to get all recordings that take place in a defined time frame.

Description

This search can be performed by doing a PUT request on Chunks/Search. To set some conditions and change the sub-objects that are returned, the parameters from the following table can be used as query parameters.

Parameters

Name	Type	Required?	Description	Example
start	string (Parsable to DateTime)	No	Start of the time span the booking definitions take place in	2023-01-04T16:40:27.67Z
end	string (Parsable to DateTime)	No	End of the time span the booking definitions take place in	2023-01-05T16:40:27.67Z
commandType	string (“Workflow”, “CapabilityRecorder”, “CapabilitySwitch”, “CapabilityUnknown”)	No	Type of commands that should take place in the defined time range. If not set, the search is performed for all types.	“CapabilityRecorder”
content	string	No	Defines which other objects from the hierarchy should be returned.	Commands.Routings

In addition to that, it is possible to filter the search results by in ports (“inPortIds”) and devices (“deviceIds”) in the request body.

Reference

vidicontrol/schedulercore/swagger/index.html

Example

PUT vidicontrol/schedulercore/SchedulerCore/BookingService/v1/Chunks/Search?start=2023-09-05T10%3A20%3A41.904Z&end=2023-09-05T11%3A20%3A41.904Z&commandType=CapabilityRecorder&content=Commands.Routings

Body

JSON

{
  "inPortIds": [
    "aN"
  ],
  "deviceIds": [
    "00B"
  ]
}

Result

CODE

[
  {
    "id": "w9MR",
    "commandList": [
      {
        "id": "o5Ya",
        "capabilityId": "wl",
        "poolId": null,
        "deviceId": "0B",
        "executionTime": "2023-09-05T09:56:58Z",
        "duration": 2,
        "index": 0,
        "executionState": "Done",
        "handling": "WaitForResult",
        "content": "{\"action\":\"Switch\",\"input\":{}}",
        "commandType": "CapabilityRouter",
        "inPortId": "aN",
        "outPortId": "Jyl",
        "routingList": []
      },
      {
        "id": "WrGj",
        "capabilityId": "M93",
        "poolId": "ALN",
        "deviceId": "00B",
        "executionTime": "2023-09-05T09:57:00Z",
        "duration": 4800,
        "index": 1,
        "executionState": "Done",
        "handling": "WaitForResult",
        "content": "{\"action\":\"Record\",\"input\":{}}",
        "commandType": "CapabilityRecorder",
        "inPortId": "aN",
        "outPortId": null,
        "routingList": []
      }
    ],
    "vcItemId": "ITEM-VX-21281",
    "metadata": null,
    "start": "2023-09-05T09:56:58Z",
    "end": "2023-09-05T11:17:00Z",
    "executionState": "Done",
    "title": null,
    "clipId": "{532c965e-eb22-47d0-a946-9ef5a0c54983}",
    "parentInfo": {
      "bookingId": null,
      "bookingDefinitionId": null,
      "bookingDefinitionType": "Single"
    }
  }
]