UC Search for all Recordings within a Timeframe [VCon IG]
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 timeframe.
Description
This search can be performed by doing a GET request on the BookingDefinitions. 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 |
pool | array[string] | No | Pools used to execute the commands of the booking definitions | 0B |
content | string | No | Defines which other objects from the hierarchy should be returned. | Bookings,Bookings.Chunks,Bookings.Chunks.Commands |
Reference
Example
GET vidicontrol/schedulercore/SchedulerCore/BookingService/v1/BookingDefinitions?start=2023-01-04T16%3A40%3A27.67Z&end=2023-01-05T16%3A40%3A27.67Z&pools=0B&pools=GD&content=Bookings
Result
[
{
"id": "XKy",
"bookings": [
{
"id": "XKy",
"chunkList": [],
"start": "2023-01-05T04:57:23Z",
"end": "2023-01-05T05:04:23Z",
"vcItemSequenceId": "",
"metadata": null,
"bookingDefinitionId": null
}
],
"vcCollectionId": "COLLECTION-VX-888",
"metadata": null,
"start": "2023-01-05T04:57:23Z",
"end": "2023-01-05T05:04:23Z",
"pattern": "",
"type": 0
},
{
"id": "Z0a",
"bookings": [
{
"id": "Z0a",
"chunkList": [],
"start": "2023-01-05T04:57:23Z",
"end": "2023-01-05T05:04:23Z",
"vcItemSequenceId": "",
"metadata": null,
"bookingDefinitionId": null
}
],
"vcCollectionId": "COLLECTION-VX-889",
"metadata": null,
"start": "2023-01-05T04:57:23Z",
"end": "2023-01-05T05:04:23Z",
"pattern": "",
"type": 0
}
]