User API
The User API exposes user records — distinct from the Me API which is scoped to the authenticated caller.
You read user records here when you need information about other users your token can see (typically other members of organizations or groups you share).
Endpoints at a glance
| Endpoint | What it returns |
|---|---|
GET /v1/users |
Paginated list of users visible to the caller |
GET /v1/users/{id} |
A specific user record |
PATCH /v1/users/{id} |
Update a user record (own record + admin override) |
GET /v1/users/{id}/observations |
Observations owned by the user |
GET /v1/users/{id}/observing-accounts |
Observing accounts owned by the user |
User creation goes through the auth service's signup flow rather
than POST /v1/users — there is no direct API for creating users.
Visibility
User-record visibility is gated by relationship:
- You always see your own record (use Me API for ergonomics).
- You see other users you share an organization or group membership with.
- Public profile fields (display name, organization affiliations where the user has chosen to make those public) may be visible to anyone with a valid token.
Private fields (email address, account state, internal flags) are restricted to the user themselves and to administrators.
Common task recipes
- Look up a collaborator's user record.
GET /v1/users?email=...if your token has permission to filter by email; otherwise navigate via shared organization memberships. - Update your profile. PATCH your own user record. Some fields
(
display_name,bio, profile image) are user-editable; others (email, account state) require workflows through the auth service. - Browse public profiles. Many observatories surface a user's observations and contributions through the public profile view — the relevant fields ride on the user record itself.
Reference
User API 2.0.0
Endpoints for resources owned by users.
Users
PATCH /users/{entity_id_or_slug}
Update Entity User
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
{
"affiliation": null,
"birthdate": null,
"country": null,
"description": null,
"facebookId": null,
"firstName": null,
"githubId": null,
"language": null,
"lastName": null,
"linkedinId": null,
"location": null,
"name": null,
"orcidId": null,
"profileImageId": null,
"title": null,
"twitterId": null,
"username": null,
"websiteUrl": null
}
Schema of the request body
{
"properties": {
"affiliation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Institutional affiliation shown on the public profile."
},
"birthdate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Birthdate shown on the public profile."
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Country in the public profile."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Bio/description in the public profile."
},
"facebookId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Facebook handle/ID shown on the public profile."
},
"firstName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First name of the user."
},
"githubId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "GitHub username shown on the public profile."
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Preferred language shown on the public profile."
},
"lastName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Last name of the user."
},
"linkedinId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "LinkedIn handle/ID shown on the public profile."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Location in the public profile."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the user."
},
"orcidId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "ORCID iD shown on the public profile."
},
"profileImageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Profile image of the user."
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Professional title shown on the public profile."
},
"twitterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Twitter / X handle shown on the public profile."
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Username of the user."
},
"websiteUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Website URL in the public profile."
}
},
"title": "UserProfileUpdate",
"type": "object"
}
Responses
{
"affiliation": null,
"age": null,
"birthdate": null,
"country": null,
"createdOn": null,
"description": null,
"email": "string",
"entityType": "string",
"facebookId": null,
"firstName": null,
"githubId": null,
"id": 0,
"language": null,
"lastName": null,
"linkedinId": null,
"location": null,
"name": "string",
"orcidId": null,
"profileImageId": null,
"slug": "string",
"title": null,
"twitterId": null,
"username": "string",
"websiteUrl": null
}
Schema of the response body
{
"properties": {
"affiliation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Affiliation provided by the user in their public profile"
},
"age": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Age of the user"
},
"birthdate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Birthdate provided by the user in their public profile"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Country provided by the user or organization in their public profile"
},
"createdOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Creation time of this account"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Description/Bio provided by the user or organization in their public profile"
},
"email": {
"description": "Email address of the user",
"type": "string"
},
"entityType": {
"const": "user",
"type": "string"
},
"facebookId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Facebook ID provided by the user in their public profile"
},
"firstName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First name of the user"
},
"githubId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "GitHub ID provided by the user in their public profile"
},
"id": {
"description": "Unique identifier of the user/organization.",
"type": "integer"
},
"language": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Language provided by the user or organization in their public profile"
},
"lastName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Last name of the user"
},
"linkedinId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "LinkedIn ID provided by the user in their public profile"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Location provided by the user or organization in their public profile"
},
"name": {
"description": "Name of the user/organization.",
"type": "string"
},
"orcidId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "ORCID ID provided by the user in their public profile"
},
"profileImageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Profile image of the user/organization."
},
"slug": {
"description": "Unique identifier used in URLs referencing the user/organization.",
"type": "string"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Title provided by the user in their public profile"
},
"twitterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Twitter ID provided by the user in their public profile"
},
"username": {
"description": "Username of the user",
"type": "string"
},
"websiteUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Website URL provided by the user or organization in their public profile"
}
},
"required": [
"id",
"name",
"slug",
"entityType",
"username",
"email"
],
"title": "UserPublic",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/devices
Read Entity Devices
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
assigned |
query | No | |||
device_type |
query | No | |||
deviceType |
query | No | |||
entity_id_or_slug |
path | No | Entity id or slug | ||
id |
query | No | |||
manufacturer |
query | No | |||
model_name |
query | No | |||
modelName |
query | No | |||
name |
query | No | |||
observatory_id |
query | No | |||
observatoryId |
query | No | |||
owner_id |
query | No | |||
ownerId |
query | No | |||
q |
query | No | |||
serial_number |
query | No | |||
serialNumber |
query | No | |||
sort_by |
query | No | |||
sortBy |
query | No | |||
telescope_id |
query | No | |||
telescopeId |
query | No | |||
token |
query | No | |||
uid |
query | No |
Responses
{
"items": [
null
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"discriminator": {
"mapping": {
"antenna": "#/components/schemas/Antenna",
"camera": "#/components/schemas/Camera",
"enclosure": "#/components/schemas/Enclosure",
"filter_wheel": "#/components/schemas/FilterWheel",
"focuser": "#/components/schemas/Focuser",
"instrument_rotator": "#/components/schemas/InstrumentRotator",
"mount": "#/components/schemas/Mount",
"ota": "#/components/schemas/Ota",
"radio_backend": "#/components/schemas/RadioBackend",
"receiver": "#/components/schemas/Receiver",
"weather_sensor": "#/components/schemas/WeatherSensor"
},
"propertyName": "deviceType"
},
"oneOf": [
{
"$ref": "#/components/schemas/Antenna"
},
{
"$ref": "#/components/schemas/Focuser"
},
{
"$ref": "#/components/schemas/Camera"
},
{
"$ref": "#/components/schemas/Enclosure"
},
{
"$ref": "#/components/schemas/FilterWheel"
},
{
"$ref": "#/components/schemas/InstrumentRotator"
},
{
"$ref": "#/components/schemas/Mount"
},
{
"$ref": "#/components/schemas/Ota"
},
{
"$ref": "#/components/schemas/RadioBackend"
},
{
"$ref": "#/components/schemas/Receiver"
},
{
"$ref": "#/components/schemas/WeatherSensor"
}
]
},
"title": "Items",
"type": "array"
},
"page": {
"minimum": 1.0,
"title": "Page",
"type": "integer"
},
"pages": {
"minimum": 0.0,
"title": "Pages",
"type": "integer"
},
"size": {
"minimum": 1.0,
"title": "Size",
"type": "integer"
},
"total": {
"minimum": 0.0,
"title": "Total",
"type": "integer"
}
},
"required": [
"items",
"total",
"page",
"size",
"pages"
],
"title": "Page[Annotated[Union[Antenna, Focuser, Camera, Enclosure, FilterWheel, InstrumentRotator, Mount, Ota, RadioBackend, Receiver, WeatherSensor], FieldInfo(annotation=NoneType, required=True, discriminator='device_type')]]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/devices
Create Entity Device
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
Schema of the request body
{
"discriminator": {
"mapping": {
"antenna": "#/components/schemas/AntennaCreate",
"camera": "#/components/schemas/CameraCreate",
"enclosure": "#/components/schemas/EnclosureCreate",
"filter_wheel": "#/components/schemas/FilterWheelCreate",
"focuser": "#/components/schemas/FocuserCreate",
"instrument_rotator": "#/components/schemas/InstrumentRotatorCreate",
"mount": "#/components/schemas/MountCreate",
"ota": "#/components/schemas/OtaCreate",
"radio_backend": "#/components/schemas/RadioBackendCreate",
"receiver": "#/components/schemas/ReceiverCreate",
"weather_sensor": "#/components/schemas/WeatherSensorCreate"
},
"propertyName": "deviceType"
},
"oneOf": [
{
"$ref": "#/components/schemas/AntennaCreate"
},
{
"$ref": "#/components/schemas/FocuserCreate"
},
{
"$ref": "#/components/schemas/CameraCreate"
},
{
"$ref": "#/components/schemas/EnclosureCreate"
},
{
"$ref": "#/components/schemas/FilterWheelCreate"
},
{
"$ref": "#/components/schemas/InstrumentRotatorCreate"
},
{
"$ref": "#/components/schemas/MountCreate"
},
{
"$ref": "#/components/schemas/OtaCreate"
},
{
"$ref": "#/components/schemas/RadioBackendCreate"
},
{
"$ref": "#/components/schemas/ReceiverCreate"
},
{
"$ref": "#/components/schemas/WeatherSensorCreate"
}
],
"title": "Body"
}
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"antenna": "#/components/schemas/Antenna",
"camera": "#/components/schemas/Camera",
"enclosure": "#/components/schemas/Enclosure",
"filter_wheel": "#/components/schemas/FilterWheel",
"focuser": "#/components/schemas/Focuser",
"instrument_rotator": "#/components/schemas/InstrumentRotator",
"mount": "#/components/schemas/Mount",
"ota": "#/components/schemas/Ota",
"radio_backend": "#/components/schemas/RadioBackend",
"receiver": "#/components/schemas/Receiver",
"weather_sensor": "#/components/schemas/WeatherSensor"
},
"propertyName": "deviceType"
},
"oneOf": [
{
"$ref": "#/components/schemas/Antenna"
},
{
"$ref": "#/components/schemas/Focuser"
},
{
"$ref": "#/components/schemas/Camera"
},
{
"$ref": "#/components/schemas/Enclosure"
},
{
"$ref": "#/components/schemas/FilterWheel"
},
{
"$ref": "#/components/schemas/InstrumentRotator"
},
{
"$ref": "#/components/schemas/Mount"
},
{
"$ref": "#/components/schemas/Ota"
},
{
"$ref": "#/components/schemas/RadioBackend"
},
{
"$ref": "#/components/schemas/Receiver"
},
{
"$ref": "#/components/schemas/WeatherSensor"
}
],
"title": "Response Create Entity Device Users Entity Id Or Slug Devices Post"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/devices/{device_id}
Read Entity Device
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
device_id |
path | No | Device id or uid | ||
token |
query | No |
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"antenna": "#/components/schemas/Antenna",
"camera": "#/components/schemas/Camera",
"enclosure": "#/components/schemas/Enclosure",
"filter_wheel": "#/components/schemas/FilterWheel",
"focuser": "#/components/schemas/Focuser",
"instrument_rotator": "#/components/schemas/InstrumentRotator",
"mount": "#/components/schemas/Mount",
"ota": "#/components/schemas/Ota",
"radio_backend": "#/components/schemas/RadioBackend",
"receiver": "#/components/schemas/Receiver",
"weather_sensor": "#/components/schemas/WeatherSensor"
},
"propertyName": "deviceType"
},
"oneOf": [
{
"$ref": "#/components/schemas/Antenna"
},
{
"$ref": "#/components/schemas/Focuser"
},
{
"$ref": "#/components/schemas/Camera"
},
{
"$ref": "#/components/schemas/Enclosure"
},
{
"$ref": "#/components/schemas/FilterWheel"
},
{
"$ref": "#/components/schemas/InstrumentRotator"
},
{
"$ref": "#/components/schemas/Mount"
},
{
"$ref": "#/components/schemas/Ota"
},
{
"$ref": "#/components/schemas/RadioBackend"
},
{
"$ref": "#/components/schemas/Receiver"
},
{
"$ref": "#/components/schemas/WeatherSensor"
}
],
"title": "Response Read Entity Device Users Entity Id Or Slug Devices Device Id Get"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PATCH /users/{entity_id_or_slug}/devices/{device_id}
Update Entity Device
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
device_id |
path | No | Device id or uid | ||
token |
query | No |
Request body
Schema of the request body
{
"discriminator": {
"mapping": {
"antenna": "#/components/schemas/AntennaUpdate",
"camera": "#/components/schemas/CameraUpdate",
"enclosure": "#/components/schemas/EnclosureUpdate",
"filter_wheel": "#/components/schemas/FilterWheelUpdate",
"focuser": "#/components/schemas/FocuserUpdate",
"instrument_rotator": "#/components/schemas/InstrumentRotatorUpdate",
"mount": "#/components/schemas/MountUpdate",
"ota": "#/components/schemas/OtaUpdate",
"radio_backend": "#/components/schemas/RadioBackendUpdate",
"receiver": "#/components/schemas/ReceiverUpdate",
"weather_sensor": "#/components/schemas/WeatherSensorUpdate"
},
"propertyName": "deviceType"
},
"oneOf": [
{
"$ref": "#/components/schemas/AntennaUpdate"
},
{
"$ref": "#/components/schemas/FocuserUpdate"
},
{
"$ref": "#/components/schemas/CameraUpdate"
},
{
"$ref": "#/components/schemas/EnclosureUpdate"
},
{
"$ref": "#/components/schemas/FilterWheelUpdate"
},
{
"$ref": "#/components/schemas/InstrumentRotatorUpdate"
},
{
"$ref": "#/components/schemas/MountUpdate"
},
{
"$ref": "#/components/schemas/OtaUpdate"
},
{
"$ref": "#/components/schemas/RadioBackendUpdate"
},
{
"$ref": "#/components/schemas/ReceiverUpdate"
},
{
"$ref": "#/components/schemas/WeatherSensorUpdate"
}
],
"title": "Body"
}
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"antenna": "#/components/schemas/Antenna",
"camera": "#/components/schemas/Camera",
"enclosure": "#/components/schemas/Enclosure",
"filter_wheel": "#/components/schemas/FilterWheel",
"focuser": "#/components/schemas/Focuser",
"instrument_rotator": "#/components/schemas/InstrumentRotator",
"mount": "#/components/schemas/Mount",
"ota": "#/components/schemas/Ota",
"radio_backend": "#/components/schemas/RadioBackend",
"receiver": "#/components/schemas/Receiver",
"weather_sensor": "#/components/schemas/WeatherSensor"
},
"propertyName": "deviceType"
},
"oneOf": [
{
"$ref": "#/components/schemas/Antenna"
},
{
"$ref": "#/components/schemas/Focuser"
},
{
"$ref": "#/components/schemas/Camera"
},
{
"$ref": "#/components/schemas/Enclosure"
},
{
"$ref": "#/components/schemas/FilterWheel"
},
{
"$ref": "#/components/schemas/InstrumentRotator"
},
{
"$ref": "#/components/schemas/Mount"
},
{
"$ref": "#/components/schemas/Ota"
},
{
"$ref": "#/components/schemas/RadioBackend"
},
{
"$ref": "#/components/schemas/Receiver"
},
{
"$ref": "#/components/schemas/WeatherSensor"
}
],
"title": "Response Update Entity Device Users Entity Id Or Slug Devices Device Id Patch"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/devices/{device_id}/detail
Read Entity Device Detail
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
device_id |
path | No | Device id or uid | ||
token |
query | No |
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"antenna": "#/components/schemas/AntennaDetail",
"camera": "#/components/schemas/CameraDetail",
"enclosure": "#/components/schemas/EnclosureDetail",
"filter_wheel": "#/components/schemas/FilterWheelDetail",
"focuser": "#/components/schemas/FocuserDetail",
"instrument_rotator": "#/components/schemas/InstrumentRotatorDetail",
"mount": "#/components/schemas/MountDetail",
"ota": "#/components/schemas/OtaDetail",
"radio_backend": "#/components/schemas/RadioBackendDetail",
"receiver": "#/components/schemas/ReceiverDetail",
"weather_sensor": "#/components/schemas/WeatherSensorDetail"
},
"propertyName": "deviceType"
},
"oneOf": [
{
"$ref": "#/components/schemas/AntennaDetail"
},
{
"$ref": "#/components/schemas/FocuserDetail"
},
{
"$ref": "#/components/schemas/CameraDetail"
},
{
"$ref": "#/components/schemas/EnclosureDetail"
},
{
"$ref": "#/components/schemas/FilterWheelDetail"
},
{
"$ref": "#/components/schemas/InstrumentRotatorDetail"
},
{
"$ref": "#/components/schemas/MountDetail"
},
{
"$ref": "#/components/schemas/OtaDetail"
},
{
"$ref": "#/components/schemas/RadioBackendDetail"
},
{
"$ref": "#/components/schemas/ReceiverDetail"
},
{
"$ref": "#/components/schemas/WeatherSensorDetail"
}
],
"title": "Response Read Entity Device Detail Users Entity Id Or Slug Devices Device Id Detail Get"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/integrations
Read Entity Integrations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Responses
{
"items": [
null
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"discriminator": {
"mapping": {
"dropbox": "#/components/schemas/DropboxIntegration",
"google_drive": "#/components/schemas/GoogleDriveIntegration",
"hermes_alert": "#/components/schemas/AlertIntegration",
"nasa_gcn_alert": "#/components/schemas/AlertIntegration",
"orcid": "#/components/schemas/OrcidIntegration",
"s3_minio": "#/components/schemas/S3MinioIntegration",
"slack": "#/components/schemas/SlackIntegration",
"treasure_map": "#/components/schemas/TreasureMapIntegration"
},
"propertyName": "integrationType"
},
"oneOf": [
{
"$ref": "#/components/schemas/AlertIntegration"
},
{
"$ref": "#/components/schemas/S3MinioIntegration"
},
{
"$ref": "#/components/schemas/TreasureMapIntegration"
},
{
"$ref": "#/components/schemas/GoogleDriveIntegration"
},
{
"$ref": "#/components/schemas/DropboxIntegration"
},
{
"$ref": "#/components/schemas/OrcidIntegration"
},
{
"$ref": "#/components/schemas/SlackIntegration"
}
]
},
"title": "Items",
"type": "array"
},
"page": {
"minimum": 1.0,
"title": "Page",
"type": "integer"
},
"pages": {
"minimum": 0.0,
"title": "Pages",
"type": "integer"
},
"size": {
"minimum": 1.0,
"title": "Size",
"type": "integer"
},
"total": {
"minimum": 0.0,
"title": "Total",
"type": "integer"
}
},
"required": [
"items",
"total",
"page",
"size",
"pages"
],
"title": "Page[Annotated[Union[AlertIntegration, S3MinioIntegration, TreasureMapIntegration, GoogleDriveIntegration, DropboxIntegration, OrcidIntegration, SlackIntegration], FieldInfo(annotation=NoneType, required=True, discriminator='integration_type')]]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/integrations
Create Entity Integration
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
Schema of the request body
{
"discriminator": {
"mapping": {
"dropbox": "#/components/schemas/DropboxIntegrationCreate",
"google_drive": "#/components/schemas/GoogleDriveIntegrationCreate",
"hermes_alert": "#/components/schemas/AlertIntegrationCreate",
"nasa_gcn_alert": "#/components/schemas/AlertIntegrationCreate",
"orcid": "#/components/schemas/OrcidIntegrationCreate",
"s3_minio": "#/components/schemas/S3MinioIntegrationCreate",
"slack": "#/components/schemas/SlackIntegrationCreate",
"treasure_map": "#/components/schemas/TreasureMapIntegrationCreate"
},
"propertyName": "integrationType"
},
"oneOf": [
{
"$ref": "#/components/schemas/AlertIntegrationCreate"
},
{
"$ref": "#/components/schemas/S3MinioIntegrationCreate"
},
{
"$ref": "#/components/schemas/TreasureMapIntegrationCreate"
},
{
"$ref": "#/components/schemas/GoogleDriveIntegrationCreate"
},
{
"$ref": "#/components/schemas/DropboxIntegrationCreate"
},
{
"$ref": "#/components/schemas/OrcidIntegrationCreate"
},
{
"$ref": "#/components/schemas/SlackIntegrationCreate"
}
],
"title": "Body"
}
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"dropbox": "#/components/schemas/DropboxIntegration",
"google_drive": "#/components/schemas/GoogleDriveIntegration",
"hermes_alert": "#/components/schemas/AlertIntegration",
"nasa_gcn_alert": "#/components/schemas/AlertIntegration",
"orcid": "#/components/schemas/OrcidIntegration",
"s3_minio": "#/components/schemas/S3MinioIntegration",
"slack": "#/components/schemas/SlackIntegration",
"treasure_map": "#/components/schemas/TreasureMapIntegration"
},
"propertyName": "integrationType"
},
"oneOf": [
{
"$ref": "#/components/schemas/AlertIntegration"
},
{
"$ref": "#/components/schemas/S3MinioIntegration"
},
{
"$ref": "#/components/schemas/TreasureMapIntegration"
},
{
"$ref": "#/components/schemas/GoogleDriveIntegration"
},
{
"$ref": "#/components/schemas/DropboxIntegration"
},
{
"$ref": "#/components/schemas/OrcidIntegration"
},
{
"$ref": "#/components/schemas/SlackIntegration"
}
],
"title": "Response Create Entity Integration Users Entity Id Or Slug Integrations Post"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/integrations/available
Read Entity Available Integrations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Responses
{
"items": [
{
"definition": {
"authType": "none",
"category": "alerts",
"defaultConfig": {},
"description": null,
"displayName": "string",
"id": 0,
"integrationType": "hermes_alert",
"managedBySystem": true,
"supportsMultiple": true,
"uiMeta": {}
},
"integration": null
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/IntegrationAvailability"
},
"title": "Items",
"type": "array"
},
"page": {
"minimum": 1.0,
"title": "Page",
"type": "integer"
},
"pages": {
"minimum": 0.0,
"title": "Pages",
"type": "integer"
},
"size": {
"minimum": 1.0,
"title": "Size",
"type": "integer"
},
"total": {
"minimum": 0.0,
"title": "Total",
"type": "integer"
}
},
"required": [
"items",
"total",
"page",
"size",
"pages"
],
"title": "Page[IntegrationAvailability]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PUT /users/{entity_id_or_slug}/integrations/{integration_id}
Update Entity Integration
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
integration_id |
path | integer | No | ||
token |
query | No |
Request body
Schema of the request body
{
"discriminator": {
"mapping": {
"dropbox": "#/components/schemas/DropboxIntegrationUpdate",
"google_drive": "#/components/schemas/GoogleDriveIntegrationUpdate",
"hermes_alert": "#/components/schemas/AlertIntegrationUpdate",
"nasa_gcn_alert": "#/components/schemas/AlertIntegrationUpdate",
"orcid": "#/components/schemas/OrcidIntegrationUpdate",
"s3_minio": "#/components/schemas/S3MinioIntegrationUpdate",
"slack": "#/components/schemas/SlackIntegrationUpdate",
"treasure_map": "#/components/schemas/TreasureMapIntegrationUpdate"
},
"propertyName": "integrationType"
},
"oneOf": [
{
"$ref": "#/components/schemas/AlertIntegrationUpdate"
},
{
"$ref": "#/components/schemas/S3MinioIntegrationUpdate"
},
{
"$ref": "#/components/schemas/TreasureMapIntegrationUpdate"
},
{
"$ref": "#/components/schemas/GoogleDriveIntegrationUpdate"
},
{
"$ref": "#/components/schemas/DropboxIntegrationUpdate"
},
{
"$ref": "#/components/schemas/OrcidIntegrationUpdate"
},
{
"$ref": "#/components/schemas/SlackIntegrationUpdate"
}
],
"title": "Body"
}
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"dropbox": "#/components/schemas/DropboxIntegration",
"google_drive": "#/components/schemas/GoogleDriveIntegration",
"hermes_alert": "#/components/schemas/AlertIntegration",
"nasa_gcn_alert": "#/components/schemas/AlertIntegration",
"orcid": "#/components/schemas/OrcidIntegration",
"s3_minio": "#/components/schemas/S3MinioIntegration",
"slack": "#/components/schemas/SlackIntegration",
"treasure_map": "#/components/schemas/TreasureMapIntegration"
},
"propertyName": "integrationType"
},
"oneOf": [
{
"$ref": "#/components/schemas/AlertIntegration"
},
{
"$ref": "#/components/schemas/S3MinioIntegration"
},
{
"$ref": "#/components/schemas/TreasureMapIntegration"
},
{
"$ref": "#/components/schemas/GoogleDriveIntegration"
},
{
"$ref": "#/components/schemas/DropboxIntegration"
},
{
"$ref": "#/components/schemas/OrcidIntegration"
},
{
"$ref": "#/components/schemas/SlackIntegration"
}
],
"title": "Response Update Entity Integration Users Entity Id Or Slug Integrations Integration Id Put"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/observations
Read Entity Observations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
-creator |
query | No | |||
-creatorId |
query | No | |||
-group |
query | No | |||
-groupId |
query | No | |||
-kind |
query | No | |||
-organization |
query | No | |||
-organizationId |
query | No | |||
-owner |
query | No | |||
-ownerId |
query | No | |||
-status |
query | No | |||
completed_after |
query | No | |||
completed_before |
query | No | |||
completedAfter |
query | No | |||
completedBefore |
query | No | |||
created_after |
query | No | |||
created_before |
query | No | |||
createdAfter |
query | No | |||
createdBefore |
query | No | |||
creator |
query | No | |||
creator_ |
query | No | |||
creator_id |
query | No | |||
creator_id_ |
query | No | |||
creatorId |
query | No | |||
entity_id_or_slug |
path | No | Entity id or slug | ||
group |
query | No | |||
group_ |
query | No | |||
group_id |
query | No | |||
group_id_ |
query | No | |||
groupId |
query | No | |||
id |
query | No | |||
is_original |
query | No | |||
isOriginal |
query | No | |||
kind |
query | No | |||
kind_ |
query | No | |||
last_activity_after |
query | No | |||
last_activity_before |
query | No | |||
lastActivityAfter |
query | No | |||
lastActivityBefore |
query | No | |||
name |
query | No | |||
observation_type |
query | No | |||
observationType |
query | No | |||
organization |
query | No | |||
organization_ |
query | No | |||
organization_id |
query | No | |||
organization_id_ |
query | No | |||
organizationId |
query | No | |||
original_id |
query | No | |||
originalId |
query | No | |||
owner |
query | No | |||
owner_ |
query | No | |||
owner_id |
query | No | |||
owner_id_ |
query | No | |||
ownerId |
query | No | |||
sort_by |
query | No | |||
sortBy |
query | No | |||
status |
query | No | |||
status_ |
query | No | |||
token |
query | No |
Responses
{
"items": [
{
"cancelOn": null,
"completedOn": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creator": null,
"creatorId": 0,
"creatorUid": null,
"currentIteration": 0,
"galleryItems": null,
"groupUid": null,
"id": 0,
"instrumentAssignmentMode": "observation",
"instrumentIds": null,
"instrumentLockTimeoutSec": 10.12,
"instrumentMode": "none",
"interruptLowerPriority": true,
"isDeleted": true,
"isPublic": true,
"iterationInterval": 10.12,
"iterationIntervalType": "fixed",
"iterations": 0,
"kind": "template",
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingBlockPolicy": "request_iteration",
"observingGrantIds": null,
"opticalImagingConfiguration": null,
"originalId": null,
"originalUid": null,
"owner": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"requestTypes": [
"optical_imaging"
],
"startAfter": null,
"status": "active",
"target": null,
"targetId": null,
"targetUid": null,
"uid": "901239d4-4827-48bc-b501-267cd65c895a",
"updatedOn": "2022-04-13T15:42:05.901Z"
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ObservationSummary"
},
"title": "Items",
"type": "array"
},
"page": {
"minimum": 1.0,
"title": "Page",
"type": "integer"
},
"pages": {
"minimum": 0.0,
"title": "Pages",
"type": "integer"
},
"size": {
"minimum": 1.0,
"title": "Size",
"type": "integer"
},
"total": {
"minimum": 0.0,
"title": "Total",
"type": "integer"
}
},
"required": [
"items",
"total",
"page",
"size",
"pages"
],
"title": "Page[ObservationSummary]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/observations
Create Entity Observation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
{
"cancelOn": null,
"completedOn": null,
"instrumentAssignmentMode": null,
"instrumentIds": null,
"instrumentLockTimeoutSec": null,
"instrumentMode": null,
"interruptLowerPriority": null,
"isDeleted": null,
"isPublic": null,
"iterationInterval": null,
"iterationIntervalType": null,
"iterations": null,
"kind": null,
"lastActivityOn": null,
"name": "string",
"observingBlockPolicy": null,
"observingGrantIds": null,
"opticalImagingConfiguration": null,
"originalId": null,
"ownerId": 0,
"priority": null,
"progressFraction": null,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"renderSettings": null,
"requests": null,
"startAfter": null,
"status": null,
"target": null
}
Schema of the request body
{
"properties": {
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"instrumentAssignmentMode": {
"anyOf": [
{
"$ref": "#/components/schemas/InstrumentAssignmentMode"
},
{
"type": "null"
}
],
"default": "observation"
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentLockTimeoutSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": 60.0
},
"instrumentMode": {
"anyOf": [
{
"$ref": "#/components/schemas/InstrumentAccessMode"
},
{
"type": "null"
}
],
"default": "none"
},
"interruptLowerPriority": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false
},
"isDeleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false
},
"isPublic": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false
},
"iterationInterval": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": 0.0
},
"iterationIntervalType": {
"anyOf": [
{
"$ref": "#/components/schemas/IterationIntervalType"
},
{
"type": "null"
}
],
"default": "fixed"
},
"iterations": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 1
},
"kind": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservationKind"
},
{
"type": "null"
}
],
"default": "instance"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observingBlockPolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservingBlockPolicy"
},
{
"type": "null"
}
],
"default": "observation_iteration"
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Input"
},
{
"type": "null"
}
]
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"ownerId": {
"type": "integer"
},
"priority": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0
},
"progressFraction": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": 0.0
},
"radioMappingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/RadioMappingConfiguration"
},
{
"type": "null"
}
]
},
"radioTrackingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/RadioTrackingConfiguration"
},
{
"type": "null"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"requests": {
"anyOf": [
{
"items": {
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequestCreate",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequestCreate",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequestCreate",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequestCreate",
"radio_mapping": "#/components/schemas/RadioMappingRequestCreate",
"radio_tracking": "#/components/schemas/RadioTrackingRequestCreate"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequestCreate"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequestCreate"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequestCreate"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequestCreate"
},
{
"$ref": "#/components/schemas/RadioTrackingRequestCreate"
},
{
"$ref": "#/components/schemas/RadioMappingRequestCreate"
}
]
},
"type": "array"
},
{
"type": "null"
}
]
},
"startAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservationStatus"
},
{
"type": "null"
}
],
"default": "active"
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/TargetCreate"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"ownerId"
],
"title": "ObservationCreate",
"type": "object"
}
Responses
{
"cancelOn": null,
"completedOn": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creatorId": 0,
"creatorUid": null,
"currentIteration": 0,
"groupUid": null,
"id": 0,
"instrumentAssignmentMode": "observation",
"instrumentIds": null,
"instrumentLockTimeoutSec": 10.12,
"instrumentMode": "none",
"interruptLowerPriority": true,
"isDeleted": true,
"isPublic": true,
"iterationInterval": 10.12,
"iterationIntervalType": "fixed",
"iterations": 0,
"kind": "template",
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingBlockPolicy": "request_iteration",
"observingGrantIds": null,
"opticalImagingConfiguration": null,
"originalId": null,
"originalUid": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"requestTypes": [
"optical_imaging"
],
"startAfter": null,
"status": "active",
"targetId": null,
"targetUid": null,
"uid": "87503571-4760-47e7-8718-c12849360201",
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"createdOn": {
"description": "Creation timestamp.",
"format": "date-time",
"type": "string"
},
"creatorId": {
"description": "User who created it.",
"type": "integer"
},
"creatorUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"currentIteration": {
"default": 0,
"type": "integer"
},
"groupUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"description": "Unique identifier of the observation.",
"type": "integer"
},
"instrumentAssignmentMode": {
"$ref": "#/components/schemas/InstrumentAssignmentMode"
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentLockTimeoutSec": {
"type": "number"
},
"instrumentMode": {
"$ref": "#/components/schemas/InstrumentAccessMode"
},
"interruptLowerPriority": {
"description": "Interrupt lower priority.",
"type": "boolean"
},
"isDeleted": {
"description": "Flag indicating if deleted.",
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"iterationInterval": {
"type": "number"
},
"iterationIntervalType": {
"$ref": "#/components/schemas/IterationIntervalType"
},
"iterations": {
"type": "integer"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"description": "Name of the observation.",
"type": "string"
},
"observabilityLastUpdatedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Timestamp of the last observability refresh."
},
"observingBlockPolicy": {
"$ref": "#/components/schemas/ObservingBlockPolicy",
"default": "observation_iteration",
"description": "How observation tasks should be grouped into uninterrupted scheduling blocks."
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Output"
},
{
"type": "null"
}
]
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the observation forked from."
},
"originalUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"ownerId": {
"description": "Entity that funds this observation.",
"type": "integer"
},
"ownerUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"priority": {
"type": "integer"
},
"progressFraction": {
"type": "number"
},
"radioMappingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/RadioMappingConfiguration"
},
{
"type": "null"
}
]
},
"radioTrackingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/RadioTrackingConfiguration"
},
{
"type": "null"
}
]
},
"requestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"startAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/components/schemas/ObservationStatus"
},
"targetId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the target associated with the observation."
},
"targetUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"updatedOn": {
"description": "Update timestamp.",
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"uid",
"targetId",
"status",
"kind",
"isDeleted",
"createdOn",
"updatedOn",
"name",
"ownerId",
"creatorId",
"interruptLowerPriority",
"priority",
"instrumentAssignmentMode",
"instrumentLockTimeoutSec",
"iterations",
"iterationIntervalType",
"iterationInterval",
"progressFraction",
"isPublic",
"instrumentMode"
],
"title": "Observation",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/observatories
Read Entity Observatories
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
-ownerId |
query | No | |||
entity_id_or_slug |
path | No | Entity id or slug | ||
id |
query | No | |||
name |
query | No | |||
owner_id |
query | No | |||
owner_id_ |
query | No | |||
ownerId |
query | No | |||
slug |
query | No | |||
token |
query | No | |||
uid |
query | No |
Responses
{
"items": [
{
"countryCode": "string",
"description": null,
"elevationM": 10.12,
"galleryItemIds": null,
"iauCode": null,
"id": null,
"imageId": null,
"ipCameraIds": null,
"isAvailable": true,
"isPublic": true,
"latitudeDeg": 10.12,
"location": "string",
"longitudeDeg": 10.12,
"name": "string",
"owner": null,
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"shortName": null,
"site": null,
"siteId": null,
"siteUid": null,
"slug": "string",
"telescopeIds": null,
"uid": "57bc3d61-5fa4-4be4-bb31-cd1fd7f30cf2",
"weatherSensorIds": null
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ObservatorySummary"
},
"title": "Items",
"type": "array"
},
"page": {
"minimum": 1.0,
"title": "Page",
"type": "integer"
},
"pages": {
"minimum": 0.0,
"title": "Pages",
"type": "integer"
},
"size": {
"minimum": 1.0,
"title": "Size",
"type": "integer"
},
"total": {
"minimum": 0.0,
"title": "Total",
"type": "integer"
}
},
"required": [
"items",
"total",
"page",
"size",
"pages"
],
"title": "Page[ObservatorySummary]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/observatories
Create Entity Observatory
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
{
"countryCode": "string",
"description": null,
"elevationM": 10.12,
"iauCode": null,
"imageId": null,
"isAvailable": true,
"isPublic": null,
"latitudeDeg": 10.12,
"location": "string",
"longitudeDeg": 10.12,
"name": "string",
"ownerId": 0,
"shortName": null,
"siteId": null
}
Schema of the request body
{
"properties": {
"countryCode": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"elevationM": {
"type": "number"
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"isAvailable": {
"type": "boolean"
},
"isPublic": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true
},
"latitudeDeg": {
"type": "number"
},
"location": {
"type": "string"
},
"longitudeDeg": {
"type": "number"
},
"name": {
"type": "string"
},
"ownerId": {
"type": "integer"
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"siteId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
}
},
"required": [
"ownerId",
"name",
"location",
"countryCode",
"latitudeDeg",
"longitudeDeg",
"elevationM",
"isAvailable"
],
"title": "ObservatoryCreate",
"type": "object"
}
Responses
{
"countryCode": "string",
"description": null,
"elevationM": 10.12,
"galleryItemIds": null,
"iauCode": null,
"id": null,
"imageId": null,
"ipCameraIds": null,
"isAvailable": true,
"isPublic": true,
"latitudeDeg": 10.12,
"location": "string",
"longitudeDeg": 10.12,
"name": "string",
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"shortName": null,
"siteId": null,
"siteUid": null,
"slug": "string",
"telescopeIds": null,
"uid": "deba7a0d-34ee-4a07-a61a-25492f9c9cb4",
"weatherSensorIds": null
}
Schema of the response body
{
"properties": {
"countryCode": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"elevationM": {
"type": "number"
},
"galleryItemIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"ipCameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"isAvailable": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"latitudeDeg": {
"type": "number"
},
"location": {
"type": "string"
},
"longitudeDeg": {
"type": "number"
},
"name": {
"type": "string"
},
"ownerId": {
"type": "integer"
},
"publicLatitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publicLongitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"siteId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"siteUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"type": "string"
},
"telescopeIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"weatherSensorIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
}
},
"required": [
"uid",
"name",
"slug",
"location",
"elevationM",
"isAvailable",
"ownerId",
"countryCode",
"latitudeDeg",
"longitudeDeg",
"isPublic"
],
"title": "Observatory",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/observatories/{observatory_id}
Read Entity Observatory
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observatory_id |
path | No | Observatory id or uid | ||
token |
query | No |
Responses
{
"countryCode": "string",
"description": null,
"elevationM": 10.12,
"galleryItemIds": null,
"iauCode": null,
"id": null,
"imageId": null,
"ipCameraIds": null,
"isAvailable": true,
"isPublic": true,
"latitudeDeg": 10.12,
"location": "string",
"longitudeDeg": 10.12,
"name": "string",
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"shortName": null,
"siteId": null,
"siteUid": null,
"slug": "string",
"telescopeIds": null,
"uid": "a8271c18-1634-4b46-883c-6db611b4edbb",
"weatherSensorIds": null
}
Schema of the response body
{
"properties": {
"countryCode": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"elevationM": {
"type": "number"
},
"galleryItemIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"ipCameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"isAvailable": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"latitudeDeg": {
"type": "number"
},
"location": {
"type": "string"
},
"longitudeDeg": {
"type": "number"
},
"name": {
"type": "string"
},
"ownerId": {
"type": "integer"
},
"publicLatitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publicLongitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"siteId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"siteUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"type": "string"
},
"telescopeIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"weatherSensorIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
}
},
"required": [
"uid",
"name",
"slug",
"location",
"elevationM",
"isAvailable",
"ownerId",
"countryCode",
"latitudeDeg",
"longitudeDeg",
"isPublic"
],
"title": "Observatory",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PATCH /users/{entity_id_or_slug}/observatories/{observatory_id}
Update Entity Observatory
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observatory_id |
path | No | Observatory id or uid | ||
token |
query | No |
Request body
{
"countryCode": null,
"description": null,
"elevationM": null,
"iauCode": null,
"imageId": null,
"isAvailable": null,
"isPublic": null,
"latitudeDeg": null,
"location": null,
"longitudeDeg": null,
"name": null,
"ownerId": null,
"shortName": null,
"siteId": null,
"siteUid": null,
"slug": null
}
Schema of the request body
{
"properties": {
"countryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"elevationM": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"isAvailable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isPublic": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"latitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"longitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"ownerId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"siteId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"siteUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"title": "ObservatoryUpdate",
"type": "object"
}
Responses
{
"countryCode": "string",
"description": null,
"elevationM": 10.12,
"galleryItemIds": null,
"iauCode": null,
"id": null,
"imageId": null,
"ipCameraIds": null,
"isAvailable": true,
"isPublic": true,
"latitudeDeg": 10.12,
"location": "string",
"longitudeDeg": 10.12,
"name": "string",
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"shortName": null,
"siteId": null,
"siteUid": null,
"slug": "string",
"telescopeIds": null,
"uid": "f4e39170-068e-4a10-bea8-997d66a41a8c",
"weatherSensorIds": null
}
Schema of the response body
{
"properties": {
"countryCode": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"elevationM": {
"type": "number"
},
"galleryItemIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"ipCameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"isAvailable": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"latitudeDeg": {
"type": "number"
},
"location": {
"type": "string"
},
"longitudeDeg": {
"type": "number"
},
"name": {
"type": "string"
},
"ownerId": {
"type": "integer"
},
"publicLatitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publicLongitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"siteId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"siteUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"type": "string"
},
"telescopeIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"weatherSensorIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
}
},
"required": [
"uid",
"name",
"slug",
"location",
"elevationM",
"isAvailable",
"ownerId",
"countryCode",
"latitudeDeg",
"longitudeDeg",
"isPublic"
],
"title": "Observatory",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/observatories/{observatory_id}/detail
Read Entity Observatory Detail
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observatory_id |
path | No | Observatory id or uid | ||
token |
query | No |
Responses
{
"countryCode": "string",
"description": null,
"elevationM": 10.12,
"galleryItemIds": null,
"galleryItems": [
{
"file": null,
"fileId": "c6a5d3a2-3816-486e-8cef-8c3af474f8dd",
"id": 0,
"observatoryId": 0,
"order": null,
"visibility": true
}
],
"iauCode": null,
"id": null,
"imageId": null,
"ipCameraIds": null,
"ipCameras": [
{
"id": null,
"isPrimary": true,
"lastSeen": null,
"name": "string",
"observatoryId": null,
"onvifHost": null,
"order": 0,
"pose": null,
"ptz": true,
"role": "pier",
"streams": [
{
"active": true,
"cameraId": 0,
"expiresSec": null,
"id": 0,
"isPublic": true,
"kind": "rtsp",
"quality": null
}
],
"telescopeId": null,
"uid": "5bb326c3-1da1-4ca3-809e-0c37eb96ada3",
"vendor": null
}
],
"isAvailable": true,
"isPublic": true,
"latitudeDeg": 10.12,
"location": "string",
"longitudeDeg": 10.12,
"name": "string",
"owner": null,
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"shortName": null,
"site": null,
"siteId": null,
"siteUid": null,
"slug": "string",
"telescopeIds": null,
"telescopes": [
{
"antennaIds": null,
"calibrationObservingAccountId": null,
"cameraIds": null,
"description": null,
"deviceIds": null,
"elevationM": 10.12,
"enclosureId": null,
"enclosureUid": null,
"filterWheelIds": null,
"focuserIds": null,
"galleryItemIds": null,
"iauCode": null,
"id": null,
"imageId": null,
"instrumentIds": null,
"ipCameraIds": null,
"isAvailable": true,
"isPublic": true,
"latitudeDeg": 10.12,
"localHorizon": null,
"location": "string",
"longitudeDeg": 10.12,
"mountId": null,
"mountUid": null,
"name": "string",
"observatory": null,
"observatoryId": 0,
"observatoryUid": null,
"otaIds": null,
"owner": null,
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"radioBackendIds": null,
"receiverIds": null,
"rotatorIds": null,
"shortName": null,
"slug": "string",
"uid": "215a345a-3ddc-4c21-abbc-0f6298ec0fdc"
}
],
"uid": "2c26fd88-4ef3-49a1-a907-15d8cb057719",
"weatherSensorIds": null,
"weatherSensors": [
{
"deviceType": "string",
"hasAmbientTemperature": true,
"hasCloudTemperatureDeltaC": true,
"hasHumidity": true,
"hasLightLevel": true,
"hasPressure": true,
"hasRainRate": true,
"hasRainStorm": true,
"hasSurfaceWetness": true,
"hasWindDirection": true,
"hasWindSpeedAvg10Min": true,
"hasWindSpeedAvg1Min": true,
"hasWindSpeedAvg2Min": true,
"hasWindSpeedInstantaneous": true,
"hasWindSpeedPeak10Min": true,
"hasWindSpeedPeak1Min": true,
"hasWindSpeedPeak2Min": true,
"id": null,
"imageId": null,
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "e97746f1-95f9-4242-bdae-adb013d1ab36"
}
]
}
Schema of the response body
{
"properties": {
"countryCode": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"elevationM": {
"type": "number"
},
"galleryItemIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"galleryItems": {
"default": [],
"items": {
"$ref": "#/components/schemas/ObservatoryGalleryItem"
},
"type": "array"
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"ipCameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"ipCameras": {
"default": [],
"items": {
"$ref": "#/components/schemas/IPCamera"
},
"type": "array"
},
"isAvailable": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"latitudeDeg": {
"type": "number"
},
"location": {
"type": "string"
},
"longitudeDeg": {
"type": "number"
},
"name": {
"type": "string"
},
"owner": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/OrganizationPublic",
"user": "#/components/schemas/UserPublic"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/UserPublic"
},
{
"$ref": "#/components/schemas/OrganizationPublic"
}
]
},
{
"type": "null"
}
]
},
"ownerId": {
"type": "integer"
},
"publicLatitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publicLongitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"site": {
"anyOf": [
{
"$ref": "#/components/schemas/SiteSummary"
},
{
"type": "null"
}
]
},
"siteId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"siteUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"type": "string"
},
"telescopeIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"telescopes": {
"default": [],
"items": {
"$ref": "#/components/schemas/TelescopeSummary"
},
"type": "array"
},
"uid": {
"format": "uuid",
"type": "string"
},
"weatherSensorIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"weatherSensors": {
"default": [],
"items": {
"$ref": "#/components/schemas/WeatherSensor"
},
"type": "array"
}
},
"required": [
"uid",
"name",
"slug",
"location",
"elevationM",
"isAvailable",
"ownerId",
"countryCode",
"latitudeDeg",
"longitudeDeg",
"isPublic"
],
"title": "ObservatoryDetail",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/observatories/{observatory_id}/ip-cameras
Create Observatory Ip Camera
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observatory_id |
path | No | Observatory id or uid | ||
token |
query | No |
Request body
{
"isPrimary": true,
"name": "string",
"onvifHost": null,
"order": 0,
"pose": null,
"ptz": true,
"role": "pier",
"secretRef": null,
"streams": [
{
"active": true,
"expiresSec": null,
"isPublic": true,
"kind": "rtsp",
"quality": null,
"urlTemplate": "string"
}
],
"vendor": null
}
Schema of the request body
{
"properties": {
"isPrimary": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
},
"onvifHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"order": {
"default": 0,
"type": "integer"
},
"pose": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
]
},
"ptz": {
"default": false,
"type": "boolean"
},
"role": {
"$ref": "#/components/schemas/IPCameraRole",
"default": "pier"
},
"secretRef": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"streams": {
"default": [],
"items": {
"$ref": "#/components/schemas/IPCameraStreamCreate"
},
"type": "array"
},
"vendor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name"
],
"title": "IPCameraCreate",
"type": "object"
}
Responses
{
"id": null,
"isPrimary": true,
"lastSeen": null,
"name": "string",
"observatoryId": null,
"onvifHost": null,
"order": 0,
"pose": null,
"ptz": true,
"role": "pier",
"streams": [
{
"active": true,
"cameraId": 0,
"expiresSec": null,
"id": 0,
"isPublic": true,
"kind": "rtsp",
"quality": null
}
],
"telescopeId": null,
"uid": "f00ca935-4696-4d61-b7d7-f37058c7b17d",
"vendor": null
}
Schema of the response body
{
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"isPrimary": {
"type": "boolean"
},
"lastSeen": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"onvifHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"order": {
"type": "integer"
},
"pose": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
]
},
"ptz": {
"type": "boolean"
},
"role": {
"$ref": "#/components/schemas/IPCameraRole"
},
"streams": {
"default": [],
"items": {
"$ref": "#/components/schemas/IPCameraStream"
},
"type": "array"
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"vendor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"uid",
"name",
"role",
"ptz",
"isPrimary",
"order"
],
"title": "IPCamera",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/observatories/{observatory_id}/ip-cameras/{camera_id}/streams
Create Observatory Ip Camera Stream
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
camera_id |
path | integer | No | ||
observatory_id |
path | No | Observatory id or uid | ||
token |
query | No |
Request body
{
"active": true,
"expiresSec": null,
"isPublic": true,
"kind": "rtsp",
"quality": null,
"urlTemplate": "string"
}
Schema of the request body
{
"properties": {
"active": {
"default": true,
"type": "boolean"
},
"expiresSec": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"isPublic": {
"default": false,
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/StreamKind"
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/StreamQuality"
},
{
"type": "null"
}
]
},
"urlTemplate": {
"type": "string"
}
},
"required": [
"kind",
"urlTemplate"
],
"title": "IPCameraStreamCreate",
"type": "object"
}
Responses
{
"active": true,
"cameraId": 0,
"expiresSec": null,
"id": 0,
"isPublic": true,
"kind": "rtsp",
"quality": null
}
Schema of the response body
{
"properties": {
"active": {
"type": "boolean"
},
"cameraId": {
"type": "integer"
},
"expiresSec": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"id": {
"type": "integer"
},
"isPublic": {
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/StreamKind"
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/StreamQuality"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"cameraId",
"kind",
"isPublic",
"active"
],
"title": "IPCameraStream",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/observing-accounts
Read Entity Observing Accounts
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
-owner |
query | No | |||
-ownerId |
query | No | |||
entity_id_or_slug |
path | No | Entity id or slug | ||
id |
query | No | |||
is_deleted |
query | No | |||
isDeleted |
query | No | |||
last_activity_after |
query | No | |||
last_activity_before |
query | No | |||
lastActivityAfter |
query | No | |||
lastActivityBefore |
query | No | |||
name |
query | No | |||
owner |
query | No | |||
owner_ |
query | No | |||
owner_id |
query | No | |||
owner_id_ |
query | No | |||
ownerId |
query | No | |||
parent_id |
query | No | |||
parentId |
query | No | |||
sort_by |
query | No | |||
sortBy |
query | No | |||
telescope_id |
query | No | |||
telescopeId |
query | No | |||
token |
query | No |
Responses
{
"items": [
{
"creditsUsed": null,
"effectiveQueueAccessGrants": null,
"id": 0,
"isDeleted": true,
"lastActivityOn": null,
"managingGroup": null,
"managingGroupId": null,
"name": null,
"observingPolicy": null,
"observingPolicyId": null,
"order": 0,
"owner": null,
"ownerId": 0,
"path": null,
"queueAccessGrantIds": null,
"quotas": null,
"slug": null,
"sourceAccountGrantId": null,
"sourceAccountId": null,
"sponsor": null
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ObservingAccountSummary"
},
"title": "Items",
"type": "array"
},
"page": {
"minimum": 1.0,
"title": "Page",
"type": "integer"
},
"pages": {
"minimum": 0.0,
"title": "Pages",
"type": "integer"
},
"size": {
"minimum": 1.0,
"title": "Size",
"type": "integer"
},
"total": {
"minimum": 0.0,
"title": "Total",
"type": "integer"
}
},
"required": [
"items",
"total",
"page",
"size",
"pages"
],
"title": "Page[ObservingAccountSummary]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/observing-accounts
Create Entity Observing Account
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
{
"managingGroupId": null,
"name": null,
"observingPolicyId": null,
"order": 0,
"ownerId": 0,
"queueAccessGrantIds": [
0
],
"sourceAccountId": null
}
Schema of the request body
{
"properties": {
"managingGroupId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observingPolicyId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"order": {
"type": "integer"
},
"ownerId": {
"type": "integer"
},
"queueAccessGrantIds": {
"default": [],
"items": {
"type": "integer"
},
"type": "array"
},
"sourceAccountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
}
},
"required": [
"ownerId",
"order"
],
"title": "ObservingAccountCreate",
"type": "object"
}
Responses
{
"creditsUsed": null,
"id": 0,
"isDeleted": true,
"lastActivityOn": null,
"managingGroupId": null,
"name": null,
"observingPolicyId": null,
"order": 0,
"ownerId": 0,
"path": null,
"queueAccessGrantIds": null,
"quotas": null,
"slug": null,
"sourceAccountGrantId": null,
"sourceAccountId": null
}
Schema of the response body
{
"description": "Common fields shared across observing grant variants.",
"properties": {
"creditsUsed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"id": {
"type": "integer"
},
"isDeleted": {
"default": false,
"type": "boolean"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"managingGroupId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observingPolicyId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"order": {
"type": "integer"
},
"ownerId": {
"type": "integer"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"queueAccessGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"quotas": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservingAccountQuota"
},
"type": "array"
},
{
"type": "null"
}
]
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceAccountGrantId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"sourceAccountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"ownerId",
"order"
],
"title": "ObservingAccount",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/observing-accounts/{account_id}
Read Entity Observing Account
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
account_id |
path | integer | No | Observing account id | |
token |
query | No | |||
x_owner_id |
query | No |
Responses
{
"creditsUsed": null,
"id": 0,
"isDeleted": true,
"lastActivityOn": null,
"managingGroupId": null,
"name": null,
"observingPolicyId": null,
"order": 0,
"ownerId": 0,
"path": null,
"queueAccessGrantIds": null,
"quotas": null,
"slug": null,
"sourceAccountGrantId": null,
"sourceAccountId": null
}
Schema of the response body
{
"description": "Common fields shared across observing grant variants.",
"properties": {
"creditsUsed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"id": {
"type": "integer"
},
"isDeleted": {
"default": false,
"type": "boolean"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"managingGroupId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observingPolicyId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"order": {
"type": "integer"
},
"ownerId": {
"type": "integer"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"queueAccessGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"quotas": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservingAccountQuota"
},
"type": "array"
},
{
"type": "null"
}
]
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceAccountGrantId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"sourceAccountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"ownerId",
"order"
],
"title": "ObservingAccount",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/observing-accounts/{account_id}/detail
Read Entity Observing Account Detail
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
account_id |
path | integer | No | Observing account id | |
token |
query | No | |||
x_owner_id |
query | No |
Responses
{
"creditsUsed": null,
"effectiveQueueAccessGrants": null,
"id": 0,
"isDeleted": true,
"lastActivityOn": null,
"managingGroup": null,
"managingGroupId": null,
"name": null,
"observingPolicy": null,
"observingPolicyId": null,
"order": 0,
"owner": null,
"ownerId": 0,
"path": null,
"queueAccessGrantIds": null,
"quotas": null,
"slug": null,
"sourceAccountGrant": null,
"sourceAccountGrantId": null,
"sourceAccountId": null,
"sponsor": null,
"upstreamQuotaConstraints": null
}
Schema of the response body
{
"properties": {
"creditsUsed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"effectiveQueueAccessGrants": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservingQueueAccessGrantSummary"
},
"type": "array"
},
{
"type": "null"
}
]
},
"id": {
"type": "integer"
},
"isDeleted": {
"default": false,
"type": "boolean"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"managingGroup": {
"anyOf": [
{
"$ref": "#/components/schemas/GroupSummary"
},
{
"type": "null"
}
]
},
"managingGroupId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observingPolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservingPolicySummary"
},
{
"type": "null"
}
]
},
"observingPolicyId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"order": {
"type": "integer"
},
"owner": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/OrganizationSummary",
"user": "#/components/schemas/UserSummary"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/UserSummary"
},
{
"$ref": "#/components/schemas/OrganizationSummary"
}
]
},
{
"type": "null"
}
]
},
"ownerId": {
"type": "integer"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"queueAccessGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"quotas": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservingAccountQuota"
},
"type": "array"
},
{
"type": "null"
}
]
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceAccountGrant": {
"anyOf": [
{
"discriminator": {
"mapping": {
"externally_managed": "#/components/schemas/ExternallyManagedObservingGrantBase",
"group_managed": "#/components/schemas/GroupManagedObservingGrantBase"
},
"propertyName": "grantType"
},
"oneOf": [
{
"$ref": "#/components/schemas/ExternallyManagedObservingGrantBase"
},
{
"$ref": "#/components/schemas/GroupManagedObservingGrantBase"
}
]
},
{
"type": "null"
}
]
},
"sourceAccountGrantId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"sourceAccountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"sponsor": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/OrganizationPublic",
"user": "#/components/schemas/UserPublic"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/UserPublic"
},
{
"$ref": "#/components/schemas/OrganizationPublic"
}
]
},
{
"type": "null"
}
]
},
"upstreamQuotaConstraints": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/EffectiveQuotaConstraint"
},
"type": "array"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"ownerId",
"order"
],
"title": "ObservingAccountDetail",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/profile-image
Create User Profile Image
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
{
"altTag": null,
"bucket": null,
"createdBy": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"isDataReady": true,
"mimeType": "application/json",
"name": "string",
"objectKey": null,
"remoteUri": null,
"renderSettings": null,
"secretLinkKey": null,
"size": null,
"storageType": null,
"updatedOn": "2022-04-13T15:42:05.901Z",
"visibility": "private"
}
Schema of the request body
{
"properties": {
"altTag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bucket": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdBy": {
"anyOf": [
{
"$ref": "#/components/schemas/AssetCreationMethod"
},
{
"type": "null"
}
]
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"isDataReady": {
"default": true,
"type": "boolean"
},
"mimeType": {
"$ref": "#/components/schemas/MimeType"
},
"name": {
"type": "string"
},
"objectKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remoteUri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"secretLinkKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"size": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"storageType": {
"anyOf": [
{
"$ref": "#/components/schemas/SkynetStorageType"
},
{
"type": "null"
}
]
},
"updatedOn": {
"format": "date-time",
"type": "string"
},
"visibility": {
"$ref": "#/components/schemas/FileVisibility",
"default": "private"
}
},
"required": [
"mimeType",
"name",
"updatedOn",
"createdOn"
],
"title": "FileCreate",
"type": "object"
}
Responses
{
"altTag": null,
"bucket": null,
"createdBy": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"id": "1425509c-8769-4e03-9f91-dc39b2d88762",
"isDataReady": true,
"lastAccessedOn": null,
"mimeType": "application/json",
"name": "string",
"objectKey": null,
"remoteUri": null,
"renderSettings": null,
"secretLinkKey": null,
"sizeBytes": null,
"storageType": null,
"updatedOn": "2022-04-13T15:42:05.901Z",
"visibility": "private"
}
Schema of the response body
{
"properties": {
"altTag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bucket": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdBy": {
"anyOf": [
{
"$ref": "#/components/schemas/AssetCreationMethod"
},
{
"type": "null"
}
]
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isDataReady": {
"default": true,
"type": "boolean"
},
"lastAccessedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"mimeType": {
"$ref": "#/components/schemas/MimeType"
},
"name": {
"type": "string"
},
"objectKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remoteUri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"secretLinkKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sizeBytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"storageType": {
"anyOf": [
{
"$ref": "#/components/schemas/SkynetStorageType"
},
{
"type": "null"
}
]
},
"updatedOn": {
"format": "date-time",
"type": "string"
},
"visibility": {
"$ref": "#/components/schemas/FileVisibility",
"default": "private"
}
},
"required": [
"id",
"mimeType",
"name",
"updatedOn",
"createdOn"
],
"title": "File",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PATCH /users/{entity_id_or_slug}/profile-image/{file_id}
Update User Profile Image
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
file_id |
path | string | No | ||
token |
query | No |
Request body
{
"bucket": null,
"createdBy": null,
"isDataReady": null,
"objectKey": null,
"remoteUri": null,
"renderSettings": null,
"secretLinkKey": null,
"storageType": null,
"visibility": null
}
Schema of the request body
{
"properties": {
"bucket": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdBy": {
"anyOf": [
{
"$ref": "#/components/schemas/AssetCreationMethod"
},
{
"type": "null"
}
]
},
"isDataReady": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"objectKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remoteUri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"secretLinkKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"storageType": {
"anyOf": [
{
"$ref": "#/components/schemas/SkynetStorageType"
},
{
"type": "null"
}
]
},
"visibility": {
"anyOf": [
{
"$ref": "#/components/schemas/FileVisibility"
},
{
"type": "null"
}
]
}
},
"title": "FileUpdate",
"type": "object"
}
Responses
{
"altTag": null,
"bucket": null,
"createdBy": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"id": "94105d8d-cfbb-4385-8120-c85df468e760",
"isDataReady": true,
"lastAccessedOn": null,
"mimeType": "application/json",
"name": "string",
"objectKey": null,
"remoteUri": null,
"renderSettings": null,
"secretLinkKey": null,
"sizeBytes": null,
"storageType": null,
"updatedOn": "2022-04-13T15:42:05.901Z",
"visibility": "private"
}
Schema of the response body
{
"properties": {
"altTag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bucket": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdBy": {
"anyOf": [
{
"$ref": "#/components/schemas/AssetCreationMethod"
},
{
"type": "null"
}
]
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isDataReady": {
"default": true,
"type": "boolean"
},
"lastAccessedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"mimeType": {
"$ref": "#/components/schemas/MimeType"
},
"name": {
"type": "string"
},
"objectKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"remoteUri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"secretLinkKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sizeBytes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"storageType": {
"anyOf": [
{
"$ref": "#/components/schemas/SkynetStorageType"
},
{
"type": "null"
}
]
},
"updatedOn": {
"format": "date-time",
"type": "string"
},
"visibility": {
"$ref": "#/components/schemas/FileVisibility",
"default": "private"
}
},
"required": [
"id",
"mimeType",
"name",
"updatedOn",
"createdOn"
],
"title": "File",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/profile-image/{file_id}/upload-url
Get User Profile Image Upload Url
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
file_id |
path | string | No | ||
token |
query | No |
Responses
Schema of the response body
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/telescopes
Read Entity Telescopes
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
-ownerId |
query | No | |||
entity_id_or_slug |
path | No | Entity id or slug | ||
id |
query | No | |||
name |
query | No | |||
observatory_id |
query | No | |||
observatory_uid |
query | No | |||
observatoryId |
query | No | |||
observatoryUid |
query | No | |||
owner_id |
query | No | |||
owner_id_ |
query | No | |||
ownerId |
query | No | |||
slug |
query | No | |||
sort_by |
query | No | |||
sortBy |
query | No | |||
token |
query | No | |||
uid |
query | No |
Responses
{
"items": [
{
"antennaIds": null,
"calibrationObservingAccountId": null,
"cameraIds": null,
"description": null,
"deviceIds": null,
"elevationM": 10.12,
"enclosureId": null,
"enclosureUid": null,
"filterWheelIds": null,
"focuserIds": null,
"galleryItemIds": null,
"iauCode": null,
"id": null,
"imageId": null,
"instrumentIds": null,
"ipCameraIds": null,
"isAvailable": true,
"isPublic": true,
"latitudeDeg": 10.12,
"localHorizon": null,
"location": "string",
"longitudeDeg": 10.12,
"mountId": null,
"mountUid": null,
"name": "string",
"observatory": null,
"observatoryId": 0,
"observatoryUid": null,
"otaIds": null,
"owner": null,
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"radioBackendIds": null,
"receiverIds": null,
"rotatorIds": null,
"shortName": null,
"slug": "string",
"uid": "436b20d0-c5ae-4889-93ba-e1e5779dd696"
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TelescopeSummary"
},
"title": "Items",
"type": "array"
},
"page": {
"minimum": 1.0,
"title": "Page",
"type": "integer"
},
"pages": {
"minimum": 0.0,
"title": "Pages",
"type": "integer"
},
"size": {
"minimum": 1.0,
"title": "Size",
"type": "integer"
},
"total": {
"minimum": 0.0,
"title": "Total",
"type": "integer"
}
},
"required": [
"items",
"total",
"page",
"size",
"pages"
],
"title": "Page[TelescopeSummary]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/telescopes
Create Entity Telescope
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
{
"description": null,
"elevationM": 10.12,
"enclosureId": null,
"enclosureUid": null,
"iauCode": null,
"imageId": null,
"isAvailable": true,
"isPublic": null,
"latitudeDeg": 10.12,
"localHorizon": null,
"location": "string",
"longitudeDeg": 10.12,
"mountId": null,
"mountUid": null,
"name": "string",
"observatoryId": 0,
"ownerId": 0,
"shortName": null
}
Schema of the request body
{
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"elevationM": {
"type": "number"
},
"enclosureId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"enclosureUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"isAvailable": {
"type": "boolean"
},
"isPublic": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true
},
"latitudeDeg": {
"type": "number"
},
"localHorizon": {
"anyOf": [
{
"items": {
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
"type": "array"
},
{
"type": "null"
}
]
},
"location": {
"type": "string"
},
"longitudeDeg": {
"type": "number"
},
"mountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"mountUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observatoryId": {
"type": "integer"
},
"ownerId": {
"type": "integer"
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"observatoryId",
"ownerId",
"name",
"location",
"latitudeDeg",
"longitudeDeg",
"elevationM",
"isAvailable"
],
"title": "TelescopeCreate",
"type": "object"
}
Responses
{
"antennaIds": null,
"calibrationObservingAccountId": null,
"cameraIds": null,
"description": null,
"deviceIds": null,
"elevationM": 10.12,
"enclosureId": null,
"enclosureUid": null,
"filterWheelIds": null,
"focuserIds": null,
"galleryItemIds": null,
"iauCode": null,
"id": null,
"imageId": null,
"instrumentIds": null,
"ipCameraIds": null,
"isAvailable": true,
"isPublic": true,
"latitudeDeg": 10.12,
"location": "string",
"longitudeDeg": 10.12,
"mountId": null,
"mountUid": null,
"name": "string",
"observatoryId": 0,
"observatoryUid": null,
"otaIds": null,
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"radioBackendIds": null,
"receiverIds": null,
"rotatorIds": null,
"shortName": null,
"slug": "string",
"uid": "136195f4-37b1-4938-a240-8fc8710f0047"
}
Schema of the response body
{
"properties": {
"antennaIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"calibrationObservingAccountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"cameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"deviceIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"elevationM": {
"type": "number"
},
"enclosureId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"enclosureUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"filterWheelIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"focuserIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"galleryItemIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"ipCameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"isAvailable": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"latitudeDeg": {
"type": "number"
},
"location": {
"type": "string"
},
"longitudeDeg": {
"type": "number"
},
"mountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"mountUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observatoryId": {
"type": "integer"
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"otaIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"ownerId": {
"type": "integer"
},
"publicLatitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publicLongitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"radioBackendIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"receiverIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"rotatorIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"type": "string"
},
"uid": {
"format": "uuid",
"type": "string"
}
},
"required": [
"uid",
"name",
"slug",
"location",
"elevationM",
"isAvailable",
"ownerId",
"observatoryId",
"latitudeDeg",
"longitudeDeg",
"isPublic"
],
"title": "Telescope",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/telescopes/{telescope_id}
Read Entity Telescope
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Responses
{
"antennaIds": null,
"calibrationObservingAccountId": null,
"cameraIds": null,
"description": null,
"deviceIds": null,
"elevationM": 10.12,
"enclosureId": null,
"enclosureUid": null,
"filterWheelIds": null,
"focuserIds": null,
"galleryItemIds": null,
"iauCode": null,
"id": null,
"imageId": null,
"instrumentIds": null,
"ipCameraIds": null,
"isAvailable": true,
"isPublic": true,
"latitudeDeg": 10.12,
"location": "string",
"longitudeDeg": 10.12,
"mountId": null,
"mountUid": null,
"name": "string",
"observatoryId": 0,
"observatoryUid": null,
"otaIds": null,
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"radioBackendIds": null,
"receiverIds": null,
"rotatorIds": null,
"shortName": null,
"slug": "string",
"uid": "2564dcf2-f4a8-4558-9235-9f8da30a1a42"
}
Schema of the response body
{
"properties": {
"antennaIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"calibrationObservingAccountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"cameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"deviceIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"elevationM": {
"type": "number"
},
"enclosureId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"enclosureUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"filterWheelIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"focuserIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"galleryItemIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"ipCameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"isAvailable": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"latitudeDeg": {
"type": "number"
},
"location": {
"type": "string"
},
"longitudeDeg": {
"type": "number"
},
"mountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"mountUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observatoryId": {
"type": "integer"
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"otaIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"ownerId": {
"type": "integer"
},
"publicLatitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publicLongitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"radioBackendIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"receiverIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"rotatorIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"type": "string"
},
"uid": {
"format": "uuid",
"type": "string"
}
},
"required": [
"uid",
"name",
"slug",
"location",
"elevationM",
"isAvailable",
"ownerId",
"observatoryId",
"latitudeDeg",
"longitudeDeg",
"isPublic"
],
"title": "Telescope",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PATCH /users/{entity_id_or_slug}/telescopes/{telescope_id}
Update Entity Telescope
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Request body
{
"description": null,
"elevationM": null,
"enclosureId": null,
"enclosureUid": null,
"iauCode": null,
"imageId": null,
"isAvailable": null,
"isPublic": null,
"latitudeDeg": null,
"localHorizon": null,
"location": null,
"longitudeDeg": null,
"mountId": null,
"mountUid": null,
"name": null,
"observatoryUid": null,
"ownerId": null,
"shortName": null,
"slug": null
}
Schema of the request body
{
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"elevationM": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"enclosureId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"enclosureUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"isAvailable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isPublic": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"latitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"localHorizon": {
"anyOf": [
{
"items": {
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
"type": "array"
},
{
"type": "null"
}
]
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"longitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"mountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"mountUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"ownerId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"title": "TelescopeUpdate",
"type": "object"
}
Responses
{
"antennaIds": null,
"calibrationObservingAccountId": null,
"cameraIds": null,
"description": null,
"deviceIds": null,
"elevationM": 10.12,
"enclosureId": null,
"enclosureUid": null,
"filterWheelIds": null,
"focuserIds": null,
"galleryItemIds": null,
"iauCode": null,
"id": null,
"imageId": null,
"instrumentIds": null,
"ipCameraIds": null,
"isAvailable": true,
"isPublic": true,
"latitudeDeg": 10.12,
"location": "string",
"longitudeDeg": 10.12,
"mountId": null,
"mountUid": null,
"name": "string",
"observatoryId": 0,
"observatoryUid": null,
"otaIds": null,
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"radioBackendIds": null,
"receiverIds": null,
"rotatorIds": null,
"shortName": null,
"slug": "string",
"uid": "cd0bb3b0-45f2-43b5-8893-396c35d6aa49"
}
Schema of the response body
{
"properties": {
"antennaIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"calibrationObservingAccountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"cameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"deviceIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"elevationM": {
"type": "number"
},
"enclosureId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"enclosureUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"filterWheelIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"focuserIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"galleryItemIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"ipCameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"isAvailable": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"latitudeDeg": {
"type": "number"
},
"location": {
"type": "string"
},
"longitudeDeg": {
"type": "number"
},
"mountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"mountUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observatoryId": {
"type": "integer"
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"otaIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"ownerId": {
"type": "integer"
},
"publicLatitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publicLongitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"radioBackendIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"receiverIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"rotatorIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"type": "string"
},
"uid": {
"format": "uuid",
"type": "string"
}
},
"required": [
"uid",
"name",
"slug",
"location",
"elevationM",
"isAvailable",
"ownerId",
"observatoryId",
"latitudeDeg",
"longitudeDeg",
"isPublic"
],
"title": "Telescope",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/telescopes/{telescope_id}/detail
Read Entity Telescope Detail
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Responses
{
"antennaIds": null,
"antennas": [
{
"apertureM": 10.12,
"deviceType": "string",
"id": null,
"imageId": null,
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintActions": [
{
"action": "keep_enclosure_closed",
"deviceId": 0,
"deviceUid": null,
"id": null,
"operationalConstraintId": 0,
"priority": 0,
"triggerOnStabilizing": true,
"triggerOnUnknown": true,
"triggerOnUnsafe": true,
"uid": "fab806f5-82ad-4f93-bf07-2ea940067008"
}
],
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "8c8ca6a8-450c-4f38-8404-febd2df11976"
}
],
"calibrationObservingAccountId": null,
"cameraIds": null,
"cameras": [
{
"arrayHeight": 0,
"arrayWidth": 0,
"coolerIdleTimeoutSec": 10.12,
"coolerPolicy": "always_on",
"coolerPrestartLeadTimeSec": 10.12,
"defaultBinning": 0,
"deviceType": "string",
"fullWellCapacityElectrons": 10.12,
"hasElectronicShutter": true,
"id": null,
"imageId": null,
"isColor": true,
"isGlobalShutter": true,
"manufacturer": null,
"model": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintActions": null,
"operationalConstraintIds": null,
"ownerId": 0,
"pixelSizeUm": 10.12,
"readoutModes": null,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"temperatureSetpointC": null,
"temperatureSetpointToleranceC": null,
"uid": "4facd4bc-44ff-4370-80e8-4b85a570dadd"
}
],
"description": null,
"deviceIds": null,
"elevationM": 10.12,
"enclosure": null,
"enclosureId": null,
"enclosureUid": null,
"filterWheelIds": null,
"filterWheels": [
{
"deletedPositions": null,
"deviceType": "string",
"filterShape": null,
"filterSizeMm": null,
"filterWheelPositionIds": null,
"id": null,
"imageId": null,
"manufacturer": null,
"model": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintActions": null,
"operationalConstraintIds": null,
"ownerId": 0,
"positions": [
{
"filterIds": [
"string"
],
"filterWheelId": 0,
"filterWheelUid": null,
"filters": [
{
"bandpassNm": null,
"centralWavelengthNm": null,
"filterSpecifierType": "string",
"flatExposureScaler": null,
"id": "string",
"isModifier": null
}
],
"flatExposureScaler": null,
"focusOffset": null,
"id": null,
"isActive": true,
"isDeleted": true,
"label": null,
"position": 0,
"uid": "b35b94f7-8a98-486e-8d73-865b4e667336"
}
],
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "3da207b8-6515-424b-a17d-42047ec61cd7"
}
],
"focuserIds": null,
"focusers": [
{
"deviceType": "string",
"id": null,
"imageId": null,
"manufacturer": null,
"maxPosition": 0,
"minPosition": 0,
"model": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintActions": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"stepSize": 10.12,
"telescopeId": null,
"telescopeUid": null,
"temperatureCompensated": true,
"uid": "2dc73724-9493-4cc3-a07a-59197c5500f8"
}
],
"galleryItemIds": null,
"galleryItems": null,
"iauCode": null,
"id": null,
"imageId": null,
"instrumentIds": null,
"instruments": [
null
],
"ipCameraIds": null,
"ipCameras": [
{
"id": null,
"isPrimary": true,
"lastSeen": null,
"name": "string",
"observatoryId": null,
"onvifHost": null,
"order": 0,
"pose": null,
"ptz": true,
"role": "pier",
"streams": [
{
"active": true,
"cameraId": 0,
"expiresSec": null,
"id": 0,
"isPublic": true,
"kind": "rtsp",
"quality": null
}
],
"telescopeId": null,
"uid": "4100d27f-7f19-4c9e-aed1-d35a64a497df",
"vendor": null
}
],
"isAvailable": true,
"isPublic": true,
"latitudeDeg": 10.12,
"localHorizon": null,
"location": "string",
"longitudeDeg": 10.12,
"mount": null,
"mountId": null,
"mountUid": null,
"name": "string",
"observatory": null,
"observatoryId": 0,
"observatoryUid": null,
"otaIds": null,
"otas": [
{
"apertureM": 10.12,
"deviceType": "string",
"focalLengthM": 10.12,
"id": null,
"imageId": null,
"manufacturer": null,
"model": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"offsetScalar": null,
"offsetXM": null,
"offsetYM": null,
"offsetZM": null,
"operationalConstraintActions": null,
"operationalConstraintIds": null,
"opticalDesign": null,
"ownerId": 0,
"parentOta": null,
"parentOtaId": null,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "3c559544-3954-471e-9c47-f8c890e810c9"
}
],
"owner": null,
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"radioBackendIds": null,
"radioBackends": [
{
"description": null,
"deviceType": "string",
"id": null,
"imageId": null,
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintActions": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "d5fbeee1-81ca-4740-b1c4-b2e0a92f3a72"
}
],
"receiverIds": null,
"receivers": [
{
"band": null,
"channels": [
{
"id": 0,
"isActive": true,
"offsetXArcsec": 10.12,
"offsetYArcsec": 10.12,
"polarization": "linear",
"receiverId": 0
}
],
"deviceType": "string",
"id": 0,
"imageId": null,
"isAvailable": true,
"manufacturer": null,
"maxFrequencyMhz": 10.12,
"minFrequencyMhz": 10.12,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintActions": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "7c2e9bda-6185-496a-bd9d-7f6221c83024"
}
],
"rotatorIds": null,
"rotators": [
{
"deviceType": "string",
"id": null,
"imageId": null,
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintActions": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "8160b826-88b5-4665-818a-ad6e9a2bd9f5"
}
],
"shortName": null,
"slug": "string",
"uid": "b7b758e5-6036-426d-9bbf-685bf321b4c4"
}
Schema of the response body
{
"properties": {
"antennaIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"antennas": {
"default": [],
"items": {
"$ref": "#/components/schemas/AntennaDetail"
},
"type": "array"
},
"calibrationObservingAccountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"cameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"cameras": {
"default": [],
"items": {
"$ref": "#/components/schemas/CameraDetail"
},
"type": "array"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"deviceIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"elevationM": {
"type": "number"
},
"enclosure": {
"anyOf": [
{
"$ref": "#/components/schemas/EnclosureDetail"
},
{
"type": "null"
}
]
},
"enclosureId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"enclosureUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"filterWheelIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"filterWheels": {
"default": [],
"items": {
"$ref": "#/components/schemas/FilterWheelDetail"
},
"type": "array"
},
"focuserIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"focusers": {
"default": [],
"items": {
"$ref": "#/components/schemas/FocuserDetail"
},
"type": "array"
},
"galleryItemIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"galleryItems": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/TelescopeGalleryItem"
},
"type": "array"
},
{
"type": "null"
}
]
},
"iauCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instruments": {
"default": [],
"items": {
"discriminator": {
"mapping": {
"optical_imager": "#/components/schemas/OpticalImagerDetail",
"radio_spectrometer": "#/components/schemas/RadioSpectrometerDetail"
},
"propertyName": "instrumentType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagerDetail"
},
{
"$ref": "#/components/schemas/RadioSpectrometerDetail"
}
]
},
"type": "array"
},
"ipCameraIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"ipCameras": {
"default": [],
"items": {
"$ref": "#/components/schemas/IPCamera"
},
"type": "array"
},
"isAvailable": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"latitudeDeg": {
"type": "number"
},
"localHorizon": {
"anyOf": [
{
"items": {
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
"type": "array"
},
{
"type": "null"
}
]
},
"location": {
"type": "string"
},
"longitudeDeg": {
"type": "number"
},
"mount": {
"anyOf": [
{
"$ref": "#/components/schemas/MountDetail"
},
{
"type": "null"
}
]
},
"mountId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"mountUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observatory": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservatoryWithoutTelescopes"
},
{
"type": "null"
}
]
},
"observatoryId": {
"type": "integer"
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"otaIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"otas": {
"default": [],
"items": {
"$ref": "#/components/schemas/OtaDetail"
},
"type": "array"
},
"owner": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/OrganizationPublic",
"user": "#/components/schemas/UserPublic"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/UserPublic"
},
{
"$ref": "#/components/schemas/OrganizationPublic"
}
]
},
{
"type": "null"
}
]
},
"ownerId": {
"type": "integer"
},
"publicLatitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"publicLongitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"radioBackendIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"radioBackends": {
"default": [],
"items": {
"$ref": "#/components/schemas/RadioBackendDetail"
},
"type": "array"
},
"receiverIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"receivers": {
"default": [],
"items": {
"$ref": "#/components/schemas/ReceiverDetail"
},
"type": "array"
},
"rotatorIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"rotators": {
"default": [],
"items": {
"$ref": "#/components/schemas/InstrumentRotatorDetail"
},
"type": "array"
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"slug": {
"type": "string"
},
"uid": {
"format": "uuid",
"type": "string"
}
},
"required": [
"uid",
"name",
"slug",
"location",
"elevationM",
"isAvailable",
"ownerId",
"observatoryId",
"latitudeDeg",
"longitudeDeg",
"isPublic"
],
"title": "TelescopeDetail",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/telescopes/{telescope_id}/enclosure
Read Entity Telescope Enclosure
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Responses
{
"deviceType": "string",
"diameterM": null,
"enclosurePolicy": "always_open_when_safe",
"enclosureType": "rolloff",
"hasRotation": true,
"hasShutter": true,
"id": null,
"idleCloseTimeoutSec": null,
"imageId": null,
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"slitWidthM": null,
"sunAltitudeOpenCondition": "OPEN_BELOW_THRESHOLD",
"sunAltitudeThresholdDeg": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "ced472f2-5d09-4edc-81bc-f4b16fb747f9",
"zenithOverlapAngleDeg": null
}
Schema of the response body
{
"properties": {
"deviceType": {
"const": "enclosure",
"type": "string"
},
"diameterM": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Diameter of the enclosure in meters."
},
"enclosurePolicy": {
"$ref": "#/components/schemas/EnclosurePolicy",
"description": "Enclosure policy for automatic opening/closing behavior."
},
"enclosureType": {
"$ref": "#/components/schemas/EnclosureType",
"description": ""
},
"hasRotation": {
"description": "",
"type": "boolean"
},
"hasShutter": {
"description": "",
"type": "boolean"
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The unique identifier for the device."
},
"idleCloseTimeoutSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Idle time in seconds before closing when open-for-tasks-only policy is active."
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Image asset ID for the device."
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"operationalConstraintIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Operational constraint PKs"
},
"ownerId": {
"description": "The organization or user which owns the device.",
"type": "integer"
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"slitWidthM": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Width of the dome slit in meters."
},
"sunAltitudeOpenCondition": {
"$ref": "#/components/schemas/SunAltitudeOpenCondition",
"description": "Condition that determines when to open based on sun altitude."
},
"sunAltitudeThresholdDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sun altitude threshold used to determine when to open (degrees)."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
},
"uid": {
"description": "The unique UID for the device.",
"format": "uuid",
"type": "string"
},
"zenithOverlapAngleDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Zenith overlap angle in degrees."
}
},
"required": [
"uid",
"ownerId",
"deviceType",
"hasRotation",
"hasShutter"
],
"title": "Enclosure",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PATCH /users/{entity_id_or_slug}/telescopes/{telescope_id}/enclosure
Update Entity Telescope Enclosure
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Request body
{
"deviceType": "string",
"diameterM": null,
"enclosurePolicy": null,
"enclosureType": null,
"hasRotation": null,
"hasShutter": null,
"idleCloseTimeoutSec": null,
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"serialNumber": null,
"slitWidthM": null,
"sunAltitudeOpenCondition": null,
"sunAltitudeThresholdDeg": null,
"telescopeId": null,
"telescopeUid": null,
"zenithOverlapAngleDeg": null
}
Schema of the request body
{
"properties": {
"deviceType": {
"const": "enclosure",
"type": "string"
},
"diameterM": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Diameter of the enclosure in meters."
},
"enclosurePolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/EnclosurePolicy"
},
{
"type": "null"
}
],
"description": "Enclosure policy for automatic opening/closing behavior."
},
"enclosureType": {
"anyOf": [
{
"$ref": "#/components/schemas/EnclosureType"
},
{
"type": "null"
}
],
"description": ""
},
"hasRotation": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": ""
},
"hasShutter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": ""
},
"idleCloseTimeoutSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Idle time in seconds before closing when open-for-tasks-only policy is active."
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"slitWidthM": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Width of the dome slit in meters."
},
"sunAltitudeOpenCondition": {
"anyOf": [
{
"$ref": "#/components/schemas/SunAltitudeOpenCondition"
},
{
"type": "null"
}
],
"description": "Condition that determines when to open based on sun altitude."
},
"sunAltitudeThresholdDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sun altitude threshold used to determine when to open (degrees)."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
},
"zenithOverlapAngleDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Zenith overlap angle in degrees."
}
},
"required": [
"deviceType"
],
"title": "EnclosureUpdate",
"type": "object"
}
Responses
{
"deviceType": "string",
"diameterM": null,
"enclosurePolicy": "always_open_when_safe",
"enclosureType": "rolloff",
"hasRotation": true,
"hasShutter": true,
"id": null,
"idleCloseTimeoutSec": null,
"imageId": null,
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"slitWidthM": null,
"sunAltitudeOpenCondition": "OPEN_BELOW_THRESHOLD",
"sunAltitudeThresholdDeg": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "485141ca-7562-4d6a-9872-5d35f11950da",
"zenithOverlapAngleDeg": null
}
Schema of the response body
{
"properties": {
"deviceType": {
"const": "enclosure",
"type": "string"
},
"diameterM": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Diameter of the enclosure in meters."
},
"enclosurePolicy": {
"$ref": "#/components/schemas/EnclosurePolicy",
"description": "Enclosure policy for automatic opening/closing behavior."
},
"enclosureType": {
"$ref": "#/components/schemas/EnclosureType",
"description": ""
},
"hasRotation": {
"description": "",
"type": "boolean"
},
"hasShutter": {
"description": "",
"type": "boolean"
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The unique identifier for the device."
},
"idleCloseTimeoutSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Idle time in seconds before closing when open-for-tasks-only policy is active."
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Image asset ID for the device."
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"operationalConstraintIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Operational constraint PKs"
},
"ownerId": {
"description": "The organization or user which owns the device.",
"type": "integer"
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"slitWidthM": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Width of the dome slit in meters."
},
"sunAltitudeOpenCondition": {
"$ref": "#/components/schemas/SunAltitudeOpenCondition",
"description": "Condition that determines when to open based on sun altitude."
},
"sunAltitudeThresholdDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sun altitude threshold used to determine when to open (degrees)."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
},
"uid": {
"description": "The unique UID for the device.",
"format": "uuid",
"type": "string"
},
"zenithOverlapAngleDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Zenith overlap angle in degrees."
}
},
"required": [
"uid",
"ownerId",
"deviceType",
"hasRotation",
"hasShutter"
],
"title": "Enclosure",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/telescopes/{telescope_id}/ip-cameras
Create Telescope Ip Camera
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Request body
{
"isPrimary": true,
"name": "string",
"onvifHost": null,
"order": 0,
"pose": null,
"ptz": true,
"role": "pier",
"secretRef": null,
"streams": [
{
"active": true,
"expiresSec": null,
"isPublic": true,
"kind": "rtsp",
"quality": null,
"urlTemplate": "string"
}
],
"vendor": null
}
Schema of the request body
{
"properties": {
"isPrimary": {
"default": false,
"type": "boolean"
},
"name": {
"type": "string"
},
"onvifHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"order": {
"default": 0,
"type": "integer"
},
"pose": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
]
},
"ptz": {
"default": false,
"type": "boolean"
},
"role": {
"$ref": "#/components/schemas/IPCameraRole",
"default": "pier"
},
"secretRef": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"streams": {
"default": [],
"items": {
"$ref": "#/components/schemas/IPCameraStreamCreate"
},
"type": "array"
},
"vendor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name"
],
"title": "IPCameraCreate",
"type": "object"
}
Responses
{
"id": null,
"isPrimary": true,
"lastSeen": null,
"name": "string",
"observatoryId": null,
"onvifHost": null,
"order": 0,
"pose": null,
"ptz": true,
"role": "pier",
"streams": [
{
"active": true,
"cameraId": 0,
"expiresSec": null,
"id": 0,
"isPublic": true,
"kind": "rtsp",
"quality": null
}
],
"telescopeId": null,
"uid": "054500a5-ce58-4caf-8baa-b6e335a9a617",
"vendor": null
}
Schema of the response body
{
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"isPrimary": {
"type": "boolean"
},
"lastSeen": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"onvifHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"order": {
"type": "integer"
},
"pose": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
]
},
"ptz": {
"type": "boolean"
},
"role": {
"$ref": "#/components/schemas/IPCameraRole"
},
"streams": {
"default": [],
"items": {
"$ref": "#/components/schemas/IPCameraStream"
},
"type": "array"
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"vendor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"uid",
"name",
"role",
"ptz",
"isPrimary",
"order"
],
"title": "IPCamera",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/telescopes/{telescope_id}/ip-cameras/{camera_id}/streams
Create Telescope Ip Camera Stream
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
camera_id |
path | integer | No | ||
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Request body
{
"active": true,
"expiresSec": null,
"isPublic": true,
"kind": "rtsp",
"quality": null,
"urlTemplate": "string"
}
Schema of the request body
{
"properties": {
"active": {
"default": true,
"type": "boolean"
},
"expiresSec": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"isPublic": {
"default": false,
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/StreamKind"
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/StreamQuality"
},
{
"type": "null"
}
]
},
"urlTemplate": {
"type": "string"
}
},
"required": [
"kind",
"urlTemplate"
],
"title": "IPCameraStreamCreate",
"type": "object"
}
Responses
{
"active": true,
"cameraId": 0,
"expiresSec": null,
"id": 0,
"isPublic": true,
"kind": "rtsp",
"quality": null
}
Schema of the response body
{
"properties": {
"active": {
"type": "boolean"
},
"cameraId": {
"type": "integer"
},
"expiresSec": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"id": {
"type": "integer"
},
"isPublic": {
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/StreamKind"
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/StreamQuality"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"cameraId",
"kind",
"isPublic",
"active"
],
"title": "IPCameraStream",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/telescopes/{telescope_id}/mount
Read Entity Telescope Mount
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Responses
{
"defaultPierSide": "east",
"deviceType": "string",
"id": null,
"imageId": null,
"manufacturer": null,
"maxSlewAccelerationAxis1DegPerSec2": null,
"maxSlewAccelerationAxis2DegPerSec2": null,
"maxSlewRateAxis1DegPerSec": 10.12,
"maxSlewRateAxis2DegPerSec": 10.12,
"maxSlewRateDegPerSec": 10.12,
"maxTrackingDurationSec": 10.12,
"meridianAvoidanceDeg": 10.12,
"meridianTrackingLimitDeg": 10.12,
"minAltitudeDeg": 10.12,
"modelId": null,
"mountType": "german_equatorial",
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintIds": null,
"ownerId": 0,
"pivotXM": 10.12,
"pivotYM": 10.12,
"pivotZM": 10.12,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "3c60927e-c99f-4333-9481-7d72bd63918b",
"zenithAvoidanceDeg": 10.12
}
Schema of the response body
{
"properties": {
"defaultPierSide": {
"$ref": "#/components/schemas/PierSide",
"description": ""
},
"deviceType": {
"const": "mount",
"type": "string"
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The unique identifier for the device."
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Image asset ID for the device."
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maxSlewAccelerationAxis1DegPerSec2": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": ""
},
"maxSlewAccelerationAxis2DegPerSec2": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": ""
},
"maxSlewRateAxis1DegPerSec": {
"description": "",
"type": "number"
},
"maxSlewRateAxis2DegPerSec": {
"description": "",
"type": "number"
},
"maxSlewRateDegPerSec": {
"description": "",
"type": "number"
},
"maxTrackingDurationSec": {
"description": "",
"type": "number"
},
"meridianAvoidanceDeg": {
"description": "",
"type": "number"
},
"meridianTrackingLimitDeg": {
"description": "",
"type": "number"
},
"minAltitudeDeg": {
"description": "",
"type": "number"
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"mountType": {
"$ref": "#/components/schemas/MountType",
"description": ""
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"operationalConstraintIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Operational constraint PKs"
},
"ownerId": {
"description": "The organization or user which owns the device.",
"type": "integer"
},
"pivotXM": {
"description": "X coordinate of the mount pivot in meters.",
"type": "number"
},
"pivotYM": {
"description": "Y coordinate of the mount pivot in meters.",
"type": "number"
},
"pivotZM": {
"description": "Z coordinate of the mount pivot in meters.",
"type": "number"
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
},
"uid": {
"description": "The unique UID for the device.",
"format": "uuid",
"type": "string"
},
"zenithAvoidanceDeg": {
"description": "",
"type": "number"
}
},
"required": [
"uid",
"ownerId",
"deviceType",
"meridianTrackingLimitDeg",
"maxTrackingDurationSec",
"maxSlewRateDegPerSec",
"maxSlewRateAxis1DegPerSec",
"maxSlewRateAxis2DegPerSec",
"meridianAvoidanceDeg",
"zenithAvoidanceDeg",
"minAltitudeDeg",
"pivotXM",
"pivotYM",
"pivotZM"
],
"title": "Mount",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PATCH /users/{entity_id_or_slug}/telescopes/{telescope_id}/mount
Update Entity Telescope Mount
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Request body
{
"defaultPierSide": null,
"deviceType": "string",
"manufacturer": null,
"maxSlewAccelerationAxis1DegPerSec2": null,
"maxSlewAccelerationAxis2DegPerSec2": null,
"maxSlewRateAxis1DegPerSec": 10.12,
"maxSlewRateAxis2DegPerSec": 10.12,
"maxSlewRateDegPerSec": null,
"maxTrackingDurationSec": null,
"meridianAvoidanceDeg": null,
"meridianTrackingLimitDeg": null,
"minAltitudeDeg": null,
"modelId": null,
"mountType": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"pivotXM": null,
"pivotYM": null,
"pivotZM": null,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"zenithAvoidanceDeg": null
}
Schema of the request body
{
"properties": {
"defaultPierSide": {
"anyOf": [
{
"$ref": "#/components/schemas/PierSide"
},
{
"type": "null"
}
],
"description": "Default pier side"
},
"deviceType": {
"const": "mount",
"type": "string"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maxSlewAccelerationAxis1DegPerSec2": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": ""
},
"maxSlewAccelerationAxis2DegPerSec2": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": ""
},
"maxSlewRateAxis1DegPerSec": {
"description": "",
"type": "number"
},
"maxSlewRateAxis2DegPerSec": {
"description": "",
"type": "number"
},
"maxSlewRateDegPerSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Maximum slew rate"
},
"maxTrackingDurationSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Maximum tracking duration"
},
"meridianAvoidanceDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Meridian avoidance"
},
"meridianTrackingLimitDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Meridian tracking limit"
},
"minAltitudeDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Minimum altitude"
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Mount model ID"
},
"mountType": {
"anyOf": [
{
"$ref": "#/components/schemas/MountType"
},
{
"type": "null"
}
],
"description": "Mount type"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"pivotXM": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Pivot X in meters"
},
"pivotYM": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Pivot Y in meters"
},
"pivotZM": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Pivot Z in meters"
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
},
"zenithAvoidanceDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Zenith avoidance"
}
},
"required": [
"deviceType",
"maxSlewRateAxis1DegPerSec",
"maxSlewRateAxis2DegPerSec"
],
"title": "MountUpdate",
"type": "object"
}
Responses
{
"defaultPierSide": "east",
"deviceType": "string",
"id": null,
"imageId": null,
"manufacturer": null,
"maxSlewAccelerationAxis1DegPerSec2": null,
"maxSlewAccelerationAxis2DegPerSec2": null,
"maxSlewRateAxis1DegPerSec": 10.12,
"maxSlewRateAxis2DegPerSec": 10.12,
"maxSlewRateDegPerSec": 10.12,
"maxTrackingDurationSec": 10.12,
"meridianAvoidanceDeg": 10.12,
"meridianTrackingLimitDeg": 10.12,
"minAltitudeDeg": 10.12,
"modelId": null,
"mountType": "german_equatorial",
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintIds": null,
"ownerId": 0,
"pivotXM": 10.12,
"pivotYM": 10.12,
"pivotZM": 10.12,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "bc228a98-2064-42d6-a176-4c33e04a4f24",
"zenithAvoidanceDeg": 10.12
}
Schema of the response body
{
"properties": {
"defaultPierSide": {
"$ref": "#/components/schemas/PierSide",
"description": ""
},
"deviceType": {
"const": "mount",
"type": "string"
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The unique identifier for the device."
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Image asset ID for the device."
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maxSlewAccelerationAxis1DegPerSec2": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": ""
},
"maxSlewAccelerationAxis2DegPerSec2": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": ""
},
"maxSlewRateAxis1DegPerSec": {
"description": "",
"type": "number"
},
"maxSlewRateAxis2DegPerSec": {
"description": "",
"type": "number"
},
"maxSlewRateDegPerSec": {
"description": "",
"type": "number"
},
"maxTrackingDurationSec": {
"description": "",
"type": "number"
},
"meridianAvoidanceDeg": {
"description": "",
"type": "number"
},
"meridianTrackingLimitDeg": {
"description": "",
"type": "number"
},
"minAltitudeDeg": {
"description": "",
"type": "number"
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"mountType": {
"$ref": "#/components/schemas/MountType",
"description": ""
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"operationalConstraintIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Operational constraint PKs"
},
"ownerId": {
"description": "The organization or user which owns the device.",
"type": "integer"
},
"pivotXM": {
"description": "X coordinate of the mount pivot in meters.",
"type": "number"
},
"pivotYM": {
"description": "Y coordinate of the mount pivot in meters.",
"type": "number"
},
"pivotZM": {
"description": "Z coordinate of the mount pivot in meters.",
"type": "number"
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
},
"uid": {
"description": "The unique UID for the device.",
"format": "uuid",
"type": "string"
},
"zenithAvoidanceDeg": {
"description": "",
"type": "number"
}
},
"required": [
"uid",
"ownerId",
"deviceType",
"meridianTrackingLimitDeg",
"maxTrackingDurationSec",
"maxSlewRateDegPerSec",
"maxSlewRateAxis1DegPerSec",
"maxSlewRateAxis2DegPerSec",
"meridianAvoidanceDeg",
"zenithAvoidanceDeg",
"minAltitudeDeg",
"pivotXM",
"pivotYM",
"pivotZM"
],
"title": "Mount",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/telescopes/{telescope_id}/operational-overview
Read Entity Telescope Operational Overview
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Responses
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/TelescopeOperationalOverview"
},
{
"type": "null"
}
],
"title": "Response Read Entity Telescope Operational Overview Users Entity Id Or Slug Telescopes Telescope Id Operational Overview Get"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/telescopes/{telescope_id}/radio-backend
Read Entity Telescope Radio Backend
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Responses
{
"description": null,
"deviceType": "string",
"id": null,
"imageId": null,
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "9c6d6f5b-23f7-4642-a781-7935006c7d9e"
}
Schema of the response body
{
"description": "Radio backend device.",
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Description"
},
"deviceType": {
"const": "radio_backend",
"type": "string"
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Radio backend PK"
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Image asset ID for the device."
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"operationalConstraintIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Operational constraint PKs"
},
"ownerId": {
"description": "The organization or user which owns the device.",
"type": "integer"
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
},
"uid": {
"description": "The unique UID for the device.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uid",
"ownerId",
"deviceType"
],
"title": "RadioBackend",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PATCH /users/{entity_id_or_slug}/telescopes/{telescope_id}/radio-backend
Update Entity Telescope Radio Backend
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Request body
{
"deviceType": "string",
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null
}
Schema of the request body
{
"properties": {
"deviceType": {
"const": "radio_backend",
"type": "string"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
}
},
"required": [
"deviceType"
],
"title": "RadioBackendUpdate",
"type": "object"
}
Responses
{
"description": null,
"deviceType": "string",
"id": null,
"imageId": null,
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "165dc23c-c19d-4c68-b09e-7ee62b4773c7"
}
Schema of the response body
{
"description": "Radio backend device.",
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Description"
},
"deviceType": {
"const": "radio_backend",
"type": "string"
},
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Radio backend PK"
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Image asset ID for the device."
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"operationalConstraintIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Operational constraint PKs"
},
"ownerId": {
"description": "The organization or user which owns the device.",
"type": "integer"
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
},
"uid": {
"description": "The unique UID for the device.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uid",
"ownerId",
"deviceType"
],
"title": "RadioBackend",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/telescopes/{telescope_id}/receiver
Read Entity Telescope Receiver
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Responses
{
"band": null,
"channels": [
{
"id": 0,
"isActive": true,
"offsetXArcsec": 10.12,
"offsetYArcsec": 10.12,
"polarization": "linear",
"receiverId": 0
}
],
"deviceType": "string",
"id": 0,
"imageId": null,
"isAvailable": true,
"manufacturer": null,
"maxFrequencyMhz": 10.12,
"minFrequencyMhz": 10.12,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "725da681-6024-4397-81d7-bf4ce2817fd0"
}
Schema of the response body
{
"description": "Radio receiver device.",
"properties": {
"band": {
"anyOf": [
{
"$ref": "#/components/schemas/RadioReceiverBand"
},
{
"type": "null"
}
],
"description": "Receiver band"
},
"channels": {
"description": "Receiver channels",
"items": {
"$ref": "#/components/schemas/ReceiverChannel"
},
"type": "array"
},
"deviceType": {
"const": "receiver",
"type": "string"
},
"id": {
"description": "Receiver PK",
"type": "integer"
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Image asset ID for the device."
},
"isAvailable": {
"description": "Is receiver available?",
"type": "boolean"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maxFrequencyMhz": {
"description": "Maximum frequency (MHz)",
"type": "number"
},
"minFrequencyMhz": {
"description": "Minimum frequency (MHz)",
"type": "number"
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"operationalConstraintIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Operational constraint PKs"
},
"ownerId": {
"description": "The organization or user which owns the device.",
"type": "integer"
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
},
"uid": {
"description": "The unique UID for the device.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"uid",
"ownerId",
"deviceType",
"isAvailable",
"minFrequencyMhz",
"maxFrequencyMhz"
],
"title": "Receiver",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PATCH /users/{entity_id_or_slug}/telescopes/{telescope_id}/receiver
Update Entity Telescope Receiver
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Request body
{
"deviceType": "string",
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null
}
Schema of the request body
{
"properties": {
"deviceType": {
"const": "receiver",
"type": "string"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
}
},
"required": [
"deviceType"
],
"title": "ReceiverUpdate",
"type": "object"
}
Responses
{
"band": null,
"channels": [
{
"id": 0,
"isActive": true,
"offsetXArcsec": 10.12,
"offsetYArcsec": 10.12,
"polarization": "linear",
"receiverId": 0
}
],
"deviceType": "string",
"id": 0,
"imageId": null,
"isAvailable": true,
"manufacturer": null,
"maxFrequencyMhz": 10.12,
"minFrequencyMhz": 10.12,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "be6e0a2b-6dc8-4e5c-91e3-dd547d93dc18"
}
Schema of the response body
{
"description": "Radio receiver device.",
"properties": {
"band": {
"anyOf": [
{
"$ref": "#/components/schemas/RadioReceiverBand"
},
{
"type": "null"
}
],
"description": "Receiver band"
},
"channels": {
"description": "Receiver channels",
"items": {
"$ref": "#/components/schemas/ReceiverChannel"
},
"type": "array"
},
"deviceType": {
"const": "receiver",
"type": "string"
},
"id": {
"description": "Receiver PK",
"type": "integer"
},
"imageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Image asset ID for the device."
},
"isAvailable": {
"description": "Is receiver available?",
"type": "boolean"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maxFrequencyMhz": {
"description": "Maximum frequency (MHz)",
"type": "number"
},
"minFrequencyMhz": {
"description": "Minimum frequency (MHz)",
"type": "number"
},
"modelId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the device."
},
"observatoryId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The observatory ID this device belongs to."
},
"observatoryUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The observatory UID this device belongs to."
},
"operationalConstraintIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Operational constraint PKs"
},
"ownerId": {
"description": "The organization or user which owns the device.",
"type": "integer"
},
"serialNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Serial number for the device."
},
"telescopeId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The telescope ID this device belongs to."
},
"telescopeUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The telescope UID this device belongs to."
},
"uid": {
"description": "The unique UID for the device.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"uid",
"ownerId",
"deviceType",
"isAvailable",
"minFrequencyMhz",
"maxFrequencyMhz"
],
"title": "Receiver",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/telescopes/{telescope_id}/state
Read Entity Telescope Snapshot
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
telescope_id |
path | No | Telescope id, uid, or slug | ||
token |
query | No |
Responses
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/TelescopeSnapshot"
},
{
"type": "null"
}
],
"title": "Response Read Entity Telescope Snapshot Users Entity Id Or Slug Telescopes Telescope Id State Get"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /users/{entity_id_or_slug}/tokens
Read User Tokens
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | |||
token |
query | No |
Responses
[
{
"client": null,
"description": null,
"expiresAt": null,
"id": "a9279084-d907-4c2d-9450-5cc826c67140",
"issuedAt": "2022-04-13T15:42:05.901Z",
"scope": null,
"tokenType": "access"
}
]
Schema of the response body
{
"items": {
"$ref": "#/components/schemas/TokenPublic"
},
"title": "Response Read User Tokens Users Entity Id Or Slug Tokens Get",
"type": "array"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /users/{entity_id_or_slug}/tokens
Create User Token
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | |||
token |
query | No |
Request body
{
"description": null
}
Schema of the request body
{
"description": "Request body for creating a new personal API token.",
"properties": {
"description": {
"anyOf": [
{
"maxLength": 255,
"type": "string"
},
{
"type": "null"
}
]
}
},
"title": "TokenCreate",
"type": "object"
}
Responses
{
"token": "string",
"tokenPublic": {
"client": null,
"description": null,
"expiresAt": null,
"id": "6de13faf-e8ec-4876-8ee6-7174f621b3e0",
"issuedAt": "2022-04-13T15:42:05.901Z",
"scope": null,
"tokenType": "access"
}
}
Schema of the response body
{
"description": "Response returned immediately after creating a token.",
"properties": {
"token": {
"type": "string"
},
"tokenPublic": {
"$ref": "#/components/schemas/TokenPublic"
}
},
"required": [
"token",
"tokenPublic"
],
"title": "TokenCreateResponse",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
DELETE /users/{entity_id_or_slug}/tokens/{token_id}
Delete User Token
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | |||
token |
query | No | |||
token_id |
path | string | No |
Responses
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
Schemas
AlertIntegration
| Name | Type | Description |
|---|---|---|
config |
||
cursor |
||
definitionId |
integer | |
externalAccountId |
||
externalAccountLabel |
||
id |
integer | |
installedByUserId |
||
integrationType |
string | |
isEnabled |
boolean | |
ownerId |
integer | |
sourceId |
||
status |
IntegrationStatus | |
streamConfig |
||
subscriptions |
Array<AlertSubscription> |
AlertIntegrationCreate
| Name | Type | Description |
|---|---|---|
config |
||
cursor |
||
definitionId |
integer | |
externalAccountId |
||
externalAccountLabel |
||
installedByUserId |
||
integrationType |
string | |
isEnabled |
boolean | |
secrets |
||
sourceId |
||
streamConfig |
AlertIntegrationUpdate
| Name | Type | Description |
|---|---|---|
config |
||
cursor |
||
externalAccountId |
||
externalAccountLabel |
||
installedByUserId |
||
integrationType |
string | |
isEnabled |
||
secrets |
||
sourceId |
||
status |
||
streamConfig |
AlertSubscription
| Name | Type | Description |
|---|---|---|
eventTypeHint |
||
id |
integer | |
integrationId |
integer | |
isEnabled |
boolean | |
matchExpression |
||
maxPerNight |
||
name |
string | |
priority |
integer | |
templateObservationIds |
Array<integer> |
AlertType
Type: string
Antenna
| Name | Type | Description |
|---|---|---|
apertureM |
number | |
deviceType |
string | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
AntennaCreate
| Name | Type | Description |
|---|---|---|
apertureM |
number | |
deviceType |
string | |
imageId |
Image asset ID for the device. | |
modelId |
||
name |
The name of the device. | |
observatoryUid |
UID of the observatory this device is attached to. | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeUid |
UID of the telescope this device is attached to. |
AntennaDetail
| Name | Type | Description |
|---|---|---|
apertureM |
number | |
deviceType |
string | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
AntennaUpdate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. |
AssetCreationMethod
Type: string
AuthType
Type: string
AutomationState
Type: string
BlackBodySpectralComponent
| Name | Type | Description |
|---|---|---|
id |
integer | |
spectralComponentType |
string | |
temperatureK |
number | The temperature of the black body. |
CalibrationMasterStrategy
Type: string
Camera
| Name | Type | Description |
|---|---|---|
arrayHeight |
integer | Number of physical pixels along the vertical axis. |
arrayWidth |
integer | Number of physical pixels along the horizontal axis. |
coolerIdleTimeoutSec |
number | Idle timeout in seconds before turning off the cooler. |
coolerPolicy |
CameraCoolerPolicy | Camera cooler policy for automatic temperature control. |
coolerPrestartLeadTimeSec |
number | Lead time in seconds to pre-cool before tasks. |
defaultBinning |
integer | Default binning factor for the camera. |
deviceType |
string | |
fullWellCapacityElectrons |
number | Unbinned full well capacity in electrons. |
hasElectronicShutter |
boolean | Whether the camera has an electronic shutter. |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
isColor |
boolean | Whether the camera is color or monochrome. |
isGlobalShutter |
boolean | Whether the camera is either a CCD or a global shutter CMOS. |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
pixelSizeUm |
number | Unbinned pixel size in microns. |
readoutModes |
||
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
temperatureSetpointC |
Target camera temperature setpoint in degrees Celsius. | |
temperatureSetpointToleranceC |
Allowed temperature tolerance in degrees Celsius. | |
uid |
string(uuid) | The unique UID for the device. |
CameraCoolerPolicy
Type: string
CameraCreate
| Name | Type | Description |
|---|---|---|
arrayHeight |
integer | Number of physical pixels along the vertical axis. |
arrayWidth |
integer | Number of physical pixels along the horizontal axis. |
coolerIdleTimeoutSec |
number | Idle timeout in seconds before turning off the cooler. |
coolerPolicy |
CameraCoolerPolicy | Camera cooler policy for automatic temperature control. |
coolerPrestartLeadTimeSec |
number | Lead time in seconds to pre-cool before tasks. |
defaultBinning |
integer | Default binning factor for the camera. |
deviceType |
string | |
fullWellCapacityElectrons |
number | Unbinned full well capacity in electrons. |
hasElectronicShutter |
boolean | Whether the camera has an electronic shutter. |
imageId |
Image asset ID for the device. | |
isColor |
boolean | Whether the camera is color or monochrome. |
isGlobalShutter |
boolean | Whether the camera is either a CCD or a global shutter CMOS. |
modelId |
||
name |
The name of the device. | |
observatoryUid |
UID of the observatory this device is attached to. | |
ownerId |
integer | The organization or user which owns the device. |
pixelSizeUm |
number | Unbinned pixel size in microns. |
serialNumber |
Serial number for the device. | |
telescopeUid |
UID of the telescope this device is attached to. | |
temperatureSetpointC |
Target camera temperature setpoint in degrees Celsius. | |
temperatureSetpointToleranceC |
Allowed temperature tolerance in degrees Celsius. |
CameraDetail
| Name | Type | Description |
|---|---|---|
arrayHeight |
integer | Number of physical pixels along the vertical axis. |
arrayWidth |
integer | Number of physical pixels along the horizontal axis. |
coolerIdleTimeoutSec |
number | Idle timeout in seconds before turning off the cooler. |
coolerPolicy |
CameraCoolerPolicy | Camera cooler policy for automatic temperature control. |
coolerPrestartLeadTimeSec |
number | Lead time in seconds to pre-cool before tasks. |
defaultBinning |
integer | Default binning factor for the camera. |
deviceType |
string | |
fullWellCapacityElectrons |
number | Unbinned full well capacity in electrons. |
hasElectronicShutter |
boolean | Whether the camera has an electronic shutter. |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
isColor |
boolean | Whether the camera is color or monochrome. |
isGlobalShutter |
boolean | Whether the camera is either a CCD or a global shutter CMOS. |
manufacturer |
||
model |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
pixelSizeUm |
number | Unbinned pixel size in microns. |
readoutModes |
||
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
temperatureSetpointC |
Target camera temperature setpoint in degrees Celsius. | |
temperatureSetpointToleranceC |
Allowed temperature tolerance in degrees Celsius. | |
uid |
string(uuid) | The unique UID for the device. |
CameraModel
| Name | Type | Description |
|---|---|---|
arrayHeight |
integer | |
arrayWidth |
integer | |
deviceType |
string | |
fullWellCapacity |
number | |
hasElectronicShutter |
boolean | |
id |
||
imageId |
||
isColor |
boolean | |
isGlobalShutter |
boolean | |
manufacturer |
||
modelName |
string | |
pixelSize |
number | |
readoutModes |
CameraReadoutMode
| Name | Type | Description |
|---|---|---|
binning |
integer | Binning factor for the readout mode. |
bitDepth |
integer | Bit depth for the readout mode. |
blankLevelCounts |
number | Blank level in counts. |
cameraId |
ID of the camera this readout mode belongs to. | |
cameraModelId |
ID of the camera model this readout mode belongs to. | |
darkCurrentElectronsPerSec |
number | Dark current in electrons/second at standard temperature. |
description |
string | Description of the readout mode. |
gainElectronsPerCount |
number | Inverse gain factor in electrons/count. |
hardwareId |
string | ID of the readout mode in the TCS backend. |
id |
integer | ID of the readout mode. |
isFastReadout |
boolean | Whether the readout mode is fast. |
isHdr |
boolean | Whether the readout mode is high dynamic range. |
isHighGain |
boolean | Whether the readout mode is high gain. |
isLdr |
boolean | Whether the readout mode is low dynamic range. |
isLowGain |
boolean | Whether the readout mode is low gain. |
isLowNoise |
boolean | Whether the readout mode is low noise. |
isNonRbiFlood |
boolean | Whether RBI flooding is disabled for the readout mode. |
isRbiFlood |
boolean | Whether RBI flooding is enabled for the readout mode. |
readoutNoiseElectrons |
number | Readout noise in electrons. |
readoutTimeSec |
number | Full-frame readout time in seconds. |
CameraUpdate
| Name | Type | Description |
|---|---|---|
arrayHeight |
Number of physical pixels along the vertical axis. | |
arrayWidth |
Number of physical pixels along the horizontal axis. | |
coolerIdleTimeoutSec |
Idle timeout in seconds before turning off the cooler. | |
coolerPolicy |
Camera cooler policy for automatic temperature control. | |
coolerPrestartLeadTimeSec |
Lead time in seconds to pre-cool before tasks. | |
deviceType |
string | |
fullWellCapacityElectrons |
Unbinned full well capacity in electrons. | |
hasElectronicShutter |
Whether the camera has an electronic shutter. | |
isColor |
Whether the camera is color or monochrome. | |
isGlobalShutter |
Whether the camera is either a CCD or a global shutter CMOS. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
pixelSizeUm |
Unbinned pixel size in microns. | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
temperatureSetpointC |
Target camera temperature setpoint in degrees Celsius. | |
temperatureSetpointToleranceC |
Allowed temperature tolerance in degrees Celsius. |
CatalogObjectType
Type: string
CatalogPosition
| Name | Type | Description |
|---|---|---|
catalogObject |
||
catalogObjectId |
integer | |
id |
integer | |
positionType |
string | |
targetId |
||
uid |
string(uuid) |
CatalogPositionCreate
| Name | Type | Description |
|---|---|---|
catalogObjectId |
integer | |
positionType |
string |
CoordinateType
Type: string
DataPolicy
Type: string
DeviceOperationalSnapshot
| Name | Type | Description |
|---|---|---|
id |
integer | |
resourceType |
string | |
resourceUid |
string(uuid) | |
status |
OperationalStatus | |
timestamp |
string(date-time) |
DeviceSortField
Type: string
DeviceType
Type: string
DitherStrategy
Type: string
DropboxIntegration
| Name | Type | Description |
|---|---|---|
config |
||
cursor |
||
definitionId |
integer | |
externalAccountId |
||
externalAccountLabel |
||
id |
integer | |
integrationType |
string | |
isEnabled |
boolean | |
namespaceId |
||
ownerId |
integer | |
rootPath |
||
status |
IntegrationStatus | |
teamId |
DropboxIntegrationCreate
| Name | Type | Description |
|---|---|---|
config |
||
cursor |
||
definitionId |
integer | |
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
boolean | |
namespaceId |
||
rootPath |
||
secrets |
||
teamId |
DropboxIntegrationUpdate
| Name | Type | Description |
|---|---|---|
config |
||
cursor |
||
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
||
namespaceId |
||
rootPath |
||
secrets |
||
status |
||
teamId |
EclipticCoordinates
| Name | Type | Description |
|---|---|---|
coordinateType |
string | Type of the coordinate system |
distanceAu |
Distance from origin in AU | |
epoch |
Epoch of observation | |
equinoxJyear |
Equinox of coordinates in Julian years | |
id |
integer | Primary key for the TargetCoordinates |
latDeg |
number | Ecliptic latitude in degrees |
lonDeg |
number | Ecliptic longitude in degrees |
pmLatMasPerYear |
Proper motion in latitude in mas/year | |
pmLonMasPerYear |
Proper motion in longitude times cos(lat) in mas/year | |
radialVelocityKmPerSec |
Radial velocity in km/s | |
type |
Type of ecliptic coordinates |
EclipticCoordinatesCreate
| Name | Type | Description |
|---|---|---|
coordinateType |
string | Type of the coordinate system |
distanceAu |
Distance from origin in AU | |
epoch |
Epoch of observation | |
equinoxJyear |
Equinox of coordinates in Julian years | |
latDeg |
number | Ecliptic latitude in degrees |
lonDeg |
number | Ecliptic longitude in degrees |
pmLatMasPerYear |
Proper motion in latitude in mas/year | |
pmLonMasPerYear |
Proper motion in longitude times cos(lat) in mas/year | |
radialVelocityKmPerSec |
Radial velocity in km/s | |
type |
Type of ecliptic coordinates |
EclipticCoordinateType
Type: string
EffectiveQuotaConstraint
| Name | Type | Description |
|---|---|---|
appliesReason |
string | |
controllerEntity |
||
controllerGroup |
||
depth |
integer | |
isShared |
boolean | |
quota |
EffectiveQuotaSnapshot | |
scopeLabel |
||
sourceAccountId |
integer | |
sourceAccountName |
||
sourceAccountSlug |
||
sourceGrantId |
||
sourceType |
string |
EffectiveQuotaSnapshot
| Name | Type | Description |
|---|---|---|
anchorAt |
||
createdOn |
string(date-time) | |
creditsRemainingInWindow |
number | |
creditsUsedInWindow |
number | |
currentWindowEnd |
||
currentWindowStart |
||
enabled |
boolean | |
id |
integer | |
maxCredits |
number | |
periodType |
ObservingQuotaPeriodType | |
startsAtLocalTime |
||
timezone |
string | |
updatedOn |
string(date-time) |
EffectiveShutdownInterlock
| Name | Type | Description |
|---|---|---|
expiresAt |
||
id |
integer | |
isEnabled |
boolean | |
lastModified |
||
name |
string | |
observatoryId |
||
observatoryUid |
||
ownerId |
integer | |
reason |
||
scopeType |
ShutdownInterlockScopeType | |
startsAt |
||
status |
ShutdownInterlockStatus | |
telescopeId |
||
telescopeUid |
||
uid |
string(uuid) |
Enclosure
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
diameterM |
Diameter of the enclosure in meters. | |
enclosurePolicy |
EnclosurePolicy | Enclosure policy for automatic opening/closing behavior. |
enclosureType |
EnclosureType | |
hasRotation |
boolean | |
hasShutter |
boolean | |
id |
The unique identifier for the device. | |
idleCloseTimeoutSec |
Idle time in seconds before closing when open-for-tasks-only policy is active. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
slitWidthM |
Width of the dome slit in meters. | |
sunAltitudeOpenCondition |
SunAltitudeOpenCondition | Condition that determines when to open based on sun altitude. |
sunAltitudeThresholdDeg |
Sun altitude threshold used to determine when to open (degrees). | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
zenithOverlapAngleDeg |
Zenith overlap angle in degrees. |
EnclosureCreate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
diameterM |
Diameter of the enclosure in meters. | |
enclosurePolicy |
Enclosure policy for automatic opening/closing behavior. | |
enclosureType |
EnclosureType | |
hasRotation |
boolean | |
hasShutter |
boolean | |
idleCloseTimeoutSec |
Idle time in seconds before closing when open-for-tasks-only policy is active. | |
imageId |
Image asset ID for the device. | |
modelId |
||
name |
The name of the device. | |
observatoryUid |
UID of the observatory this device is attached to. | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
slitWidthM |
Width of the dome slit in meters. | |
sunAltitudeOpenCondition |
Condition that determines when to open based on sun altitude. | |
sunAltitudeThresholdDeg |
Sun altitude threshold used to determine when to open (degrees). | |
telescopeUid |
UID of the telescope this device is attached to. | |
zenithOverlapAngleDeg |
Zenith overlap angle in degrees. |
EnclosureDetail
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
diameterM |
Diameter of the enclosure in meters. | |
enclosurePolicy |
EnclosurePolicy | Enclosure policy for automatic opening/closing behavior. |
enclosureType |
EnclosureType | |
hasRotation |
boolean | |
hasShutter |
boolean | |
id |
The unique identifier for the device. | |
idleCloseTimeoutSec |
Idle time in seconds before closing when open-for-tasks-only policy is active. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
model |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
slitWidthM |
Width of the dome slit in meters. | |
sunAltitudeOpenCondition |
SunAltitudeOpenCondition | Condition that determines when to open based on sun altitude. |
sunAltitudeThresholdDeg |
Sun altitude threshold used to determine when to open (degrees). | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
zenithOverlapAngleDeg |
Zenith overlap angle in degrees. |
EnclosureModel
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
diameterM |
||
enclosureType |
||
hasRotation |
boolean | |
hasShutter |
boolean | |
id |
||
imageId |
||
manufacturer |
||
modelName |
string | |
slitWidth |
||
zenithOverlapAngleDeg |
Zenith overlap angle in degrees. |
EnclosurePolicy
Type: string
EnclosureType
Type: string
EnclosureUpdate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
diameterM |
Diameter of the enclosure in meters. | |
enclosurePolicy |
Enclosure policy for automatic opening/closing behavior. | |
enclosureType |
||
hasRotation |
||
hasShutter |
||
idleCloseTimeoutSec |
Idle time in seconds before closing when open-for-tasks-only policy is active. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
serialNumber |
Serial number for the device. | |
slitWidthM |
Width of the dome slit in meters. | |
sunAltitudeOpenCondition |
Condition that determines when to open based on sun altitude. | |
sunAltitudeThresholdDeg |
Sun altitude threshold used to determine when to open (degrees). | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
zenithOverlapAngleDeg |
Zenith overlap angle in degrees. |
EphemeralPosition
| Name | Type | Description |
|---|---|---|
ephemeris |
Array<EphemerisRecord> | |
id |
integer | |
positionType |
string | |
targetId |
||
uid |
string(uuid) |
EphemeralPositionCreate
| Name | Type | Description |
|---|---|---|
positionType |
string |
EphemerisRecord
| Name | Type | Description |
|---|---|---|
coordinates |
||
coordinatesId |
||
epoch |
string(date-time) | |
id |
EquatorialCoordinates
| Name | Type | Description |
|---|---|---|
coordinateType |
string | Type of the coordinate system |
decDeg |
number | ICRS declination in degrees |
distancePc |
Distance in pc | |
epoch |
Epoch of observation | |
id |
integer | Primary key for the TargetCoordinates |
pmDecMasPerYear |
Proper motion in Dec in mas/year | |
pmRaMasPerYear |
Proper motion in RA times cos(Dec) in mas/year | |
raDeg |
number | ICRS right ascension in degrees |
radialVelocityKmPerSec |
Radial velocity in km/s |
EquatorialCoordinatesCreate
| Name | Type | Description |
|---|---|---|
coordinateType |
string | Type of the coordinate system |
decDeg |
number | ICRS declination in degrees |
distancePc |
Distance in pc | |
epoch |
Epoch of observation | |
pmDecMasPerYear |
Proper motion in Dec in mas/year | |
pmRaMasPerYear |
Proper motion in RA times cos(Dec) in mas/year | |
raDeg |
number | ICRS right ascension in degrees |
radialVelocityKmPerSec |
Radial velocity in km/s |
ExponentialTemporalComponent
| Name | Type | Description |
|---|---|---|
eventTime |
string(date-time) | UTC time of event. |
id |
integer | |
index |
number | The exponential decay index. |
referenceTimeSec |
number | Characteristic fading time in seconds. |
temporalComponentType |
string |
ExternallyManagedObservingGrantBase
| Name | Type | Description |
|---|---|---|
accountId |
integer | |
allowExternalDelegation |
boolean | |
creditsUsed |
||
entityId |
integer | |
grantType |
string | |
id |
integer | |
quotas |
||
revoked |
boolean |
File
| Name | Type | Description |
|---|---|---|
altTag |
||
bucket |
||
createdBy |
||
createdOn |
string(date-time) | |
id |
string(uuid) | |
isDataReady |
boolean | |
lastAccessedOn |
||
mimeType |
MimeType | |
name |
string | |
objectKey |
||
remoteUri |
||
renderSettings |
||
secretLinkKey |
||
sizeBytes |
||
storageType |
||
updatedOn |
string(date-time) | |
visibility |
FileVisibility |
FileCreate
| Name | Type | Description |
|---|---|---|
altTag |
||
bucket |
||
createdBy |
||
createdOn |
string(date-time) | |
isDataReady |
boolean | |
mimeType |
MimeType | |
name |
string | |
objectKey |
||
remoteUri |
||
renderSettings |
||
secretLinkKey |
||
size |
||
storageType |
||
updatedOn |
string(date-time) | |
visibility |
FileVisibility |
FileSummary
| Name | Type | Description |
|---|---|---|
altTag |
||
bucket |
||
createdBy |
||
createdOn |
string(date-time) | |
id |
string(uuid) | |
isDataReady |
boolean | |
lastAccessedOn |
||
mimeType |
MimeType | |
name |
string | |
objectKey |
||
remoteUri |
||
renderSettings |
||
secretLinkKey |
||
size |
||
storageType |
||
updatedOn |
string(date-time) | |
visibility |
FileVisibility |
FileUpdate
| Name | Type | Description |
|---|---|---|
bucket |
||
createdBy |
||
isDataReady |
||
objectKey |
||
remoteUri |
||
renderSettings |
||
secretLinkKey |
||
storageType |
||
visibility |
FileVisibility
Type: string
Filter
| Name | Type | Description |
|---|---|---|
bandpassNm |
Bandpass of the filter in nanometers | |
centralWavelengthNm |
Central wavelength of the filter in nanometers | |
filterSpecifierType |
string | |
flatExposureScaler |
Scale factor applied to the base twilight flat exposure time for this filter. | |
id |
string | Unique identifier of the filter specifier |
isModifier |
True if the filter is a modifier (e.g. polarizer) |
FilterShape
Type: string
FilterWheel
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
filterShape |
The shape of the filter slot | |
filterSizeMm |
The diameter of the filter slot if round the length of a side if square in millimeters | |
filterWheelPositionIds |
List of filter wheel position PKs | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
FilterWheelCreate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
imageId |
Image asset ID for the device. | |
modelId |
||
name |
The name of the device. | |
observatoryUid |
UID of the observatory this device is attached to. | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeUid |
UID of the telescope this device is attached to. |
FilterWheelDetail
| Name | Type | Description |
|---|---|---|
deletedPositions |
Deleted filter wheel positions when explicitly requested. | |
deviceType |
string | |
filterShape |
The shape of the filter slot | |
filterSizeMm |
The diameter of the filter slot if round the length of a side if square in millimeters | |
filterWheelPositionIds |
List of filter wheel position PKs | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
model |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
positions |
Array<FilterWheelPositionDetail> | List of filter wheel positions. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
FilterWheelModel
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
filterShape |
||
filterSize |
||
id |
||
imageId |
||
manufacturer |
||
modelName |
string |
FilterWheelPositionDetail
| Name | Type | Description |
|---|---|---|
filterIds |
Array<string> | Filter specifier IDs for this position. |
filters |
Array<Filter> | List of filters in this position |
filterWheelId |
integer | The ID of the filter wheel this position belongs to. |
filterWheelUid |
The UID of the filter wheel this position belongs to. | |
flatExposureScaler |
Initial twilight flat exposure scale in seconds for this filter wheel position. | |
focusOffset |
The focus offset in mm when this filter is in use. | |
id |
The unique identifier for the filter wheel position. | |
isActive |
boolean | Whether this filter wheel position is selectable. |
isDeleted |
boolean | Whether this filter wheel position is removed from the current configuration view. |
label |
The label of the filter wheel position. | |
position |
integer | The zero-based slot index of the filter wheel position. |
uid |
string(uuid) | The unique UID for the filter wheel position. |
FilterWheelPositionUpdate
| Name | Type | Description |
|---|---|---|
filterIds |
Filter specifier IDs for this position. | |
flatExposureScaler |
Initial twilight flat exposure scale in seconds for this filter wheel position. | |
focusOffset |
The focus offset in mm when this filter is in use. | |
id |
The unique identifier for the filter wheel position. | |
isActive |
Whether this filter wheel position is selectable. | |
isDeleted |
Whether this filter wheel position is removed from the current configuration view. | |
label |
string | The label of the filter wheel position. |
position |
integer | The zero-based slot index of the filter wheel position. |
FilterWheelUpdate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
positions |
List of filter wheel positions. | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. |
FixedPosition
| Name | Type | Description |
|---|---|---|
coordinates |
||
coordinatesId |
integer | |
id |
integer | |
positionType |
string | |
targetId |
||
uid |
string(uuid) |
FixedPositionCreate
| Name | Type | Description |
|---|---|---|
coordinates |
||
positionType |
string |
FlatFieldSource
Type: string
Focuser
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
maxPosition |
integer | Maximum focuser position. |
minPosition |
integer | Minimum focuser position. |
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
stepSize |
number | Size of each step, in the focuser driver's reported position units (e.g. microns for ASCOM, motor steps for others). |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
temperatureCompensated |
boolean | Whether temperature compensation is supported. |
uid |
string(uuid) | The unique UID for the device. |
FocuserCreate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
imageId |
Image asset ID for the device. | |
maxPosition |
integer | Maximum focuser position. |
minPosition |
integer | Minimum focuser position. |
modelId |
||
name |
The name of the device. | |
observatoryUid |
UID of the observatory this device is attached to. | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
stepSize |
number | Size of each step, in the focuser driver's reported position units (e.g. microns for ASCOM, motor steps for others). |
telescopeUid |
UID of the telescope this device is attached to. | |
temperatureCompensated |
boolean | Whether temperature compensation is supported. |
FocuserDetail
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
maxPosition |
integer | Maximum focuser position. |
minPosition |
integer | Minimum focuser position. |
model |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
stepSize |
number | Size of each step, in the focuser driver's reported position units (e.g. microns for ASCOM, motor steps for others). |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
temperatureCompensated |
boolean | Whether temperature compensation is supported. |
uid |
string(uuid) | The unique UID for the device. |
FocuserModel
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
id |
||
imageId |
||
manufacturer |
||
maxPosition |
integer | |
minPosition |
integer | |
modelName |
string | |
stepSize |
number | |
temperatureCompensated |
boolean |
FocuserUpdate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
manufacturer |
||
maxPosition |
Maximum focuser position. | |
minPosition |
Minimum focuser position. | |
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
serialNumber |
Serial number for the device. | |
stepSize |
Size of each step, in the focuser driver's reported position units (e.g. microns for ASCOM, motor steps for others). | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
temperatureCompensated |
Whether temperature compensation is supported. |
FocusTemperatureSource
Type: string
GalacticCoordinates
| Name | Type | Description |
|---|---|---|
coordinateType |
string | Type of the coordinate system |
distancePc |
Distance in pc | |
epoch |
Epoch of observation | |
id |
integer | Primary key for the TargetCoordinates |
latDeg |
number | Galactic latitude in degrees |
lonDeg |
number | Galactic longitude in degrees |
pmLatMasPerYear |
Proper motion in latitude in mas/year | |
pmLonMasPerYear |
Proper motion in longitude times cos(lat) in mas/year | |
radialVelocityKmPerSec |
Radial velocity in km/s |
GalacticCoordinatesCreate
| Name | Type | Description |
|---|---|---|
coordinateType |
string | Type of the coordinate system |
distancePc |
Distance in pc | |
epoch |
Epoch of observation | |
latDeg |
number | Galactic latitude in degrees |
lonDeg |
number | Galactic longitude in degrees |
pmLatMasPerYear |
Proper motion in latitude in mas/year | |
pmLonMasPerYear |
Proper motion in longitude times cos(lat) in mas/year | |
radialVelocityKmPerSec |
Radial velocity in km/s |
GoogleDriveDriveType
Type: string
GoogleDriveIntegration
| Name | Type | Description |
|---|---|---|
accountEmail |
||
config |
||
cursor |
||
definitionId |
integer | |
domain |
||
driveType |
||
externalAccountId |
||
externalAccountLabel |
||
id |
integer | |
integrationType |
string | |
isEnabled |
boolean | |
ownerId |
integer | |
status |
IntegrationStatus |
GoogleDriveIntegrationCreate
| Name | Type | Description |
|---|---|---|
accountEmail |
||
config |
||
cursor |
||
definitionId |
integer | |
domain |
||
driveType |
||
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
boolean | |
secrets |
GoogleDriveIntegrationUpdate
| Name | Type | Description |
|---|---|---|
accountEmail |
||
config |
||
cursor |
||
domain |
||
driveType |
||
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
||
secrets |
||
status |
GroupManagedObservingGrantBase
| Name | Type | Description |
|---|---|---|
accountId |
integer | |
creditsUsed |
||
grantType |
string | |
groupId |
integer | |
id |
integer | |
quotas |
||
revoked |
boolean |
GroupSummary
| Name | Type | Description |
|---|---|---|
allowDataPolicyOverride |
boolean | Whether overriding the data policy is allowed |
allowInvitations |
boolean | Whether invitations are allowed |
dataPolicy |
Data policy. | |
defaultRoleId |
Default role for users in this group. | |
description |
string | Description of the group |
id |
integer | Unique identifier of the group. |
memberCount |
Number of members in the group | |
name |
string | Name of the group |
organizationId |
Unique identifier of the organization to which the group belongs | |
slug |
string | Unique identifier used in URLs referencing the group. |
HorizontalCoordinates
| Name | Type | Description |
|---|---|---|
altDeg |
number | Altitude in degrees |
azDeg |
number | Azimuth in degrees |
coordinateType |
string | Type of the coordinate system |
epoch |
Epoch of observation | |
id |
integer | Primary key for the TargetCoordinates |
pmAltArcsecPerSec |
Proper motion in altitude in arcsec/s | |
pmAzArcsecPerSec |
Proper motion in azimuth times cos(alt) in arcsec/s |
HorizontalCoordinatesCreate
| Name | Type | Description |
|---|---|---|
altDeg |
number | Altitude in degrees |
azDeg |
number | Azimuth in degrees |
coordinateType |
string | Type of the coordinate system |
epoch |
Epoch of observation | |
pmAltArcsecPerSec |
Proper motion in altitude in arcsec/s | |
pmAzArcsecPerSec |
Proper motion in azimuth times cos(alt) in arcsec/s |
HTTPValidationError
| Name | Type | Description |
|---|---|---|
detail |
Array<ValidationError> |
InstrumentAccessMode
Type: string
InstrumentAssignmentMode
Type: string
InstrumentOperationalSnapshot
| Name | Type | Description |
|---|---|---|
id |
integer | |
resourceType |
string | |
resourceUid |
string(uuid) | |
status |
OperationalStatus | |
timestamp |
string(date-time) |
InstrumentRotator
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
InstrumentRotatorCreate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
imageId |
Image asset ID for the device. | |
modelId |
||
name |
The name of the device. | |
observatoryUid |
UID of the observatory this device is attached to. | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeUid |
UID of the telescope this device is attached to. |
InstrumentRotatorDetail
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
InstrumentRotatorUpdate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. |
IntegrationAvailability
| Name | Type | Description |
|---|---|---|
definition |
IntegrationDefinition | |
integration |
IntegrationCategory
Type: string
IntegrationDefinition
| Name | Type | Description |
|---|---|---|
authType |
AuthType | |
category |
IntegrationCategory | |
defaultConfig |
||
description |
||
displayName |
string | |
id |
integer | |
integrationType |
IntegrationType | |
managedBySystem |
boolean | |
supportsMultiple |
boolean | |
uiMeta |
IntegrationStatus
Type: string
IntegrationType
Type: string
IPCamera
| Name | Type | Description |
|---|---|---|
id |
||
isPrimary |
boolean | |
lastSeen |
||
name |
string | |
observatoryId |
||
onvifHost |
||
order |
integer | |
pose |
||
ptz |
boolean | |
role |
IPCameraRole | |
streams |
Array<IPCameraStream> | |
telescopeId |
||
uid |
string(uuid) | |
vendor |
IPCameraCreate
| Name | Type | Description |
|---|---|---|
isPrimary |
boolean | |
name |
string | |
onvifHost |
||
order |
integer | |
pose |
||
ptz |
boolean | |
role |
IPCameraRole | |
secretRef |
||
streams |
Array<IPCameraStreamCreate> | |
vendor |
IPCameraRole
Type: string
IPCameraStream
| Name | Type | Description |
|---|---|---|
active |
boolean | |
cameraId |
integer | |
expiresSec |
||
id |
integer | |
isPublic |
boolean | |
kind |
StreamKind | |
quality |
IPCameraStreamCreate
| Name | Type | Description |
|---|---|---|
active |
boolean | |
expiresSec |
||
isPublic |
boolean | |
kind |
StreamKind | |
quality |
||
urlTemplate |
string |
IterationIntervalType
Type: string
JPLPlanetName
Type: string
LunarPhaseDirection
Type: string
MajorSolarSystemObject
| Name | Type | Description |
|---|---|---|
catalogObjectType |
string | |
id |
integer | Primary key of the catalog object |
name |
MajorSolarSystemObjectName | Name of the major solar‑system object |
uid |
string(uuid) | Stable UUID of the catalog object |
MajorSolarSystemObjectName
Type: string
ManualControlLease
| Name | Type | Description |
|---|---|---|
createdAt |
Lease creation timestamp (UTC). | |
expiresAt |
Lease expiration timestamp (UTC). | |
id |
integer | Manual control lease identifier. |
ownerId |
integer | Entity ID that owns the lease. |
reason |
Optional reason for taking manual control. | |
status |
Lease lifecycle status. | |
telescopeId |
integer | Telescope associated with this lease. |
ManualControlLeaseState
Type: string
MimeType
Type: string
Mount
| Name | Type | Description |
|---|---|---|
defaultPierSide |
PierSide | |
deviceType |
string | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
maxSlewAccelerationAxis1DegPerSec2 |
||
maxSlewAccelerationAxis2DegPerSec2 |
||
maxSlewRateAxis1DegPerSec |
number | |
maxSlewRateAxis2DegPerSec |
number | |
maxSlewRateDegPerSec |
number | |
maxTrackingDurationSec |
number | |
meridianAvoidanceDeg |
number | |
meridianTrackingLimitDeg |
number | |
minAltitudeDeg |
number | |
modelId |
||
mountType |
MountType | |
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
pivotXM |
number | X coordinate of the mount pivot in meters. |
pivotYM |
number | Y coordinate of the mount pivot in meters. |
pivotZM |
number | Z coordinate of the mount pivot in meters. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
zenithAvoidanceDeg |
number |
MountCreate
| Name | Type | Description |
|---|---|---|
defaultPierSide |
PierSide | |
deviceType |
string | |
imageId |
Image asset ID for the device. | |
maxSlewAccelerationAxis1DegPerSec2 |
||
maxSlewAccelerationAxis2DegPerSec2 |
||
maxSlewRateAxis1DegPerSec |
number | |
maxSlewRateAxis2DegPerSec |
number | |
maxSlewRateDegPerSec |
number | |
maxTrackingDurationSec |
number | |
meridianAvoidanceDeg |
number | |
meridianTrackingLimitDeg |
number | |
minAltitudeDeg |
number | |
modelId |
||
mountType |
MountType | |
name |
The name of the device. | |
observatoryUid |
UID of the observatory this device is attached to. | |
ownerId |
integer | The organization or user which owns the device. |
pivotXM |
number | X coordinate of the mount pivot in meters. |
pivotYM |
number | Y coordinate of the mount pivot in meters. |
pivotZM |
number | Z coordinate of the mount pivot in meters. |
serialNumber |
Serial number for the device. | |
telescopeUid |
UID of the telescope this device is attached to. | |
zenithAvoidanceDeg |
number |
MountDetail
| Name | Type | Description |
|---|---|---|
defaultPierSide |
PierSide | |
deviceType |
string | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
maxSlewAccelerationAxis1DegPerSec2 |
||
maxSlewAccelerationAxis2DegPerSec2 |
||
maxSlewRateAxis1DegPerSec |
number | |
maxSlewRateAxis2DegPerSec |
number | |
maxSlewRateDegPerSec |
number | |
maxTrackingDurationSec |
number | |
meridianAvoidanceDeg |
number | |
meridianTrackingLimitDeg |
number | |
minAltitudeDeg |
number | |
model |
||
modelId |
||
mountType |
MountType | |
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
pivotXM |
number | X coordinate of the mount pivot in meters. |
pivotYM |
number | Y coordinate of the mount pivot in meters. |
pivotZM |
number | Z coordinate of the mount pivot in meters. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
zenithAvoidanceDeg |
number |
MountModel
| Name | Type | Description |
|---|---|---|
defaultPierSide |
PierSide | |
deviceType |
string | |
id |
||
imageId |
||
manufacturer |
||
maxSlewAccelerationAxis1DegPerSec2 |
||
maxSlewAccelerationAxis2DegPerSec2 |
||
maxSlewRateAxis1DegPerSec |
number | |
maxSlewRateAxis2DegPerSec |
number | |
meridianTrackingLimitDeg |
number | |
modelName |
string | |
mountType |
MountType |
MountType
Type: string
MountUpdate
| Name | Type | Description |
|---|---|---|
defaultPierSide |
Default pier side | |
deviceType |
string | |
manufacturer |
||
maxSlewAccelerationAxis1DegPerSec2 |
||
maxSlewAccelerationAxis2DegPerSec2 |
||
maxSlewRateAxis1DegPerSec |
number | |
maxSlewRateAxis2DegPerSec |
number | |
maxSlewRateDegPerSec |
Maximum slew rate | |
maxTrackingDurationSec |
Maximum tracking duration | |
meridianAvoidanceDeg |
Meridian avoidance | |
meridianTrackingLimitDeg |
Meridian tracking limit | |
minAltitudeDeg |
Minimum altitude | |
modelId |
Mount model ID | |
mountType |
Mount type | |
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
pivotXM |
Pivot X in meters | |
pivotYM |
Pivot Y in meters | |
pivotZM |
Pivot Z in meters | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
zenithAvoidanceDeg |
Zenith avoidance |
MpcComet
| Name | Type | Description |
|---|---|---|
argumentOfPerihelionDeg |
number | Argument of perihelion in degrees |
catalogObjectType |
string | |
designation |
Comet designation | |
eccentricity |
number | Orbital eccentricity |
id |
integer | Primary key of the catalog object |
inclinationDeg |
number | Inclination in degrees |
longitudeOfAscendingNodeDeg |
number | Longitude of ascending node in degrees |
name |
string | Comet name |
number |
Comet number | |
orbitType |
string | Orbit type |
perihelionDistanceAu |
number | Perihelion distance in AU |
perihelionEpochJyear |
number | Epoch of perihelion in Julian years |
uid |
string(uuid) | Stable UUID of the catalog object |
MpcOrbit
| Name | Type | Description |
|---|---|---|
argumentOfPerihelionDeg |
number | Argument of perihelion in degrees |
catalogObjectType |
string | |
designation |
string | Orbit designation |
eccentricity |
number | Orbital eccentricity |
epochJyear |
number | Epoch of elements in Julian years |
gMag |
G magnitude | |
hMag |
H magnitude | |
id |
integer | Primary key of the catalog object |
inclinationDeg |
number | Inclination in degrees |
longitudeOfAscendingNodeDeg |
number | Longitude of ascending node in degrees |
meanAnomalyDeg |
number | Mean anomaly in degrees |
name |
string | Name of the orbited object |
number |
Orbit number | |
semimajorAxisAu |
number | Semimajor axis in AU |
uid |
string(uuid) | Stable UUID of the catalog object |
NoradSatellite
| Name | Type | Description |
|---|---|---|
catalogObjectType |
string | |
classification |
string | Satellite classification |
id |
integer | Primary key of the catalog object |
internationalDesignator |
International Designator (COSPAR ID) | |
name |
Satellite name | |
omm |
Orbit Mean‑Elements Message fields | |
satelliteCatalogNumber |
integer | NORAD catalog number |
tle |
Two‑ or Three‑Line Elements | |
uid |
string(uuid) | Stable UUID of the catalog object |
Observation
| Name | Type | Description |
|---|---|---|
cancelOn |
||
completedOn |
||
createdOn |
string(date-time) | Creation timestamp. |
creatorId |
integer | User who created it. |
creatorUid |
||
currentIteration |
integer | |
groupUid |
||
id |
integer | Unique identifier of the observation. |
instrumentAssignmentMode |
InstrumentAssignmentMode | |
instrumentIds |
||
instrumentLockTimeoutSec |
number | |
instrumentMode |
InstrumentAccessMode | |
interruptLowerPriority |
boolean | Interrupt lower priority. |
isDeleted |
boolean | Flag indicating if deleted. |
isPublic |
boolean | |
iterationInterval |
number | |
iterationIntervalType |
IterationIntervalType | |
iterations |
integer | |
kind |
ObservationKind | |
lastActivityOn |
||
name |
string | Name of the observation. |
observabilityLastUpdatedOn |
Timestamp of the last observability refresh. | |
observingBlockPolicy |
ObservingBlockPolicy | How observation tasks should be grouped into uninterrupted scheduling blocks. |
observingGrantIds |
||
opticalImagingConfiguration |
||
originalId |
Unique identifier of the observation forked from. | |
originalUid |
||
ownerId |
integer | Entity that funds this observation. |
ownerUid |
||
priority |
integer | |
progressFraction |
number | |
radioMappingConfiguration |
||
radioTrackingConfiguration |
||
requestTypes |
Array<ObservationType> | |
startAfter |
||
status |
ObservationStatus | |
targetId |
Unique identifier of the target associated with the observation. | |
targetUid |
||
uid |
string(uuid) | |
updatedOn |
string(date-time) | Update timestamp. |
ObservationCreate
| Name | Type | Description |
|---|---|---|
cancelOn |
||
completedOn |
||
instrumentAssignmentMode |
||
instrumentIds |
||
instrumentLockTimeoutSec |
||
instrumentMode |
||
interruptLowerPriority |
||
isDeleted |
||
isPublic |
||
iterationInterval |
||
iterationIntervalType |
||
iterations |
||
kind |
||
lastActivityOn |
||
name |
string | |
observingBlockPolicy |
||
observingGrantIds |
||
opticalImagingConfiguration |
||
originalId |
||
ownerId |
integer | |
priority |
||
progressFraction |
||
radioMappingConfiguration |
||
radioTrackingConfiguration |
||
renderSettings |
||
requests |
||
startAfter |
||
status |
||
target |
ObservationGalleryItem
| Name | Type | Description |
|---|---|---|
file |
||
fileId |
string(uuid) | |
id |
integer | |
observationId |
integer | |
observationUid |
||
order |
||
visibility |
boolean |
ObservationKind
Type: string
ObservationPositionOffsetFrame
Type: string
ObservationRequestStatus
Type: string
ObservationSortField
Type: string
ObservationStatus
Type: string
ObservationSummary
| Name | Type | Description |
|---|---|---|
cancelOn |
||
completedOn |
||
createdOn |
string(date-time) | Creation timestamp. |
creator |
||
creatorId |
integer | User who created it. |
creatorUid |
||
currentIteration |
integer | |
galleryItems |
||
groupUid |
||
id |
integer | Unique identifier of the observation. |
instrumentAssignmentMode |
InstrumentAssignmentMode | |
instrumentIds |
||
instrumentLockTimeoutSec |
number | |
instrumentMode |
InstrumentAccessMode | |
interruptLowerPriority |
boolean | Interrupt lower priority. |
isDeleted |
boolean | Flag indicating if deleted. |
isPublic |
boolean | |
iterationInterval |
number | |
iterationIntervalType |
IterationIntervalType | |
iterations |
integer | |
kind |
ObservationKind | |
lastActivityOn |
||
name |
string | Name of the observation. |
observabilityLastUpdatedOn |
Timestamp of the last observability refresh. | |
observingBlockPolicy |
ObservingBlockPolicy | How observation tasks should be grouped into uninterrupted scheduling blocks. |
observingGrantIds |
||
opticalImagingConfiguration |
||
originalId |
Unique identifier of the observation forked from. | |
originalUid |
||
owner |
||
ownerId |
integer | Entity that funds this observation. |
ownerUid |
||
priority |
integer | |
progressFraction |
number | |
radioMappingConfiguration |
||
radioTrackingConfiguration |
||
requestTypes |
Array<ObservationType> | |
startAfter |
||
status |
ObservationStatus | |
target |
||
targetId |
Unique identifier of the target associated with the observation. | |
targetUid |
||
uid |
string(uuid) | |
updatedOn |
string(date-time) | Update timestamp. |
ObservationTrackingMode
Type: string
ObservationType
Type: string
Observatory
| Name | Type | Description |
|---|---|---|
countryCode |
string | |
description |
||
elevationM |
number | |
galleryItemIds |
||
iauCode |
||
id |
||
imageId |
||
ipCameraIds |
||
isAvailable |
boolean | |
isPublic |
boolean | |
latitudeDeg |
number | |
location |
string | |
longitudeDeg |
number | |
name |
string | |
ownerId |
integer | |
publicLatitudeDeg |
||
publicLongitudeDeg |
||
shortName |
||
siteId |
||
siteUid |
||
slug |
string | |
telescopeIds |
||
uid |
string(uuid) | |
weatherSensorIds |
ObservatoryCreate
| Name | Type | Description |
|---|---|---|
countryCode |
string | |
description |
||
elevationM |
number | |
iauCode |
||
imageId |
||
isAvailable |
boolean | |
isPublic |
||
latitudeDeg |
number | |
location |
string | |
longitudeDeg |
number | |
name |
string | |
ownerId |
integer | |
shortName |
||
siteId |
ObservatoryDetail
| Name | Type | Description |
|---|---|---|
countryCode |
string | |
description |
||
elevationM |
number | |
galleryItemIds |
||
galleryItems |
Array<ObservatoryGalleryItem> | |
iauCode |
||
id |
||
imageId |
||
ipCameraIds |
||
ipCameras |
Array<IPCamera> | |
isAvailable |
boolean | |
isPublic |
boolean | |
latitudeDeg |
number | |
location |
string | |
longitudeDeg |
number | |
name |
string | |
owner |
||
ownerId |
integer | |
publicLatitudeDeg |
||
publicLongitudeDeg |
||
shortName |
||
site |
||
siteId |
||
siteUid |
||
slug |
string | |
telescopeIds |
||
telescopes |
Array<TelescopeSummary> | |
uid |
string(uuid) | |
weatherSensorIds |
||
weatherSensors |
Array<WeatherSensor> |
ObservatoryGalleryItem
| Name | Type | Description |
|---|---|---|
file |
||
fileId |
string(uuid) | |
id |
integer | |
observatoryId |
integer | |
order |
||
visibility |
boolean |
ObservatoryOperationalSnapshot
| Name | Type | Description |
|---|---|---|
id |
integer | |
resourceType |
string | |
resourceUid |
string(uuid) | |
status |
OperationalStatus | |
timestamp |
string(date-time) |
ObservatorySummary
| Name | Type | Description |
|---|---|---|
countryCode |
string | |
description |
||
elevationM |
number | |
galleryItemIds |
||
iauCode |
||
id |
||
imageId |
||
ipCameraIds |
||
isAvailable |
boolean | |
isPublic |
boolean | |
latitudeDeg |
number | |
location |
string | |
longitudeDeg |
number | |
name |
string | |
owner |
||
ownerId |
integer | |
publicLatitudeDeg |
||
publicLongitudeDeg |
||
shortName |
||
site |
||
siteId |
||
siteUid |
||
slug |
string | |
telescopeIds |
||
uid |
string(uuid) | |
weatherSensorIds |
ObservatoryUpdate
| Name | Type | Description |
|---|---|---|
countryCode |
||
description |
||
elevationM |
||
iauCode |
||
imageId |
||
isAvailable |
||
isPublic |
||
latitudeDeg |
||
location |
||
longitudeDeg |
||
name |
||
ownerId |
||
shortName |
||
siteId |
||
siteUid |
||
slug |
ObservatoryWithoutTelescopes
| Name | Type | Description |
|---|---|---|
countryCode |
string | |
description |
||
elevationM |
number | |
galleryItemIds |
||
galleryItems |
Array<ObservatoryGalleryItem> | |
iauCode |
||
id |
||
imageId |
||
ipCameraIds |
||
ipCameras |
Array<IPCamera> | |
isAvailable |
boolean | |
isPublic |
boolean | |
latitudeDeg |
number | |
location |
string | |
longitudeDeg |
number | |
name |
string | |
owner |
||
ownerId |
integer | |
publicLatitudeDeg |
||
publicLongitudeDeg |
||
shortName |
||
site |
||
siteId |
||
siteUid |
||
slug |
string | |
telescopeIds |
||
telescopes |
Array<TelescopeSummary> | |
uid |
string(uuid) | |
weatherSensorIds |
||
weatherSensors |
Array<WeatherSensor> |
ObservingAccount
| Name | Type | Description |
|---|---|---|
creditsUsed |
||
id |
integer | |
isDeleted |
boolean | |
lastActivityOn |
||
managingGroupId |
||
name |
||
observingPolicyId |
||
order |
integer | |
ownerId |
integer | |
path |
||
queueAccessGrantIds |
||
quotas |
||
slug |
||
sourceAccountGrantId |
||
sourceAccountId |
ObservingAccountCreate
| Name | Type | Description |
|---|---|---|
managingGroupId |
||
name |
||
observingPolicyId |
||
order |
integer | |
ownerId |
integer | |
queueAccessGrantIds |
Array<integer> | |
sourceAccountId |
ObservingAccountDetail
| Name | Type | Description |
|---|---|---|
creditsUsed |
||
effectiveQueueAccessGrants |
||
id |
integer | |
isDeleted |
boolean | |
lastActivityOn |
||
managingGroup |
||
managingGroupId |
||
name |
||
observingPolicy |
||
observingPolicyId |
||
order |
integer | |
owner |
||
ownerId |
integer | |
path |
||
queueAccessGrantIds |
||
quotas |
||
slug |
||
sourceAccountGrant |
||
sourceAccountGrantId |
||
sourceAccountId |
||
sponsor |
||
upstreamQuotaConstraints |
ObservingAccountQuota
| Name | Type | Description |
|---|---|---|
accountId |
integer | |
anchorAt |
||
createdOn |
string(date-time) | |
creditsRemainingInWindow |
number | |
creditsUsedInWindow |
number | |
currentWindowEnd |
||
currentWindowStart |
||
enabled |
boolean | |
id |
integer | |
maxCredits |
number | |
periodType |
ObservingQuotaPeriodType | |
startsAtLocalTime |
||
timezone |
string | |
updatedOn |
string(date-time) |
ObservingAccountSortField
Type: string
ObservingAccountSummary
| Name | Type | Description |
|---|---|---|
creditsUsed |
||
effectiveQueueAccessGrants |
||
id |
integer | |
isDeleted |
boolean | |
lastActivityOn |
||
managingGroup |
||
managingGroupId |
||
name |
||
observingPolicy |
||
observingPolicyId |
||
order |
integer | |
owner |
||
ownerId |
integer | |
path |
||
queueAccessGrantIds |
||
quotas |
||
slug |
||
sourceAccountGrantId |
||
sourceAccountId |
||
sponsor |
ObservingBlockPolicy
Type: string
ObservingDataPolicy
Type: string
ObservingGrantQuota
| Name | Type | Description |
|---|---|---|
anchorAt |
||
createdOn |
string(date-time) | |
creditsRemainingInWindow |
number | |
creditsUsedInWindow |
number | |
currentWindowEnd |
||
currentWindowStart |
||
enabled |
boolean | |
grantId |
integer | |
id |
integer | |
maxCredits |
number | |
periodType |
ObservingQuotaPeriodType | |
startsAtLocalTime |
||
timezone |
string | |
updatedOn |
string(date-time) |
ObservingPolicySummary
| Name | Type | Description |
|---|---|---|
allowedCatalogObjectTypes |
||
allowedCoordinateTypes |
||
allowedDataPolicies |
Array<ObservingDataPolicy> | |
allowedRequestTypes |
Array<ObservationType> | |
allowedTargetPositionTypes |
||
allowHiddenObservation |
boolean | |
allowHiddenTelemetry |
boolean | |
dataPublicAfter |
||
description |
||
id |
integer | |
name |
string | |
organizationId |
integer |
ObservingQueueAccessGrantSummary
| Name | Type | Description |
|---|---|---|
effectiveOrder |
integer | |
id |
integer | |
observingPolicyId |
||
order |
integer | |
queue |
||
queueId |
integer | |
revoked |
boolean | |
telescopeAccessGrant |
||
telescopeAccessGrantId |
integer | |
timeContested |
number | |
timeUsed |
number | |
timeWaiting |
number |
ObservingQueueAccessPrioritization
Type: string
ObservingQueueSummary
| Name | Type | Description |
|---|---|---|
accessPrioritization |
ObservingQueueAccessPrioritization | |
canInterrupt |
boolean | |
description |
string | |
enabled |
boolean | |
id |
integer | |
name |
string | |
order |
integer | |
slug |
string | |
telescope |
||
telescopeId |
integer |
ObservingQuotaPeriodType
Type: string
OperationalConstraintAction
| Name | Type | Description |
|---|---|---|
action |
OperationalConstraintActionType | |
deviceId |
integer | |
deviceUid |
||
id |
||
operationalConstraintId |
integer | |
priority |
integer | |
triggerOnStabilizing |
boolean | |
triggerOnUnknown |
boolean | |
triggerOnUnsafe |
boolean | |
uid |
string(uuid) |
OperationalConstraintActionType
Type: string
OperationalStatus
Type: string
OpticalImagerCalibrationConfiguration
| Name | Type | Description |
|---|---|---|
biasMaxSunElevationDeg |
number | Maximum allowed Sun elevation for bias calibrations (degrees) |
biasMinSunElevationDeg |
number | Minimum allowed Sun elevation for bias calibrations (degrees) |
calibrationIntervalHours |
number | Desired interval between calibration observations (hours) |
darkExposureTimes |
Array<number> | Dark exposure times to collect, in seconds. |
darkMaxSunElevationDeg |
number | Maximum allowed Sun elevation for dark calibrations (degrees) |
darkMinSunElevationDeg |
number | Minimum allowed Sun elevation for dark calibrations (degrees) |
flatFieldSource |
FlatFieldSource | Flat field illumination source |
flatToleranceFraction |
number | Fractional tolerance for flat-field average counts |
imagerId |
integer | Optical imager ID |
maxExposureTimeSec |
number | Maximum acceptable exposure time for flats (seconds) |
minExposureTimeSec |
number | Minimum acceptable exposure time for flats (seconds) |
numBiases |
integer | Number of bias frames |
numDarks |
integer | Number of dark frames |
numFlats |
integer | Number of flat frames |
screenFlatEnclosureAzimuthDeg |
Enclosure azimuth for enclosure-screen flats (degrees) | |
screenFlatMaxSunElevationDeg |
number | Maximum allowed Sun elevation for enclosure-screen flat calibrations (degrees) |
screenFlatMinSunElevationDeg |
number | Minimum allowed Sun elevation for enclosure-screen flat calibrations (degrees) |
screenFlatMountAltitudeDeg |
Mount altitude for enclosure-screen flats (degrees) | |
screenFlatMountAzimuthDeg |
Mount azimuth for enclosure-screen flats (degrees) | |
targetFullWellFraction |
number | Target fraction of full well depth for flats |
twilightFlatMaxSunElevationDeg |
number | Maximum allowed Sun elevation for twilight flat calibrations (degrees) |
twilightFlatMinSunElevationDeg |
number | Minimum allowed Sun elevation for twilight flat calibrations (degrees) |
OpticalImagerDetail
| Name | Type | Description |
|---|---|---|
calibrationConfiguration |
Calibration configuration | |
calibrationMasterStrategy |
CalibrationMasterStrategy | How calibration masters are produced |
camera |
Camera details | |
cameraId |
integer | Camera PK |
cameraUid |
Camera UID | |
configurationUpdatedOn |
string(date-time) | Timestamp of last scheduling-relevant configuration update |
configurationVersion |
integer | Monotonic scheduling configuration version |
filterCombinations |
Allowed filter combos | |
filterWheelIds |
Array<integer> | Filter Wheel PKs |
filterWheels |
Array<FilterWheelDetail> | |
filterWheelUids |
Filter Wheel UIDs | |
focuser |
Focuser details | |
focuserId |
Focuser PK | |
focuserUid |
Focuser UID | |
focusReferenceTemperatureC |
Reference temperature for focus calibration | |
focusTemperatureCompensationEnabled |
boolean | Whether focus temperature compensation is enabled |
focusTemperatureSlope |
Focus slope (position units per degree) | |
focusTemperatureSource |
Temperature source for focus compensation | |
focusZeroPoint |
Focuser position at reference temperature | |
fov |
FOV (width, height) in degrees | |
id |
Instrument PK | |
instrumentRotator |
Instrument rotator details | |
instrumentRotatorId |
Instrument rotator PK | |
instrumentRotatorUid |
Instrument rotator UID | |
instrumentType |
string | Optical imager |
isActive |
boolean | Is active? |
name |
string | Instrument name |
ota |
OTA details | |
otaId |
integer | OTA PK |
otaUid |
OTA UID | |
pixelScale |
Pixel scale (arcsec/pixel) | |
seeingArcsec |
number | Seeing (arcsec) |
skyParams |
Sky parameters | |
telescope |
Telescope | |
telescopeId |
integer | Owning telescope PK |
telescopeUid |
Owning telescope UID | |
uid |
string(uuid) | Instrument UID |
weatherSensorId |
Weather sensor PK for ambient focus compensation | |
weatherSensorUid |
Weather sensor UID for ambient focus compensation |
OpticalImagingBiasCalibrationRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
expiresOn |
||
instrumentId |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
||
temperatureBand |
OpticalImagingConfiguration-Input
| Name | Type | Description |
|---|---|---|
brightnessModel |
||
brightnessModelId |
||
ditherPositionAngleDeg |
||
ditherSteps |
||
ditherStepSizeDeg |
||
ditherStrategy |
DitherStrategy | |
fieldLockedOn |
||
imageNormalizationSettingsId |
||
lunarPhaseDirection |
||
maxElevationDeg |
||
maxMoonPhaseFraction |
||
maxPixelScaleArcsecPerPx |
||
maxSunElevationDeg |
||
maxTiles |
integer | |
minElevationDeg |
||
minFovXArcmin |
||
minFovYArcmin |
||
minMoonPhaseFraction |
||
minMoonSeparationDeg |
||
minPixelScaleArcsecPerPx |
||
minSunElevationDeg |
||
positionAngleDeg |
||
recenteringThreshold |
||
saturationModel |
||
saturationModelId |
||
temporalOffsetSec |
number | |
tileOverlap |
number | |
trackingMode |
ObservationTrackingMode |
OpticalImagingConfiguration-Output
| Name | Type | Description |
|---|---|---|
brightnessModel |
||
brightnessModelId |
||
ditherPositionAngleDeg |
||
ditherSteps |
||
ditherStepSizeDeg |
||
ditherStrategy |
DitherStrategy | |
fieldLockedOn |
||
imageNormalizationSettingsId |
||
lunarPhaseDirection |
||
maxElevationDeg |
||
maxMoonPhaseFraction |
||
maxPixelScaleArcsecPerPx |
||
maxSunElevationDeg |
||
maxTiles |
integer | |
minElevationDeg |
||
minFovXArcmin |
||
minFovYArcmin |
||
minMoonPhaseFraction |
||
minMoonSeparationDeg |
||
minPixelScaleArcsecPerPx |
||
minSunElevationDeg |
||
positionAngleDeg |
||
recenteringThreshold |
||
saturationModel |
||
saturationModelId |
||
temporalOffsetSec |
number | |
tileOverlap |
number | |
trackingMode |
ObservationTrackingMode |
OpticalImagingDarkCalibrationRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
expiresOn |
||
exposureTimeSec |
||
instrumentId |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
||
temperatureBand |
OpticalImagingFlatCalibrationRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
expiresOn |
||
filterIds |
||
instrumentId |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
maxExposureTimeSec |
||
minExposureTimeSec |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
||
targetFullWellFraction |
||
temperatureBand |
OpticalImagingRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
allowBinning |
||
allowCoadding |
||
allowRegistration |
||
createdOn |
||
electronicShutter |
||
exposureTimeSec |
||
fastReadout |
||
filterSpecifierIds |
||
globalShutter |
||
hdr |
||
highGain |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
maxBitDepth |
||
minBitDepth |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
rbiFlood |
||
requestType |
string | |
status |
||
targetFullWellFraction |
||
targetSnr |
OrbitalPosition
| Name | Type | Description |
|---|---|---|
argumentOfPerihelionDeg |
number | |
eccentricity |
number | |
epochJyear |
number | |
id |
integer | |
inclinationDeg |
number | |
longitudeOfAscendingNodeDeg |
number | |
meanAnomalyDeg |
number | |
orbitType |
OrbitType | |
positionType |
string | |
semilatusRectumAu |
number | |
targetId |
||
uid |
string(uuid) |
OrbitalPositionCreate
| Name | Type | Description |
|---|---|---|
argumentOfPerihelionDeg |
number | |
eccentricity |
number | |
epochJyear |
number | |
inclinationDeg |
number | |
longitudeOfAscendingNodeDeg |
number | |
meanAnomalyDeg |
number | |
orbitType |
OrbitType | |
positionType |
string | |
semilatusRectumAu |
number |
OrbitType
Type: string
OrcidIntegration
| Name | Type | Description |
|---|---|---|
accessScopes |
Array<string> | |
config |
||
cursor |
||
definitionId |
integer | |
externalAccountId |
||
externalAccountLabel |
||
id |
integer | |
integrationType |
string | |
isEnabled |
boolean | |
orcid |
||
ownerId |
integer | |
refreshExpiresAt |
||
status |
IntegrationStatus |
OrcidIntegrationCreate
| Name | Type | Description |
|---|---|---|
accessScopes |
Array<string> | |
config |
||
cursor |
||
definitionId |
integer | |
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
boolean | |
orcid |
||
refreshExpiresAt |
||
secrets |
OrcidIntegrationUpdate
| Name | Type | Description |
|---|---|---|
accessScopes |
||
config |
||
cursor |
||
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
||
orcid |
||
refreshExpiresAt |
||
secrets |
||
status |
Organization
| Name | Type | Description |
|---|---|---|
allowRequestToJoin |
boolean | Whether request-to-join is allowed |
country |
Country provided by the user or organization in their public profile | |
createdOn |
Creation time of this account | |
defaultRoleId |
Default role for users in this organization. | |
description |
Description/Bio provided by the user or organization in their public profile | |
entityType |
string | |
id |
integer | Unique identifier of the user/organization. |
location |
Location provided by the user or organization in their public profile | |
memberCount |
Number of members in the organization | |
name |
string | Name of the user/organization. |
observingPolicyIds |
Observing policy PKs configured for the organization. | |
profileImageId |
Profile image of the user/organization. | |
shortName |
Short name of the organization | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
websiteUrl |
Website URL provided by the user or organization in their public profile |
OrganizationPublic
| Name | Type | Description |
|---|---|---|
allowRequestToJoin |
boolean | Whether request-to-join is allowed |
country |
Country provided by the user or organization in their public profile | |
createdOn |
Creation time of this account | |
defaultRoleId |
Default role for users in this organization. | |
description |
Description/Bio provided by the user or organization in their public profile | |
entityType |
string | |
id |
integer | Unique identifier of the user/organization. |
location |
Location provided by the user or organization in their public profile | |
memberCount |
Number of members in the organization | |
name |
string | Name of the user/organization. |
observingPolicyIds |
Observing policy PKs configured for the organization. | |
profileImageId |
Profile image of the user/organization. | |
shortName |
Short name of the organization | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
websiteUrl |
Website URL provided by the user or organization in their public profile |
OrganizationSummary
| Name | Type | Description |
|---|---|---|
allowRequestToJoin |
boolean | Whether request-to-join is allowed |
country |
Country provided by the user or organization in their public profile | |
createdOn |
Creation time of this account | |
defaultRoleId |
Default role for users in this organization. | |
description |
Description/Bio provided by the user or organization in their public profile | |
entityType |
string | |
id |
integer | Unique identifier of the user/organization. |
location |
Location provided by the user or organization in their public profile | |
memberCount |
Number of members in the organization | |
name |
string | Name of the user/organization. |
observingPolicyIds |
Observing policy PKs configured for the organization. | |
profileImageId |
Profile image of the user/organization. | |
shortName |
Short name of the organization | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
websiteUrl |
Website URL provided by the user or organization in their public profile |
Ota
| Name | Type | Description |
|---|---|---|
apertureM |
number | Unobstructed aperture of the OTA in meters. |
deviceType |
string | |
focalLengthM |
number | Focal length of the OTA in meters. |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
offsetScalar |
Distance from mount pivot to OTA axis in meters along mount reference axis. | |
offsetXM |
X offset from parent OTA axis in meters. | |
offsetYM |
Y offset from parent OTA axis in meters. | |
offsetZM |
Z offset from parent OTA axis in meters. | |
operationalConstraintIds |
Operational constraint PKs | |
opticalDesign |
||
ownerId |
integer | The organization or user which owns the device. |
parentOta |
||
parentOtaId |
ID of the parent OTA if piggybacked. | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
OtaCreate
| Name | Type | Description |
|---|---|---|
apertureM |
number | Unobstructed aperture of the OTA in meters. |
deviceType |
string | |
focalLengthM |
number | Focal length of the OTA in meters. |
imageId |
Image asset ID for the device. | |
modelId |
||
name |
The name of the device. | |
observatoryUid |
UID of the observatory this device is attached to. | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeUid |
UID of the telescope this device is attached to. |
OtaDetail
| Name | Type | Description |
|---|---|---|
apertureM |
number | Unobstructed aperture of the OTA in meters. |
deviceType |
string | |
focalLengthM |
number | Focal length of the OTA in meters. |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
model |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
offsetScalar |
Distance from mount pivot to OTA axis in meters along mount reference axis. | |
offsetXM |
X offset from parent OTA axis in meters. | |
offsetYM |
Y offset from parent OTA axis in meters. | |
offsetZM |
Z offset from parent OTA axis in meters. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
opticalDesign |
||
ownerId |
integer | The organization or user which owns the device. |
parentOta |
||
parentOtaId |
ID of the parent OTA if piggybacked. | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
OtaModel
| Name | Type | Description |
|---|---|---|
apertureM |
number | |
deviceType |
string | |
focalLength |
number | |
id |
||
imageId |
||
manufacturer |
||
modelName |
string | |
opticalDesign |
OtaUpdate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. |
Page_Annotated_Union_AlertIntegration__S3MinioIntegration__TreasureMapIntegration__GoogleDriveIntegration__DropboxIntegration__OrcidIntegration__SlackIntegrationFieldInfoannotation_NoneTyperequired_True__discriminator__integration_type____
| Name | Type | Description |
|---|---|---|
items |
Array<> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_Annotated_Union_Antenna__Focuser__Camera__Enclosure__FilterWheel__InstrumentRotator__Mount__Ota__RadioBackend__Receiver__WeatherSensorFieldInfoannotation_NoneTyperequired_True__discriminator__device_type____
| Name | Type | Description |
|---|---|---|
items |
Array<> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_IntegrationAvailability_
| Name | Type | Description |
|---|---|---|
items |
Array<IntegrationAvailability> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_ObservationSummary_
| Name | Type | Description |
|---|---|---|
items |
Array<ObservationSummary> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_ObservatorySummary_
| Name | Type | Description |
|---|---|---|
items |
Array<ObservatorySummary> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_ObservingAccountSummary_
| Name | Type | Description |
|---|---|---|
items |
Array<ObservingAccountSummary> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_TelescopeSummary_
| Name | Type | Description |
|---|---|---|
items |
Array<TelescopeSummary> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
PierSide
Type: string
PlanetarySatellite
| Name | Type | Description |
|---|---|---|
bsp |
string | Name of the SPK ephemeris file |
catalogObjectType |
string | |
id |
integer | Primary key of the catalog object |
name |
string | Name of the satellite |
number |
integer | The JPL number of the satellite |
planet |
JPLPlanetName | Central planet of the satellite |
uid |
string(uuid) | Stable UUID of the catalog object |
PolarizationType
Type: string
PowerLawSpectralComponent
| Name | Type | Description |
|---|---|---|
id |
integer | |
index |
number | The power law decay index. |
spectralComponentType |
string |
PowerLawTemporalComponent
| Name | Type | Description |
|---|---|---|
eventTime |
string(date-time) | UTC time of event. |
id |
integer | |
index |
number | The power law decay index. |
referenceTimeSec |
number | Characteristic fading time in seconds. |
temporalComponentType |
string |
RadioBackend
| Name | Type | Description |
|---|---|---|
description |
Description | |
deviceType |
string | |
id |
Radio backend PK | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
RadioBackendCreate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
imageId |
Image asset ID for the device. | |
modelId |
||
name |
The name of the device. | |
observatoryUid |
UID of the observatory this device is attached to. | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeUid |
UID of the telescope this device is attached to. |
RadioBackendDetail
| Name | Type | Description |
|---|---|---|
description |
Description | |
deviceType |
string | |
id |
Radio backend PK | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
RadioBackendUpdate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. |
RadioCoordinateUnit
Type: string
RadioMappingConfiguration
| Name | Type | Description |
|---|---|---|
coordinateUnit |
RadioCoordinateUnit | |
daisyDiameter |
||
densityAlongSweeps |
number | |
densityBetweenSweeps |
||
integrationTimeSec |
||
mappingStrategy |
RadioMappingStrategy | |
maxSunElevationDeg |
number | |
minElevationDeg |
number | |
minSunSeparationDeg |
number | |
rasterSizeXDeg |
||
rasterSizeYDeg |
||
slewSpeedDegPerSec |
||
sweepDirection |
RadioMappingRasterDirection
Type: string
RadioMappingRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
createdOn |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
minResolutionMhz |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
polarization |
||
requestType |
string | |
spectroscopyWindows |
||
status |
RadioMappingStrategy
Type: string
RadioReceiverBand
Type: string
RadioReceiverChannelBackendConnection
| Name | Type | Description |
|---|---|---|
id |
integer | Connection PK |
isActive |
boolean | Is active? |
radioBackendId |
integer | Radio backend PK |
receiverChannelId |
integer | Receiver channel PK |
RadioSpectrometerDetail
| Name | Type | Description |
|---|---|---|
antenna |
Antenna details | |
antennaId |
Antenna PK | |
antennaUid |
Antenna UID | |
beamwidth |
Beamwidth (degrees) | |
channelBackendConnections |
Array<RadioReceiverChannelBackendConnection> | Receiver channel to backend connections |
configurationUpdatedOn |
string(date-time) | Timestamp of last scheduling-relevant configuration update |
configurationVersion |
integer | Monotonic scheduling configuration version |
id |
Instrument PK | |
instrumentType |
string | Radio spectrometer |
isActive |
boolean | Is active? |
name |
string | Instrument name |
receiverIds |
Receiver PKs | |
receivers |
Receivers | |
telescope |
Telescope | |
telescopeId |
integer | Owning telescope PK |
telescopeUid |
Owning telescope UID | |
uid |
string(uuid) | Instrument UID |
RadioSpectroscopyWindowCreate
| Name | Type | Description |
|---|---|---|
bandwidthMhz |
number | |
centerFrequencyMhz |
number |
RadioTrackingConfiguration
| Name | Type | Description |
|---|---|---|
coordinateUnit |
||
maxSunElevationDeg |
number | |
minElevationDeg |
number | |
minSunSeparationDeg |
number | |
offOffsetX |
||
offOffsetY |
||
trackingStrategy |
RadioTrackingStrategy |
RadioTrackingRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
createdOn |
||
duration |
number | |
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
maxIntegrationTimeMs |
||
minResolutionMhz |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
polarization |
||
requestType |
string | |
requireContinuum |
boolean | |
spectroscopyWindows |
||
status |
RadioTrackingStrategy
Type: string
Receiver
| Name | Type | Description |
|---|---|---|
band |
Receiver band | |
channels |
Array<ReceiverChannel> | Receiver channels |
deviceType |
string | |
id |
integer | Receiver PK |
imageId |
Image asset ID for the device. | |
isAvailable |
boolean | Is receiver available? |
manufacturer |
||
maxFrequencyMhz |
number | Maximum frequency (MHz) |
minFrequencyMhz |
number | Minimum frequency (MHz) |
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
ReceiverChannel
| Name | Type | Description |
|---|---|---|
id |
integer | Receiver channel PK |
isActive |
boolean | Is active? |
offsetXArcsec |
number | Offset in X (arcsec) |
offsetYArcsec |
number | Offset in Y (arcsec) |
polarization |
PolarizationType | Polarization type |
receiverId |
integer | Receiver PK |
ReceiverCreate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
imageId |
Image asset ID for the device. | |
isAvailable |
boolean | Is receiver available? |
maxFrequencyMhz |
number | Maximum frequency (MHz) |
minFrequencyMhz |
number | Minimum frequency (MHz) |
modelId |
||
name |
The name of the device. | |
observatoryUid |
UID of the observatory this device is attached to. | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeUid |
UID of the telescope this device is attached to. |
ReceiverDetail
| Name | Type | Description |
|---|---|---|
band |
Receiver band | |
channels |
Array<ReceiverChannel> | Receiver channels |
deviceType |
string | |
id |
integer | Receiver PK |
imageId |
Image asset ID for the device. | |
isAvailable |
boolean | Is receiver available? |
manufacturer |
||
maxFrequencyMhz |
number | Maximum frequency (MHz) |
minFrequencyMhz |
number | Minimum frequency (MHz) |
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
ReceiverUpdate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. |
RenderNormalization
| Name | Type | Description |
|---|---|---|
backgroundPercentile |
number | Percentile used for the background level. |
midtonePercentile |
number | Percentile used for the midtone level. |
saturationPercentile |
number | Percentile used for the saturation level. |
stretch |
string | Stretch algorithm to apply. |
RenderPalette
| Name | Type | Description |
|---|---|---|
colormap |
string | Colormap name. |
invert |
boolean | Whether to invert the colormap. |
nan |
string | How to render NaN values. |
RenderSettings
| Name | Type | Description |
|---|---|---|
normalization |
RenderNormalization | |
rendering |
RenderPalette | |
schemaVersion |
integer | Render settings schema version. |
S3MinioIntegration
| Name | Type | Description |
|---|---|---|
bucket |
||
config |
||
cursor |
||
definitionId |
integer | |
endpointUrl |
||
externalAccountId |
||
externalAccountLabel |
||
id |
integer | |
integrationType |
string | |
isEnabled |
boolean | |
ownerId |
integer | |
pathStyle |
boolean | |
publicBaseUrl |
||
region |
||
status |
IntegrationStatus |
S3MinioIntegrationCreate
| Name | Type | Description |
|---|---|---|
bucket |
||
config |
||
cursor |
||
definitionId |
integer | |
endpointUrl |
||
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
boolean | |
pathStyle |
boolean | |
publicBaseUrl |
||
region |
||
secrets |
S3MinioIntegrationUpdate
| Name | Type | Description |
|---|---|---|
bucket |
||
config |
||
cursor |
||
endpointUrl |
||
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
||
pathStyle |
||
publicBaseUrl |
||
region |
||
secrets |
||
status |
ShutdownInterlockScopeType
Type: string
ShutdownInterlockSnapshotStatus
Type: string
ShutdownInterlockStatus
Type: string
SiteSummary
| Name | Type | Description |
|---|---|---|
countryCode |
string | |
elevationM |
number | |
iauCode |
||
id |
||
latitudeDeg |
number | |
location |
string | |
longitudeDeg |
number | |
name |
string | |
owner |
||
ownerId |
||
slug |
string | |
uid |
string(uuid) |
SkyBrightnessModel
| Name | Type | Description |
|---|---|---|
id |
integer | Primary key |
modelType |
string |
SkynetStorageType
Type: string
SlackIntegration
| Name | Type | Description |
|---|---|---|
botTokenScopes |
Array<string> | |
botUserId |
||
config |
||
cursor |
||
defaultChannelId |
||
definitionId |
integer | |
externalAccountId |
||
externalAccountLabel |
||
id |
integer | |
integrationType |
string | |
isEnabled |
boolean | |
ownerId |
integer | |
status |
IntegrationStatus | |
teamId |
||
teamName |
SlackIntegrationCreate
| Name | Type | Description |
|---|---|---|
botTokenScopes |
Array<string> | |
botUserId |
||
config |
||
cursor |
||
defaultChannelId |
||
definitionId |
integer | |
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
boolean | |
secrets |
||
teamId |
||
teamName |
SlackIntegrationUpdate
| Name | Type | Description |
|---|---|---|
botTokenScopes |
||
botUserId |
||
config |
||
cursor |
||
defaultChannelId |
||
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
||
secrets |
||
status |
||
teamId |
||
teamName |
SourceBrightnessModel
| Name | Type | Description |
|---|---|---|
avMag |
number | Absolute V-band extinction |
filter |
||
filterId |
Filter used as reference | |
id |
integer | Primary key |
isPointSource |
boolean | True if point source, False if extended |
magnitudeMag |
number | Point source magnitude or extended source surface brightness |
modelType |
string | |
rv |
number | Ratio of total to selective extinction |
spectralComponent |
||
spectralComponentId |
Associated spectral component | |
temporalComponent |
||
temporalComponentId |
Associated temporal component |
StreamKind
Type: string
StreamQuality
Type: string
SunAltitudeOpenCondition
Type: string
Target
| Name | Type | Description |
|---|---|---|
id |
integer | Primary key for the Target |
isDeleted |
boolean | Flag indicating if the target is deleted |
kind |
ObservationKind | Lifecycle classification for the target |
name |
string | Name of the Target |
originalId |
Original target id | |
positionId |
Primary key of the target's position. Resolved through the graph bundle's `target_positions` map. | |
positionOffsetFrame |
ObservationPositionOffsetFrame | |
positionOffsetReferenceTime |
||
positionOffsetXDeg |
number | |
positionOffsetYDeg |
number | |
status |
TargetStatus | Status of the target |
targetPosition |
TargetAcquisitionPhase
Type: string
TargetCreate
| Name | Type | Description |
|---|---|---|
isDeleted |
||
kind |
||
name |
string | |
originalId |
||
position |
||
positionOffsetFrame |
ObservationPositionOffsetFrame | |
positionOffsetReferenceTime |
||
positionOffsetXDeg |
number | |
positionOffsetYDeg |
number | |
status |
TargetPositionType
Type: string
TargetStatus
Type: string
TaskPhase
Type: string
Telescope
| Name | Type | Description |
|---|---|---|
antennaIds |
||
calibrationObservingAccountId |
||
cameraIds |
||
description |
||
deviceIds |
||
elevationM |
number | |
enclosureId |
||
enclosureUid |
||
filterWheelIds |
||
focuserIds |
||
galleryItemIds |
||
iauCode |
||
id |
||
imageId |
||
instrumentIds |
||
ipCameraIds |
||
isAvailable |
boolean | |
isPublic |
boolean | |
latitudeDeg |
number | |
location |
string | |
longitudeDeg |
number | |
mountId |
||
mountUid |
||
name |
string | |
observatoryId |
integer | |
observatoryUid |
||
otaIds |
||
ownerId |
integer | |
publicLatitudeDeg |
||
publicLongitudeDeg |
||
radioBackendIds |
||
receiverIds |
||
rotatorIds |
||
shortName |
||
slug |
string | |
uid |
string(uuid) |
TelescopeAccessGrant
| Name | Type | Description |
|---|---|---|
entityId |
||
id |
integer | |
revoked |
boolean | |
shares |
number | |
telescopeId |
integer | |
timeContested |
number | |
timeUsed |
number | |
timeWaiting |
number |
TelescopeControlAuthority
Type: string
TelescopeCreate
| Name | Type | Description |
|---|---|---|
description |
||
elevationM |
number | |
enclosureId |
||
enclosureUid |
||
iauCode |
||
imageId |
||
isAvailable |
boolean | |
isPublic |
||
latitudeDeg |
number | |
localHorizon |
||
location |
string | |
longitudeDeg |
number | |
mountId |
||
mountUid |
||
name |
string | |
observatoryId |
integer | |
ownerId |
integer | |
shortName |
TelescopeDetail
| Name | Type | Description |
|---|---|---|
antennaIds |
||
antennas |
Array<AntennaDetail> | |
calibrationObservingAccountId |
||
cameraIds |
||
cameras |
Array<CameraDetail> | |
description |
||
deviceIds |
||
elevationM |
number | |
enclosure |
||
enclosureId |
||
enclosureUid |
||
filterWheelIds |
||
filterWheels |
Array<FilterWheelDetail> | |
focuserIds |
||
focusers |
Array<FocuserDetail> | |
galleryItemIds |
||
galleryItems |
||
iauCode |
||
id |
||
imageId |
||
instrumentIds |
||
instruments |
Array<> | |
ipCameraIds |
||
ipCameras |
Array<IPCamera> | |
isAvailable |
boolean | |
isPublic |
boolean | |
latitudeDeg |
number | |
localHorizon |
||
location |
string | |
longitudeDeg |
number | |
mount |
||
mountId |
||
mountUid |
||
name |
string | |
observatory |
||
observatoryId |
integer | |
observatoryUid |
||
otaIds |
||
otas |
Array<OtaDetail> | |
owner |
||
ownerId |
integer | |
publicLatitudeDeg |
||
publicLongitudeDeg |
||
radioBackendIds |
||
radioBackends |
Array<RadioBackendDetail> | |
receiverIds |
||
receivers |
Array<ReceiverDetail> | |
rotatorIds |
||
rotators |
Array<InstrumentRotatorDetail> | |
shortName |
||
slug |
string | |
uid |
string(uuid) |
TelescopeGalleryItem
| Name | Type | Description |
|---|---|---|
file |
||
fileId |
string(uuid) | |
id |
integer | |
order |
||
telescopeId |
integer | |
visibility |
boolean |
TelescopeLtd
| Name | Type | Description |
|---|---|---|
antennaIds |
||
calibrationObservingAccountId |
||
cameraIds |
||
description |
||
deviceIds |
||
elevationM |
number | |
enclosureId |
||
enclosureUid |
||
filterWheelIds |
||
focuserIds |
||
galleryItemIds |
||
iauCode |
||
id |
||
imageId |
||
instrumentIds |
||
ipCameraIds |
||
isAvailable |
boolean | |
isPublic |
boolean | |
latitudeDeg |
number | |
location |
string | |
longitudeDeg |
number | |
mountId |
||
mountUid |
||
name |
string | |
observatoryId |
integer | |
observatoryUid |
||
otaIds |
||
ownerId |
integer | |
publicLatitudeDeg |
||
publicLongitudeDeg |
||
radioBackendIds |
||
receiverIds |
||
rotatorIds |
||
shortName |
||
slug |
string | |
uid |
string(uuid) |
TelescopeOperationalOverview
| Name | Type | Description |
|---|---|---|
devices |
||
instruments |
||
observatory |
||
telescope |
TelescopeSnapshot
| Name | Type | Description |
|---|---|---|
acquisitionActive |
boolean | |
acquisitionEnclosureReady |
||
acquisitionInstrumentUid |
||
acquisitionLastError |
||
acquisitionMountReady |
||
acquisitionPhase |
||
acquisitionTargetId |
||
activeShutdownInterlock |
||
automationState |
||
automationStateReason |
||
blockedReason |
||
controlAuthority |
TelescopeControlAuthority | |
currentTaskId |
||
degradedReason |
||
dispatchGateReason |
||
manualControlLease |
||
shutdownInterlockStatus |
||
shutdownReason |
||
shutdownSource |
||
taskActive |
boolean | |
taskId |
||
taskInstrumentUid |
||
taskLastTerminalOutcome |
||
taskPhase |
||
taskTargetId |
||
telescopeId |
||
telescopeUid |
||
timestamp |
string(date-time) |
TelescopeSortField
Type: string
TelescopeSummary
| Name | Type | Description |
|---|---|---|
antennaIds |
||
calibrationObservingAccountId |
||
cameraIds |
||
description |
||
deviceIds |
||
elevationM |
number | |
enclosureId |
||
enclosureUid |
||
filterWheelIds |
||
focuserIds |
||
galleryItemIds |
||
iauCode |
||
id |
||
imageId |
||
instrumentIds |
||
ipCameraIds |
||
isAvailable |
boolean | |
isPublic |
boolean | |
latitudeDeg |
number | |
localHorizon |
||
location |
string | |
longitudeDeg |
number | |
mountId |
||
mountUid |
||
name |
string | |
observatory |
||
observatoryId |
integer | |
observatoryUid |
||
otaIds |
||
owner |
||
ownerId |
integer | |
publicLatitudeDeg |
||
publicLongitudeDeg |
||
radioBackendIds |
||
receiverIds |
||
rotatorIds |
||
shortName |
||
slug |
string | |
uid |
string(uuid) |
TelescopeUpdate
| Name | Type | Description |
|---|---|---|
description |
||
elevationM |
||
enclosureId |
||
enclosureUid |
||
iauCode |
||
imageId |
||
isAvailable |
||
isPublic |
||
latitudeDeg |
||
localHorizon |
||
location |
||
longitudeDeg |
||
mountId |
||
mountUid |
||
name |
||
observatoryUid |
||
ownerId |
||
shortName |
||
slug |
TokenClientInfo
| Name | Type | Description |
|---|---|---|
clientId |
||
description |
||
isConfidential |
||
name |
TokenCreate
| Name | Type | Description |
|---|---|---|
description |
TokenCreateResponse
| Name | Type | Description |
|---|---|---|
token |
string | |
tokenPublic |
TokenPublic |
TokenPublic
| Name | Type | Description |
|---|---|---|
client |
||
description |
||
expiresAt |
||
id |
string(uuid) | |
issuedAt |
string(date-time) | |
scope |
||
tokenType |
TokenType |
TokenType
Type: string
TopocentricCoordinates
| Name | Type | Description |
|---|---|---|
coordinateType |
string | Type of the coordinate system |
decDeg |
number | Topocentric or observed declination in degrees |
epoch |
Epoch of observation | |
haDeg |
number | Topocentric or observed hour angle in degrees |
id |
integer | Primary key for the TargetCoordinates |
pmDecArcsecPerSec |
Proper motion in Dec in arcsec/s | |
pmHaArcsecPerSec |
Proper motion in HA times cos(Dec) in arcsec/s | |
refraction |
boolean | Coordinates need correction for refraction? False = observed (refraction-corrected), true = topocentric |
TopocentricCoordinatesCreate
| Name | Type | Description |
|---|---|---|
coordinateType |
string | Type of the coordinate system |
decDeg |
number | Topocentric or observed declination in degrees |
epoch |
Epoch of observation | |
haDeg |
number | Topocentric or observed hour angle in degrees |
pmDecArcsecPerSec |
Proper motion in Dec in arcsec/s | |
pmHaArcsecPerSec |
Proper motion in HA times cos(Dec) in arcsec/s | |
refraction |
boolean | Coordinates need correction for refraction? False = observed (refraction-corrected), true = topocentric |
TreasureMapIntegration
| Name | Type | Description |
|---|---|---|
config |
||
cursor |
||
definitionId |
integer | |
externalAccountId |
||
externalAccountLabel |
||
id |
integer | |
integrationType |
string | |
isEnabled |
boolean | |
ownerId |
integer | |
status |
IntegrationStatus |
TreasureMapIntegrationCreate
| Name | Type | Description |
|---|---|---|
config |
||
cursor |
||
definitionId |
integer | |
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
boolean | |
secrets |
TreasureMapIntegrationUpdate
| Name | Type | Description |
|---|---|---|
config |
||
cursor |
||
externalAccountId |
||
externalAccountLabel |
||
integrationType |
string | |
isEnabled |
||
secrets |
||
status |
User
| Name | Type | Description |
|---|---|---|
affiliation |
Affiliation provided by the user in their public profile | |
age |
Age of the user | |
birthdate |
Birthdate provided by the user in their public profile | |
country |
Country provided by the user or organization in their public profile | |
createdOn |
Creation time of this account | |
description |
Description/Bio provided by the user or organization in their public profile | |
email |
string | Email address of the user |
entityType |
string | |
facebookId |
Facebook ID provided by the user in their public profile | |
firstName |
First name of the user | |
githubId |
GitHub ID provided by the user in their public profile | |
id |
integer | Unique identifier of the user/organization. |
language |
Language provided by the user or organization in their public profile | |
lastName |
Last name of the user | |
linkedinId |
LinkedIn ID provided by the user in their public profile | |
location |
Location provided by the user or organization in their public profile | |
name |
string | Name of the user/organization. |
orcidId |
ORCID ID provided by the user in their public profile | |
profileImageId |
Profile image of the user/organization. | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
title |
Title provided by the user in their public profile | |
twitterId |
Twitter ID provided by the user in their public profile | |
username |
string | Username of the user |
websiteUrl |
Website URL provided by the user or organization in their public profile |
UserProfileUpdate
| Name | Type | Description |
|---|---|---|
affiliation |
Institutional affiliation shown on the public profile. | |
birthdate |
Birthdate shown on the public profile. | |
country |
Country in the public profile. | |
description |
Bio/description in the public profile. | |
facebookId |
Facebook handle/ID shown on the public profile. | |
firstName |
First name of the user. | |
githubId |
GitHub username shown on the public profile. | |
language |
Preferred language shown on the public profile. | |
lastName |
Last name of the user. | |
linkedinId |
LinkedIn handle/ID shown on the public profile. | |
location |
Location in the public profile. | |
name |
Name of the user. | |
orcidId |
ORCID iD shown on the public profile. | |
profileImageId |
Profile image of the user. | |
title |
Professional title shown on the public profile. | |
twitterId |
Twitter / X handle shown on the public profile. | |
username |
Username of the user. | |
websiteUrl |
Website URL in the public profile. |
UserPublic
| Name | Type | Description |
|---|---|---|
affiliation |
Affiliation provided by the user in their public profile | |
age |
Age of the user | |
birthdate |
Birthdate provided by the user in their public profile | |
country |
Country provided by the user or organization in their public profile | |
createdOn |
Creation time of this account | |
description |
Description/Bio provided by the user or organization in their public profile | |
email |
string | Email address of the user |
entityType |
string | |
facebookId |
Facebook ID provided by the user in their public profile | |
firstName |
First name of the user | |
githubId |
GitHub ID provided by the user in their public profile | |
id |
integer | Unique identifier of the user/organization. |
language |
Language provided by the user or organization in their public profile | |
lastName |
Last name of the user | |
linkedinId |
LinkedIn ID provided by the user in their public profile | |
location |
Location provided by the user or organization in their public profile | |
name |
string | Name of the user/organization. |
orcidId |
ORCID ID provided by the user in their public profile | |
profileImageId |
Profile image of the user/organization. | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
title |
Title provided by the user in their public profile | |
twitterId |
Twitter ID provided by the user in their public profile | |
username |
string | Username of the user |
websiteUrl |
Website URL provided by the user or organization in their public profile |
UserSummary
| Name | Type | Description |
|---|---|---|
affiliation |
Affiliation provided by the user in their public profile | |
age |
Age of the user | |
birthdate |
Birthdate provided by the user in their public profile | |
country |
Country provided by the user or organization in their public profile | |
createdOn |
Creation time of this account | |
description |
Description/Bio provided by the user or organization in their public profile | |
email |
string | Email address of the user |
entityType |
string | |
facebookId |
Facebook ID provided by the user in their public profile | |
firstName |
First name of the user | |
githubId |
GitHub ID provided by the user in their public profile | |
id |
integer | Unique identifier of the user/organization. |
language |
Language provided by the user or organization in their public profile | |
lastName |
Last name of the user | |
linkedinId |
LinkedIn ID provided by the user in their public profile | |
location |
Location provided by the user or organization in their public profile | |
name |
string | Name of the user/organization. |
orcidId |
ORCID ID provided by the user in their public profile | |
profileImageId |
Profile image of the user/organization. | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
title |
Title provided by the user in their public profile | |
twitterId |
Twitter ID provided by the user in their public profile | |
username |
string | Username of the user |
websiteUrl |
Website URL provided by the user or organization in their public profile |
ValidationError
| Name | Type | Description |
|---|---|---|
ctx |
||
input |
||
loc |
Array<> | |
msg |
string | |
type |
string |
WeatherSensor
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
hasAmbientTemperature |
boolean | |
hasCloudTemperatureDeltaC |
boolean | |
hasHumidity |
boolean | |
hasLightLevel |
boolean | |
hasPressure |
boolean | |
hasRainRate |
boolean | |
hasRainStorm |
boolean | |
hasSurfaceWetness |
boolean | |
hasWindDirection |
boolean | |
hasWindSpeedAvg10Min |
boolean | |
hasWindSpeedAvg1Min |
boolean | |
hasWindSpeedAvg2Min |
boolean | |
hasWindSpeedInstantaneous |
boolean | |
hasWindSpeedPeak10Min |
boolean | |
hasWindSpeedPeak1Min |
boolean | |
hasWindSpeedPeak2Min |
boolean | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
WeatherSensorCreate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
hasAmbientTemperature |
boolean | |
hasCloudTemperatureDeltaC |
boolean | |
hasHumidity |
boolean | |
hasLightLevel |
boolean | |
hasPressure |
boolean | |
hasRainRate |
boolean | |
hasRainStorm |
boolean | |
hasSurfaceWetness |
boolean | |
hasWindDirection |
boolean | |
hasWindSpeedAvg10Min |
boolean | |
hasWindSpeedAvg1Min |
boolean | |
hasWindSpeedAvg2Min |
boolean | |
hasWindSpeedInstantaneous |
boolean | |
hasWindSpeedPeak10Min |
boolean | |
hasWindSpeedPeak1Min |
boolean | |
hasWindSpeedPeak2Min |
boolean | |
imageId |
Image asset ID for the device. | |
modelId |
||
name |
The name of the device. | |
observatoryUid |
UID of the observatory this device is attached to. | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeUid |
UID of the telescope this device is attached to. |
WeatherSensorDetail
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
hasAmbientTemperature |
boolean | |
hasCloudTemperatureDeltaC |
boolean | |
hasHumidity |
boolean | |
hasLightLevel |
boolean | |
hasPressure |
boolean | |
hasRainRate |
boolean | |
hasRainStorm |
boolean | |
hasSurfaceWetness |
boolean | |
hasWindDirection |
boolean | |
hasWindSpeedAvg10Min |
boolean | |
hasWindSpeedAvg1Min |
boolean | |
hasWindSpeedAvg2Min |
boolean | |
hasWindSpeedInstantaneous |
boolean | |
hasWindSpeedPeak10Min |
boolean | |
hasWindSpeedPeak1Min |
boolean | |
hasWindSpeedPeak2Min |
boolean | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
model |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
WeatherSensorModel
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
hasAmbientTemperature |
boolean | |
hasCloudTemperatureDeltaC |
boolean | |
hasHumidity |
boolean | |
hasLightLevel |
boolean | |
hasPressure |
boolean | |
hasRainRate |
boolean | |
hasRainStorm |
boolean | |
hasSurfaceWetness |
boolean | |
hasWindDirection |
boolean | |
hasWindSpeedAvg10Min |
boolean | |
hasWindSpeedAvg1Min |
boolean | |
hasWindSpeedAvg2Min |
boolean | |
hasWindSpeedInstantaneous |
boolean | |
hasWindSpeedPeak10Min |
boolean | |
hasWindSpeedPeak1Min |
boolean | |
hasWindSpeedPeak2Min |
boolean | |
id |
||
imageId |
||
manufacturer |
||
modelName |
string |
WeatherSensorUpdate
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
hasAmbientTemperature |
||
hasCloudTemperatureDeltaC |
||
hasHumidity |
||
hasLightLevel |
||
hasPressure |
||
hasRainRate |
||
hasRainStorm |
||
hasSurfaceWetness |
||
hasWindDirection |
||
hasWindSpeedAvg10Min |
||
hasWindSpeedAvg1Min |
||
hasWindSpeedAvg2Min |
||
hasWindSpeedInstantaneous |
||
hasWindSpeedPeak10Min |
||
hasWindSpeedPeak1Min |
||
hasWindSpeedPeak2Min |
||
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. |