GET /api/collections/smart
Returns a list of all smart collections. Operation ID:GetSmartCollections.
Response Fields
integer
required
Internal database identifier for the smart collection.
string
required
Display name for the collection.
string
required
The search query string that defines the collection’s contents. Uses ErsatzTV’s Lucene-style search syntax.
POST /api/collections/smart/new
Creates a new smart collection. Operation ID:CreateSmartCollection.
Request Body
string
required
Display name for the new smart collection.
string
required
The search query that populates the collection (e.g.
genre:Action type:movie).Response Fields
integer
required
The ID of the newly created smart collection.
200 OK with the CreateSmartCollectionResult object on success, or an HTTP Problem response on failure.
PUT /api/collections/smart/update
Updates an existing smart collection’s name or query. Operation ID:UpdateSmartCollection.
Request Body
integer
required
The ID of the smart collection to update.
string
required
The new display name for the collection.
string
required
The updated search query string.
200 OK with an UpdateSmartCollectionResult on success, or a Problem response on failure.
DELETE /api/collections/smart/delete/
Deletes a smart collection by its integer ID. Operation ID:DeleteSmartCollection.
integer
required
The ID of the smart collection to delete.
200 OK on success, or a Problem response if the deletion fails (for example, if the collection is referenced by an active schedule block).
Deleting a smart collection does not immediately affect running playouts, but any schedule blocks or scripted schedules that reference the deleted collection will fail to resolve content on the next playout rebuild.