Organization API¶
The Organization API covers organizations, their memberships, roles, and invitations. If you're managing institutional accounts, group membership, or RBAC permissions, this is the surface.
For user-side operations (the individual user record), see the User and Me APIs.
Endpoints at a glance¶
| Resource | What it is |
|---|---|
/v1/organizations |
Organization records — institutional owners |
/v1/organizations/{id}/memberships |
Memberships linking users to the organization |
/v1/organizations/{id}/invitations |
Pending invitations to join the organization |
/v1/organizations/{id}/roles |
RBAC role definitions for the organization |
Groups and group operations live on the dedicated groups router
(not in this split today); they share many of the same patterns as
organizations.
Permissions¶
Organization-level operations require either:
- Membership with sufficient role — RBAC roles in the organization grant fine-grained permissions (manage members, manage observatories, manage observing accounts, etc.).
- First-party admin authority — for Skynet staff operating on organizations they don't directly belong to.
For the model behind this, see Entities.
Invitation flow¶
A common task: bring a new user into an organization.
POST /v1/organizations/{id}/invitationswith the recipient's email and the role(s) to assign on acceptance.- The recipient receives an email with a signed token.
- The recipient hits the acceptance endpoint (typically through
the web app) which creates the
OrganizationMembershipand applies the assigned roles.
Invitations can be revoked before acceptance via DELETE on the invitation.
Common task recipes¶
- List my organizations. Hit
/v1/me/organization-memberships(the Me API) rather than scanning/v1/organizations; the/meroute is filtered to your memberships. - Add an org-owned telescope. Create the telescope through
/v1/telescopeswithownerIdset to the organization's ID. The current user must have a role on the organization that allows managing telescopes. - Promote a member. Issue a role assignment to the membership. Roles are per-organization records — you can't reuse a role definition across orgs.
Reference¶
Organization API 2.0.0¶
Endpoints for managing organizations, memberships, roles and related resources.
Organizations¶
GET /organizations¶
Read Organizations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
query | No | |||
slug |
query | No | |||
token |
query | No |
Responses
{
"items": [
{
"allowRequestToJoin": true,
"country": null,
"createdOn": null,
"defaultRoleId": null,
"description": null,
"entityType": "string",
"id": 0,
"isPublic": true,
"location": null,
"memberCount": null,
"membersVisibleToMembers": true,
"name": "string",
"observingPolicyIds": null,
"profileImageId": null,
"shortName": null,
"slug": "string",
"websiteUrl": null
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrganizationSummary"
},
"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[OrganizationSummary]",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/invitations¶
Post Org Invitations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
token |
query | No |
Request body
{
"email": "string",
"groupAssignments": null,
"invitationType": "string",
"organizationId": 0,
"roleNames": [
"owner"
]
}
Schema of the request body
{
"properties": {
"email": {
"description": "",
"type": "string"
},
"groupAssignments": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrganizationInvitationGroupAssignmentCreate"
},
"type": "array"
},
{
"type": "null"
}
],
"description": ""
},
"invitationType": {
"const": "organization_invitation",
"type": "string"
},
"organizationId": {
"description": "",
"type": "integer"
},
"roleNames": {
"default": [],
"items": {
"$ref": "#/components/schemas/OrganizationRoleName"
},
"type": "array"
}
},
"required": [
"email",
"invitationType",
"organizationId"
],
"title": "OrganizationInvitationCreate",
"type": "object"
}
Responses
{
"createdById": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"email": null,
"emailSent": true,
"entityId": null,
"expiresIn": 0,
"groupAssignments": null,
"id": "77900511-652c-4145-ab3d-4da1a587d0aa",
"invitationType": "string",
"lastSentOn": null,
"organizationId": 0,
"roleNames": [
"owner"
],
"status": "accepted",
"used": true
}
Schema of the response body
{
"properties": {
"createdById": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Entity who created the invitation."
},
"createdOn": {
"description": "",
"format": "date-time",
"type": "string"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": ""
},
"emailSent": {
"description": "",
"type": "boolean"
},
"entityId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"expiresIn": {
"description": "",
"type": "integer"
},
"groupAssignments": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/OrganizationInvitationGroupAssignment"
},
"type": "array"
},
{
"type": "null"
}
],
"description": ""
},
"id": {
"description": "",
"format": "uuid",
"type": "string"
},
"invitationType": {
"const": "organization_invitation",
"type": "string"
},
"lastSentOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": ""
},
"organizationId": {
"description": "",
"type": "integer"
},
"roleNames": {
"default": [],
"items": {
"$ref": "#/components/schemas/OrganizationRoleName"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/InvitationStatus",
"description": ""
},
"used": {
"description": "",
"type": "boolean"
}
},
"required": [
"id",
"createdOn",
"expiresIn",
"emailSent",
"used",
"status",
"invitationType",
"organizationId"
],
"title": "OrganizationInvitation",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/invitations/batch¶
Post Org Invitations Batch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
token |
query | No |
Request body
Responses
[
{
"createdById": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"email": null,
"emailSent": true,
"entityId": null,
"expiresIn": 0,
"groupAssignments": null,
"id": "55063965-585b-448d-8951-8aae18e14f44",
"invitationType": "string",
"lastSentOn": null,
"organizationId": 0,
"roleNames": [
"owner"
],
"status": "accepted",
"used": true
}
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}¶
Read Organization
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Responses
{
"allowRequestToJoin": true,
"country": null,
"createdOn": null,
"defaultRoleId": null,
"description": null,
"entityType": "string",
"id": 0,
"isPublic": true,
"location": null,
"memberCount": null,
"membersVisibleToMembers": true,
"name": "string",
"observingPolicyIds": null,
"profileImageId": null,
"shortName": null,
"slug": "string",
"websiteUrl": null
}
Schema of the response body
{
"properties": {
"allowRequestToJoin": {
"description": "Whether request-to-join is allowed",
"type": "boolean"
},
"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"
},
"defaultRoleId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Default role for users in this organization."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Description/Bio provided by the user or organization in their public profile"
},
"entityType": {
"const": "organization",
"type": "string"
},
"id": {
"description": "Unique identifier of the user/organization.",
"type": "integer"
},
"isPublic": {
"default": true,
"description": "Whether the organization is listed in the public directory and exposes a public profile.",
"type": "boolean"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Location provided by the user or organization in their public profile"
},
"memberCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of members in the organization"
},
"membersVisibleToMembers": {
"default": true,
"description": "Whether ordinary members can see the organization's member roster (both the /members endpoint and the public directory).",
"type": "boolean"
},
"name": {
"description": "Name of the user/organization.",
"type": "string"
},
"observingPolicyIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Observing policy PKs configured for the organization."
},
"profileImageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Profile image of the user/organization."
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Short name of the organization"
},
"slug": {
"description": "Unique identifier used in URLs referencing the user/organization.",
"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",
"allowRequestToJoin"
],
"title": "Organization",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /organizations/{entity_id_or_slug}¶
Update Organization
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
{
"allowRequestToJoin": null,
"country": null,
"description": null,
"isPublic": null,
"location": null,
"membersVisibleToMembers": null,
"name": null,
"profileImageId": null,
"shortName": null,
"websiteUrl": null
}
Schema of the request body
{
"properties": {
"allowRequestToJoin": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Whether request-to-join is allowed."
},
"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."
},
"isPublic": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Whether the organization is listed in the public directory and exposes a public profile."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Location in the public profile."
},
"membersVisibleToMembers": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Whether ordinary members can see the organization's member roster."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the organization."
},
"profileImageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Profile image of the organization."
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Short name of the organization."
},
"websiteUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Website URL in the public profile."
}
},
"title": "OrganizationProfileUpdate",
"type": "object"
}
Responses
{
"allowRequestToJoin": true,
"country": null,
"createdOn": null,
"defaultRoleId": null,
"description": null,
"entityType": "string",
"id": 0,
"isPublic": true,
"location": null,
"memberCount": null,
"membersVisibleToMembers": true,
"name": "string",
"observingPolicyIds": null,
"profileImageId": null,
"shortName": null,
"slug": "string",
"websiteUrl": null
}
Schema of the response body
{
"properties": {
"allowRequestToJoin": {
"description": "Whether request-to-join is allowed",
"type": "boolean"
},
"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"
},
"defaultRoleId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Default role for users in this organization."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Description/Bio provided by the user or organization in their public profile"
},
"entityType": {
"const": "organization",
"type": "string"
},
"id": {
"description": "Unique identifier of the user/organization.",
"type": "integer"
},
"isPublic": {
"default": true,
"description": "Whether the organization is listed in the public directory and exposes a public profile.",
"type": "boolean"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Location provided by the user or organization in their public profile"
},
"memberCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of members in the organization"
},
"membersVisibleToMembers": {
"default": true,
"description": "Whether ordinary members can see the organization's member roster (both the /members endpoint and the public directory).",
"type": "boolean"
},
"name": {
"description": "Name of the user/organization.",
"type": "string"
},
"observingPolicyIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Observing policy PKs configured for the organization."
},
"profileImageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Profile image of the user/organization."
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Short name of the organization"
},
"slug": {
"description": "Unique identifier used in URLs referencing the user/organization.",
"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",
"allowRequestToJoin"
],
"title": "OrganizationPublic",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/alert-subscriptions¶
Read Alert Subscriptions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Responses
{
"items": [
{
"cancelAfterHours": null,
"cooldownSec": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creatorId": 0,
"eventTypeHint": null,
"expiresOn": null,
"filters": {
"activeMonths": null,
"decMaxDeg": null,
"decMinDeg": null,
"grb": null,
"gw": null,
"maxErrorRadiusDeg": null,
"maxEventAgeSec": 10.12,
"minGalacticLatitudeDeg": null,
"minMoonSeparationDeg": null,
"minSunSeparationDeg": null,
"noticeTypes": [
"initial"
],
"sources": [
"string"
],
"survey": null
},
"fireOnTestAlerts": true,
"id": 0,
"isEnabled": true,
"lastFiredOn": null,
"matchExpression": null,
"maxPerNight": null,
"name": "string",
"observingGrantIds": [
0
],
"onRetraction": "cancel",
"onUpdate": "update_target",
"ownerId": 0,
"priority": 0,
"specs": [
{
"data": {},
"id": 0,
"label": null,
"position": 0,
"schemaKind": "string",
"schemaVersion": 0,
"subscriptionId": 0,
"substitution": null
}
],
"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/AlertSubscription"
},
"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[AlertSubscription]",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{entity_id_or_slug}/alert-subscriptions¶
Create Alert Subscription
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
{
"cancelAfterHours": null,
"cooldownSec": null,
"eventTypeHint": null,
"expiresOn": null,
"filters": {
"activeMonths": null,
"decMaxDeg": null,
"decMinDeg": null,
"grb": null,
"gw": null,
"maxErrorRadiusDeg": null,
"maxEventAgeSec": 10.12,
"minGalacticLatitudeDeg": null,
"minMoonSeparationDeg": null,
"minSunSeparationDeg": null,
"noticeTypes": [
"initial"
],
"sources": [
"string"
],
"survey": null
},
"fireOnTestAlerts": true,
"isEnabled": true,
"matchExpression": null,
"maxPerNight": null,
"name": "string",
"observingGrantIds": [
0
],
"onRetraction": "cancel",
"onUpdate": "update_target",
"priority": 0,
"specs": [
{
"data": {},
"label": null,
"schemaKind": "string",
"schemaVersion": 0,
"substitution": null
}
]
}
Schema of the request body
{
"properties": {
"cancelAfterHours": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
]
},
"cooldownSec": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
]
},
"eventTypeHint": {
"anyOf": [
{
"$ref": "#/components/schemas/AlertType"
},
{
"type": "null"
}
]
},
"expiresOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"filters": {
"$ref": "#/components/schemas/AlertSubscriptionFilters"
},
"fireOnTestAlerts": {
"default": false,
"type": "boolean"
},
"isEnabled": {
"default": true,
"type": "boolean"
},
"matchExpression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maxPerNight": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observingGrantIds": {
"items": {
"type": "integer"
},
"minItems": 1,
"type": "array"
},
"onRetraction": {
"$ref": "#/components/schemas/AlertRetractionPolicy",
"default": "cancel"
},
"onUpdate": {
"$ref": "#/components/schemas/AlertUpdatePolicy",
"default": "update_target"
},
"priority": {
"default": 0,
"type": "integer"
},
"specs": {
"items": {
"$ref": "#/components/schemas/AlertSubscriptionSpecCreate"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"filters",
"observingGrantIds",
"specs"
],
"title": "AlertSubscriptionCreate",
"type": "object"
}
Responses
{
"cancelAfterHours": null,
"cooldownSec": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creatorId": 0,
"eventTypeHint": null,
"expiresOn": null,
"filters": {
"activeMonths": null,
"decMaxDeg": null,
"decMinDeg": null,
"grb": null,
"gw": null,
"maxErrorRadiusDeg": null,
"maxEventAgeSec": 10.12,
"minGalacticLatitudeDeg": null,
"minMoonSeparationDeg": null,
"minSunSeparationDeg": null,
"noticeTypes": [
"initial"
],
"sources": [
"string"
],
"survey": null
},
"fireOnTestAlerts": true,
"id": 0,
"isEnabled": true,
"lastFiredOn": null,
"matchExpression": null,
"maxPerNight": null,
"name": "string",
"observingGrantIds": [
0
],
"onRetraction": "cancel",
"onUpdate": "update_target",
"ownerId": 0,
"priority": 0,
"specs": [
{
"data": {},
"id": 0,
"label": null,
"position": 0,
"schemaKind": "string",
"schemaVersion": 0,
"subscriptionId": 0,
"substitution": null
}
],
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"cancelAfterHours": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
]
},
"cooldownSec": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
]
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"creatorId": {
"type": "integer"
},
"eventTypeHint": {
"anyOf": [
{
"$ref": "#/components/schemas/AlertType"
},
{
"type": "null"
}
]
},
"expiresOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"filters": {
"$ref": "#/components/schemas/AlertSubscriptionFilters"
},
"fireOnTestAlerts": {
"default": false,
"type": "boolean"
},
"id": {
"type": "integer"
},
"isEnabled": {
"default": true,
"type": "boolean"
},
"lastFiredOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"matchExpression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maxPerNight": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observingGrantIds": {
"items": {
"type": "integer"
},
"type": "array"
},
"onRetraction": {
"$ref": "#/components/schemas/AlertRetractionPolicy",
"default": "cancel"
},
"onUpdate": {
"$ref": "#/components/schemas/AlertUpdatePolicy",
"default": "update_target"
},
"ownerId": {
"type": "integer"
},
"priority": {
"default": 0,
"type": "integer"
},
"specs": {
"items": {
"$ref": "#/components/schemas/AlertSubscriptionSpec"
},
"type": "array"
},
"updatedOn": {
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"filters",
"id",
"ownerId",
"creatorId",
"createdOn",
"updatedOn"
],
"title": "AlertSubscription",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /organizations/{entity_id_or_slug}/alert-subscriptions/{subscription_id}¶
Delete Alert Subscription
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
subscription_id |
path | integer | No | ||
token |
query | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/alert-subscriptions/{subscription_id}¶
Read Alert Subscription
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
subscription_id |
path | integer | No | ||
token |
query | No |
Responses
{
"cancelAfterHours": null,
"cooldownSec": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creatorId": 0,
"eventTypeHint": null,
"expiresOn": null,
"filters": {
"activeMonths": null,
"decMaxDeg": null,
"decMinDeg": null,
"grb": null,
"gw": null,
"maxErrorRadiusDeg": null,
"maxEventAgeSec": 10.12,
"minGalacticLatitudeDeg": null,
"minMoonSeparationDeg": null,
"minSunSeparationDeg": null,
"noticeTypes": [
"initial"
],
"sources": [
"string"
],
"survey": null
},
"fireOnTestAlerts": true,
"id": 0,
"isEnabled": true,
"lastFiredOn": null,
"matchExpression": null,
"maxPerNight": null,
"name": "string",
"observingGrantIds": [
0
],
"onRetraction": "cancel",
"onUpdate": "update_target",
"ownerId": 0,
"priority": 0,
"specs": [
{
"data": {},
"id": 0,
"label": null,
"position": 0,
"schemaKind": "string",
"schemaVersion": 0,
"subscriptionId": 0,
"substitution": null
}
],
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"cancelAfterHours": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
]
},
"cooldownSec": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
]
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"creatorId": {
"type": "integer"
},
"eventTypeHint": {
"anyOf": [
{
"$ref": "#/components/schemas/AlertType"
},
{
"type": "null"
}
]
},
"expiresOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"filters": {
"$ref": "#/components/schemas/AlertSubscriptionFilters"
},
"fireOnTestAlerts": {
"default": false,
"type": "boolean"
},
"id": {
"type": "integer"
},
"isEnabled": {
"default": true,
"type": "boolean"
},
"lastFiredOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"matchExpression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maxPerNight": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observingGrantIds": {
"items": {
"type": "integer"
},
"type": "array"
},
"onRetraction": {
"$ref": "#/components/schemas/AlertRetractionPolicy",
"default": "cancel"
},
"onUpdate": {
"$ref": "#/components/schemas/AlertUpdatePolicy",
"default": "update_target"
},
"ownerId": {
"type": "integer"
},
"priority": {
"default": 0,
"type": "integer"
},
"specs": {
"items": {
"$ref": "#/components/schemas/AlertSubscriptionSpec"
},
"type": "array"
},
"updatedOn": {
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"filters",
"id",
"ownerId",
"creatorId",
"createdOn",
"updatedOn"
],
"title": "AlertSubscription",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PUT /organizations/{entity_id_or_slug}/alert-subscriptions/{subscription_id}¶
Update Alert Subscription
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
subscription_id |
path | integer | No | ||
token |
query | No |
Request body
{
"cancelAfterHours": null,
"cooldownSec": null,
"eventTypeHint": null,
"expiresOn": null,
"filters": null,
"fireOnTestAlerts": null,
"isEnabled": null,
"matchExpression": null,
"maxPerNight": null,
"name": null,
"observingGrantIds": null,
"onRetraction": null,
"onUpdate": null,
"priority": null,
"specs": null
}
Schema of the request body
{
"properties": {
"cancelAfterHours": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
]
},
"cooldownSec": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
]
},
"eventTypeHint": {
"anyOf": [
{
"$ref": "#/components/schemas/AlertType"
},
{
"type": "null"
}
]
},
"expiresOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"filters": {
"anyOf": [
{
"$ref": "#/components/schemas/AlertSubscriptionFilters"
},
{
"type": "null"
}
]
},
"fireOnTestAlerts": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"matchExpression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maxPerNight": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
]
},
"onRetraction": {
"anyOf": [
{
"$ref": "#/components/schemas/AlertRetractionPolicy"
},
{
"type": "null"
}
]
},
"onUpdate": {
"anyOf": [
{
"$ref": "#/components/schemas/AlertUpdatePolicy"
},
{
"type": "null"
}
]
},
"priority": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"specs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/AlertSubscriptionSpecCreate"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
]
}
},
"title": "AlertSubscriptionUpdate",
"type": "object"
}
Responses
{
"cancelAfterHours": null,
"cooldownSec": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creatorId": 0,
"eventTypeHint": null,
"expiresOn": null,
"filters": {
"activeMonths": null,
"decMaxDeg": null,
"decMinDeg": null,
"grb": null,
"gw": null,
"maxErrorRadiusDeg": null,
"maxEventAgeSec": 10.12,
"minGalacticLatitudeDeg": null,
"minMoonSeparationDeg": null,
"minSunSeparationDeg": null,
"noticeTypes": [
"initial"
],
"sources": [
"string"
],
"survey": null
},
"fireOnTestAlerts": true,
"id": 0,
"isEnabled": true,
"lastFiredOn": null,
"matchExpression": null,
"maxPerNight": null,
"name": "string",
"observingGrantIds": [
0
],
"onRetraction": "cancel",
"onUpdate": "update_target",
"ownerId": 0,
"priority": 0,
"specs": [
{
"data": {},
"id": 0,
"label": null,
"position": 0,
"schemaKind": "string",
"schemaVersion": 0,
"subscriptionId": 0,
"substitution": null
}
],
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"cancelAfterHours": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
]
},
"cooldownSec": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "null"
}
]
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"creatorId": {
"type": "integer"
},
"eventTypeHint": {
"anyOf": [
{
"$ref": "#/components/schemas/AlertType"
},
{
"type": "null"
}
]
},
"expiresOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"filters": {
"$ref": "#/components/schemas/AlertSubscriptionFilters"
},
"fireOnTestAlerts": {
"default": false,
"type": "boolean"
},
"id": {
"type": "integer"
},
"isEnabled": {
"default": true,
"type": "boolean"
},
"lastFiredOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"matchExpression": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maxPerNight": {
"anyOf": [
{
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observingGrantIds": {
"items": {
"type": "integer"
},
"type": "array"
},
"onRetraction": {
"$ref": "#/components/schemas/AlertRetractionPolicy",
"default": "cancel"
},
"onUpdate": {
"$ref": "#/components/schemas/AlertUpdatePolicy",
"default": "update_target"
},
"ownerId": {
"type": "integer"
},
"priority": {
"default": 0,
"type": "integer"
},
"specs": {
"items": {
"$ref": "#/components/schemas/AlertSubscriptionSpec"
},
"type": "array"
},
"updatedOn": {
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"filters",
"id",
"ownerId",
"creatorId",
"createdOn",
"updatedOn"
],
"title": "AlertSubscription",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{entity_id_or_slug}/alert-subscriptions/{subscription_id}:test-fire¶
Test Fire Alert Subscription
Description
Push a synthetic test event through the REAL fire path (funding
revalidation, substitution, observation creation). Requires the
subscription's fire_on_test_alerts debug toggle.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
subscription_id |
path | integer | No | ||
token |
query | No |
Request body
Responses
{
"alertEventId": 0,
"attempts": 0,
"createdOn": "2022-04-13T15:42:05.901Z",
"error": null,
"eventGroupKey": "string",
"id": 0,
"kind": "fire",
"observationId": null,
"processedOn": null,
"skipReason": null,
"status": "pending",
"subscriptionId": 0
}
Schema of the response body
{
"description": "Audit row: why a subscription fired (or was skipped) for an event.",
"properties": {
"alertEventId": {
"type": "integer"
},
"attempts": {
"default": 0,
"type": "integer"
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"eventGroupKey": {
"type": "string"
},
"id": {
"type": "integer"
},
"kind": {
"$ref": "#/components/schemas/AlertTriggerKind"
},
"observationId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"processedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"skipReason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/components/schemas/AlertTriggerStatus"
},
"subscriptionId": {
"type": "integer"
}
},
"required": [
"id",
"subscriptionId",
"alertEventId",
"eventGroupKey",
"kind",
"status",
"createdOn"
],
"title": "AlertTrigger",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{entity_id_or_slug}/alert-subscriptions:backtest¶
Backtest Alert Filters
Description
Evaluate a draft filter set against recently received alert events.
Each event is evaluated with now anchored to its own
received_on so age predicates behave as they would have live.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
{
"filters": {
"activeMonths": null,
"decMaxDeg": null,
"decMinDeg": null,
"grb": null,
"gw": null,
"maxErrorRadiusDeg": null,
"maxEventAgeSec": 10.12,
"minGalacticLatitudeDeg": null,
"minMoonSeparationDeg": null,
"minSunSeparationDeg": null,
"noticeTypes": [
"initial"
],
"sources": [
"string"
],
"survey": null
},
"limit": 0,
"since": null
}
Schema of the request body
{
"properties": {
"filters": {
"$ref": "#/components/schemas/AlertSubscriptionFilters"
},
"limit": {
"default": 200,
"maximum": 1000.0,
"minimum": 1.0,
"type": "integer"
},
"since": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"filters"
],
"title": "AlertBacktestRequest",
"type": "object"
}
Responses
{
"evaluated": 0,
"matchedCount": 0,
"results": [
{
"event": {
"classification": {},
"containmentProbability": null,
"decDeg": null,
"errorRadiusDeg": null,
"eventGroupKey": "string",
"eventName": null,
"eventTime": null,
"externalId": "string",
"id": 0,
"isTest": true,
"noticeType": "initial",
"payload": {},
"raDeg": null,
"receivedOn": "2022-04-13T15:42:05.901Z",
"skymapObjectKey": null,
"sourceId": 0,
"topic": "string"
},
"failedPredicates": [
"string"
],
"matched": true
}
]
}
Schema of the response body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/alert-triggers¶
Read Alert Triggers
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Responses
{
"items": [
{
"alertEventId": 0,
"attempts": 0,
"createdOn": "2022-04-13T15:42:05.901Z",
"error": null,
"eventGroupKey": "string",
"id": 0,
"kind": "fire",
"observationId": null,
"processedOn": null,
"skipReason": null,
"status": "pending",
"subscriptionId": 0
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/AlertTrigger"
},
"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[AlertTrigger]",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/detail¶
Read Organization Detail
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Responses
{
"allowRequestToJoin": true,
"country": null,
"createdOn": null,
"defaultRoleId": null,
"description": null,
"entityType": "string",
"id": 0,
"isPublic": true,
"location": null,
"memberCount": null,
"membersVisibleToMembers": true,
"name": "string",
"observingPolicies": null,
"observingPolicyIds": null,
"profileImageId": null,
"shortName": null,
"slug": "string",
"websiteUrl": null
}
Schema of the response body
{
"properties": {
"allowRequestToJoin": {
"description": "Whether request-to-join is allowed",
"type": "boolean"
},
"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"
},
"defaultRoleId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Default role for users in this organization."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Description/Bio provided by the user or organization in their public profile"
},
"entityType": {
"const": "organization",
"type": "string"
},
"id": {
"description": "Unique identifier of the user/organization.",
"type": "integer"
},
"isPublic": {
"default": true,
"description": "Whether the organization is listed in the public directory and exposes a public profile.",
"type": "boolean"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Location provided by the user or organization in their public profile"
},
"memberCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of members in the organization"
},
"membersVisibleToMembers": {
"default": true,
"description": "Whether ordinary members can see the organization's member roster (both the /members endpoint and the public directory).",
"type": "boolean"
},
"name": {
"description": "Name of the user/organization.",
"type": "string"
},
"observingPolicies": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservingPolicySummary"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Observing policies configured for the organization."
},
"observingPolicyIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Observing policy PKs configured for the organization."
},
"profileImageId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Profile image of the user/organization."
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Short name of the organization"
},
"slug": {
"description": "Unique identifier used in URLs referencing the user/organization.",
"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",
"allowRequestToJoin"
],
"title": "OrganizationDetail",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{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 Organizations Entity Id Or Slug Devices Post"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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 Organizations Entity Id Or Slug Devices Device Id Get"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /organizations/{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 Organizations Entity Id Or Slug Devices Device Id Patch"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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 Organizations Entity Id Or Slug Devices Device Id Detail Get"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/groups¶
Read Organization Groups
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
id |
query | No | |||
organization_id |
query | No | |||
organizationId |
query | No | |||
query_string |
query | No | |||
queryString |
query | No | |||
token |
query | No |
Responses
{
"items": [
{
"allowDataPolicyOverride": true,
"allowInvitations": true,
"dataPolicy": null,
"defaultRoleId": null,
"description": "string",
"id": 0,
"memberCount": null,
"name": "string",
"organizationId": null,
"slug": "string"
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Group"
},
"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[Group]",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{entity_id_or_slug}/groups¶
Create Group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
{
"allowDataPolicyOverride": null,
"allowInvitations": null,
"dataPolicy": null,
"defaultRoleId": null,
"description": null,
"name": "string",
"organizationId": null,
"slug": "string"
}
Schema of the request body
{
"properties": {
"allowDataPolicyOverride": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"description": "Whether overriding the data policy is allowed"
},
"allowInvitations": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"description": "Whether invitations are allowed"
},
"dataPolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/DataPolicy"
},
{
"type": "null"
}
],
"description": "Data policy."
},
"defaultRoleId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Default role for users in this group."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "Description of the group"
},
"name": {
"description": "Name of the group",
"type": "string"
},
"organizationId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the organization to which the group belongs"
},
"slug": {
"description": "Unique identifier used in URLs referencing the group.",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "GroupCreate",
"type": "object"
}
Responses
{
"allowDataPolicyOverride": true,
"allowInvitations": true,
"dataPolicy": null,
"defaultRoleId": null,
"description": "string",
"id": 0,
"memberCount": null,
"name": "string",
"organizationId": null,
"slug": "string"
}
Schema of the response body
{
"properties": {
"allowDataPolicyOverride": {
"description": "Whether overriding the data policy is allowed",
"type": "boolean"
},
"allowInvitations": {
"description": "Whether invitations are allowed",
"type": "boolean"
},
"dataPolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/DataPolicy"
},
{
"type": "null"
}
],
"description": "Data policy."
},
"defaultRoleId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Default role for users in this group."
},
"description": {
"description": "Description of the group",
"type": "string"
},
"id": {
"description": "Unique identifier of the group.",
"type": "integer"
},
"memberCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of members in the group"
},
"name": {
"description": "Name of the group",
"type": "string"
},
"organizationId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the organization to which the group belongs"
},
"slug": {
"description": "Unique identifier used in URLs referencing the group.",
"type": "string"
}
},
"required": [
"id",
"name",
"slug",
"description",
"allowInvitations",
"allowDataPolicyOverride"
],
"title": "Group",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/groups/{group_id_slug}¶
Read Organization Group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
group_id_slug |
path | No | |||
token |
query | No |
Responses
{
"allowDataPolicyOverride": true,
"allowInvitations": true,
"dataPolicy": null,
"defaultRoleId": null,
"description": "string",
"id": 0,
"memberCount": null,
"name": "string",
"organizationId": null,
"slug": "string"
}
Schema of the response body
{
"properties": {
"allowDataPolicyOverride": {
"description": "Whether overriding the data policy is allowed",
"type": "boolean"
},
"allowInvitations": {
"description": "Whether invitations are allowed",
"type": "boolean"
},
"dataPolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/DataPolicy"
},
{
"type": "null"
}
],
"description": "Data policy."
},
"defaultRoleId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Default role for users in this group."
},
"description": {
"description": "Description of the group",
"type": "string"
},
"id": {
"description": "Unique identifier of the group.",
"type": "integer"
},
"memberCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of members in the group"
},
"name": {
"description": "Name of the group",
"type": "string"
},
"organizationId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the organization to which the group belongs"
},
"slug": {
"description": "Unique identifier used in URLs referencing the group.",
"type": "string"
}
},
"required": [
"id",
"name",
"slug",
"description",
"allowInvitations",
"allowDataPolicyOverride"
],
"title": "Group",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /organizations/{entity_id_or_slug}/groups/{group_id}¶
Delete Group
Description
Hard-delete a group. Cascades on the SQLA side delete the group's role grants, memberships, and invitations.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
group_id |
path | integer | No | ||
token |
query | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PUT /organizations/{entity_id_or_slug}/groups/{group_id}¶
Update Group
Description
Update a group's metadata. Body shape mirrors GroupCreate —
organization_id is ignored (a group can't be re-parented through
this endpoint).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
group_id |
path | integer | No | ||
token |
query | No |
Request body
{
"allowDataPolicyOverride": null,
"allowInvitations": null,
"dataPolicy": null,
"defaultRoleId": null,
"description": null,
"name": "string",
"organizationId": null,
"slug": "string"
}
Schema of the request body
{
"properties": {
"allowDataPolicyOverride": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"description": "Whether overriding the data policy is allowed"
},
"allowInvitations": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"description": "Whether invitations are allowed"
},
"dataPolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/DataPolicy"
},
{
"type": "null"
}
],
"description": "Data policy."
},
"defaultRoleId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Default role for users in this group."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"description": "Description of the group"
},
"name": {
"description": "Name of the group",
"type": "string"
},
"organizationId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the organization to which the group belongs"
},
"slug": {
"description": "Unique identifier used in URLs referencing the group.",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "GroupCreate",
"type": "object"
}
Responses
{
"allowDataPolicyOverride": true,
"allowInvitations": true,
"dataPolicy": null,
"defaultRoleId": null,
"description": "string",
"id": 0,
"memberCount": null,
"name": "string",
"organizationId": null,
"slug": "string"
}
Schema of the response body
{
"properties": {
"allowDataPolicyOverride": {
"description": "Whether overriding the data policy is allowed",
"type": "boolean"
},
"allowInvitations": {
"description": "Whether invitations are allowed",
"type": "boolean"
},
"dataPolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/DataPolicy"
},
{
"type": "null"
}
],
"description": "Data policy."
},
"defaultRoleId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Default role for users in this group."
},
"description": {
"description": "Description of the group",
"type": "string"
},
"id": {
"description": "Unique identifier of the group.",
"type": "integer"
},
"memberCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Number of members in the group"
},
"name": {
"description": "Name of the group",
"type": "string"
},
"organizationId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the organization to which the group belongs"
},
"slug": {
"description": "Unique identifier used in URLs referencing the group.",
"type": "string"
}
},
"required": [
"id",
"name",
"slug",
"description",
"allowInvitations",
"allowDataPolicyOverride"
],
"title": "Group",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{entity_id_or_slug}/groups/{group_id}/invitations¶
Post Group Invitation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
group_id |
path | integer | No | ||
token |
query | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"email": {
"description": "",
"type": "string"
},
"groupId": {
"description": "",
"type": "integer"
},
"invitationType": {
"const": "group_invitation",
"type": "string"
},
"roleNames": {
"default": [],
"items": {
"$ref": "#/components/schemas/GroupRoleName"
},
"type": "array"
}
},
"required": [
"email",
"invitationType",
"groupId"
],
"title": "GroupInvitationCreate",
"type": "object"
}
Responses
{
"createdById": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"email": null,
"emailSent": true,
"entityId": null,
"expiresIn": 0,
"groupId": 0,
"id": "3215a379-e6f4-4aa9-8e1d-5fd5bd0fce76",
"invitationType": "string",
"lastSentOn": null,
"roleNames": [
"maintainer"
],
"status": "accepted",
"used": true
}
Schema of the response body
{
"properties": {
"createdById": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Entity who created the invitation."
},
"createdOn": {
"description": "",
"format": "date-time",
"type": "string"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": ""
},
"emailSent": {
"description": "",
"type": "boolean"
},
"entityId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": ""
},
"expiresIn": {
"description": "",
"type": "integer"
},
"groupId": {
"description": "",
"type": "integer"
},
"id": {
"description": "",
"format": "uuid",
"type": "string"
},
"invitationType": {
"const": "group_invitation",
"type": "string"
},
"lastSentOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": ""
},
"roleNames": {
"default": [],
"items": {
"$ref": "#/components/schemas/GroupRoleName"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/InvitationStatus",
"description": ""
},
"used": {
"description": "",
"type": "boolean"
}
},
"required": [
"id",
"createdOn",
"expiresIn",
"emailSent",
"used",
"status",
"invitationType",
"groupId"
],
"title": "GroupInvitation",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"items": {
"items": {
"discriminator": {
"mapping": {
"dropbox": "#/components/schemas/DropboxIntegration",
"google_drive": "#/components/schemas/GoogleDriveIntegration",
"s3_minio": "#/components/schemas/S3MinioIntegration",
"slack": "#/components/schemas/SlackIntegration",
"treasure_map": "#/components/schemas/TreasureMapIntegration"
},
"propertyName": "integrationType"
},
"oneOf": [
{
"$ref": "#/components/schemas/S3MinioIntegration"
},
{
"$ref": "#/components/schemas/TreasureMapIntegration"
},
{
"$ref": "#/components/schemas/GoogleDriveIntegration"
},
{
"$ref": "#/components/schemas/DropboxIntegration"
},
{
"$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[S3MinioIntegration, TreasureMapIntegration, GoogleDriveIntegration, DropboxIntegration, SlackIntegration], FieldInfo(annotation=NoneType, required=True, discriminator='integration_type')]]",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{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",
"s3_minio": "#/components/schemas/S3MinioIntegrationCreate",
"slack": "#/components/schemas/SlackIntegrationCreate",
"treasure_map": "#/components/schemas/TreasureMapIntegrationCreate"
},
"propertyName": "integrationType"
},
"oneOf": [
{
"$ref": "#/components/schemas/S3MinioIntegrationCreate"
},
{
"$ref": "#/components/schemas/TreasureMapIntegrationCreate"
},
{
"$ref": "#/components/schemas/GoogleDriveIntegrationCreate"
},
{
"$ref": "#/components/schemas/DropboxIntegrationCreate"
},
{
"$ref": "#/components/schemas/SlackIntegrationCreate"
}
],
"title": "Body"
}
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"dropbox": "#/components/schemas/DropboxIntegration",
"google_drive": "#/components/schemas/GoogleDriveIntegration",
"s3_minio": "#/components/schemas/S3MinioIntegration",
"slack": "#/components/schemas/SlackIntegration",
"treasure_map": "#/components/schemas/TreasureMapIntegration"
},
"propertyName": "integrationType"
},
"oneOf": [
{
"$ref": "#/components/schemas/S3MinioIntegration"
},
{
"$ref": "#/components/schemas/TreasureMapIntegration"
},
{
"$ref": "#/components/schemas/GoogleDriveIntegration"
},
{
"$ref": "#/components/schemas/DropboxIntegration"
},
{
"$ref": "#/components/schemas/SlackIntegration"
}
],
"title": "Response Create Entity Integration Organizations Entity Id Or Slug Integrations Post"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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": "treasure_map",
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PUT /organizations/{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",
"s3_minio": "#/components/schemas/S3MinioIntegrationUpdate",
"slack": "#/components/schemas/SlackIntegrationUpdate",
"treasure_map": "#/components/schemas/TreasureMapIntegrationUpdate"
},
"propertyName": "integrationType"
},
"oneOf": [
{
"$ref": "#/components/schemas/S3MinioIntegrationUpdate"
},
{
"$ref": "#/components/schemas/TreasureMapIntegrationUpdate"
},
{
"$ref": "#/components/schemas/GoogleDriveIntegrationUpdate"
},
{
"$ref": "#/components/schemas/DropboxIntegrationUpdate"
},
{
"$ref": "#/components/schemas/SlackIntegrationUpdate"
}
],
"title": "Body"
}
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"dropbox": "#/components/schemas/DropboxIntegration",
"google_drive": "#/components/schemas/GoogleDriveIntegration",
"s3_minio": "#/components/schemas/S3MinioIntegration",
"slack": "#/components/schemas/SlackIntegration",
"treasure_map": "#/components/schemas/TreasureMapIntegration"
},
"propertyName": "integrationType"
},
"oneOf": [
{
"$ref": "#/components/schemas/S3MinioIntegration"
},
{
"$ref": "#/components/schemas/TreasureMapIntegration"
},
{
"$ref": "#/components/schemas/GoogleDriveIntegration"
},
{
"$ref": "#/components/schemas/DropboxIntegration"
},
{
"$ref": "#/components/schemas/SlackIntegration"
}
],
"title": "Response Update Entity Integration Organizations Entity Id Or Slug Integrations Integration Id Put"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/invitations¶
Read Invitations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
is_accepted |
query | No | |||
isAccepted |
query | No | |||
query_string |
query | No | |||
queryString |
query | No | |||
token |
query | No |
Responses
{
"items": [
{
"createdById": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"email": null,
"emailSent": true,
"entityId": null,
"expiresIn": 0,
"groupAssignments": null,
"id": "153d77fe-0d6a-4739-9009-67c430005ed9",
"invitationType": "string",
"lastSentOn": null,
"organizationId": 0,
"roleNames": [
"owner"
],
"status": "accepted",
"used": true
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrganizationInvitation"
},
"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[OrganizationInvitation]",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/members¶
Read Organization Members
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
-groupId |
query | No | |||
entity_id_or_slug |
path | No | Entity id or slug | ||
group_id_ |
query | No | |||
query_string |
query | No | |||
queryString |
query | No | |||
token |
query | No | |||
user_ids |
query | No | |||
userIds |
query | No |
Responses
{
"items": [
{
"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,
"orcidVerifiedAt": null,
"profileImageId": null,
"slug": "string",
"title": null,
"twitterId": null,
"username": "string",
"websiteUrl": null
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/UserWithEmail"
},
"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[UserWithEmail]",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/members-with-roles¶
Read Organization Members With Roles
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
-groupId |
query | No | |||
entity_id_or_slug |
path | No | Entity id or slug | ||
group_id_ |
query | No | |||
query_string |
query | No | |||
queryString |
query | No | |||
token |
query | No | |||
user_ids |
query | No | |||
userIds |
query | No |
Responses
{
"items": [
{
"groupsWithRoles": [
{
"group": {
"allowDataPolicyOverride": true,
"allowInvitations": true,
"dataPolicy": null,
"defaultRoleId": null,
"description": "string",
"id": 0,
"memberCount": null,
"name": "string",
"organizationId": null,
"slug": "string"
},
"roleNames": [
"maintainer"
]
}
],
"member": {
"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,
"orcidVerifiedAt": null,
"profileImageId": null,
"slug": "string",
"title": null,
"twitterId": null,
"username": "string",
"websiteUrl": null
},
"roleNames": [
"owner"
]
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrganizationMemberWithRoles"
},
"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[OrganizationMemberWithRoles]",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /organizations/{entity_id_or_slug}/members/{member_id}¶
Remove User From Org
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
member_id |
path | integer | No | ||
token |
query | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PUT /organizations/{entity_id_or_slug}/members/{member_id}¶
Edit Members Roles
Description
Replace the org-role assignments for a single member.
The body is the desired list of role names. Existing grants that aren't in the list are removed; missing ones are inserted. Returns the resulting set of grants.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
member_id |
path | integer | No | ||
token |
query | No |
Request body
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/memberships¶
Read Organization Memberships
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
-groupId |
query | No | |||
entity_id_or_slug |
path | No | Entity id or slug | ||
group_id_ |
query | No | |||
query_string |
query | No | |||
queryString |
query | No | |||
token |
query | No | |||
user_ids |
query | No | |||
userIds |
query | No |
Responses
{
"items": [
{
"joinedOn": "2022-04-13T15:42:05.901Z",
"organizationId": 0,
"userId": 0
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/OrganizationMembership"
},
"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[OrganizationMembership]",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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 | |||
-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 | |||
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 | |||
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": [
{
"affinityHandoffAfterSec": null,
"affinityMigrateAt": "frame",
"cadenceCalendarUnit": null,
"cadenceGapSec": null,
"cadenceKind": "asap",
"cadenceLevel": null,
"cadencePeriodSec": null,
"cancelOn": null,
"cohesionLevel": null,
"completedOn": null,
"coordinationKind": null,
"coordinationStartToleranceSec": null,
"copiesCount": null,
"copiesMode": "single",
"createdOn": "2022-04-13T15:42:05.901Z",
"creator": null,
"creatorId": 0,
"creatorUid": null,
"currentEpoch": 0,
"epochCount": 0,
"galleryItems": null,
"groupUid": null,
"id": 0,
"instrumentIds": null,
"instrumentMode": "none",
"interruptLowerPriority": true,
"interruptRecovery": "resume",
"isDeleted": true,
"isPublic": true,
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingGrantIds": null,
"opticalImagingConfiguration": null,
"owner": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"requestTypes": [
"optical_imaging"
],
"sampleOrdering": "request_major",
"startAfter": null,
"status": "active",
"target": null,
"targetId": null,
"targetUid": null,
"uid": "1fc30ef8-0f1a-4283-bd4e-a04033bee66e",
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{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
{
"affinityHandoffAfterSec": null,
"affinityMigrateAt": null,
"cadenceCalendarUnit": null,
"cadenceGapSec": null,
"cadenceKind": null,
"cadenceLevel": null,
"cadencePeriodSec": null,
"cancelOn": null,
"cohesionLevel": null,
"completedOn": null,
"coordinationKind": null,
"coordinationStartToleranceSec": null,
"copiesCount": null,
"copiesMode": null,
"epochCount": null,
"instrumentIds": null,
"instrumentMode": null,
"interruptLowerPriority": null,
"interruptRecovery": null,
"isDeleted": null,
"isPublic": null,
"lastActivityOn": null,
"name": "string",
"observingGrantIds": null,
"opticalImagingConfiguration": null,
"ownerId": 0,
"priority": null,
"progressFraction": null,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"renderSettings": null,
"requests": null,
"sampleOrdering": null,
"startAfter": null,
"status": null,
"target": null
}
Schema of the request body
{
"properties": {
"affinityHandoffAfterSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"affinityMigrateAt": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRung"
},
{
"type": "null"
}
],
"default": "observation"
},
"cadenceCalendarUnit": {
"anyOf": [
{
"$ref": "#/components/schemas/CalendarUnit"
},
{
"type": "null"
}
]
},
"cadenceGapSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"cadenceKind": {
"anyOf": [
{
"$ref": "#/components/schemas/CadenceKind"
},
{
"type": "null"
}
],
"default": "asap"
},
"cadenceLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRung"
},
{
"type": "null"
}
]
},
"cadencePeriodSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"cohesionLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRung"
},
{
"type": "null"
}
],
"default": "epoch"
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"coordinationKind": {
"anyOf": [
{
"$ref": "#/components/schemas/CoordinationKind"
},
{
"type": "null"
}
]
},
"coordinationStartToleranceSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"copiesCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"copiesMode": {
"anyOf": [
{
"$ref": "#/components/schemas/CopiesMode"
},
{
"type": "null"
}
],
"default": "single"
},
"epochCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 1
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentMode": {
"anyOf": [
{
"$ref": "#/components/schemas/InstrumentAccessMode"
},
{
"type": "null"
}
],
"default": "none"
},
"interruptLowerPriority": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false
},
"interruptRecovery": {
"anyOf": [
{
"$ref": "#/components/schemas/InterruptRecovery"
},
{
"type": "null"
}
],
"default": "resume"
},
"isDeleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false
},
"isPublic": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Input"
},
{
"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"
}
]
},
"sampleOrdering": {
"anyOf": [
{
"$ref": "#/components/schemas/SampleOrdering"
},
{
"type": "null"
}
],
"default": "request_major"
},
"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
{
"affinityHandoffAfterSec": null,
"affinityMigrateAt": "frame",
"cadenceCalendarUnit": null,
"cadenceGapSec": null,
"cadenceKind": "asap",
"cadenceLevel": null,
"cadencePeriodSec": null,
"cancelOn": null,
"cohesionLevel": null,
"completedOn": null,
"coordinationKind": null,
"coordinationStartToleranceSec": null,
"copiesCount": null,
"copiesMode": "single",
"createdOn": "2022-04-13T15:42:05.901Z",
"creatorId": 0,
"creatorUid": null,
"currentEpoch": 0,
"epochCount": 0,
"groupUid": null,
"id": 0,
"instrumentIds": null,
"instrumentMode": "none",
"interruptLowerPriority": true,
"interruptRecovery": "resume",
"isDeleted": true,
"isPublic": true,
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingGrantIds": null,
"opticalImagingConfiguration": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"requestTypes": [
"optical_imaging"
],
"sampleOrdering": "request_major",
"startAfter": null,
"status": "active",
"targetId": null,
"targetUid": null,
"uid": "83cd57a9-cb66-49b5-87cc-80d6a4af05fd",
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"affinityHandoffAfterSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"affinityMigrateAt": {
"$ref": "#/components/schemas/ScheduleRung",
"default": "observation"
},
"cadenceCalendarUnit": {
"anyOf": [
{
"$ref": "#/components/schemas/CalendarUnit"
},
{
"type": "null"
}
]
},
"cadenceGapSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"cadenceKind": {
"$ref": "#/components/schemas/CadenceKind",
"default": "asap"
},
"cadenceLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRung"
},
{
"type": "null"
}
]
},
"cadencePeriodSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"cohesionLevel": {
"$ref": "#/components/schemas/ScheduleRung",
"default": "epoch"
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"coordinationKind": {
"anyOf": [
{
"$ref": "#/components/schemas/CoordinationKind"
},
{
"type": "null"
}
]
},
"coordinationStartToleranceSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"copiesCount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"copiesMode": {
"$ref": "#/components/schemas/CopiesMode",
"default": "single"
},
"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"
}
]
},
"currentEpoch": {
"default": 0,
"type": "integer"
},
"epochCount": {
"default": 1,
"description": "Number of visits. 0 = repeat indefinitely.",
"type": "integer"
},
"groupUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"description": "Unique identifier of the observation.",
"type": "integer"
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentMode": {
"$ref": "#/components/schemas/InstrumentAccessMode"
},
"interruptLowerPriority": {
"description": "Interrupt lower priority.",
"type": "boolean"
},
"interruptRecovery": {
"$ref": "#/components/schemas/InterruptRecovery",
"default": "resume"
},
"isDeleted": {
"description": "Flag indicating if deleted.",
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"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."
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Output"
},
{
"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"
},
"sampleOrdering": {
"$ref": "#/components/schemas/SampleOrdering",
"default": "request_major"
},
"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",
"isDeleted",
"createdOn",
"updatedOn",
"name",
"ownerId",
"creatorId",
"interruptLowerPriority",
"priority",
"progressFraction",
"isPublic",
"instrumentMode"
],
"title": "Observation",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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": "53fc51d7-d235-452a-bc19-27f8f9514aa5",
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{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": "2b8acc91-be8e-41a6-b9e5-4c2cc53e7071",
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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": "5eeeea1b-ac65-44f2-bb4b-289164b6a86c",
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /organizations/{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": "142c43b0-c3c3-4dac-b0aa-cf78695f01e6",
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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": "d053e321-b4c9-426f-857a-fe6f3aa79181",
"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": "76039cf5-88f8-4aa2-9aac-f18561696791",
"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": "746dcd51-6c68-4a7b-9058-a2e204bd4dbe"
}
],
"uid": "2858624a-d6b5-451c-b6f4-eff536d1920a",
"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": "006b1203-315b-4011-afd8-387691bc2ebb"
}
]
}
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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/observing-policies¶
Read Entity Observing Policies
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
id |
query | No | |||
name |
query | No | |||
observing_account_id |
query | No | |||
observingAccountId |
query | No | |||
organization_id |
query | No | |||
organizationId |
query | No | |||
token |
query | No |
Responses
{
"items": [
{
"allowHiddenObservation": true,
"allowHiddenTelemetry": true,
"allowedCatalogObjectTypes": null,
"allowedCoordinateTypes": null,
"allowedDataPolicies": [
"local"
],
"allowedRequestTypes": [
"optical_imaging"
],
"allowedTargetPositionTypes": null,
"dataPublicAfter": null,
"description": null,
"id": 0,
"name": "string",
"organizationId": 0
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ObservingPolicySummary"
},
"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[ObservingPolicySummary]",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{entity_id_or_slug}/observing-policies¶
Create Observing Policy
Description
Create a new observing policy for the path organization.
organization_id is taken from the authorized path owner, not the request
body — a caller cannot create a policy under another organization.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
token |
query | No |
Request body
{
"allowHiddenObservation": true,
"allowHiddenTelemetry": true,
"allowedCatalogObjectTypes": null,
"allowedCoordinateTypes": null,
"allowedDataPolicies": [
"local"
],
"allowedRequestTypes": [
"optical_imaging"
],
"allowedTargetPositionTypes": null,
"dataPublicAfter": null,
"description": null,
"name": "string",
"organizationId": 0
}
Schema of the request body
{
"description": "Create payload for an observing policy.\n\n``name`` is required (the column is ``NOT NULL``). ``allowed_data_policies``\nand ``allowed_request_types`` are required with at least one value (no\nwildcard). The other three allow-lists follow the tri-state null convention —\nomit (or send ``null``) for \"unrestricted\", send ``[]`` for \"none allowed\".",
"properties": {
"allowHiddenObservation": {
"type": "boolean"
},
"allowHiddenTelemetry": {
"type": "boolean"
},
"allowedCatalogObjectTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CatalogObjectType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedCoordinateTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CoordinateType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedDataPolicies": {
"items": {
"$ref": "#/components/schemas/ObservingDataPolicy"
},
"minItems": 1,
"type": "array"
},
"allowedRequestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"minItems": 1,
"type": "array"
},
"allowedTargetPositionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/TargetPositionType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"dataPublicAfter": {
"anyOf": [
{
"format": "duration",
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"organizationId": {
"type": "integer"
}
},
"required": [
"name",
"organizationId",
"allowedDataPolicies",
"allowedRequestTypes",
"allowHiddenObservation",
"allowHiddenTelemetry"
],
"title": "ObservingPolicyCreate",
"type": "object"
}
Responses
{
"allowHiddenObservation": true,
"allowHiddenTelemetry": true,
"allowedCatalogObjectTypes": null,
"allowedCoordinateTypes": null,
"allowedDataPolicies": [
"local"
],
"allowedRequestTypes": [
"optical_imaging"
],
"allowedTargetPositionTypes": null,
"dataPublicAfter": null,
"description": null,
"id": 0,
"name": "string",
"organizationId": 0
}
Schema of the response body
{
"description": "Pydantic representation of an observing policy.",
"properties": {
"allowHiddenObservation": {
"type": "boolean"
},
"allowHiddenTelemetry": {
"type": "boolean"
},
"allowedCatalogObjectTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CatalogObjectType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedCoordinateTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CoordinateType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedDataPolicies": {
"items": {
"$ref": "#/components/schemas/ObservingDataPolicy"
},
"type": "array"
},
"allowedRequestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"allowedTargetPositionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/TargetPositionType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"dataPublicAfter": {
"anyOf": [
{
"format": "duration",
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"organizationId": {
"type": "integer"
}
},
"required": [
"id",
"name",
"allowedDataPolicies",
"allowedRequestTypes",
"allowHiddenObservation",
"allowHiddenTelemetry",
"organizationId"
],
"title": "ObservingPolicy",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /organizations/{entity_id_or_slug}/observing-policies/{policy_id}¶
Delete Observing Policy
Description
Delete an observing policy owned by the path organization.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
policy_id |
path | integer | No | ||
token |
query | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/observing-policies/{policy_id}¶
Read Entity Observing Policy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
policy_id |
path | integer | No | ||
token |
query | No |
Responses
{
"allowHiddenObservation": true,
"allowHiddenTelemetry": true,
"allowedCatalogObjectTypes": null,
"allowedCoordinateTypes": null,
"allowedDataPolicies": [
"local"
],
"allowedRequestTypes": [
"optical_imaging"
],
"allowedTargetPositionTypes": null,
"dataPublicAfter": null,
"description": null,
"id": 0,
"name": "string",
"organizationId": 0
}
Schema of the response body
{
"description": "Pydantic representation of an observing policy.",
"properties": {
"allowHiddenObservation": {
"type": "boolean"
},
"allowHiddenTelemetry": {
"type": "boolean"
},
"allowedCatalogObjectTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CatalogObjectType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedCoordinateTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CoordinateType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedDataPolicies": {
"items": {
"$ref": "#/components/schemas/ObservingDataPolicy"
},
"type": "array"
},
"allowedRequestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"allowedTargetPositionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/TargetPositionType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"dataPublicAfter": {
"anyOf": [
{
"format": "duration",
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"organizationId": {
"type": "integer"
}
},
"required": [
"id",
"name",
"allowedDataPolicies",
"allowedRequestTypes",
"allowHiddenObservation",
"allowHiddenTelemetry",
"organizationId"
],
"title": "ObservingPolicy",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /organizations/{entity_id_or_slug}/observing-policies/{policy_id}¶
Update Observing Policy
Description
Update an observing policy owned by the path organization.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
policy_id |
path | integer | No | ||
token |
query | No |
Request body
{
"allowHiddenObservation": null,
"allowHiddenTelemetry": null,
"allowedCatalogObjectTypes": null,
"allowedCoordinateTypes": null,
"allowedDataPolicies": null,
"allowedRequestTypes": null,
"allowedTargetPositionTypes": null,
"dataPublicAfter": null,
"description": null,
"name": null
}
Schema of the request body
{
"description": "Partial update (PATCH) for an observing policy.\n\nEvery field is optional: the router applies only the fields the client\nactually sends (``model_dump(exclude_unset=True)``), so omitting a field\nleaves it unchanged.\n\n``allowed_data_policies`` and ``allowed_request_types`` are required,\nenumerated lists (no wildcard); when present they must carry at least one\nvalue (``min_length=1``) — you cannot PATCH them to ``[]`` or ``null``. The\nother three allow-lists follow the tri-state null convention: sending\n``null`` sets the wildcard (\"all allowed\"), ``[]`` denies everything.",
"properties": {
"allowHiddenObservation": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"allowHiddenTelemetry": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"allowedCatalogObjectTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CatalogObjectType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedCoordinateTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CoordinateType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedDataPolicies": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservingDataPolicy"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
]
},
"allowedRequestTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
]
},
"allowedTargetPositionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/TargetPositionType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"dataPublicAfter": {
"anyOf": [
{
"format": "duration",
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"title": "ObservingPolicyUpdate",
"type": "object"
}
Responses
{
"allowHiddenObservation": true,
"allowHiddenTelemetry": true,
"allowedCatalogObjectTypes": null,
"allowedCoordinateTypes": null,
"allowedDataPolicies": [
"local"
],
"allowedRequestTypes": [
"optical_imaging"
],
"allowedTargetPositionTypes": null,
"dataPublicAfter": null,
"description": null,
"id": 0,
"name": "string",
"organizationId": 0
}
Schema of the response body
{
"description": "Pydantic representation of an observing policy.",
"properties": {
"allowHiddenObservation": {
"type": "boolean"
},
"allowHiddenTelemetry": {
"type": "boolean"
},
"allowedCatalogObjectTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CatalogObjectType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedCoordinateTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CoordinateType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedDataPolicies": {
"items": {
"$ref": "#/components/schemas/ObservingDataPolicy"
},
"type": "array"
},
"allowedRequestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"allowedTargetPositionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/TargetPositionType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"dataPublicAfter": {
"anyOf": [
{
"format": "duration",
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"organizationId": {
"type": "integer"
}
},
"required": [
"id",
"name",
"allowedDataPolicies",
"allowedRequestTypes",
"allowHiddenObservation",
"allowHiddenTelemetry",
"organizationId"
],
"title": "ObservingPolicy",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/observing-policies/{policy_id}/detail¶
Read Entity Observing Policy Detail
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
entity_id_or_slug |
path | No | Entity id or slug | ||
policy_id |
path | integer | No | ||
token |
query | No |
Responses
{
"allowHiddenObservation": true,
"allowHiddenTelemetry": true,
"allowedCatalogObjectTypes": null,
"allowedCoordinateTypes": null,
"allowedDataPolicies": [
"local"
],
"allowedRequestTypes": [
"optical_imaging"
],
"allowedTargetPositionTypes": null,
"dataPublicAfter": null,
"description": null,
"id": 0,
"name": "string",
"observingAccounts": null,
"observingQueueAccessGrants": null,
"organizationId": 0
}
Schema of the response body
{
"description": "Observing policy with associated observing accounts.",
"properties": {
"allowHiddenObservation": {
"type": "boolean"
},
"allowHiddenTelemetry": {
"type": "boolean"
},
"allowedCatalogObjectTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CatalogObjectType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedCoordinateTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CoordinateType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"allowedDataPolicies": {
"items": {
"$ref": "#/components/schemas/ObservingDataPolicy"
},
"type": "array"
},
"allowedRequestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"allowedTargetPositionTypes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/TargetPositionType"
},
"type": "array"
},
{
"type": "null"
}
]
},
"dataPublicAfter": {
"anyOf": [
{
"format": "duration",
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"observingAccounts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservingAccountSummary"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of observing accounts associated with this policy."
},
"observingQueueAccessGrants": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservingQueueAccessGrantSummary"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "List of observing queue access grants associated with this policy."
},
"organizationId": {
"type": "integer"
}
},
"required": [
"id",
"name",
"allowedDataPolicies",
"allowedRequestTypes",
"allowHiddenObservation",
"allowHiddenTelemetry",
"organizationId"
],
"title": "ObservingPolicyDetail",
"type": "object"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{entity_id_or_slug}/profile-image¶
Create Organization 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,
"sizeBytes": 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"
}
]
},
"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": [
"mimeType",
"name",
"updatedOn",
"createdOn"
],
"title": "FileCreate",
"type": "object"
}
Responses
{
"altTag": null,
"bucket": null,
"createdBy": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"id": "fae424e3-8b67-42b2-8e9f-70ce2701e062",
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /organizations/{entity_id_or_slug}/profile-image/{file_id}¶
Update Organization 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": "4d4a6e02-ce3d-4f36-82c1-4119e2330f22",
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{entity_id_or_slug}/profile-image/{file_id}/upload-url¶
Get Organization 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
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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": "cacaf1c5-775a-449f-92d4-4e30ef850df0"
}
],
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /organizations/{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": "6cd3037d-43a6-40bc-a24d-a0bdd6e9a263"
}
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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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": "d0fefe7e-a8e5-4b99-8d17-b48fc51b476a"
}
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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /organizations/{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": "3f553bba-b967-4867-abdc-09ca7346cb42"
}
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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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": "018073a4-a114-44be-9380-a62fbaa749c2"
}
],
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "9f6f3f86-cc86-49db-849e-7625282636c8"
}
],
"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": "92fbe913-abb1-4ce3-9347-8d3349cd1f98"
}
],
"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,
"flatExposureSunElevationCoeffPerDeg": null,
"id": "string",
"isModifier": null,
"throughputFraction": null
}
],
"flatExposureScaler": null,
"focusOffset": null,
"id": null,
"isActive": true,
"isDeleted": true,
"label": null,
"position": 0,
"uid": "548eded7-3122-4350-a2b2-dffccfa18c3c"
}
],
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "4bd5fc8a-6494-41df-abdc-663a598a8f96"
}
],
"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": "a6ec7088-8fab-4afc-8f32-7aa0d457b1e1"
}
],
"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": "c30dd729-7b35-4166-bb0b-2de0cb6deb5d",
"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": "76a7f02b-0abc-4598-8529-2898e678ed8f"
}
],
"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,
"radioFilters": [
{
"id": 0,
"name": null,
"startFrequencyMhz": 10.12,
"stopFrequencyMhz": 10.12
}
],
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "6cf19ec6-58eb-4fc4-9ea4-661d35b67e1e"
}
],
"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": "1ae4cb6b-f484-4767-99b4-779c17939421"
}
],
"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": "03ca65fd-cf5d-4fc2-839a-56abd9f18f23"
}
],
"shortName": null,
"slug": "string",
"uid": "b2d19b23-3949-4233-b75f-a9adf96ee0a9"
}
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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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": "a99099c6-80f7-4b88-a128-d311cd024b11",
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /organizations/{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": "66238805-7f01-46e0-b31f-3a73f271749e",
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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,
"settleTimeSec": 10.12,
"telescopeId": null,
"telescopeUid": null,
"uid": "18358bc8-f228-4cde-88f4-f83da4ac6abc",
"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."
},
"settleTimeSec": {
"default": 1.0,
"description": "Seconds the mount must hold within the on-target tolerance before it reports on-target.",
"type": "number"
},
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /organizations/{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": null,
"maxSlewRateAxis2DegPerSec": null,
"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": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": ""
},
"maxSlewRateAxis2DegPerSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": ""
},
"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"
],
"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,
"settleTimeSec": 10.12,
"telescopeId": null,
"telescopeUid": null,
"uid": "c73241cd-d909-4a59-9dff-9523afcb6bd6",
"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."
},
"settleTimeSec": {
"default": 1.0,
"description": "Seconds the mount must hold within the on-target tolerance before it reports on-target.",
"type": "number"
},
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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,
"radioFilters": [
{
"id": 0,
"name": null,
"startFrequencyMhz": 10.12,
"stopFrequencyMhz": 10.12
}
],
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "7f199052-1cf4-4cdd-9c14-0fe475d65b5a"
}
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"
},
"radioFilters": {
"description": "Radio filters available on this backend",
"items": {
"$ref": "#/components/schemas/RadioFilter"
},
"type": "array"
},
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /organizations/{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,
"radioFilters": [
{
"id": 0,
"name": null,
"startFrequencyMhz": 10.12,
"stopFrequencyMhz": 10.12
}
],
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "1be62fcf-aee3-4f7f-825b-46cc26aae874"
}
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"
},
"radioFilters": {
"description": "Radio filters available on this backend",
"items": {
"$ref": "#/components/schemas/RadioFilter"
},
"type": "array"
},
"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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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": "0afe048c-6b1d-42d0-87de-5290688be2a1"
}
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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /organizations/{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": "03e59dac-fe77-461a-81d0-ee45f41314a9"
}
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"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{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
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /organizations/{organization_id}/roles¶
Read Organization Roles
Description
List the role-name templates available for organizations.
Roles are no longer per-organization rows; they are enum-keyed templates
defined in :mod:skynet_db.auth.role_permissions. The same role names and
permission sets apply to every organization.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
organization_id |
path | integer | No | ||
token |
query | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schemas¶
AlertBacktestRequest¶
| Name | Type | Description |
|---|---|---|
filters |
AlertSubscriptionFilters | |
limit |
integer | |
since |
AlertBacktestResponse¶
| Name | Type | Description |
|---|---|---|
evaluated |
integer | |
matchedCount |
integer | |
results |
Array<AlertBacktestResult> |
AlertBacktestResult¶
| Name | Type | Description |
|---|---|---|
event |
AlertEvent | |
failedPredicates |
Array<string> | |
matched |
boolean |
AlertEvent¶
| Name | Type | Description |
|---|---|---|
classification |
||
containmentProbability |
||
decDeg |
||
errorRadiusDeg |
||
eventGroupKey |
string | |
eventName |
||
eventTime |
||
externalId |
string | |
id |
integer | |
isTest |
boolean | |
noticeType |
AlertNoticeType | |
payload |
||
raDeg |
||
receivedOn |
string(date-time) | |
skymapObjectKey |
||
sourceId |
integer | |
topic |
string |
AlertFiltersGrb¶
| Name | Type | Description |
|---|---|---|
excludeBogus |
boolean | |
instruments |
||
minSnr |
AlertFiltersGw¶
| Name | Type | Description |
|---|---|---|
groups |
||
maxDistanceMpc |
||
maxFarHz |
||
maxSkymapArea90Deg2 |
||
minBnsProbability |
||
minHasNs |
||
minHasRemnant |
||
minNsbhProbability |
||
requireSignificant |
AlertFiltersSurvey¶
| Name | Type | Description |
|---|---|---|
maxAgeDays |
||
maxMagnitude |
||
minDetections |
||
minKnScore |
||
minSnScore |
AlertNoticeType¶
Type: string
AlertRetractionPolicy¶
Type: string
AlertSubscription¶
| Name | Type | Description |
|---|---|---|
cancelAfterHours |
||
cooldownSec |
||
createdOn |
string(date-time) | |
creatorId |
integer | |
eventTypeHint |
||
expiresOn |
||
filters |
AlertSubscriptionFilters | |
fireOnTestAlerts |
boolean | |
id |
integer | |
isEnabled |
boolean | |
lastFiredOn |
||
matchExpression |
||
maxPerNight |
||
name |
string | |
observingGrantIds |
Array<integer> | |
onRetraction |
AlertRetractionPolicy | |
onUpdate |
AlertUpdatePolicy | |
ownerId |
integer | |
priority |
integer | |
specs |
Array<AlertSubscriptionSpec> | |
updatedOn |
string(date-time) |
AlertSubscriptionCreate¶
| Name | Type | Description |
|---|---|---|
cancelAfterHours |
||
cooldownSec |
||
eventTypeHint |
||
expiresOn |
||
filters |
AlertSubscriptionFilters | |
fireOnTestAlerts |
boolean | |
isEnabled |
boolean | |
matchExpression |
||
maxPerNight |
||
name |
string | |
observingGrantIds |
Array<integer> | |
onRetraction |
AlertRetractionPolicy | |
onUpdate |
AlertUpdatePolicy | |
priority |
integer | |
specs |
Array<AlertSubscriptionSpecCreate> |
AlertSubscriptionFilters¶
| Name | Type | Description |
|---|---|---|
activeMonths |
||
decMaxDeg |
||
decMinDeg |
||
grb |
||
gw |
||
maxErrorRadiusDeg |
||
maxEventAgeSec |
number | |
minGalacticLatitudeDeg |
||
minMoonSeparationDeg |
||
minSunSeparationDeg |
||
noticeTypes |
Array<AlertNoticeType> | |
sources |
Array<string> | |
survey |
AlertSubscriptionSpec¶
| Name | Type | Description |
|---|---|---|
data |
||
id |
integer | |
label |
||
position |
integer | |
schemaKind |
string | |
schemaVersion |
integer | |
subscriptionId |
integer | |
substitution |
AlertSubscriptionSpecCreate¶
| Name | Type | Description |
|---|---|---|
data |
||
label |
||
schemaKind |
string | |
schemaVersion |
integer | |
substitution |
AlertSubscriptionUpdate¶
| Name | Type | Description |
|---|---|---|
cancelAfterHours |
||
cooldownSec |
||
eventTypeHint |
||
expiresOn |
||
filters |
||
fireOnTestAlerts |
||
isEnabled |
||
matchExpression |
||
maxPerNight |
||
name |
||
observingGrantIds |
||
onRetraction |
||
onUpdate |
||
priority |
||
specs |
AlertSubstitution¶
| Name | Type | Description |
|---|---|---|
nameTemplate |
||
priorityOverride |
||
startDelaySec |
number | |
target |
string |
AlertTestFireRequest¶
| Name | Type | Description |
|---|---|---|
decDeg |
number | |
errorRadiusDeg |
number | |
raDeg |
number |
AlertTrigger¶
| Name | Type | Description |
|---|---|---|
alertEventId |
integer | |
attempts |
integer | |
createdOn |
string(date-time) | |
error |
||
eventGroupKey |
string | |
id |
integer | |
kind |
AlertTriggerKind | |
observationId |
||
processedOn |
||
skipReason |
||
status |
AlertTriggerStatus | |
subscriptionId |
integer |
AlertTriggerKind¶
Type: string
AlertTriggerStatus¶
Type: string
AlertType¶
Type: string
AlertUpdatePolicy¶
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. |
CadenceKind¶
Type: string
CalendarUnit¶
Type: string
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
CoordinationKind¶
Type: string
CopiesMode¶
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 | |
createdById |
||
createdOn |
||
creditsUsed |
||
entityId |
integer | |
grantType |
string | |
id |
integer | |
quotas |
||
revoked |
boolean | |
revokedById |
||
revokedOn |
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 |
||
sizeBytes |
||
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 |
||
sizeBytes |
||
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. | |
flatExposureSunElevationCoeffPerDeg |
Per-degree coefficient b in the twilight-flat first-guess model exptime ~ exp(b*|sun_elevation_deg|); ~1.2 broadband, ~0.9 narrowband; null defaults to 1.2. | |
id |
string | Unique identifier of the filter specifier |
isModifier |
True if the filter is a modifier (e.g. polarizer) | |
throughputFraction |
Relative broadband throughput (0-1) for plate-solve filter selection; null = unknown |
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 |
Group¶
| 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. |
GroupCreate¶
| Name | Type | Description |
|---|---|---|
allowDataPolicyOverride |
Whether overriding the data policy is allowed | |
allowInvitations |
Whether invitations are allowed | |
dataPolicy |
Data policy. | |
defaultRoleId |
Default role for users in this group. | |
description |
Description of 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. |
GroupInvitation¶
| Name | Type | Description |
|---|---|---|
createdById |
Entity who created the invitation. | |
createdOn |
string(date-time) | |
email |
||
emailSent |
boolean | |
entityId |
||
expiresIn |
integer | |
groupId |
integer | |
id |
string(uuid) | |
invitationType |
string | |
lastSentOn |
||
roleNames |
Array<GroupRoleName> | |
status |
InvitationStatus | |
used |
boolean |
GroupInvitationCreate¶
| Name | Type | Description |
|---|---|---|
email |
string | |
groupId |
integer | |
invitationType |
string | |
roleNames |
Array<GroupRoleName> |
GroupManagedObservingGrantBase¶
| Name | Type | Description |
|---|---|---|
accountId |
integer | |
createdById |
||
createdOn |
||
creditsUsed |
||
grantType |
string | |
groupId |
integer | |
id |
integer | |
quotas |
||
revoked |
boolean | |
revokedById |
||
revokedOn |
GroupRoleName¶
Type: string
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. |
GroupWithRoles¶
| Name | Type | Description |
|---|---|---|
group |
Group | |
roleNames |
Array<GroupRoleName> |
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
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
InterruptRecovery¶
Type: string
InvitationStatus¶
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 |
IPCameraRole¶
Type: string
IPCameraStream¶
| Name | Type | Description |
|---|---|---|
active |
boolean | |
cameraId |
integer | |
expiresSec |
||
id |
integer | |
isPublic |
boolean | |
kind |
StreamKind | |
quality |
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. | |
settleTimeSec |
number | Seconds the mount must hold within the on-target tolerance before it reports on-target. |
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. | |
settleTimeSec |
number | Seconds the mount must hold within the on-target tolerance before it reports on-target. |
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 |
||
maxSlewRateAxis2DegPerSec |
||
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 |
|---|---|---|
affinityHandoffAfterSec |
||
affinityMigrateAt |
ScheduleRung | |
cadenceCalendarUnit |
||
cadenceGapSec |
||
cadenceKind |
CadenceKind | |
cadenceLevel |
||
cadencePeriodSec |
||
cancelOn |
||
cohesionLevel |
ScheduleRung | |
completedOn |
||
coordinationKind |
||
coordinationStartToleranceSec |
||
copiesCount |
||
copiesMode |
CopiesMode | |
createdOn |
string(date-time) | Creation timestamp. |
creatorId |
integer | User who created it. |
creatorUid |
||
currentEpoch |
integer | |
epochCount |
integer | Number of visits. 0 = repeat indefinitely. |
groupUid |
||
id |
integer | Unique identifier of the observation. |
instrumentIds |
||
instrumentMode |
InstrumentAccessMode | |
interruptLowerPriority |
boolean | Interrupt lower priority. |
interruptRecovery |
InterruptRecovery | |
isDeleted |
boolean | Flag indicating if deleted. |
isPublic |
boolean | |
lastActivityOn |
||
name |
string | Name of the observation. |
observabilityLastUpdatedOn |
Timestamp of the last observability refresh. | |
observingGrantIds |
||
opticalImagingConfiguration |
||
ownerId |
integer | Entity that funds this observation. |
ownerUid |
||
priority |
integer | |
progressFraction |
number | |
radioMappingConfiguration |
||
radioTrackingConfiguration |
||
requestTypes |
Array<ObservationType> | |
sampleOrdering |
SampleOrdering | |
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 |
|---|---|---|
affinityHandoffAfterSec |
||
affinityMigrateAt |
||
cadenceCalendarUnit |
||
cadenceGapSec |
||
cadenceKind |
||
cadenceLevel |
||
cadencePeriodSec |
||
cancelOn |
||
cohesionLevel |
||
completedOn |
||
coordinationKind |
||
coordinationStartToleranceSec |
||
copiesCount |
||
copiesMode |
||
epochCount |
||
instrumentIds |
||
instrumentMode |
||
interruptLowerPriority |
||
interruptRecovery |
||
isDeleted |
||
isPublic |
||
lastActivityOn |
||
name |
string | |
observingGrantIds |
||
opticalImagingConfiguration |
||
ownerId |
integer | |
priority |
||
progressFraction |
||
radioMappingConfiguration |
||
radioTrackingConfiguration |
||
renderSettings |
||
requests |
||
sampleOrdering |
||
startAfter |
||
status |
||
target |
ObservationGalleryItem¶
| Name | Type | Description |
|---|---|---|
file |
||
fileId |
string(uuid) | |
id |
integer | |
observationId |
integer | |
observationUid |
||
order |
||
visibility |
boolean |
ObservationPositionOffsetFrame¶
Type: string
ObservationRequestStatus¶
Type: string
ObservationSortField¶
Type: string
ObservationStatus¶
Type: string
ObservationSummary¶
| Name | Type | Description |
|---|---|---|
affinityHandoffAfterSec |
||
affinityMigrateAt |
ScheduleRung | |
cadenceCalendarUnit |
||
cadenceGapSec |
||
cadenceKind |
CadenceKind | |
cadenceLevel |
||
cadencePeriodSec |
||
cancelOn |
||
cohesionLevel |
ScheduleRung | |
completedOn |
||
coordinationKind |
||
coordinationStartToleranceSec |
||
copiesCount |
||
copiesMode |
CopiesMode | |
createdOn |
string(date-time) | Creation timestamp. |
creator |
||
creatorId |
integer | User who created it. |
creatorUid |
||
currentEpoch |
integer | |
epochCount |
integer | Number of visits. 0 = repeat indefinitely. |
galleryItems |
||
groupUid |
||
id |
integer | Unique identifier of the observation. |
instrumentIds |
||
instrumentMode |
InstrumentAccessMode | |
interruptLowerPriority |
boolean | Interrupt lower priority. |
interruptRecovery |
InterruptRecovery | |
isDeleted |
boolean | Flag indicating if deleted. |
isPublic |
boolean | |
lastActivityOn |
||
name |
string | Name of the observation. |
observabilityLastUpdatedOn |
Timestamp of the last observability refresh. | |
observingGrantIds |
||
opticalImagingConfiguration |
||
owner |
||
ownerId |
integer | Entity that funds this observation. |
ownerUid |
||
priority |
integer | |
progressFraction |
number | |
radioMappingConfiguration |
||
radioTrackingConfiguration |
||
requestTypes |
Array<ObservationType> | |
sampleOrdering |
SampleOrdering | |
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 |
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) |
ObservingPolicy¶
| Name | Type | Description |
|---|---|---|
allowedCatalogObjectTypes |
||
allowedCoordinateTypes |
||
allowedDataPolicies |
Array<ObservingDataPolicy> | |
allowedRequestTypes |
Array<ObservationType> | |
allowedTargetPositionTypes |
||
allowHiddenObservation |
boolean | |
allowHiddenTelemetry |
boolean | |
dataPublicAfter |
||
description |
||
id |
integer | |
name |
string | |
organizationId |
integer |
ObservingPolicyCreate¶
| Name | Type | Description |
|---|---|---|
allowedCatalogObjectTypes |
||
allowedCoordinateTypes |
||
allowedDataPolicies |
Array<ObservingDataPolicy> | |
allowedRequestTypes |
Array<ObservationType> | |
allowedTargetPositionTypes |
||
allowHiddenObservation |
boolean | |
allowHiddenTelemetry |
boolean | |
dataPublicAfter |
||
description |
||
name |
string | |
organizationId |
integer |
ObservingPolicyDetail¶
| Name | Type | Description |
|---|---|---|
allowedCatalogObjectTypes |
||
allowedCoordinateTypes |
||
allowedDataPolicies |
Array<ObservingDataPolicy> | |
allowedRequestTypes |
Array<ObservationType> | |
allowedTargetPositionTypes |
||
allowHiddenObservation |
boolean | |
allowHiddenTelemetry |
boolean | |
dataPublicAfter |
||
description |
||
id |
integer | |
name |
string | |
observingAccounts |
List of observing accounts associated with this policy. | |
observingQueueAccessGrants |
List of observing queue access grants associated with this policy. | |
organizationId |
integer |
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 |
ObservingPolicyUpdate¶
| Name | Type | Description |
|---|---|---|
allowedCatalogObjectTypes |
||
allowedCoordinateTypes |
||
allowedDataPolicies |
||
allowedRequestTypes |
||
allowedTargetPositionTypes |
||
allowHiddenObservation |
||
allowHiddenTelemetry |
||
dataPublicAfter |
||
description |
||
name |
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 | Interval between bias/dark calibration samples (hours) |
calibrationObservationMaxAgeHours |
number | Roll the calibration observation over once it is older than this (hours) |
calibrationObservationMaxTasks |
integer | Roll the calibration observation over once it has this many tasks |
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 |
twilightFlatIntervalHours |
number | Interval between samples of each twilight-flat filter (hours) |
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) | |
pointingRefinementEnabled |
boolean | Whether pre-flight pointing refinement runs for this imager |
seeingArcsec |
number | Seeing (arcsec) |
skyParams |
Sky parameters | |
solveBlindFallbackEnabled |
boolean | On an adequate-source miss, fall back to a blind triangle solve to recover the reference PA + parity |
solveExposureSec |
number | Base solve test-exposure time, scaled by filter throughput |
solveFilterPolicy |
SolveFilterPolicy | Solve-filter selection policy |
solveLastMeasuredAt |
When the server pipeline last confirmed/corrected PA/parity | |
solveMinFilterThroughputFraction |
number | Min filter throughput (0-1) usable for a solve exposure |
solveMinSources |
integer | Extracted-source floor splitting the miss remedy: at/above = blind-eligible, below = repoint-eligible |
solveParity |
Net image handedness as the WCS-determinant sign (+1 normal, -1 flipped) | |
solvePointingRadiusArcmin |
number | Pointing-uncertainty search radius for the constrained solve |
solveReferencePositionAngleDeg |
On-sky PA when the rotator reads 0 (solver adds the live rotator angle) | |
solveRepointAttempts |
integer | Max repoint-and-retry fields tried on star-poor misses (only used when solve_repoint_enabled) |
solveRepointDistanceArcmin |
number | Distance to slew for each repoint attempt (cycling N/E/S/W) |
solveRepointEnabled |
boolean | On a star-poor miss, slew to a nearby field, solve there, and apply the correction back to the target |
solveRotationToleranceDeg |
number | Max rotation deviation from the prior for the constrained solve |
solveScaleToleranceFraction |
number | Max scale deviation from the prior (0-1) for the constrained solve |
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 |
||
modifiedOn |
||
observationId |
||
order |
integer | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
sampleCount |
||
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 |
||
repointingStrategy |
RepointingStrategy | |
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 |
||
repointingStrategy |
RepointingStrategy | |
saturationModel |
||
saturationModelId |
||
temporalOffsetSec |
number | |
tileOverlap |
number | |
trackingMode |
ObservationTrackingMode |
OpticalImagingDarkCalibrationRequestCreate¶
| Name | Type | Description |
|---|---|---|
active |
||
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
expiresOn |
||
exposureTimeSec |
||
instrumentId |
||
instrumentMode |
||
isDeleted |
||
modifiedOn |
||
observationId |
||
order |
integer | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
sampleCount |
||
status |
||
temperatureBand |
OpticalImagingFlatCalibrationRequestCreate¶
| Name | Type | Description |
|---|---|---|
active |
||
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
expiresOn |
||
filterIds |
||
instrumentId |
||
instrumentMode |
||
isDeleted |
||
maxExposureTimeSec |
||
minExposureTimeSec |
||
modifiedOn |
||
observationId |
||
order |
integer | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
sampleCount |
||
status |
||
targetFullWellFraction |
||
temperatureBand |
OpticalImagingRequestCreate¶
| Name | Type | Description |
|---|---|---|
active |
||
allowBinning |
||
allowCoadding |
||
allowRegistration |
||
createdOn |
||
electronicShutter |
||
exposureTimeSec |
||
fastReadout |
||
filterSpecifierIds |
||
globalShutter |
||
hdr |
||
highGain |
||
instrumentMode |
||
isDeleted |
||
maxBitDepth |
||
minBitDepth |
||
modifiedOn |
||
observationId |
||
order |
integer | |
rbiFlood |
||
requestType |
string | |
sampleCount |
||
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
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. |
isPublic |
boolean | Whether the organization is listed in the public directory and exposes a public profile. |
location |
Location provided by the user or organization in their public profile | |
memberCount |
Number of members in the organization | |
membersVisibleToMembers |
boolean | Whether ordinary members can see the organization's member roster (both the /members endpoint and the public directory). |
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 |
OrganizationDetail¶
| 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. |
isPublic |
boolean | Whether the organization is listed in the public directory and exposes a public profile. |
location |
Location provided by the user or organization in their public profile | |
memberCount |
Number of members in the organization | |
membersVisibleToMembers |
boolean | Whether ordinary members can see the organization's member roster (both the /members endpoint and the public directory). |
name |
string | Name of the user/organization. |
observingPolicies |
Observing policies configured for the 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 |
OrganizationInvitation¶
| Name | Type | Description |
|---|---|---|
createdById |
Entity who created the invitation. | |
createdOn |
string(date-time) | |
email |
||
emailSent |
boolean | |
entityId |
||
expiresIn |
integer | |
groupAssignments |
||
id |
string(uuid) | |
invitationType |
string | |
lastSentOn |
||
organizationId |
integer | |
roleNames |
Array<OrganizationRoleName> | |
status |
InvitationStatus | |
used |
boolean |
OrganizationInvitationCreate¶
| Name | Type | Description |
|---|---|---|
email |
string | |
groupAssignments |
||
invitationType |
string | |
organizationId |
integer | |
roleNames |
Array<OrganizationRoleName> |
OrganizationInvitationGroupAssignment¶
| Name | Type | Description |
|---|---|---|
groupId |
integer | |
id |
integer | |
roleNames |
Array<GroupRoleName> |
OrganizationInvitationGroupAssignmentCreate¶
| Name | Type | Description |
|---|---|---|
groupId |
integer | |
id |
||
roleNames |
Array<GroupRoleName> |
OrganizationMembership¶
| Name | Type | Description |
|---|---|---|
joinedOn |
string(date-time) | |
organizationId |
integer | |
userId |
integer |
OrganizationMemberWithRoles¶
| Name | Type | Description |
|---|---|---|
groupsWithRoles |
Array<GroupWithRoles> | |
member |
UserWithEmail | |
roleNames |
Array<OrganizationRoleName> |
OrganizationProfileUpdate¶
| Name | Type | Description |
|---|---|---|
allowRequestToJoin |
Whether request-to-join is allowed. | |
country |
Country in the public profile. | |
description |
Bio/description in the public profile. | |
isPublic |
Whether the organization is listed in the public directory and exposes a public profile. | |
location |
Location in the public profile. | |
membersVisibleToMembers |
Whether ordinary members can see the organization's member roster. | |
name |
Name of the organization. | |
profileImageId |
Profile image of the organization. | |
shortName |
Short name of the organization. | |
websiteUrl |
Website URL in the 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. |
isPublic |
boolean | Whether the organization is listed in the public directory and exposes a public profile. |
location |
Location provided by the user or organization in their public profile | |
memberCount |
Number of members in the organization | |
membersVisibleToMembers |
boolean | Whether ordinary members can see the organization's member roster (both the /members endpoint and the public directory). |
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 |
OrganizationRoleGrant¶
| Name | Type | Description |
|---|---|---|
grantedOn |
string(date-time) | |
grantorId |
||
groupId |
||
id |
integer | |
organizationId |
integer | |
roleName |
OrganizationRoleName | |
userId |
OrganizationRoleName¶
Type: string
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. |
isPublic |
boolean | Whether the organization is listed in the public directory and exposes a public profile. |
location |
Location provided by the user or organization in their public profile | |
memberCount |
Number of members in the organization | |
membersVisibleToMembers |
boolean | Whether ordinary members can see the organization's member roster (both the /members endpoint and the public directory). |
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_AlertSubscription_¶
| Name | Type | Description |
|---|---|---|
items |
Array<AlertSubscription> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_AlertTrigger_¶
| Name | Type | Description |
|---|---|---|
items |
Array<AlertTrigger> | |
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_Annotated_Union_S3MinioIntegration__TreasureMapIntegration__GoogleDriveIntegration__DropboxIntegration__SlackIntegrationFieldInfoannotation_NoneTyperequired_True__discriminator__integration_type____¶
| Name | Type | Description |
|---|---|---|
items |
Array<> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_Group_¶
| Name | Type | Description |
|---|---|---|
items |
Array<Group> | |
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_ObservingPolicySummary_¶
| Name | Type | Description |
|---|---|---|
items |
Array<ObservingPolicySummary> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_OrganizationInvitation_¶
| Name | Type | Description |
|---|---|---|
items |
Array<OrganizationInvitation> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_OrganizationMembership_¶
| Name | Type | Description |
|---|---|---|
items |
Array<OrganizationMembership> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_OrganizationMemberWithRoles_¶
| Name | Type | Description |
|---|---|---|
items |
Array<OrganizationMemberWithRoles> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_OrganizationSummary_¶
| Name | Type | Description |
|---|---|---|
items |
Array<OrganizationSummary> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_TelescopeSummary_¶
| Name | Type | Description |
|---|---|---|
items |
Array<TelescopeSummary> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_UserWithEmail_¶
| Name | Type | Description |
|---|---|---|
items |
Array<UserWithEmail> | |
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. |
radioFilters |
Array<RadioFilter> | Radio filters available on this backend |
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. |
radioFilters |
Array<RadioFilter> | Radio filters available on this backend |
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
RadioFilter¶
| Name | Type | Description |
|---|---|---|
id |
integer | Radio filter PK |
name |
Filter name | |
startFrequencyMhz |
number | Filter lower frequency bound (MHz) |
stopFrequencyMhz |
number | Filter upper frequency bound (MHz) |
RadioMappingConfiguration¶
| Name | Type | Description |
|---|---|---|
coordinateType |
CoordinateType | |
coordinateUnit |
RadioCoordinateUnit | |
daisyDiameter |
||
densityAlongSweeps |
number | |
densityBetweenSweeps |
||
enableSphericalCorrection |
boolean | |
integrationTimeSec |
||
mappingStrategy |
RadioMappingStrategy | |
maxSunElevationDeg |
number | |
minElevationDeg |
number | |
minSunSeparationDeg |
number | |
rasterSizeX |
||
rasterSizeY |
||
slewSpeedDegPerSec |
||
sweepDirection |
RadioMappingRasterDirection¶
Type: string
RadioMappingRequestCreate¶
| Name | Type | Description |
|---|---|---|
active |
||
createdOn |
||
instrumentMode |
||
isDeleted |
||
minResolutionMhz |
||
modifiedOn |
||
observationId |
||
order |
integer | |
polarization |
||
requestType |
string | |
sampleCount |
||
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 |
RadioReceiverSummary¶
| Name | Type | Description |
|---|---|---|
band |
Receiver band | |
id |
integer | Receiver PK |
maxFrequencyMhz |
number | Maximum frequency (MHz) |
minFrequencyMhz |
number | Minimum frequency (MHz) |
name |
string | Receiver name |
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 | |
receiverSummaries |
Compact descriptors of the connected 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 |
||
durationSec |
number | |
instrumentMode |
||
isDeleted |
||
maxIntegrationTimeMs |
||
minResolutionMhz |
||
modifiedOn |
||
observationId |
||
order |
integer | |
polarization |
||
requestType |
string | |
requireContinuum |
boolean | |
sampleCount |
||
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. |
RepointingStrategy¶
Type: string
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 |
SampleOrdering¶
Type: string
ScheduleRung¶
Type: string
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 |
SkyBrightnessModelCreate¶
| Name | Type | Description |
|---|---|---|
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 |
SolveFilterPolicy¶
Type: string
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 |
SourceBrightnessModelCreate¶
| Name | Type | Description |
|---|---|---|
avMag |
Absolute V-band extinction | |
filterId |
Filter used as reference | |
isPointSource |
True if point source, False if extended | |
magnitudeMag |
number | Point source magnitude or extended source surface brightness |
modelType |
string | |
rv |
Ratio of total to selective extinction | |
spectralComponentId |
Associated spectral component | |
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 |
name |
string | Name of the Target |
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 |
||
name |
string | |
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 |
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 | |
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 |
OAuth-verified ORCID iD shown on the public profile | |
orcidVerifiedAt |
When the ORCID iD was verified via OAuth (null = no verified iD) | |
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 |
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 | |
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 |
OAuth-verified ORCID iD shown on the public profile | |
orcidVerifiedAt |
When the ORCID iD was verified via OAuth (null = no verified iD) | |
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 | |
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 |
OAuth-verified ORCID iD shown on the public profile | |
orcidVerifiedAt |
When the ORCID iD was verified via OAuth (null = no verified iD) | |
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 |
UserWithEmail¶
| 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 | Type of entity (user/organization) |
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 |
OAuth-verified ORCID iD shown on the public profile | |
orcidVerifiedAt |
When the ORCID iD was verified via OAuth (null = no verified iD) | |
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. |