CitraClient.Antennas (citra_client v0.3.0)
View SourceGenerated operations for OpenAPI tag antennas.
Summary
Functions
Create Antennas
Delete Antennas
Get Antenna
Get Antenna Collection Requests
Get Antenna Tasks
List Antennas
List User Antennas
Upsert Antennas
Functions
Create Antennas
Create new antennas for the current user (bulk create)
POST /antennas
Body
Request body (map or generated struct).
Delete Antennas
Delete one or more antennas for the current user (bulk delete)
DELETE /antennas
Body
Request body (map or generated struct).
Get Antenna
GET /antennas/{antenna_id}
Path parameters
antenna_id(path)
Get Antenna Collection Requests
Get all collection requests for a specific antenna (via tasks) with their associated tasks
GET /antennas/{antenna_id}/collection-requests
Path parameters
antenna_id(path)
Options (passed via keyword list)
:window_start_after— Filter requests with window starting after this time (ISO 8601 format):window_start_before— Filter requests with window starting before this time (ISO 8601 format):window_stop_after— Filter requests with window stopping after this time (ISO 8601 format):window_stop_before— Filter requests with window stopping before this time (ISO 8601 format):statuses— Filter requests by status (can provide multiple statuses)
Get Antenna Tasks
Get all tasks for a specific antenna, optionally filtered by a set of parameters
GET /antennas/{antenna_id}/tasks
Path parameters
antenna_id(path)
Options (passed via keyword list)
:task_start_after— Filter tasks starting after this time (ISO 8601 format):task_start_before— Filter tasks starting before this time (ISO 8601 format):task_stop_after— Filter tasks stopping after this time (ISO 8601 format):task_stop_before— Filter tasks stopping before this time (ISO 8601 format):statuses— Filter tasks by status (can provide multiple statuses)
List Antennas
List all antennas, optionally filtered by IDs
GET /antennas
Options (passed via keyword list)
:ids— Filter antennas by specific IDs
List User Antennas
List current user's antennas, optionally filtered by IDs
GET /my/antennas
Options (passed via keyword list)
:ids— Filter antennas by specific IDs
Upsert Antennas
Create and/or update antennas for the current user (bulk upsert)
PUT /antennas
Body
Request body (map or generated struct).