CitraClient.Telescopes (citra_client v0.3.0)

View Source

Generated operations for OpenAPI tag telescopes.

Summary

Functions

create_telescopes(body)

Create Telescopes

Create new telescopes for the current user (bulk create)

POST /telescopes

Body

Request body (map or generated struct).

delete_telescopes(body)

Delete Telescopes

Delete one or more telescopes for the current user (bulk delete)

DELETE /telescopes

Body

Request body (map or generated struct).

get_telescope(telescope_id)

Get Telescope

GET /telescopes/{telescope_id}

Path parameters

  • telescope_id (path)

get_telescope_collection_requests(telescope_id, opts \\ [])

Get Telescope Collection Requests

Get all collection requests for a specific telescope (via tasks) with their associated tasks

GET /telescopes/{telescope_id}/collection-requests

Path parameters

  • telescope_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_telescope_tasks(telescope_id, opts \\ [])

Get Telescope Tasks

Get all tasks for a specific telescope, optionally filtered by a set of parameters

GET /telescopes/{telescope_id}/tasks

Path parameters

  • telescope_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_telescopes(opts \\ [])

List Telescopes

List all telescopes, optionally filtered by IDs

GET /telescopes

Options (passed via keyword list)

  • :ids — Filter telescopes by specific IDs

list_user_telescopes(opts \\ [])

List User Telescopes

List current user's telescopes, optionally filtered by IDs

GET /my/telescopes

Options (passed via keyword list)

  • :ids — Filter telescopes by specific IDs

update_telescopes(body)

Update Telescopes

Update one or more telescopes for the current user (bulk update)

PATCH /telescopes

Body

Request body (map or generated struct).

upsert_telescopes(body)

Upsert Telescopes

Create and/or update telescopes for the current user (bulk upsert)

PUT /telescopes

Body

Request body (map or generated struct).