BookingDefinition [VCon IG]
A BookingDefinition is a collection of one to many Bookings. It can describe several types of bookings:
Single occurrence: A job planned for a one-time execution.
Recurring job: A job, that is recurring and can be described by a recurring pattern, i.e. a weekly or bi-weekly recording at a given time for a given duration.
Multi Job: A job which runs parallel on several devices, i.e. several camera perspectives during a sports match are recorded at once.
In VidiCore, all created objects under a BookingDefinition are part of a collection.
Properties
Property | Possible Values | Example | Description | Writeable? |
---|---|---|---|---|
id | string | 0B | External ID of the BookingDefinition. | Read only (Created by VidiControl). |
vcCollectionId | string | COLLECTION-VX-39 | ID of the associated collection in VidiCore. | Read only. |
metadata | string (VidiCore Metadata Document) | Metadata of the associated VidiCore collection. | Write only. | |
start | string (DateTime using the universal sortable date/time pattern) | 2023-01-04T16:40:27.67Z |
Currently not used. | Read and write. |
end | string (DateTime using the universal sortable date/time pattern) | 2023-01-04T17:40:27.67Z |
Currently not used. | Read and write. |
pattern | Recurrency pattern if the BookingDefinition represents a recurring recording. Currently not used. | Read and write. | ||
type | Integer 0 = Single, 1 = Multi, 2 = Crash, 3 = Recurring, 4 = Lock | 0 | The type of the BookingDefinition. Currently not used. | Read and write. |
bookings | Array of Booking objects | See Booking | Booking objects this BookingDefinition is containing. | Read and write. |
Example JSON Snippet
{
"id": "AwM",
"bookings": [
{
"id": "AwM",
"chunkList": [
{
"id": "RRy",
"commandList": [
{
"id": "X2RQ",
"capabilityId": "0B",
"poolId": "2n",
"deviceId": "XA",
"executionTime": "2023-01-05T05:00:23Z",
"duration": 120,
"index": 1,
"executionState": "Error",
"handling": "WaitForResult",
"content": "{\"action\":\"Record\"}",
"commandType": "CapabilityRecorder",
"inPortId": "GD",
"outPortId": "dl"
},
{
"id": "7QoZ",
"capabilityId": "wl",
"poolId": null,
"deviceId": "0B",
"executionTime": "2023-01-05T04:59:23Z",
"duration": 60,
"index": 0,
"executionState": "Done",
"handling": "WaitForResult",
"content": "{\"action\":\"Switch\"}",
"commandType": "CapabilityRouter",
"inPortId": "GD",
"outPortId": "rn"
}
],
"vcItemId": "ITEM-VX-965",
"metadata": null,
"start": "2023-01-05T04:59:23Z",
"end": "2023-01-05T05:02:23Z",
"executionState": "Error",
"title": "test",
"clipId": null
}
],
"start": "2023-01-05T04:57:23Z",
"end": "2023-01-05T05:04:23Z",
"vcItemSequenceId": "",
"metadata": null,
"bookingDefinitionId": null
}
],
"vcCollectionId": "COLLECTION-VX-878",
"metadata": null,
"start": "2023-01-05T04:57:23Z",
"end": "2023-01-05T05:04:23Z",
"pattern": "",
"type": 0
}