Observation API
The Observation API covers everything observation-shaped: observations themselves, observation requests, observation tasks, and targets. It's the API you'll spend the most time in if you're automating data acquisition.
Endpoints at a glance
This page embeds the auto-generated OpenAPI reference (below) which is the authoritative source. The narrative here covers what isn't obvious from the spec.
| Resource | What it is |
|---|---|
/v1/observations |
Observations — the top-level container. See Observation schema |
/v1/observation-requests |
Per-observation data requests (imaging, radio, calibrations). Polymorphic on requestType |
/v1/observation-tasks |
Per-task execution records the scheduler creates from requests |
/v1/targets |
Celestial targets — fixed, catalog, ephemeral, orbital positions |
Action endpoints
A few common operations are action endpoints rather than direct PATCHes, because they involve state transitions:
| Endpoint | What it does |
|---|---|
POST /v1/observations/{id}/publish |
Transition from kind: draft to kind: instance; make the observation visible to the scheduler |
POST /v1/observations/{id}/cancel |
Mark the observation canceled; any pending tasks are dropped |
POST /v1/observations/{id}/fork |
Create a new draft from an existing observation |
See Editor → Publish for the publish state transition in detail.
Common pitfalls
- Polymorphic discrimination. Every request and task carries a
requestType/taskType. When you create a request, the body shape depends on the discriminator. See Conventions → Polymorphic resources. - Targets are nested resources. They attach to an observation,
not standalone —
/v1/targetsexists for reads but writes typically happen as part of the observation editor flow. - Drafts vs. instances. Both kinds remain editable. Drafts aren't visible to the scheduler; instances are. Publishing flips the discriminator — see Editor → Publish and Projects vs. observations.
- Quota mechanics. Submitting an observation costs nothing.
Credits are tallied against the funding account and grant as
tasks dispatch (
ObservingAccountTxnrecords). Throttling is driven by quotas attached to accounts and grants — each quota is a(period_type, max_credits)rule; period types arelifetime,day,week,month, ornight. Multiple quotas can attach to the same account / grant and all must be satisfied; dispatch pauses when any one would be exceeded. Quota-exceeded observations stall rather than error, and resume as quota frees up. See Observing accounts → Quotas.
Common task recipes
The curl quickstart walks the most common flow (create draft → set target → add request → attach grant → publish → poll).
Other recipes worth knowing:
- Submit from an existing project template — use
POST /v1/project-templates/{uid}/instantiateinstead of building a draft from scratch. See Project templates. - Bulk submission — submit observations one at a time today; there's no bulk endpoint. Wrap the per-observation calls with your own retry logic.
- Watch for completion — poll
GET /v1/observations/{id}forstatus: completed, or subscribe to thetelescope_loganddevice_snapshotstreams via WebSocket for finer-grained progress.
Reference
Observation API 2.0.0
Endpoints for managing observations, observation requests, tasks and related resources.
Data Requests
GET /observation-requests
Read Requests
Description
Retrieve a page of observation requests.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
filter_observation_id |
query | No | |||
filterObservationId |
query | No | |||
id |
query | No | |||
is_deleted |
query | No | |||
is_original |
query | No | |||
isDeleted |
query | No | |||
isOriginal |
query | No | |||
kind |
query | No | |||
original_id |
query | No | |||
originalId |
query | No | |||
sort_by |
query | No | |||
sortBy |
query | No | |||
status |
query | No | |||
token |
query | No |
Responses
{
"items": [
null
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequestSummary",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequestSummary",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequestSummary",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequestSummary",
"radio_mapping": "#/components/schemas/RadioMappingRequestSummary",
"radio_tracking": "#/components/schemas/RadioTrackingRequestSummary"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequestSummary"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequestSummary"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequestSummary"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequestSummary"
},
{
"$ref": "#/components/schemas/RadioTrackingRequestSummary"
},
{
"$ref": "#/components/schemas/RadioMappingRequestSummary"
}
]
},
"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[OpticalImagingRequestSummary, OpticalImagingBiasCalibrationRequestSummary, OpticalImagingDarkCalibrationRequestSummary, OpticalImagingFlatCalibrationRequestSummary, RadioTrackingRequestSummary, RadioMappingRequestSummary], FieldInfo(annotation=NoneType, required=True, discriminator='request_type')]]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /observation-requests
Create Request
Description
Create a new observation request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
token |
query | No |
Request body
Schema of the request body
{
"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"
}
],
"title": "Body"
}
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequestDetail",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail",
"radio_mapping": "#/components/schemas/RadioMappingRequestDetail",
"radio_tracking": "#/components/schemas/RadioTrackingRequestDetail"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/RadioTrackingRequestDetail"
},
{
"$ref": "#/components/schemas/RadioMappingRequestDetail"
}
],
"title": "Response Create Request Observation Requests Post"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
DELETE /observation-requests/{request_id}
Delete Request
Description
Remove an observation request from the system.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
request_id |
path | integer | No | ||
token |
query | No |
Responses
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observation-requests/{request_id}
Read Request
Description
Retrieve a specific observation request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
request_id |
path | integer | No | ||
token |
query | No |
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequest",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequest",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequest",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequest",
"radio_mapping": "#/components/schemas/RadioMappingRequest",
"radio_tracking": "#/components/schemas/RadioTrackingRequest"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequest"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequest"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequest"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequest"
},
{
"$ref": "#/components/schemas/RadioTrackingRequest"
},
{
"$ref": "#/components/schemas/RadioMappingRequest"
}
],
"title": "Response Read Request Observation Requests Request Id Get"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PATCH /observation-requests/{request_id}
Update Request
Description
Modify an existing observation request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
request_id |
path | integer | No | ||
token |
query | No |
Request body
Schema of the request body
{
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequestUpdate",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequestUpdate",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequestUpdate",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequestUpdate",
"radio_mapping": "#/components/schemas/RadioMappingRequestUpdate",
"radio_tracking": "#/components/schemas/RadioTrackingRequestUpdate"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequestUpdate"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequestUpdate"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequestUpdate"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequestUpdate"
},
{
"$ref": "#/components/schemas/RadioTrackingRequestUpdate"
},
{
"$ref": "#/components/schemas/RadioMappingRequestUpdate"
}
],
"title": "Body"
}
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequestDetail",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail",
"radio_mapping": "#/components/schemas/RadioMappingRequestDetail",
"radio_tracking": "#/components/schemas/RadioTrackingRequestDetail"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/RadioTrackingRequestDetail"
},
{
"$ref": "#/components/schemas/RadioMappingRequestDetail"
}
],
"title": "Response Update Request Observation Requests Request Id Patch"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observation-requests/{request_id}/detail
Read Request Detail
Description
Retrieve a detailed observation request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
request_id |
path | integer | No | ||
token |
query | No |
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequestDetail",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail",
"radio_mapping": "#/components/schemas/RadioMappingRequestDetail",
"radio_tracking": "#/components/schemas/RadioTrackingRequestDetail"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/RadioTrackingRequestDetail"
},
{
"$ref": "#/components/schemas/RadioMappingRequestDetail"
}
],
"title": "Response Read Request Detail Observation Requests Request Id Detail Get"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /observation-requests/{request_id}/draft
Create Request Draft
Description
Generate a draft copy of an existing request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
request_id |
path | integer | No | ||
token |
query | No |
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequestDetail",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail",
"radio_mapping": "#/components/schemas/RadioMappingRequestDetail",
"radio_tracking": "#/components/schemas/RadioTrackingRequestDetail"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/RadioTrackingRequestDetail"
},
{
"$ref": "#/components/schemas/RadioMappingRequestDetail"
}
],
"title": "Response Create Request Draft Observation Requests Request Id Draft Post"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /observation-requests/{request_id}/publish
Submit Request Draft
Description
Publish a previously created draft request.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
request_id |
path | integer | No | ||
token |
query | No |
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequestDetail",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail",
"radio_mapping": "#/components/schemas/RadioMappingRequestDetail",
"radio_tracking": "#/components/schemas/RadioTrackingRequestDetail"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/RadioTrackingRequestDetail"
},
{
"$ref": "#/components/schemas/RadioMappingRequestDetail"
}
],
"title": "Response Submit Request Draft Observation Requests Request Id Publish Post"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
Observation Tasks
GET /observation-tasks
Read Tasks
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
binning |
query | No | |||
completed_after |
query | No | |||
completed_before |
query | No | |||
completedAfter |
query | No | |||
completedBefore |
query | No | |||
earliest_start_after |
query | No | |||
earliest_start_before |
query | No | |||
earliestStartAfter |
query | No | |||
earliestStartBefore |
query | No | |||
expiration_after |
query | No | |||
expirationAfter |
query | No | |||
filter_id |
query | No | |||
filterId |
query | No | |||
id |
query | No | |||
observation_id |
query | No | |||
observation_iteration |
query | No | |||
observationId |
query | No | |||
observationIteration |
query | No | |||
planned_start_after |
query | No | |||
planned_start_before |
query | No | |||
plannedStartAfter |
query | No | |||
plannedStartBefore |
query | No | |||
request_id |
query | No | |||
requestId |
query | No | |||
shutter_state |
query | No | |||
shutterState |
query | No | |||
sort_by |
query | No | |||
sortBy |
query | No | |||
status |
query | No | |||
telescope_id |
query | No | |||
telescopeId |
query | No | |||
token |
query | No |
Responses
{
"items": [
null
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingTaskSummary",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationTaskSummary",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationTaskSummary",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationTaskSummary",
"radio_mapping": "#/components/schemas/RadioMappingTaskSummary",
"radio_tracking": "#/components/schemas/RadioTrackingTaskSummary"
},
"propertyName": "taskType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingTaskSummary"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationTaskSummary"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationTaskSummary"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationTaskSummary"
},
{
"$ref": "#/components/schemas/RadioTrackingTaskSummary"
},
{
"$ref": "#/components/schemas/RadioMappingTaskSummary"
}
]
},
"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[OpticalImagingTaskSummary, OpticalImagingBiasCalibrationTaskSummary, OpticalImagingDarkCalibrationTaskSummary, OpticalImagingFlatCalibrationTaskSummary, RadioTrackingTaskSummary, RadioMappingTaskSummary], FieldInfo(annotation=NoneType, required=True, discriminator='task_type')]]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observation-tasks/{task_id}
Read Task
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
task_id |
path | integer | No | ||
token |
query | No |
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingTask",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationTask",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationTask",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationTask",
"radio_mapping": "#/components/schemas/RadioMappingTask",
"radio_tracking": "#/components/schemas/RadioTrackingTask"
},
"propertyName": "taskType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingTask"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationTask"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationTask"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationTask"
},
{
"$ref": "#/components/schemas/RadioTrackingTask"
},
{
"$ref": "#/components/schemas/RadioMappingTask"
}
],
"title": "Response Read Task Observation Tasks Task Id Get"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observation-tasks/{task_id}/detail
Read Task Detail
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
task_id |
path | integer | No | ||
token |
query | No |
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingTaskDetail",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationTaskDetail",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationTaskDetail",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationTaskDetail",
"radio_mapping": "#/components/schemas/RadioMappingTaskDetail",
"radio_tracking": "#/components/schemas/RadioTrackingTaskDetail"
},
"propertyName": "taskType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingTaskDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationTaskDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationTaskDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationTaskDetail"
},
{
"$ref": "#/components/schemas/RadioTrackingTaskDetail"
},
{
"$ref": "#/components/schemas/RadioMappingTaskDetail"
}
],
"title": "Response Read Task Detail Observation Tasks Task Id Detail Get"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
Observations
GET /observations
Read Observations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
-creator |
query | No | |||
-creatorId |
query | No | |||
-group |
query | No | |||
-groupId |
query | No | |||
-kind |
query | No | |||
-organization |
query | No | |||
-organizationId |
query | No | |||
-owner |
query | No | |||
-ownerId |
query | No | |||
-status |
query | No | |||
completed_after |
query | No | |||
completed_before |
query | No | |||
completedAfter |
query | No | |||
completedBefore |
query | No | |||
created_after |
query | No | |||
created_before |
query | No | |||
createdAfter |
query | No | |||
createdBefore |
query | No | |||
creator |
query | No | |||
creator_ |
query | No | |||
creator_id |
query | No | |||
creator_id_ |
query | No | |||
creatorId |
query | No | |||
group |
query | No | |||
group_ |
query | No | |||
group_id |
query | No | |||
group_id_ |
query | No | |||
groupId |
query | No | |||
id |
query | No | |||
is_original |
query | No | |||
isOriginal |
query | No | |||
kind |
query | No | |||
kind_ |
query | No | |||
last_activity_after |
query | No | |||
last_activity_before |
query | No | |||
lastActivityAfter |
query | No | |||
lastActivityBefore |
query | No | |||
name |
query | No | |||
observation_type |
query | No | |||
observationType |
query | No | |||
organization |
query | No | |||
organization_ |
query | No | |||
organization_id |
query | No | |||
organization_id_ |
query | No | |||
organizationId |
query | No | |||
original_id |
query | No | |||
originalId |
query | No | |||
owner |
query | No | |||
owner_ |
query | No | |||
owner_id |
query | No | |||
owner_id_ |
query | No | |||
ownerId |
query | No | |||
sort_by |
query | No | |||
sortBy |
query | No | |||
status |
query | No | |||
status_ |
query | No | |||
token |
query | No |
Responses
{
"items": [
{
"cancelOn": null,
"completedOn": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creator": null,
"creatorId": 0,
"creatorUid": null,
"currentIteration": 0,
"galleryItems": null,
"groupUid": null,
"id": 0,
"instrumentAssignmentMode": "observation",
"instrumentIds": null,
"instrumentLockTimeoutSec": 10.12,
"instrumentMode": "none",
"interruptLowerPriority": true,
"isDeleted": true,
"isPublic": true,
"iterationInterval": 10.12,
"iterationIntervalType": "fixed",
"iterations": 0,
"kind": "template",
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingBlockPolicy": "request_iteration",
"observingGrantIds": null,
"opticalImagingConfiguration": null,
"originalId": null,
"originalUid": null,
"owner": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"requestTypes": [
"optical_imaging"
],
"startAfter": null,
"status": "active",
"target": null,
"targetId": null,
"targetUid": null,
"uid": "ce7b12b3-a309-419d-8b72-eae9131bf5f6",
"updatedOn": "2022-04-13T15:42:05.901Z"
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ObservationSummary"
},
"title": "Items",
"type": "array"
},
"page": {
"minimum": 1.0,
"title": "Page",
"type": "integer"
},
"pages": {
"minimum": 0.0,
"title": "Pages",
"type": "integer"
},
"size": {
"minimum": 1.0,
"title": "Size",
"type": "integer"
},
"total": {
"minimum": 0.0,
"title": "Total",
"type": "integer"
}
},
"required": [
"items",
"total",
"page",
"size",
"pages"
],
"title": "Page[ObservationSummary]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
DELETE /observations/{observation_id}
Delete Observation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Responses
Schema of the response body
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}
Read Observation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Responses
{
"cancelOn": null,
"completedOn": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creatorId": 0,
"creatorUid": null,
"currentIteration": 0,
"groupUid": null,
"id": 0,
"instrumentAssignmentMode": "observation",
"instrumentIds": null,
"instrumentLockTimeoutSec": 10.12,
"instrumentMode": "none",
"interruptLowerPriority": true,
"isDeleted": true,
"isPublic": true,
"iterationInterval": 10.12,
"iterationIntervalType": "fixed",
"iterations": 0,
"kind": "template",
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingBlockPolicy": "request_iteration",
"observingGrantIds": null,
"opticalImagingConfiguration": null,
"originalId": null,
"originalUid": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"requestTypes": [
"optical_imaging"
],
"startAfter": null,
"status": "active",
"targetId": null,
"targetUid": null,
"uid": "20337f5b-9127-4dd6-9960-a80c7792e011",
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"createdOn": {
"description": "Creation timestamp.",
"format": "date-time",
"type": "string"
},
"creatorId": {
"description": "User who created it.",
"type": "integer"
},
"creatorUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"currentIteration": {
"default": 0,
"type": "integer"
},
"groupUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"description": "Unique identifier of the observation.",
"type": "integer"
},
"instrumentAssignmentMode": {
"$ref": "#/components/schemas/InstrumentAssignmentMode"
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentLockTimeoutSec": {
"type": "number"
},
"instrumentMode": {
"$ref": "#/components/schemas/InstrumentAccessMode"
},
"interruptLowerPriority": {
"description": "Interrupt lower priority.",
"type": "boolean"
},
"isDeleted": {
"description": "Flag indicating if deleted.",
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"iterationInterval": {
"type": "number"
},
"iterationIntervalType": {
"$ref": "#/components/schemas/IterationIntervalType"
},
"iterations": {
"type": "integer"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"description": "Name of the observation.",
"type": "string"
},
"observabilityLastUpdatedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Timestamp of the last observability refresh."
},
"observingBlockPolicy": {
"$ref": "#/components/schemas/ObservingBlockPolicy",
"default": "observation_iteration",
"description": "How observation tasks should be grouped into uninterrupted scheduling blocks."
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Output"
},
{
"type": "null"
}
]
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the observation forked from."
},
"originalUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"ownerId": {
"description": "Entity that funds this observation.",
"type": "integer"
},
"ownerUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"priority": {
"type": "integer"
},
"progressFraction": {
"type": "number"
},
"radioMappingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/RadioMappingConfiguration"
},
{
"type": "null"
}
]
},
"radioTrackingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/RadioTrackingConfiguration"
},
{
"type": "null"
}
]
},
"requestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"startAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/components/schemas/ObservationStatus"
},
"targetId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the target associated with the observation."
},
"targetUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"updatedOn": {
"description": "Update timestamp.",
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"uid",
"targetId",
"status",
"kind",
"isDeleted",
"createdOn",
"updatedOn",
"name",
"ownerId",
"creatorId",
"interruptLowerPriority",
"priority",
"instrumentAssignmentMode",
"instrumentLockTimeoutSec",
"iterations",
"iterationIntervalType",
"iterationInterval",
"progressFraction",
"isPublic",
"instrumentMode"
],
"title": "Observation",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PATCH /observations/{observation_id}
Update Observation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Request body
{
"cancelOn": null,
"completedOn": null,
"instrumentAssignmentMode": null,
"instrumentIds": null,
"instrumentLockTimeoutSec": null,
"instrumentMode": null,
"interruptLowerPriority": null,
"isDeleted": null,
"isPublic": null,
"iterationInterval": null,
"iterationIntervalType": null,
"iterations": null,
"kind": null,
"lastActivityOn": null,
"name": null,
"observabilityLastUpdatedOn": null,
"observingBlockPolicy": null,
"observingGrantIds": null,
"opticalImagingConfiguration": null,
"originalId": null,
"ownerId": null,
"priority": null,
"progressFraction": null,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"renderSettings": null,
"startAfter": null,
"status": null
}
Schema of the request body
{
"properties": {
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"instrumentAssignmentMode": {
"anyOf": [
{
"$ref": "#/components/schemas/InstrumentAssignmentMode"
},
{
"type": "null"
}
]
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentLockTimeoutSec": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"instrumentMode": {
"anyOf": [
{
"$ref": "#/components/schemas/InstrumentAccessMode"
},
{
"type": "null"
}
]
},
"interruptLowerPriority": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isDeleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isPublic": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"iterationInterval": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"iterationIntervalType": {
"anyOf": [
{
"$ref": "#/components/schemas/IterationIntervalType"
},
{
"type": "null"
}
]
},
"iterations": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"kind": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservationKind"
},
{
"type": "null"
}
]
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observabilityLastUpdatedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"observingBlockPolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservingBlockPolicy"
},
{
"type": "null"
}
]
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Input"
},
{
"type": "null"
}
]
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"ownerId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"priority": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"progressFraction": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"radioMappingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/RadioMappingConfiguration"
},
{
"type": "null"
}
]
},
"radioTrackingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/RadioTrackingConfiguration"
},
{
"type": "null"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"startAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservationStatus"
},
{
"type": "null"
}
]
}
},
"title": "ObservationUpdate",
"type": "object"
}
Responses
{
"cancelOn": null,
"completedOn": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creator": null,
"creatorId": 0,
"creatorUid": null,
"currentIteration": 0,
"galleryItems": null,
"groupUid": null,
"id": 0,
"instrumentAssignmentMode": "observation",
"instrumentIds": null,
"instrumentLockTimeoutSec": 10.12,
"instrumentMode": "none",
"interruptLowerPriority": true,
"isDeleted": true,
"isPublic": true,
"iterationInterval": 10.12,
"iterationIntervalType": "fixed",
"iterations": 0,
"kind": "template",
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingBlockPolicy": "request_iteration",
"observingGrantIds": null,
"observingGrants": null,
"opticalImagingConfiguration": null,
"originalId": null,
"originalUid": null,
"owner": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"renderSettings": null,
"requestTypes": [
"optical_imaging"
],
"startAfter": null,
"status": "active",
"target": null,
"targetId": null,
"targetUid": null,
"uid": "2ab141bc-4630-4a46-ad0b-3e8486461699",
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"createdOn": {
"description": "Creation timestamp.",
"format": "date-time",
"type": "string"
},
"creator": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"type": "null"
}
]
},
"creatorId": {
"description": "User who created it.",
"type": "integer"
},
"creatorUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"currentIteration": {
"default": 0,
"type": "integer"
},
"galleryItems": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservationGalleryItem"
},
"type": "array"
},
{
"type": "null"
}
]
},
"groupUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"description": "Unique identifier of the observation.",
"type": "integer"
},
"instrumentAssignmentMode": {
"$ref": "#/components/schemas/InstrumentAssignmentMode"
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentLockTimeoutSec": {
"type": "number"
},
"instrumentMode": {
"$ref": "#/components/schemas/InstrumentAccessMode"
},
"interruptLowerPriority": {
"description": "Interrupt lower priority.",
"type": "boolean"
},
"isDeleted": {
"description": "Flag indicating if deleted.",
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"iterationInterval": {
"type": "number"
},
"iterationIntervalType": {
"$ref": "#/components/schemas/IterationIntervalType"
},
"iterations": {
"type": "integer"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"description": "Name of the observation.",
"type": "string"
},
"observabilityLastUpdatedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Timestamp of the last observability refresh."
},
"observingBlockPolicy": {
"$ref": "#/components/schemas/ObservingBlockPolicy",
"default": "observation_iteration",
"description": "How observation tasks should be grouped into uninterrupted scheduling blocks."
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"observingGrants": {
"anyOf": [
{
"items": {
"discriminator": {
"mapping": {
"externally_managed": "#/components/schemas/ExternallyManagedObservingGrantDetail",
"group": "#/components/schemas/GroupObservingGrantDetail",
"group_managed": "#/components/schemas/GroupManagedObservingGrantDetail",
"member": "#/components/schemas/MemberObservingGrantDetail",
"owner": "#/components/schemas/OwnerObservingGrantDetail"
},
"propertyName": "grantType"
},
"oneOf": [
{
"$ref": "#/components/schemas/MemberObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupObservingGrantDetail"
},
{
"$ref": "#/components/schemas/OwnerObservingGrantDetail"
},
{
"$ref": "#/components/schemas/ExternallyManagedObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupManagedObservingGrantDetail"
}
]
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Output"
},
{
"type": "null"
}
]
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the observation forked from."
},
"originalUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"owner": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"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"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"requestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"startAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/components/schemas/ObservationStatus"
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/Target"
},
{
"type": "null"
}
]
},
"targetId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the target associated with the observation."
},
"targetUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"updatedOn": {
"description": "Update timestamp.",
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"uid",
"targetId",
"status",
"kind",
"isDeleted",
"createdOn",
"updatedOn",
"name",
"ownerId",
"creatorId",
"interruptLowerPriority",
"priority",
"instrumentAssignmentMode",
"instrumentLockTimeoutSec",
"iterations",
"iterationIntervalType",
"iterationInterval",
"progressFraction",
"isPublic",
"instrumentMode"
],
"title": "ObservationDetail",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/assets
Read Observation Assets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
created_by |
query | No | |||
createdBy |
query | No | |||
id |
query | No | |||
is_transferrable |
query | No | |||
isTransferrable |
query | No | |||
mime_type |
query | No | |||
mimeType |
query | No | |||
name |
query | No | |||
observation_id |
path | integer | No | Observation id | |
processing_flags |
query | No | |||
processing_flags_exclude |
query | No | |||
processingFlags |
query | No | |||
processingFlagsExclude |
query | No | |||
role |
query | No | |||
role_exclude |
query | No | |||
roleExclude |
query | No | |||
sort_by |
query | No | |||
sortBy |
query | No | |||
task_id |
query | No | |||
taskId |
query | No | |||
token |
query | No | |||
transfer_state |
query | No | |||
transferState |
query | No | |||
view |
query | No |
Responses
{
"items": [
{
"currentAnalysisRun": null,
"currentAnalysisRunId": null,
"currentProcessingOutput": null,
"currentProcessingOutputId": null,
"currentProcessingRun": null,
"currentProcessingRunId": null,
"currentRenderRun": null,
"currentRenderRunId": null,
"file": null,
"fileId": "ee883948-81de-41c3-a814-63d0e8515277",
"id": 0,
"instrumentId": 0,
"instrumentUid": null,
"isTransferrable": true,
"lastTransferAttempt": null,
"nextEligibleRenderAt": null,
"observationId": 0,
"observationUid": null,
"previewFile": null,
"previewFileId": null,
"processingFlags": null,
"reductionInfo": null,
"remoteFilePath": null,
"renderDirtyAt": null,
"role": null,
"rootObservationAssetId": null,
"rootObservationAssetUid": null,
"taskInfo": null,
"taskResultProcessingOutputs": null,
"thumbnailFile": null,
"thumbnailFileId": null,
"transferError": null,
"transferProgressFraction": null,
"transferState": null,
"uid": "dabff400-1329-43f7-9131-de3c501e13d6"
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ObservationAssetSummary"
},
"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[ObservationAssetSummary]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /observations/{observation_id}/clone
Create Observation Clone
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Responses
{
"cancelOn": null,
"completedOn": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creator": null,
"creatorId": 0,
"creatorUid": null,
"currentIteration": 0,
"galleryItems": null,
"groupUid": null,
"id": 0,
"instrumentAssignmentMode": "observation",
"instrumentIds": null,
"instrumentLockTimeoutSec": 10.12,
"instrumentMode": "none",
"interruptLowerPriority": true,
"isDeleted": true,
"isPublic": true,
"iterationInterval": 10.12,
"iterationIntervalType": "fixed",
"iterations": 0,
"kind": "template",
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingBlockPolicy": "request_iteration",
"observingGrantIds": null,
"observingGrants": null,
"opticalImagingConfiguration": null,
"originalId": null,
"originalUid": null,
"owner": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"renderSettings": null,
"requestTypes": [
"optical_imaging"
],
"startAfter": null,
"status": "active",
"target": null,
"targetId": null,
"targetUid": null,
"uid": "2d8efed1-a5ed-4f2f-a8d0-5581ed804426",
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"createdOn": {
"description": "Creation timestamp.",
"format": "date-time",
"type": "string"
},
"creator": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"type": "null"
}
]
},
"creatorId": {
"description": "User who created it.",
"type": "integer"
},
"creatorUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"currentIteration": {
"default": 0,
"type": "integer"
},
"galleryItems": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservationGalleryItem"
},
"type": "array"
},
{
"type": "null"
}
]
},
"groupUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"description": "Unique identifier of the observation.",
"type": "integer"
},
"instrumentAssignmentMode": {
"$ref": "#/components/schemas/InstrumentAssignmentMode"
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentLockTimeoutSec": {
"type": "number"
},
"instrumentMode": {
"$ref": "#/components/schemas/InstrumentAccessMode"
},
"interruptLowerPriority": {
"description": "Interrupt lower priority.",
"type": "boolean"
},
"isDeleted": {
"description": "Flag indicating if deleted.",
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"iterationInterval": {
"type": "number"
},
"iterationIntervalType": {
"$ref": "#/components/schemas/IterationIntervalType"
},
"iterations": {
"type": "integer"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"description": "Name of the observation.",
"type": "string"
},
"observabilityLastUpdatedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Timestamp of the last observability refresh."
},
"observingBlockPolicy": {
"$ref": "#/components/schemas/ObservingBlockPolicy",
"default": "observation_iteration",
"description": "How observation tasks should be grouped into uninterrupted scheduling blocks."
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"observingGrants": {
"anyOf": [
{
"items": {
"discriminator": {
"mapping": {
"externally_managed": "#/components/schemas/ExternallyManagedObservingGrantDetail",
"group": "#/components/schemas/GroupObservingGrantDetail",
"group_managed": "#/components/schemas/GroupManagedObservingGrantDetail",
"member": "#/components/schemas/MemberObservingGrantDetail",
"owner": "#/components/schemas/OwnerObservingGrantDetail"
},
"propertyName": "grantType"
},
"oneOf": [
{
"$ref": "#/components/schemas/MemberObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupObservingGrantDetail"
},
{
"$ref": "#/components/schemas/OwnerObservingGrantDetail"
},
{
"$ref": "#/components/schemas/ExternallyManagedObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupManagedObservingGrantDetail"
}
]
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Output"
},
{
"type": "null"
}
]
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the observation forked from."
},
"originalUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"owner": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"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"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"requestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"startAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/components/schemas/ObservationStatus"
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/Target"
},
{
"type": "null"
}
]
},
"targetId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the target associated with the observation."
},
"targetUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"updatedOn": {
"description": "Update timestamp.",
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"uid",
"targetId",
"status",
"kind",
"isDeleted",
"createdOn",
"updatedOn",
"name",
"ownerId",
"creatorId",
"interruptLowerPriority",
"priority",
"instrumentAssignmentMode",
"instrumentLockTimeoutSec",
"iterations",
"iterationIntervalType",
"iterationInterval",
"progressFraction",
"isPublic",
"instrumentMode"
],
"title": "ObservationDetail",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/data-tools
Read Observation Data Tools
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Responses
[
null
]
Schema of the response body
{
"items": {
"discriminator": {
"mapping": {
"cluster_modeling": "#/components/schemas/ClusterModelingTool",
"radio_tracking_continuum": "#/components/schemas/RadioTrackingContinuumDataTool",
"radio_tracking_spectrum": "#/components/schemas/RadioTrackingSpectrumDataTool",
"spectral_composer": "#/components/schemas/SpectralComposerTool",
"time_lapse_creator": "#/components/schemas/TimeLapseCreatorTool",
"time_series_photometry": "#/components/schemas/TimeSeriesPhotometryTool",
"transient_detector": "#/components/schemas/TransientDetectorTool"
},
"propertyName": "dataToolType"
},
"oneOf": [
{
"$ref": "#/components/schemas/TimeSeriesPhotometryTool"
},
{
"$ref": "#/components/schemas/SpectralComposerTool"
},
{
"$ref": "#/components/schemas/TimeLapseCreatorTool"
},
{
"$ref": "#/components/schemas/ClusterModelingTool"
},
{
"$ref": "#/components/schemas/TransientDetectorTool"
},
{
"$ref": "#/components/schemas/RadioTrackingContinuumDataTool"
},
{
"$ref": "#/components/schemas/RadioTrackingSpectrumDataTool"
}
]
},
"title": "Response Read Observation Data Tools Observations Observation Id Data Tools Get",
"type": "array"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /observations/{observation_id}/data-tools
Create Data Tool
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Request body
Schema of the request body
{
"discriminator": {
"mapping": {
"cluster_modeling": "#/components/schemas/ClusterModelingToolCreate",
"radio_tracking_continuum": "#/components/schemas/RadioTrackingContinuumDataToolCreate",
"radio_tracking_spectrum": "#/components/schemas/RadioTrackingSpectrumDataToolCreate",
"spectral_composer": "#/components/schemas/SpectralComposerToolCreate",
"time_lapse_creator": "#/components/schemas/TimeLapseCreatorToolCreate",
"time_series_photometry": "#/components/schemas/TimeSeriesPhotometryToolCreate",
"transient_detector": "#/components/schemas/TransientDetectorToolCreate"
},
"propertyName": "dataToolType"
},
"oneOf": [
{
"$ref": "#/components/schemas/TimeSeriesPhotometryToolCreate"
},
{
"$ref": "#/components/schemas/SpectralComposerToolCreate"
},
{
"$ref": "#/components/schemas/TimeLapseCreatorToolCreate"
},
{
"$ref": "#/components/schemas/ClusterModelingToolCreate"
},
{
"$ref": "#/components/schemas/TransientDetectorToolCreate"
},
{
"$ref": "#/components/schemas/RadioTrackingContinuumDataToolCreate"
},
{
"$ref": "#/components/schemas/RadioTrackingSpectrumDataToolCreate"
}
],
"title": "Body"
}
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"cluster_modeling": "#/components/schemas/ClusterModelingTool",
"radio_tracking_continuum": "#/components/schemas/RadioTrackingContinuumDataTool",
"radio_tracking_spectrum": "#/components/schemas/RadioTrackingSpectrumDataTool",
"spectral_composer": "#/components/schemas/SpectralComposerTool",
"time_lapse_creator": "#/components/schemas/TimeLapseCreatorTool",
"time_series_photometry": "#/components/schemas/TimeSeriesPhotometryTool",
"transient_detector": "#/components/schemas/TransientDetectorTool"
},
"propertyName": "dataToolType"
},
"oneOf": [
{
"$ref": "#/components/schemas/TimeSeriesPhotometryTool"
},
{
"$ref": "#/components/schemas/SpectralComposerTool"
},
{
"$ref": "#/components/schemas/TimeLapseCreatorTool"
},
{
"$ref": "#/components/schemas/ClusterModelingTool"
},
{
"$ref": "#/components/schemas/TransientDetectorTool"
},
{
"$ref": "#/components/schemas/RadioTrackingContinuumDataTool"
},
{
"$ref": "#/components/schemas/RadioTrackingSpectrumDataTool"
}
],
"title": "Response Create Data Tool Observations Observation Id Data Tools Post"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/data-tools/available
Read Observation Available Data Tools
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Responses
{
"items": [
{
"allowMultiple": true,
"dataToolType": "radio_tracking_continuum",
"defaultConfigSchema": null,
"description": null,
"iconUrl": null,
"id": 0,
"instances": [
null
],
"name": "string",
"version": null
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DataToolDefinitionWithInstances"
},
"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[DataToolDefinitionWithInstances]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PUT /observations/{observation_id}/data-tools/{data_tool_id}
Update Data Tool
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
data_tool_id |
path | integer | No | ||
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Request body
Schema of the request body
{
"discriminator": {
"mapping": {
"cluster_modeling": "#/components/schemas/ClusterModelingToolUpdate",
"radio_tracking_continuum": "#/components/schemas/RadioTrackingContinuumDataToolUpdate",
"radio_tracking_spectrum": "#/components/schemas/RadioTrackingSpectrumDataToolUpdate",
"spectral_composer": "#/components/schemas/SpectralComposerToolUpdate",
"time_lapse_creator": "#/components/schemas/TimeLapseCreatorToolUpdate",
"time_series_photometry": "#/components/schemas/TimeSeriesPhotometryToolUpdate",
"transient_detector": "#/components/schemas/TransientDetectorToolUpdate"
},
"propertyName": "dataToolType"
},
"oneOf": [
{
"$ref": "#/components/schemas/TimeSeriesPhotometryToolUpdate"
},
{
"$ref": "#/components/schemas/SpectralComposerToolUpdate"
},
{
"$ref": "#/components/schemas/TimeLapseCreatorToolUpdate"
},
{
"$ref": "#/components/schemas/ClusterModelingToolUpdate"
},
{
"$ref": "#/components/schemas/TransientDetectorToolUpdate"
},
{
"$ref": "#/components/schemas/RadioTrackingContinuumDataToolUpdate"
},
{
"$ref": "#/components/schemas/RadioTrackingSpectrumDataToolUpdate"
}
],
"title": "Body"
}
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"cluster_modeling": "#/components/schemas/ClusterModelingTool",
"radio_tracking_continuum": "#/components/schemas/RadioTrackingContinuumDataTool",
"radio_tracking_spectrum": "#/components/schemas/RadioTrackingSpectrumDataTool",
"spectral_composer": "#/components/schemas/SpectralComposerTool",
"time_lapse_creator": "#/components/schemas/TimeLapseCreatorTool",
"time_series_photometry": "#/components/schemas/TimeSeriesPhotometryTool",
"transient_detector": "#/components/schemas/TransientDetectorTool"
},
"propertyName": "dataToolType"
},
"oneOf": [
{
"$ref": "#/components/schemas/TimeSeriesPhotometryTool"
},
{
"$ref": "#/components/schemas/SpectralComposerTool"
},
{
"$ref": "#/components/schemas/TimeLapseCreatorTool"
},
{
"$ref": "#/components/schemas/ClusterModelingTool"
},
{
"$ref": "#/components/schemas/TransientDetectorTool"
},
{
"$ref": "#/components/schemas/RadioTrackingContinuumDataTool"
},
{
"$ref": "#/components/schemas/RadioTrackingSpectrumDataTool"
}
],
"title": "Response Update Data Tool Observations Observation Id Data Tools Data Tool Id Put"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/detail
Read Observation Detail
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Responses
{
"cancelOn": null,
"completedOn": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creator": null,
"creatorId": 0,
"creatorUid": null,
"currentIteration": 0,
"galleryItems": null,
"groupUid": null,
"id": 0,
"instrumentAssignmentMode": "observation",
"instrumentIds": null,
"instrumentLockTimeoutSec": 10.12,
"instrumentMode": "none",
"interruptLowerPriority": true,
"isDeleted": true,
"isPublic": true,
"iterationInterval": 10.12,
"iterationIntervalType": "fixed",
"iterations": 0,
"kind": "template",
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingBlockPolicy": "request_iteration",
"observingGrantIds": null,
"observingGrants": null,
"opticalImagingConfiguration": null,
"originalId": null,
"originalUid": null,
"owner": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"renderSettings": null,
"requestTypes": [
"optical_imaging"
],
"startAfter": null,
"status": "active",
"target": null,
"targetId": null,
"targetUid": null,
"uid": "89e296ef-d75e-4105-874f-fa679c78672a",
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"createdOn": {
"description": "Creation timestamp.",
"format": "date-time",
"type": "string"
},
"creator": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"type": "null"
}
]
},
"creatorId": {
"description": "User who created it.",
"type": "integer"
},
"creatorUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"currentIteration": {
"default": 0,
"type": "integer"
},
"galleryItems": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservationGalleryItem"
},
"type": "array"
},
{
"type": "null"
}
]
},
"groupUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"description": "Unique identifier of the observation.",
"type": "integer"
},
"instrumentAssignmentMode": {
"$ref": "#/components/schemas/InstrumentAssignmentMode"
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentLockTimeoutSec": {
"type": "number"
},
"instrumentMode": {
"$ref": "#/components/schemas/InstrumentAccessMode"
},
"interruptLowerPriority": {
"description": "Interrupt lower priority.",
"type": "boolean"
},
"isDeleted": {
"description": "Flag indicating if deleted.",
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"iterationInterval": {
"type": "number"
},
"iterationIntervalType": {
"$ref": "#/components/schemas/IterationIntervalType"
},
"iterations": {
"type": "integer"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"description": "Name of the observation.",
"type": "string"
},
"observabilityLastUpdatedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Timestamp of the last observability refresh."
},
"observingBlockPolicy": {
"$ref": "#/components/schemas/ObservingBlockPolicy",
"default": "observation_iteration",
"description": "How observation tasks should be grouped into uninterrupted scheduling blocks."
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"observingGrants": {
"anyOf": [
{
"items": {
"discriminator": {
"mapping": {
"externally_managed": "#/components/schemas/ExternallyManagedObservingGrantDetail",
"group": "#/components/schemas/GroupObservingGrantDetail",
"group_managed": "#/components/schemas/GroupManagedObservingGrantDetail",
"member": "#/components/schemas/MemberObservingGrantDetail",
"owner": "#/components/schemas/OwnerObservingGrantDetail"
},
"propertyName": "grantType"
},
"oneOf": [
{
"$ref": "#/components/schemas/MemberObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupObservingGrantDetail"
},
{
"$ref": "#/components/schemas/OwnerObservingGrantDetail"
},
{
"$ref": "#/components/schemas/ExternallyManagedObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupManagedObservingGrantDetail"
}
]
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Output"
},
{
"type": "null"
}
]
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the observation forked from."
},
"originalUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"owner": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"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"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"requestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"startAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/components/schemas/ObservationStatus"
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/Target"
},
{
"type": "null"
}
]
},
"targetId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the target associated with the observation."
},
"targetUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"updatedOn": {
"description": "Update timestamp.",
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"uid",
"targetId",
"status",
"kind",
"isDeleted",
"createdOn",
"updatedOn",
"name",
"ownerId",
"creatorId",
"interruptLowerPriority",
"priority",
"instrumentAssignmentMode",
"instrumentLockTimeoutSec",
"iterations",
"iterationIntervalType",
"iterationInterval",
"progressFraction",
"isPublic",
"instrumentMode"
],
"title": "ObservationDetail",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /observations/{observation_id}/draft
Create Observation Draft
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Responses
{
"cancelOn": null,
"completedOn": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creator": null,
"creatorId": 0,
"creatorUid": null,
"currentIteration": 0,
"galleryItems": null,
"groupUid": null,
"id": 0,
"instrumentAssignmentMode": "observation",
"instrumentIds": null,
"instrumentLockTimeoutSec": 10.12,
"instrumentMode": "none",
"interruptLowerPriority": true,
"isDeleted": true,
"isPublic": true,
"iterationInterval": 10.12,
"iterationIntervalType": "fixed",
"iterations": 0,
"kind": "template",
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingBlockPolicy": "request_iteration",
"observingGrantIds": null,
"observingGrants": null,
"opticalImagingConfiguration": null,
"originalId": null,
"originalUid": null,
"owner": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"renderSettings": null,
"requestTypes": [
"optical_imaging"
],
"startAfter": null,
"status": "active",
"target": null,
"targetId": null,
"targetUid": null,
"uid": "d25a3028-5cb3-4756-b5af-308de78e2c5b",
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"createdOn": {
"description": "Creation timestamp.",
"format": "date-time",
"type": "string"
},
"creator": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"type": "null"
}
]
},
"creatorId": {
"description": "User who created it.",
"type": "integer"
},
"creatorUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"currentIteration": {
"default": 0,
"type": "integer"
},
"galleryItems": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservationGalleryItem"
},
"type": "array"
},
{
"type": "null"
}
]
},
"groupUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"description": "Unique identifier of the observation.",
"type": "integer"
},
"instrumentAssignmentMode": {
"$ref": "#/components/schemas/InstrumentAssignmentMode"
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentLockTimeoutSec": {
"type": "number"
},
"instrumentMode": {
"$ref": "#/components/schemas/InstrumentAccessMode"
},
"interruptLowerPriority": {
"description": "Interrupt lower priority.",
"type": "boolean"
},
"isDeleted": {
"description": "Flag indicating if deleted.",
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"iterationInterval": {
"type": "number"
},
"iterationIntervalType": {
"$ref": "#/components/schemas/IterationIntervalType"
},
"iterations": {
"type": "integer"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"description": "Name of the observation.",
"type": "string"
},
"observabilityLastUpdatedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Timestamp of the last observability refresh."
},
"observingBlockPolicy": {
"$ref": "#/components/schemas/ObservingBlockPolicy",
"default": "observation_iteration",
"description": "How observation tasks should be grouped into uninterrupted scheduling blocks."
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"observingGrants": {
"anyOf": [
{
"items": {
"discriminator": {
"mapping": {
"externally_managed": "#/components/schemas/ExternallyManagedObservingGrantDetail",
"group": "#/components/schemas/GroupObservingGrantDetail",
"group_managed": "#/components/schemas/GroupManagedObservingGrantDetail",
"member": "#/components/schemas/MemberObservingGrantDetail",
"owner": "#/components/schemas/OwnerObservingGrantDetail"
},
"propertyName": "grantType"
},
"oneOf": [
{
"$ref": "#/components/schemas/MemberObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupObservingGrantDetail"
},
{
"$ref": "#/components/schemas/OwnerObservingGrantDetail"
},
{
"$ref": "#/components/schemas/ExternallyManagedObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupManagedObservingGrantDetail"
}
]
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Output"
},
{
"type": "null"
}
]
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the observation forked from."
},
"originalUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"owner": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"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"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"requestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"startAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/components/schemas/ObservationStatus"
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/Target"
},
{
"type": "null"
}
]
},
"targetId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the target associated with the observation."
},
"targetUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"updatedOn": {
"description": "Update timestamp.",
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"uid",
"targetId",
"status",
"kind",
"isDeleted",
"createdOn",
"updatedOn",
"name",
"ownerId",
"creatorId",
"interruptLowerPriority",
"priority",
"instrumentAssignmentMode",
"instrumentLockTimeoutSec",
"iterations",
"iterationIntervalType",
"iterationInterval",
"progressFraction",
"isPublic",
"instrumentMode"
],
"title": "ObservationDetail",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/events
Read Observation Events
Description
List notification events for this observation, newest first.
Powers the activity panel on the observation detail page. Includes
every event row tagged with this observation's id — both the
user-subscribable kinds (observation.work_started /
observation.completed) and the activity-feed-only ones
(observation.task_started / observation.task_completed /
observation.work_interrupted).
Empty for observations whose state-change history predates the
notification system. The ix_events_observation_id partial index
makes this query fast even with a long-lived events table.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Responses
{
"items": [
{
"createdOn": "2022-04-13T15:42:05.901Z",
"dedupKey": null,
"deviceId": null,
"eventKind": "observation.work_started",
"id": 0,
"message": null,
"observationId": null,
"observatoryId": null,
"observingAccountId": null,
"operationalConstraintId": null,
"ownerEntityId": null,
"payload": {},
"renderedMessage": null,
"resourceId": 0,
"resourceKind": "observation",
"telescopeId": null
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/EventRead"
},
"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[EventRead]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/observability
Read Observation Observability
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
extendedInfo |
query | boolean | True | No | |
observation_id |
path | integer | No | Observation id | |
resolution |
query | number | 1 | No | |
span |
query | number | 1 | No | |
start |
query | No | |||
telescopeId |
query | No | |||
token |
query | No |
Responses
{
"items": [
{
"endsOn": "2022-04-13T15:42:05.901Z",
"instrumentId": 0,
"obsId": 0,
"observable": true,
"reason": "string",
"requestId": null,
"requestType": "optical_imaging",
"startsOn": "2022-04-13T15:42:05.901Z",
"telescopeId": null
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ObservabilityWindow"
},
"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[ObservabilityWindow]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/observability-windows
List Observation Observability Windows
Description
Return previously-computed observability windows from the
observability_windows table, filtered by a half-open time-range
overlap predicate.
Unlike /observability, this endpoint does not recompute the
target's visibility — it's a thin DB read. Use it from clients that
need to render windows visible in a particular pan range (Gantt
chart, scheduling-grid UIs); use /observability when the caller
needs a fresh compute over an arbitrary span (e.g. probing a future
eligibility window before commit).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
endsAfter |
query | No | |||
observable |
query | True | No | ||
observation_id |
path | integer | No | Observation id | |
requestType |
query | No | |||
startsBefore |
query | No | |||
telescopeId |
query | No | |||
token |
query | No |
Responses
{
"items": [
{
"endsOn": "2022-04-13T15:42:05.901Z",
"instrumentId": 0,
"obsId": 0,
"observable": true,
"reason": "string",
"requestId": null,
"requestType": "optical_imaging",
"startsOn": "2022-04-13T15:42:05.901Z",
"telescopeId": null
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ObservabilityWindow"
},
"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[ObservabilityWindow]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/observing-plans-preview
Get Observing Plans Preview
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
instrument_ids |
query | array | No | List of instrument IDs to generate observing plans for | |
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Responses
{
"items": [
{
"allRequestsObservable": true,
"anyRequestsObservable": true,
"constraints": [
"string"
],
"instrument": null,
"isObservable": true,
"legendColor": "string",
"observabilityWindows": [
{
"endsOn": "2022-04-13T15:42:05.901Z",
"instrumentId": 0,
"obsId": 0,
"observable": true,
"reason": "string",
"requestId": null,
"requestType": "optical_imaging",
"startsOn": "2022-04-13T15:42:05.901Z",
"telescopeId": null
}
],
"observationId": 0,
"opticalImagingConfigurationPlan": null,
"radioMappingConfigurationPlan": null,
"radioTrackingConfigurationPlan": null,
"requestPlanMap": {},
"telescope": {
"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": "6d7f7b9e-7afa-441b-843e-2336bd25405e"
}
],
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "e8573137-6c40-4923-8a7b-6010957e24cd"
}
],
"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": "0c595671-143f-409e-89f4-7c9bf64f27c0"
}
],
"description": null,
"deviceIds": null,
"elevationM": 10.12,
"enclosure": null,
"enclosureId": null,
"enclosureUid": null,
"filterWheelIds": null,
"filterWheels": [
{
"deletedPositions": null,
"deviceType": "string",
"filterShape": null,
"filterSizeMm": null,
"filterWheelPositionIds": null,
"id": null,
"imageId": null,
"manufacturer": null,
"model": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintActions": null,
"operationalConstraintIds": null,
"ownerId": 0,
"positions": [
{
"filterIds": [
"string"
],
"filterWheelId": 0,
"filterWheelUid": null,
"filters": [
{
"bandpassNm": null,
"centralWavelengthNm": null,
"filterSpecifierType": "string",
"flatExposureScaler": null,
"id": "string",
"isModifier": null
}
],
"flatExposureScaler": null,
"focusOffset": null,
"id": null,
"isActive": true,
"isDeleted": true,
"label": null,
"position": 0,
"uid": "2d2d38a1-4e8d-4b63-9a9e-413d690af11a"
}
],
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "a067cc5f-b03b-42e4-86a1-ac61857f844e"
}
],
"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": "9a5b7b35-6299-42c0-8d8f-455de258893e"
}
],
"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": "22b69a82-20b0-4bda-ab41-e9e1938b5a95",
"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": "5bcf88cc-9dd6-4219-b81c-266a271fe8f6"
}
],
"owner": null,
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"radioBackendIds": null,
"radioBackends": [
{
"description": null,
"deviceType": "string",
"id": null,
"imageId": null,
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintActions": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "b91f2e89-d624-430a-a7b1-df2eeb9d0a16"
}
],
"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": "a3c5fe81-603d-4eeb-8984-9ec69d41829c"
}
],
"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": "a9879290-9cec-4150-a090-aecb434009b2"
}
],
"shortName": null,
"slug": "string",
"uid": "71211b37-357c-4c80-9f63-32fbf4ce6155"
}
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ObservingPlan"
},
"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[ObservingPlan]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/observing-plans/
Get Observing Plans
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
instrument_ids |
query | array | No | List of instrument IDs to generate observing plans for | |
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Responses
{
"items": [
{
"allRequestsObservable": true,
"anyRequestsObservable": true,
"constraints": [
"string"
],
"instrument": null,
"isObservable": true,
"legendColor": "string",
"observabilityWindows": [
{
"endsOn": "2022-04-13T15:42:05.901Z",
"instrumentId": 0,
"obsId": 0,
"observable": true,
"reason": "string",
"requestId": null,
"requestType": "optical_imaging",
"startsOn": "2022-04-13T15:42:05.901Z",
"telescopeId": null
}
],
"observationId": 0,
"opticalImagingConfigurationPlan": null,
"radioMappingConfigurationPlan": null,
"radioTrackingConfigurationPlan": null,
"requestPlanMap": {},
"telescope": {
"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": "7a1def0a-e0b1-4709-b516-42da3a6aaa50"
}
],
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "f697cbd5-5357-4c26-8e2e-f05e875fad1a"
}
],
"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": "0a1e5821-b876-4a36-a2bc-b803010b9071"
}
],
"description": null,
"deviceIds": null,
"elevationM": 10.12,
"enclosure": null,
"enclosureId": null,
"enclosureUid": null,
"filterWheelIds": null,
"filterWheels": [
{
"deletedPositions": null,
"deviceType": "string",
"filterShape": null,
"filterSizeMm": null,
"filterWheelPositionIds": null,
"id": null,
"imageId": null,
"manufacturer": null,
"model": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintActions": null,
"operationalConstraintIds": null,
"ownerId": 0,
"positions": [
{
"filterIds": [
"string"
],
"filterWheelId": 0,
"filterWheelUid": null,
"filters": [
{
"bandpassNm": null,
"centralWavelengthNm": null,
"filterSpecifierType": "string",
"flatExposureScaler": null,
"id": "string",
"isModifier": null
}
],
"flatExposureScaler": null,
"focusOffset": null,
"id": null,
"isActive": true,
"isDeleted": true,
"label": null,
"position": 0,
"uid": "908030b9-bdcb-475e-b962-b9ea5378c070"
}
],
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "b3cca478-3894-47ac-a1ba-c47ccb6f71cf"
}
],
"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": "0824aaf1-f5e1-4889-bb18-f06175d415bf"
}
],
"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": "0e581f31-9162-44a1-a293-32160cfcec77",
"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": "d3196217-0126-4e8f-aa7b-e2d0bbcc96e3"
}
],
"owner": null,
"ownerId": 0,
"publicLatitudeDeg": null,
"publicLongitudeDeg": null,
"radioBackendIds": null,
"radioBackends": [
{
"description": null,
"deviceType": "string",
"id": null,
"imageId": null,
"manufacturer": null,
"modelId": null,
"name": null,
"observatoryId": null,
"observatoryUid": null,
"operationalConstraintActions": null,
"operationalConstraintIds": null,
"ownerId": 0,
"serialNumber": null,
"telescopeId": null,
"telescopeUid": null,
"uid": "7ca4dd41-12a4-499f-a730-2d682f65a71f"
}
],
"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": "ccdbc53e-bc55-44d5-bbf3-c2f1769c2937"
}
],
"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": "5e0489af-b9a5-4822-8316-240a533f6304"
}
],
"shortName": null,
"slug": "string",
"uid": "8a3117b0-6d83-4006-b08d-abb9681bd3d2"
}
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ObservingPlan"
},
"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[ObservingPlan]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /observations/{observation_id}/publish
Publish Observation Draft
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Responses
{
"cancelOn": null,
"completedOn": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creator": null,
"creatorId": 0,
"creatorUid": null,
"currentIteration": 0,
"galleryItems": null,
"groupUid": null,
"id": 0,
"instrumentAssignmentMode": "observation",
"instrumentIds": null,
"instrumentLockTimeoutSec": 10.12,
"instrumentMode": "none",
"interruptLowerPriority": true,
"isDeleted": true,
"isPublic": true,
"iterationInterval": 10.12,
"iterationIntervalType": "fixed",
"iterations": 0,
"kind": "template",
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingBlockPolicy": "request_iteration",
"observingGrantIds": null,
"observingGrants": null,
"opticalImagingConfiguration": null,
"originalId": null,
"originalUid": null,
"owner": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"renderSettings": null,
"requestTypes": [
"optical_imaging"
],
"startAfter": null,
"status": "active",
"target": null,
"targetId": null,
"targetUid": null,
"uid": "470b590f-f8af-43c0-af63-56ac73dccfcd",
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"createdOn": {
"description": "Creation timestamp.",
"format": "date-time",
"type": "string"
},
"creator": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"type": "null"
}
]
},
"creatorId": {
"description": "User who created it.",
"type": "integer"
},
"creatorUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"currentIteration": {
"default": 0,
"type": "integer"
},
"galleryItems": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservationGalleryItem"
},
"type": "array"
},
{
"type": "null"
}
]
},
"groupUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"description": "Unique identifier of the observation.",
"type": "integer"
},
"instrumentAssignmentMode": {
"$ref": "#/components/schemas/InstrumentAssignmentMode"
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentLockTimeoutSec": {
"type": "number"
},
"instrumentMode": {
"$ref": "#/components/schemas/InstrumentAccessMode"
},
"interruptLowerPriority": {
"description": "Interrupt lower priority.",
"type": "boolean"
},
"isDeleted": {
"description": "Flag indicating if deleted.",
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"iterationInterval": {
"type": "number"
},
"iterationIntervalType": {
"$ref": "#/components/schemas/IterationIntervalType"
},
"iterations": {
"type": "integer"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"description": "Name of the observation.",
"type": "string"
},
"observabilityLastUpdatedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Timestamp of the last observability refresh."
},
"observingBlockPolicy": {
"$ref": "#/components/schemas/ObservingBlockPolicy",
"default": "observation_iteration",
"description": "How observation tasks should be grouped into uninterrupted scheduling blocks."
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"observingGrants": {
"anyOf": [
{
"items": {
"discriminator": {
"mapping": {
"externally_managed": "#/components/schemas/ExternallyManagedObservingGrantDetail",
"group": "#/components/schemas/GroupObservingGrantDetail",
"group_managed": "#/components/schemas/GroupManagedObservingGrantDetail",
"member": "#/components/schemas/MemberObservingGrantDetail",
"owner": "#/components/schemas/OwnerObservingGrantDetail"
},
"propertyName": "grantType"
},
"oneOf": [
{
"$ref": "#/components/schemas/MemberObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupObservingGrantDetail"
},
{
"$ref": "#/components/schemas/OwnerObservingGrantDetail"
},
{
"$ref": "#/components/schemas/ExternallyManagedObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupManagedObservingGrantDetail"
}
]
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Output"
},
{
"type": "null"
}
]
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the observation forked from."
},
"originalUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"owner": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"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"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"requestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"startAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/components/schemas/ObservationStatus"
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/Target"
},
{
"type": "null"
}
]
},
"targetId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the target associated with the observation."
},
"targetUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"updatedOn": {
"description": "Update timestamp.",
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"uid",
"targetId",
"status",
"kind",
"isDeleted",
"createdOn",
"updatedOn",
"name",
"ownerId",
"creatorId",
"interruptLowerPriority",
"priority",
"instrumentAssignmentMode",
"instrumentLockTimeoutSec",
"iterations",
"iterationIntervalType",
"iterationInterval",
"progressFraction",
"isPublic",
"instrumentMode"
],
"title": "ObservationDetail",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/requests
Read Observation Requests
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
isOriginal |
query | No | |||
observation_id |
path | integer | No | Observation id | |
sortBy |
query | No | |||
token |
query | No |
Request body
{
"filterObservationId": null,
"id": null,
"isDeleted": null,
"kind": null,
"originalId": null,
"status": null
}
Schema of the request body
{
"properties": {
"filterObservationId": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filterobservationid"
},
"id": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Id"
},
"isDeleted": {
"anyOf": [
{
"items": {
"type": "boolean"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Isdeleted"
},
"kind": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservationKind"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Kind"
},
"originalId": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Originalid"
},
"status": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservationRequestStatus"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Status"
}
},
"title": "Body_read_observation_requests_observations__observation_id__requests_get",
"type": "object"
}
Responses
{
"items": [
null
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequestSummary",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequestSummary",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequestSummary",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequestSummary",
"radio_mapping": "#/components/schemas/RadioMappingRequestSummary",
"radio_tracking": "#/components/schemas/RadioTrackingRequestSummary"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequestSummary"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequestSummary"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequestSummary"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequestSummary"
},
{
"$ref": "#/components/schemas/RadioTrackingRequestSummary"
},
{
"$ref": "#/components/schemas/RadioMappingRequestSummary"
}
]
},
"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[OpticalImagingRequestSummary, OpticalImagingBiasCalibrationRequestSummary, OpticalImagingDarkCalibrationRequestSummary, OpticalImagingFlatCalibrationRequestSummary, RadioTrackingRequestSummary, RadioMappingRequestSummary], FieldInfo(annotation=NoneType, required=True, discriminator='request_type')]]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/requests/{request_id}
Read Observation Request
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
request_id |
path | integer | No | ||
token |
query | No |
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequest",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequest",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequest",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequest",
"radio_mapping": "#/components/schemas/RadioMappingRequest",
"radio_tracking": "#/components/schemas/RadioTrackingRequest"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequest"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequest"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequest"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequest"
},
{
"$ref": "#/components/schemas/RadioTrackingRequest"
},
{
"$ref": "#/components/schemas/RadioMappingRequest"
}
],
"title": "Response Read Observation Request Observations Observation Id Requests Request Id Get"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/requests/{request_id}/detail
Read Observation Request Detail
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
request_id |
path | integer | No | ||
token |
query | No |
Responses
Schema of the response body
{
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequestDetail",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail",
"radio_mapping": "#/components/schemas/RadioMappingRequestDetail",
"radio_tracking": "#/components/schemas/RadioTrackingRequestDetail"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequestDetail"
},
{
"$ref": "#/components/schemas/RadioTrackingRequestDetail"
},
{
"$ref": "#/components/schemas/RadioMappingRequestDetail"
}
],
"title": "Response Read Observation Request Detail Observations Observation Id Requests Request Id Detail Get"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/requests/{request_id}/observing-plans-preview
Get Observing Request Plan Preview
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
instrument_ids |
query | array | No | List of instrument IDs to generate observing plans for | |
observation_id |
path | integer | No | Observation id | |
request_id |
path | integer | No | ||
token |
query | No |
Responses
{
"items": [
null
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"discriminator": {
"mapping": {
"optical_imaging": "#/components/schemas/OpticalImagingRequestPlan",
"optical_imaging_bias_calibration": "#/components/schemas/OpticalImagingBiasCalibrationRequestPlan",
"optical_imaging_dark_calibration": "#/components/schemas/OpticalImagingDarkCalibrationRequestPlan",
"optical_imaging_flat_calibration": "#/components/schemas/OpticalImagingFlatCalibrationRequestPlan",
"radio_mapping": "#/components/schemas/RadioMappingRequestPlan",
"radio_tracking": "#/components/schemas/RadioTrackingRequestPlan"
},
"propertyName": "requestType"
},
"oneOf": [
{
"$ref": "#/components/schemas/OpticalImagingRequestPlan"
},
{
"$ref": "#/components/schemas/OpticalImagingBiasCalibrationRequestPlan"
},
{
"$ref": "#/components/schemas/OpticalImagingDarkCalibrationRequestPlan"
},
{
"$ref": "#/components/schemas/OpticalImagingFlatCalibrationRequestPlan"
},
{
"$ref": "#/components/schemas/RadioTrackingRequestPlan"
},
{
"$ref": "#/components/schemas/RadioMappingRequestPlan"
}
]
},
"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[OpticalImagingRequestPlan, OpticalImagingBiasCalibrationRequestPlan, OpticalImagingDarkCalibrationRequestPlan, OpticalImagingFlatCalibrationRequestPlan, RadioTrackingRequestPlan, RadioMappingRequestPlan], FieldInfo(annotation=NoneType, required=True, discriminator='request_type')]]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/target
Read Observation Target
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
isOriginal |
query | No | |||
observation_id |
path | integer | No | Observation id | |
sortBy |
query | No | |||
token |
query | No |
Request body
{
"id": null,
"isDeleted": null,
"kind": null,
"originalId": null,
"status": null
}
Schema of the request body
{
"properties": {
"id": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Id"
},
"isDeleted": {
"anyOf": [
{
"items": {
"type": "boolean"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Isdeleted"
},
"kind": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservationKind"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Kind"
},
"originalId": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Originalid"
},
"status": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/TargetStatus"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Status"
}
},
"title": "Body_read_observation_target_observations__observation_id__target_get",
"type": "object"
}
Responses
Schema of the response body
{
"anyOf": [
{
"$ref": "#/components/schemas/Target"
},
{
"type": "null"
}
],
"title": "Response Read Observation Target Observations Observation Id Target Get"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /observations/{observation_id}/target
Post Observation Target
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
token |
query | No |
Request body
{
"isDeleted": null,
"kind": null,
"name": "string",
"originalId": null,
"position": null,
"positionOffsetFrame": "icrs_tangent",
"positionOffsetReferenceTime": null,
"positionOffsetXDeg": 10.12,
"positionOffsetYDeg": 10.12,
"status": null
}
Schema of the request body
{
"description": "Base class for creating targets.",
"properties": {
"isDeleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false
},
"kind": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservationKind"
},
{
"type": "null"
}
],
"default": "instance"
},
"name": {
"type": "string"
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"position": {
"anyOf": [
{
"discriminator": {
"mapping": {
"catalog": "#/components/schemas/CatalogPositionCreate",
"ephemeral": "#/components/schemas/EphemeralPositionCreate",
"fixed": "#/components/schemas/FixedPositionCreate",
"orbital": "#/components/schemas/OrbitalPositionCreate"
},
"propertyName": "positionType"
},
"oneOf": [
{
"$ref": "#/components/schemas/FixedPositionCreate"
},
{
"$ref": "#/components/schemas/OrbitalPositionCreate"
},
{
"$ref": "#/components/schemas/EphemeralPositionCreate"
},
{
"$ref": "#/components/schemas/CatalogPositionCreate"
}
]
},
{
"type": "null"
}
]
},
"positionOffsetFrame": {
"$ref": "#/components/schemas/ObservationPositionOffsetFrame",
"default": "icrs_tangent"
},
"positionOffsetReferenceTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"positionOffsetXDeg": {
"default": 0,
"type": "number"
},
"positionOffsetYDeg": {
"default": 0,
"type": "number"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TargetStatus"
},
{
"type": "null"
}
],
"default": "active"
}
},
"required": [
"name"
],
"title": "TargetCreate",
"type": "object"
}
Responses
{
"id": 0,
"isDeleted": true,
"kind": "template",
"name": "string",
"originalId": null,
"positionId": null,
"positionOffsetFrame": "icrs_tangent",
"positionOffsetReferenceTime": null,
"positionOffsetXDeg": 10.12,
"positionOffsetYDeg": 10.12,
"status": "active",
"targetPosition": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Primary key for the Target",
"type": "integer"
},
"isDeleted": {
"description": "Flag indicating if the target is deleted",
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind",
"description": "Lifecycle classification for the target"
},
"name": {
"description": "Name of the Target",
"type": "string"
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Original target id"
},
"positionId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Primary key of the target's position. Resolved through the graph bundle's `target_positions` map."
},
"positionOffsetFrame": {
"$ref": "#/components/schemas/ObservationPositionOffsetFrame",
"default": "icrs_tangent"
},
"positionOffsetReferenceTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"positionOffsetXDeg": {
"default": 0,
"type": "number"
},
"positionOffsetYDeg": {
"default": 0,
"type": "number"
},
"status": {
"$ref": "#/components/schemas/TargetStatus",
"description": "Status of the target"
},
"targetPosition": {
"anyOf": [
{
"discriminator": {
"mapping": {
"catalog": "#/components/schemas/CatalogPosition",
"ephemeral": "#/components/schemas/EphemeralPosition",
"fixed": "#/components/schemas/FixedPosition",
"orbital": "#/components/schemas/OrbitalPosition"
},
"propertyName": "positionType"
},
"oneOf": [
{
"$ref": "#/components/schemas/FixedPosition"
},
{
"$ref": "#/components/schemas/OrbitalPosition"
},
{
"$ref": "#/components/schemas/EphemeralPosition"
},
{
"$ref": "#/components/schemas/CatalogPosition"
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"kind",
"isDeleted",
"name"
],
"title": "Target",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations/{observation_id}/task-results
Read Observation Task Results
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation_id |
path | integer | No | Observation id | |
page |
query | integer | 1 | No | |
size |
query | integer | 25 | No | |
token |
query | No |
Responses
{
"items": [
{
"currentProcessingRun": null,
"currentProcessingRunId": null,
"dirtyFromRevision": null,
"id": 0,
"lastBuiltRevision": null,
"nextEligibleRunAt": null,
"status": "PENDING",
"task": null,
"taskId": 0,
"taskUid": null,
"uid": "48a31e20-4e77-4ac6-95e9-9047f6f36c82"
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ObservationTaskResultDetail"
},
"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[ObservationTaskResultDetail]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /observations:lookup
Lookup Observation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
observation |
query | No | |||
owner |
query | No | |||
token |
query | No |
Responses
{
"cancelOn": null,
"completedOn": null,
"createdOn": "2022-04-13T15:42:05.901Z",
"creator": null,
"creatorId": 0,
"creatorUid": null,
"currentIteration": 0,
"galleryItems": null,
"groupUid": null,
"id": 0,
"instrumentAssignmentMode": "observation",
"instrumentIds": null,
"instrumentLockTimeoutSec": 10.12,
"instrumentMode": "none",
"interruptLowerPriority": true,
"isDeleted": true,
"isPublic": true,
"iterationInterval": 10.12,
"iterationIntervalType": "fixed",
"iterations": 0,
"kind": "template",
"lastActivityOn": null,
"name": "string",
"observabilityLastUpdatedOn": null,
"observingBlockPolicy": "request_iteration",
"observingGrantIds": null,
"observingGrants": null,
"opticalImagingConfiguration": null,
"originalId": null,
"originalUid": null,
"owner": null,
"ownerId": 0,
"ownerUid": null,
"priority": 0,
"progressFraction": 10.12,
"radioMappingConfiguration": null,
"radioTrackingConfiguration": null,
"renderSettings": null,
"requestTypes": [
"optical_imaging"
],
"startAfter": null,
"status": "active",
"target": null,
"targetId": null,
"targetUid": null,
"uid": "22ee2ace-09e5-46d5-a050-5149299e040f",
"updatedOn": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"cancelOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"completedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"createdOn": {
"description": "Creation timestamp.",
"format": "date-time",
"type": "string"
},
"creator": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"type": "null"
}
]
},
"creatorId": {
"description": "User who created it.",
"type": "integer"
},
"creatorUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"currentIteration": {
"default": 0,
"type": "integer"
},
"galleryItems": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ObservationGalleryItem"
},
"type": "array"
},
{
"type": "null"
}
]
},
"groupUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"description": "Unique identifier of the observation.",
"type": "integer"
},
"instrumentAssignmentMode": {
"$ref": "#/components/schemas/InstrumentAssignmentMode"
},
"instrumentIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"instrumentLockTimeoutSec": {
"type": "number"
},
"instrumentMode": {
"$ref": "#/components/schemas/InstrumentAccessMode"
},
"interruptLowerPriority": {
"description": "Interrupt lower priority.",
"type": "boolean"
},
"isDeleted": {
"description": "Flag indicating if deleted.",
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"iterationInterval": {
"type": "number"
},
"iterationIntervalType": {
"$ref": "#/components/schemas/IterationIntervalType"
},
"iterations": {
"type": "integer"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind"
},
"lastActivityOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"description": "Name of the observation.",
"type": "string"
},
"observabilityLastUpdatedOn": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Timestamp of the last observability refresh."
},
"observingBlockPolicy": {
"$ref": "#/components/schemas/ObservingBlockPolicy",
"default": "observation_iteration",
"description": "How observation tasks should be grouped into uninterrupted scheduling blocks."
},
"observingGrantIds": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
]
},
"observingGrants": {
"anyOf": [
{
"items": {
"discriminator": {
"mapping": {
"externally_managed": "#/components/schemas/ExternallyManagedObservingGrantDetail",
"group": "#/components/schemas/GroupObservingGrantDetail",
"group_managed": "#/components/schemas/GroupManagedObservingGrantDetail",
"member": "#/components/schemas/MemberObservingGrantDetail",
"owner": "#/components/schemas/OwnerObservingGrantDetail"
},
"propertyName": "grantType"
},
"oneOf": [
{
"$ref": "#/components/schemas/MemberObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupObservingGrantDetail"
},
{
"$ref": "#/components/schemas/OwnerObservingGrantDetail"
},
{
"$ref": "#/components/schemas/ExternallyManagedObservingGrantDetail"
},
{
"$ref": "#/components/schemas/GroupManagedObservingGrantDetail"
}
]
},
"type": "array"
},
{
"type": "null"
}
]
},
"opticalImagingConfiguration": {
"anyOf": [
{
"$ref": "#/components/schemas/OpticalImagingConfiguration-Output"
},
{
"type": "null"
}
]
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the observation forked from."
},
"originalUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"owner": {
"anyOf": [
{
"discriminator": {
"mapping": {
"organization": "#/components/schemas/Organization",
"user": "#/components/schemas/User"
},
"propertyName": "entityType"
},
"oneOf": [
{
"$ref": "#/components/schemas/User"
},
{
"$ref": "#/components/schemas/Organization"
}
]
},
{
"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"
}
]
},
"renderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/RenderSettings"
},
{
"type": "null"
}
]
},
"requestTypes": {
"items": {
"$ref": "#/components/schemas/ObservationType"
},
"type": "array"
},
"startAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/components/schemas/ObservationStatus"
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/Target"
},
{
"type": "null"
}
]
},
"targetId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Unique identifier of the target associated with the observation."
},
"targetUid": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"uid": {
"format": "uuid",
"type": "string"
},
"updatedOn": {
"description": "Update timestamp.",
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"uid",
"targetId",
"status",
"kind",
"isDeleted",
"createdOn",
"updatedOn",
"name",
"ownerId",
"creatorId",
"interruptLowerPriority",
"priority",
"instrumentAssignmentMode",
"instrumentLockTimeoutSec",
"iterations",
"iterationIntervalType",
"iterationInterval",
"progressFraction",
"isPublic",
"instrumentMode"
],
"title": "ObservationDetail",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
targets
GET /targets
Read Targets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
query | No | |||
is_deleted |
query | No | |||
is_original |
query | No | |||
isDeleted |
query | No | |||
isOriginal |
query | No | |||
kind |
query | No | |||
original_id |
query | No | |||
originalId |
query | No | |||
sort_by |
query | No | |||
sortBy |
query | No | |||
status |
query | No |
Responses
{
"items": [
{
"id": 0,
"isDeleted": true,
"kind": "template",
"name": "string",
"originalId": null,
"positionId": null,
"positionOffsetFrame": "icrs_tangent",
"positionOffsetReferenceTime": null,
"positionOffsetXDeg": 10.12,
"positionOffsetYDeg": 10.12,
"status": "active",
"targetPosition": null
}
],
"page": 0,
"pages": 0,
"size": 0,
"total": 0
}
Schema of the response body
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Target"
},
"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[Target]",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /targets
Create Target
Request body
{
"isDeleted": null,
"kind": null,
"name": "string",
"originalId": null,
"position": null,
"positionOffsetFrame": "icrs_tangent",
"positionOffsetReferenceTime": null,
"positionOffsetXDeg": 10.12,
"positionOffsetYDeg": 10.12,
"status": null
}
Schema of the request body
{
"description": "Base class for creating targets.",
"properties": {
"isDeleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false
},
"kind": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservationKind"
},
{
"type": "null"
}
],
"default": "instance"
},
"name": {
"type": "string"
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"position": {
"anyOf": [
{
"discriminator": {
"mapping": {
"catalog": "#/components/schemas/CatalogPositionCreate",
"ephemeral": "#/components/schemas/EphemeralPositionCreate",
"fixed": "#/components/schemas/FixedPositionCreate",
"orbital": "#/components/schemas/OrbitalPositionCreate"
},
"propertyName": "positionType"
},
"oneOf": [
{
"$ref": "#/components/schemas/FixedPositionCreate"
},
{
"$ref": "#/components/schemas/OrbitalPositionCreate"
},
{
"$ref": "#/components/schemas/EphemeralPositionCreate"
},
{
"$ref": "#/components/schemas/CatalogPositionCreate"
}
]
},
{
"type": "null"
}
]
},
"positionOffsetFrame": {
"$ref": "#/components/schemas/ObservationPositionOffsetFrame",
"default": "icrs_tangent"
},
"positionOffsetReferenceTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"positionOffsetXDeg": {
"default": 0,
"type": "number"
},
"positionOffsetYDeg": {
"default": 0,
"type": "number"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TargetStatus"
},
{
"type": "null"
}
],
"default": "active"
}
},
"required": [
"name"
],
"title": "TargetCreate",
"type": "object"
}
Responses
{
"id": 0,
"isDeleted": true,
"kind": "template",
"name": "string",
"originalId": null,
"positionId": null,
"positionOffsetFrame": "icrs_tangent",
"positionOffsetReferenceTime": null,
"positionOffsetXDeg": 10.12,
"positionOffsetYDeg": 10.12,
"status": "active",
"targetPosition": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Primary key for the Target",
"type": "integer"
},
"isDeleted": {
"description": "Flag indicating if the target is deleted",
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind",
"description": "Lifecycle classification for the target"
},
"name": {
"description": "Name of the Target",
"type": "string"
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Original target id"
},
"positionId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Primary key of the target's position. Resolved through the graph bundle's `target_positions` map."
},
"positionOffsetFrame": {
"$ref": "#/components/schemas/ObservationPositionOffsetFrame",
"default": "icrs_tangent"
},
"positionOffsetReferenceTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"positionOffsetXDeg": {
"default": 0,
"type": "number"
},
"positionOffsetYDeg": {
"default": 0,
"type": "number"
},
"status": {
"$ref": "#/components/schemas/TargetStatus",
"description": "Status of the target"
},
"targetPosition": {
"anyOf": [
{
"discriminator": {
"mapping": {
"catalog": "#/components/schemas/CatalogPosition",
"ephemeral": "#/components/schemas/EphemeralPosition",
"fixed": "#/components/schemas/FixedPosition",
"orbital": "#/components/schemas/OrbitalPosition"
},
"propertyName": "positionType"
},
"oneOf": [
{
"$ref": "#/components/schemas/FixedPosition"
},
{
"$ref": "#/components/schemas/OrbitalPosition"
},
{
"$ref": "#/components/schemas/EphemeralPosition"
},
{
"$ref": "#/components/schemas/CatalogPosition"
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"kind",
"isDeleted",
"name"
],
"title": "Target",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
DELETE /targets/{target_id}
Delete Target
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
target_id |
path | integer | No |
Responses
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /targets/{target_id}
Read Target
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
target_id |
path | integer | No |
Responses
{
"id": 0,
"isDeleted": true,
"kind": "template",
"name": "string",
"originalId": null,
"positionId": null,
"positionOffsetFrame": "icrs_tangent",
"positionOffsetReferenceTime": null,
"positionOffsetXDeg": 10.12,
"positionOffsetYDeg": 10.12,
"status": "active",
"targetPosition": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Primary key for the Target",
"type": "integer"
},
"isDeleted": {
"description": "Flag indicating if the target is deleted",
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind",
"description": "Lifecycle classification for the target"
},
"name": {
"description": "Name of the Target",
"type": "string"
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Original target id"
},
"positionId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Primary key of the target's position. Resolved through the graph bundle's `target_positions` map."
},
"positionOffsetFrame": {
"$ref": "#/components/schemas/ObservationPositionOffsetFrame",
"default": "icrs_tangent"
},
"positionOffsetReferenceTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"positionOffsetXDeg": {
"default": 0,
"type": "number"
},
"positionOffsetYDeg": {
"default": 0,
"type": "number"
},
"status": {
"$ref": "#/components/schemas/TargetStatus",
"description": "Status of the target"
},
"targetPosition": {
"anyOf": [
{
"discriminator": {
"mapping": {
"catalog": "#/components/schemas/CatalogPosition",
"ephemeral": "#/components/schemas/EphemeralPosition",
"fixed": "#/components/schemas/FixedPosition",
"orbital": "#/components/schemas/OrbitalPosition"
},
"propertyName": "positionType"
},
"oneOf": [
{
"$ref": "#/components/schemas/FixedPosition"
},
{
"$ref": "#/components/schemas/OrbitalPosition"
},
{
"$ref": "#/components/schemas/EphemeralPosition"
},
{
"$ref": "#/components/schemas/CatalogPosition"
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"kind",
"isDeleted",
"name"
],
"title": "Target",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
PATCH /targets/{target_id}
Update Target
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
target_id |
path | integer | No |
Request body
{
"isDeleted": null,
"kind": null,
"name": null,
"originalId": null,
"position": null,
"positionOffsetFrame": null,
"positionOffsetReferenceTime": null,
"positionOffsetXDeg": null,
"positionOffsetYDeg": null,
"status": null
}
Schema of the request body
{
"description": "Base class for updating targets.",
"properties": {
"isDeleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"kind": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservationKind"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"position": {
"anyOf": [
{
"discriminator": {
"mapping": {
"catalog": "#/components/schemas/CatalogPositionUpdate",
"ephemeral": "#/components/schemas/EphemeralPositionUpdate",
"fixed": "#/components/schemas/FixedPositionUpdate",
"orbital": "#/components/schemas/OrbitalPositionUpdate"
},
"propertyName": "positionType"
},
"oneOf": [
{
"$ref": "#/components/schemas/FixedPositionUpdate"
},
{
"$ref": "#/components/schemas/OrbitalPositionUpdate"
},
{
"$ref": "#/components/schemas/EphemeralPositionUpdate"
},
{
"$ref": "#/components/schemas/CatalogPositionUpdate"
}
]
},
{
"type": "null"
}
]
},
"positionOffsetFrame": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservationPositionOffsetFrame"
},
{
"type": "null"
}
]
},
"positionOffsetReferenceTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"positionOffsetXDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"positionOffsetYDeg": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/TargetStatus"
},
{
"type": "null"
}
]
}
},
"title": "TargetUpdate",
"type": "object"
}
Responses
{
"id": 0,
"isDeleted": true,
"kind": "template",
"name": "string",
"originalId": null,
"positionId": null,
"positionOffsetFrame": "icrs_tangent",
"positionOffsetReferenceTime": null,
"positionOffsetXDeg": 10.12,
"positionOffsetYDeg": 10.12,
"status": "active",
"targetPosition": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Primary key for the Target",
"type": "integer"
},
"isDeleted": {
"description": "Flag indicating if the target is deleted",
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind",
"description": "Lifecycle classification for the target"
},
"name": {
"description": "Name of the Target",
"type": "string"
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Original target id"
},
"positionId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Primary key of the target's position. Resolved through the graph bundle's `target_positions` map."
},
"positionOffsetFrame": {
"$ref": "#/components/schemas/ObservationPositionOffsetFrame",
"default": "icrs_tangent"
},
"positionOffsetReferenceTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"positionOffsetXDeg": {
"default": 0,
"type": "number"
},
"positionOffsetYDeg": {
"default": 0,
"type": "number"
},
"status": {
"$ref": "#/components/schemas/TargetStatus",
"description": "Status of the target"
},
"targetPosition": {
"anyOf": [
{
"discriminator": {
"mapping": {
"catalog": "#/components/schemas/CatalogPosition",
"ephemeral": "#/components/schemas/EphemeralPosition",
"fixed": "#/components/schemas/FixedPosition",
"orbital": "#/components/schemas/OrbitalPosition"
},
"propertyName": "positionType"
},
"oneOf": [
{
"$ref": "#/components/schemas/FixedPosition"
},
{
"$ref": "#/components/schemas/OrbitalPosition"
},
{
"$ref": "#/components/schemas/EphemeralPosition"
},
{
"$ref": "#/components/schemas/CatalogPosition"
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"kind",
"isDeleted",
"name"
],
"title": "Target",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /targets/{target_id}/clone
Create Target Clone
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
target_id |
path | integer | No | ||
token |
query | No |
Responses
{
"id": 0,
"isDeleted": true,
"kind": "template",
"name": "string",
"originalId": null,
"positionId": null,
"positionOffsetFrame": "icrs_tangent",
"positionOffsetReferenceTime": null,
"positionOffsetXDeg": 10.12,
"positionOffsetYDeg": 10.12,
"status": "active",
"targetPosition": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Primary key for the Target",
"type": "integer"
},
"isDeleted": {
"description": "Flag indicating if the target is deleted",
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind",
"description": "Lifecycle classification for the target"
},
"name": {
"description": "Name of the Target",
"type": "string"
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Original target id"
},
"positionId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Primary key of the target's position. Resolved through the graph bundle's `target_positions` map."
},
"positionOffsetFrame": {
"$ref": "#/components/schemas/ObservationPositionOffsetFrame",
"default": "icrs_tangent"
},
"positionOffsetReferenceTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"positionOffsetXDeg": {
"default": 0,
"type": "number"
},
"positionOffsetYDeg": {
"default": 0,
"type": "number"
},
"status": {
"$ref": "#/components/schemas/TargetStatus",
"description": "Status of the target"
},
"targetPosition": {
"anyOf": [
{
"discriminator": {
"mapping": {
"catalog": "#/components/schemas/CatalogPosition",
"ephemeral": "#/components/schemas/EphemeralPosition",
"fixed": "#/components/schemas/FixedPosition",
"orbital": "#/components/schemas/OrbitalPosition"
},
"propertyName": "positionType"
},
"oneOf": [
{
"$ref": "#/components/schemas/FixedPosition"
},
{
"$ref": "#/components/schemas/OrbitalPosition"
},
{
"$ref": "#/components/schemas/EphemeralPosition"
},
{
"$ref": "#/components/schemas/CatalogPosition"
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"kind",
"isDeleted",
"name"
],
"title": "Target",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /targets/{target_id}/draft
Create Target Draft
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
target_id |
path | integer | No |
Responses
{
"id": 0,
"isDeleted": true,
"kind": "template",
"name": "string",
"originalId": null,
"positionId": null,
"positionOffsetFrame": "icrs_tangent",
"positionOffsetReferenceTime": null,
"positionOffsetXDeg": 10.12,
"positionOffsetYDeg": 10.12,
"status": "active",
"targetPosition": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Primary key for the Target",
"type": "integer"
},
"isDeleted": {
"description": "Flag indicating if the target is deleted",
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind",
"description": "Lifecycle classification for the target"
},
"name": {
"description": "Name of the Target",
"type": "string"
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Original target id"
},
"positionId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Primary key of the target's position. Resolved through the graph bundle's `target_positions` map."
},
"positionOffsetFrame": {
"$ref": "#/components/schemas/ObservationPositionOffsetFrame",
"default": "icrs_tangent"
},
"positionOffsetReferenceTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"positionOffsetXDeg": {
"default": 0,
"type": "number"
},
"positionOffsetYDeg": {
"default": 0,
"type": "number"
},
"status": {
"$ref": "#/components/schemas/TargetStatus",
"description": "Status of the target"
},
"targetPosition": {
"anyOf": [
{
"discriminator": {
"mapping": {
"catalog": "#/components/schemas/CatalogPosition",
"ephemeral": "#/components/schemas/EphemeralPosition",
"fixed": "#/components/schemas/FixedPosition",
"orbital": "#/components/schemas/OrbitalPosition"
},
"propertyName": "positionType"
},
"oneOf": [
{
"$ref": "#/components/schemas/FixedPosition"
},
{
"$ref": "#/components/schemas/OrbitalPosition"
},
{
"$ref": "#/components/schemas/EphemeralPosition"
},
{
"$ref": "#/components/schemas/CatalogPosition"
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"kind",
"isDeleted",
"name"
],
"title": "Target",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /targets/{target_id}/publish
Publish Target Draft
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
target_id |
path | integer | No | ||
token |
query | No |
Responses
{
"id": 0,
"isDeleted": true,
"kind": "template",
"name": "string",
"originalId": null,
"positionId": null,
"positionOffsetFrame": "icrs_tangent",
"positionOffsetReferenceTime": null,
"positionOffsetXDeg": 10.12,
"positionOffsetYDeg": 10.12,
"status": "active",
"targetPosition": null
}
Schema of the response body
{
"properties": {
"id": {
"description": "Primary key for the Target",
"type": "integer"
},
"isDeleted": {
"description": "Flag indicating if the target is deleted",
"type": "boolean"
},
"kind": {
"$ref": "#/components/schemas/ObservationKind",
"description": "Lifecycle classification for the target"
},
"name": {
"description": "Name of the Target",
"type": "string"
},
"originalId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Original target id"
},
"positionId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Primary key of the target's position. Resolved through the graph bundle's `target_positions` map."
},
"positionOffsetFrame": {
"$ref": "#/components/schemas/ObservationPositionOffsetFrame",
"default": "icrs_tangent"
},
"positionOffsetReferenceTime": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"positionOffsetXDeg": {
"default": 0,
"type": "number"
},
"positionOffsetYDeg": {
"default": 0,
"type": "number"
},
"status": {
"$ref": "#/components/schemas/TargetStatus",
"description": "Status of the target"
},
"targetPosition": {
"anyOf": [
{
"discriminator": {
"mapping": {
"catalog": "#/components/schemas/CatalogPosition",
"ephemeral": "#/components/schemas/EphemeralPosition",
"fixed": "#/components/schemas/FixedPosition",
"orbital": "#/components/schemas/OrbitalPosition"
},
"propertyName": "positionType"
},
"oneOf": [
{
"$ref": "#/components/schemas/FixedPosition"
},
{
"$ref": "#/components/schemas/OrbitalPosition"
},
{
"$ref": "#/components/schemas/EphemeralPosition"
},
{
"$ref": "#/components/schemas/CatalogPosition"
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"kind",
"isDeleted",
"name"
],
"title": "Target",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
Endpoints
GET /targets/{target_id}/ephemeris
Read Target Ephemeris
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
duration |
query | No | |||
end_time |
query | No | |||
endTime |
query | No | |||
observer_height_m |
query | No | |||
observer_lat |
query | No | |||
observer_lon |
query | No | |||
observerHeightM |
query | No | |||
observerLat |
query | No | |||
observerLon |
query | No | |||
output_frame |
query | No | |||
outputFrame |
query | No | |||
resolution |
query | number | 60 | No | |
start_time |
query | No | |||
startTime |
query | No | |||
target_id |
path | integer | No | ||
token |
query | No |
Responses
{
"entries": [
{
"distanceAu": null,
"epoch": "2022-04-13T15:42:05.901Z",
"latDeg": 10.12,
"lonDeg": 10.12
}
],
"frame": null,
"representation": null
}
Schema of the response body
{
"description": "Represents a target ephemeris.\n\nAttributes:\n frame (str): The coordinate frame (e.g., 'icrs', 'fk5').\n representation (str): The representation type (e.g., 'cartesian', 'spherical').\n entries (list[TargetEphemerisEntry]): List of ephemeris entries.",
"properties": {
"entries": {
"items": {
"$ref": "#/components/schemas/TargetEphemerisEntry"
},
"type": "array"
},
"frame": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"representation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"frame",
"representation",
"entries"
],
"title": "TargetEphemeris",
"type": "object"
}
{
"detail": [
{
"ctx": {},
"input": null,
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
Schemas
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. |
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. |
AssetCreationMethod
Type: string
BlackBodySpectralComponent
| Name | Type | Description |
|---|---|---|
id |
integer | |
spectralComponentType |
string | |
temperatureK |
number | The temperature of the black body. |
Body_read_observation_requests_observations__observation_id__requests_get
| Name | Type | Description |
|---|---|---|
filterObservationId |
||
id |
||
isDeleted |
||
kind |
||
originalId |
||
status |
Body_read_observation_target_observations__observation_id__target_get
| Name | Type | Description |
|---|---|---|
id |
||
isDeleted |
||
kind |
||
originalId |
||
status |
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
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. |
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 |
CatalogPositionUpdate
| Name | Type | Description |
|---|---|---|
catalogObjectId |
||
positionType |
string |
ClusterModelingTool
| Name | Type | Description |
|---|---|---|
completedOn |
||
createdOn |
string(date-time) | |
creatorId |
integer | |
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
id |
integer | |
name |
string | |
observationId |
||
priority |
integer | |
projectId |
||
startedOn |
||
status |
JobStatus | |
totalStages |
ClusterModelingToolCreate
| Name | Type | Description |
|---|---|---|
dataToolType |
string | |
name |
string | |
observationId |
||
priority |
||
projectId |
ClusterModelingToolUpdate
| Name | Type | Description |
|---|---|---|
completedOn |
||
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
name |
||
observationId |
||
priority |
||
projectId |
||
startedOn |
||
status |
||
totalStages |
CoordinateType
Type: string
DataPolicy
Type: string
DataProductStatus
Type: string
DataToolDefinitionWithInstances
| Name | Type | Description |
|---|---|---|
allowMultiple |
boolean | |
dataToolType |
DataToolType | |
defaultConfigSchema |
||
description |
||
iconUrl |
||
id |
integer | |
instances |
Array<> | |
name |
string | |
version |
DataToolType
Type: string
DitherStrategy
Type: string
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 |
EclipticCoordinatesUpdate
| 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 |
Ecliptic latitude in degrees | |
lonDeg |
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) |
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
EphemeralPosition
| Name | Type | Description |
|---|---|---|
ephemeris |
Array<EphemerisRecord> | |
id |
integer | |
positionType |
string | |
targetId |
||
uid |
string(uuid) |
EphemeralPositionCreate
| Name | Type | Description |
|---|---|---|
positionType |
string |
EphemeralPositionUpdate
| 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 |
EquatorialCoordinatesUpdate
| Name | Type | Description |
|---|---|---|
coordinateType |
string | Type of the coordinate system |
decDeg |
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 |
ICRS right ascension in degrees | |
radialVelocityKmPerSec |
Radial velocity in km/s |
EventKind
Type: string
EventRead
| Name | Type | Description |
|---|---|---|
createdOn |
string(date-time) | |
dedupKey |
||
deviceId |
||
eventKind |
EventKind | |
id |
integer | |
message |
||
observationId |
||
observatoryId |
||
observingAccountId |
||
operationalConstraintId |
||
ownerEntityId |
||
payload |
||
renderedMessage |
Human-readable message rendered from the event kind's template + payload at API response time. Distinct from the persisted ``message`` column, which is set only when the producer chose to pre-render. UIs should prefer ``message`` when present and fall back to ``rendered_message``. | |
resourceId |
integer | |
resourceKind |
EventResourceKind | |
telescopeId |
EventResourceKind
Type: string
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 |
ExposureStatus
Type: string
ExternallyManagedObservingGrantBase
| Name | Type | Description |
|---|---|---|
accountId |
integer | |
allowExternalDelegation |
boolean | |
creditsUsed |
||
entityId |
integer | |
grantType |
string | |
id |
integer | |
quotas |
||
revoked |
boolean |
ExternallyManagedObservingGrantDetail
| Name | Type | Description |
|---|---|---|
account |
||
accountId |
integer | |
allowExternalDelegation |
boolean | |
creditsUsed |
||
entity |
||
entityId |
integer | |
grantType |
string | |
id |
integer | |
quotas |
||
revoked |
boolean |
File
| Name | Type | Description |
|---|---|---|
altTag |
||
bucket |
||
createdBy |
||
createdOn |
string(date-time) | |
id |
string(uuid) | |
isDataReady |
boolean | |
lastAccessedOn |
||
mimeType |
MimeType | |
name |
string | |
objectKey |
||
remoteUri |
||
renderSettings |
||
secretLinkKey |
||
sizeBytes |
||
storageType |
||
updatedOn |
string(date-time) | |
visibility |
FileVisibility |
FileSortField
Type: string
FileSummary
| Name | Type | Description |
|---|---|---|
altTag |
||
bucket |
||
createdBy |
||
createdOn |
string(date-time) | |
id |
string(uuid) | |
isDataReady |
boolean | |
lastAccessedOn |
||
mimeType |
MimeType | |
name |
string | |
objectKey |
||
remoteUri |
||
renderSettings |
||
secretLinkKey |
||
size |
||
storageType |
||
updatedOn |
string(date-time) | |
visibility |
FileVisibility |
FileVisibility
Type: string
Filter
| Name | Type | Description |
|---|---|---|
bandpassNm |
Bandpass of the filter in nanometers | |
centralWavelengthNm |
Central wavelength of the filter in nanometers | |
filterSpecifierType |
string | |
flatExposureScaler |
Scale factor applied to the base twilight flat exposure time for this filter. | |
id |
string | Unique identifier of the filter specifier |
isModifier |
True if the filter is a modifier (e.g. polarizer) |
FilterGroup
| Name | Type | Description |
|---|---|---|
description |
Description of the filter group | |
filterIds |
Array<string> | List of filter IDs in the group |
filters |
Array<Filter> | |
filterSpecifierType |
string | |
id |
string | Unique identifier of the filter specifier |
order |
integer | Display order of the filter group |
FilterShape
Type: string
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 |
FilterWheelPosition
| Name | Type | Description |
|---|---|---|
filterIds |
Array<string> | Filter specifier IDs for 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. |
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. |
FixedPosition
| Name | Type | Description |
|---|---|---|
coordinates |
||
coordinatesId |
integer | |
id |
integer | |
positionType |
string | |
targetId |
||
uid |
string(uuid) |
FixedPositionCreate
| Name | Type | Description |
|---|---|---|
coordinates |
||
positionType |
string |
FixedPositionUpdate
| 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. |
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 |
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 |
GalacticCoordinatesUpdate
| Name | Type | Description |
|---|---|---|
coordinateType |
string | Type of the coordinate system |
distancePc |
Distance in pc | |
epoch |
Epoch of observation | |
latDeg |
Galactic latitude in degrees | |
lonDeg |
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 |
GroupManagedObservingGrantBase
| Name | Type | Description |
|---|---|---|
accountId |
integer | |
creditsUsed |
||
grantType |
string | |
groupId |
integer | |
id |
integer | |
quotas |
||
revoked |
boolean |
GroupManagedObservingGrantDetail
| Name | Type | Description |
|---|---|---|
account |
||
accountId |
integer | |
creditsUsed |
||
grantType |
string | |
group |
GroupSummary | |
groupId |
integer | |
id |
integer | |
quotas |
||
revoked |
boolean |
GroupObservingGrantDetail
| Name | Type | Description |
|---|---|---|
account |
||
accountId |
integer | |
creditsUsed |
||
grantType |
string | |
group |
GroupSummary | |
groupId |
integer | |
id |
integer | |
quotas |
||
revoked |
boolean |
GroupSummary
| Name | Type | Description |
|---|---|---|
allowDataPolicyOverride |
boolean | Whether overriding the data policy is allowed |
allowInvitations |
boolean | Whether invitations are allowed |
dataPolicy |
Data policy. | |
defaultRoleId |
Default role for users in this group. | |
description |
string | Description of the group |
id |
integer | Unique identifier of the group. |
memberCount |
Number of members in the group | |
name |
string | Name of the group |
organizationId |
Unique identifier of the organization to which the group belongs | |
slug |
string | Unique identifier used in URLs referencing the group. |
HorizontalCoordinates
| Name | Type | Description |
|---|---|---|
altDeg |
number | Altitude in degrees |
azDeg |
number | Azimuth in degrees |
coordinateType |
string | Type of the coordinate system |
epoch |
Epoch of observation | |
id |
integer | Primary key for the TargetCoordinates |
pmAltArcsecPerSec |
Proper motion in altitude in arcsec/s | |
pmAzArcsecPerSec |
Proper motion in azimuth times cos(alt) in arcsec/s |
HorizontalCoordinatesCreate
| Name | Type | Description |
|---|---|---|
altDeg |
number | Altitude in degrees |
azDeg |
number | Azimuth in degrees |
coordinateType |
string | Type of the coordinate system |
epoch |
Epoch of observation | |
pmAltArcsecPerSec |
Proper motion in altitude in arcsec/s | |
pmAzArcsecPerSec |
Proper motion in azimuth times cos(alt) in arcsec/s |
HorizontalCoordinatesUpdate
| Name | Type | Description |
|---|---|---|
altDeg |
Altitude in degrees | |
azDeg |
Azimuth in degrees | |
coordinateType |
string | Type of the coordinate system |
epoch |
Epoch of observation | |
pmAltArcsecPerSec |
Proper motion in altitude in arcsec/s | |
pmAzArcsecPerSec |
Proper motion in azimuth times cos(alt) in arcsec/s |
HTTPValidationError
| Name | Type | Description |
|---|---|---|
detail |
Array<ValidationError> |
InstrumentAccessMode
Type: string
InstrumentAssignmentMode
Type: string
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. |
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. |
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 |
IterationIntervalType
Type: string
JobExceptionMessage
| Name | Type | Description |
|---|---|---|
message |
string | |
timestamp |
string(date-time) | |
traceback |
||
type |
string |
JobStatus
Type: string
JPLPlanetName
Type: string
LunarPhaseDirection
Type: string
MajorSolarSystemObject
| Name | Type | Description |
|---|---|---|
catalogObjectType |
string | |
id |
integer | Primary key of the catalog object |
name |
MajorSolarSystemObjectName | Name of the major solar‑system object |
uid |
string(uuid) | Stable UUID of the catalog object |
MajorSolarSystemObjectName
Type: string
MemberObservingGrantDetail
| Name | Type | Description |
|---|---|---|
account |
||
accountId |
integer | |
creditsUsed |
||
grantType |
string | |
id |
integer | |
quotas |
||
revoked |
boolean | |
user |
UserWithEmail | |
userId |
integer |
MimeType
Type: string
MountDetail
| Name | Type | Description |
|---|---|---|
defaultPierSide |
PierSide | |
deviceType |
string | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
maxSlewAccelerationAxis1DegPerSec2 |
||
maxSlewAccelerationAxis2DegPerSec2 |
||
maxSlewRateAxis1DegPerSec |
number | |
maxSlewRateAxis2DegPerSec |
number | |
maxSlewRateDegPerSec |
number | |
maxTrackingDurationSec |
number | |
meridianAvoidanceDeg |
number | |
meridianTrackingLimitDeg |
number | |
minAltitudeDeg |
number | |
model |
||
modelId |
||
mountType |
MountType | |
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
pivotXM |
number | X coordinate of the mount pivot in meters. |
pivotYM |
number | Y coordinate of the mount pivot in meters. |
pivotZM |
number | Z coordinate of the mount pivot in meters. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
zenithAvoidanceDeg |
number |
MountModel
| Name | Type | Description |
|---|---|---|
defaultPierSide |
PierSide | |
deviceType |
string | |
id |
||
imageId |
||
manufacturer |
||
maxSlewAccelerationAxis1DegPerSec2 |
||
maxSlewAccelerationAxis2DegPerSec2 |
||
maxSlewRateAxis1DegPerSec |
number | |
maxSlewRateAxis2DegPerSec |
number | |
meridianTrackingLimitDeg |
number | |
modelName |
string | |
mountType |
MountType |
MountType
Type: string
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 |
ObservabilityWindow
| Name | Type | Description |
|---|---|---|
endsOn |
string(date-time) | |
instrumentId |
integer | |
observable |
boolean | |
obsId |
integer | |
reason |
string | |
requestId |
||
requestType |
ObservationType | |
startsOn |
string(date-time) | |
telescopeId |
Observation
| Name | Type | Description |
|---|---|---|
cancelOn |
||
completedOn |
||
createdOn |
string(date-time) | Creation timestamp. |
creatorId |
integer | User who created it. |
creatorUid |
||
currentIteration |
integer | |
groupUid |
||
id |
integer | Unique identifier of the observation. |
instrumentAssignmentMode |
InstrumentAssignmentMode | |
instrumentIds |
||
instrumentLockTimeoutSec |
number | |
instrumentMode |
InstrumentAccessMode | |
interruptLowerPriority |
boolean | Interrupt lower priority. |
isDeleted |
boolean | Flag indicating if deleted. |
isPublic |
boolean | |
iterationInterval |
number | |
iterationIntervalType |
IterationIntervalType | |
iterations |
integer | |
kind |
ObservationKind | |
lastActivityOn |
||
name |
string | Name of the observation. |
observabilityLastUpdatedOn |
Timestamp of the last observability refresh. | |
observingBlockPolicy |
ObservingBlockPolicy | How observation tasks should be grouped into uninterrupted scheduling blocks. |
observingGrantIds |
||
opticalImagingConfiguration |
||
originalId |
Unique identifier of the observation forked from. | |
originalUid |
||
ownerId |
integer | Entity that funds this observation. |
ownerUid |
||
priority |
integer | |
progressFraction |
number | |
radioMappingConfiguration |
||
radioTrackingConfiguration |
||
requestTypes |
Array<ObservationType> | |
startAfter |
||
status |
ObservationStatus | |
targetId |
Unique identifier of the target associated with the observation. | |
targetUid |
||
uid |
string(uuid) | |
updatedOn |
string(date-time) | Update timestamp. |
ObservationAsset
| Name | Type | Description |
|---|---|---|
currentAnalysisRunId |
||
currentProcessingOutputId |
||
currentProcessingRunId |
||
currentRenderRunId |
||
fileId |
string(uuid) | |
id |
integer | |
instrumentId |
integer | |
instrumentUid |
||
isTransferrable |
boolean | |
lastTransferAttempt |
||
nextEligibleRenderAt |
||
observationId |
integer | |
observationUid |
||
previewFileId |
||
processingFlags |
||
remoteFilePath |
||
renderDirtyAt |
||
role |
||
rootObservationAssetId |
||
rootObservationAssetUid |
||
thumbnailFileId |
||
transferError |
||
transferProgressFraction |
||
transferState |
||
uid |
string(uuid) |
ObservationAssetAnalysisRun
| Name | Type | Description |
|---|---|---|
completedOn |
||
config |
||
errorMessages |
||
headerCore |
||
id |
string(uuid) | |
imageQualityMetrics |
||
observationAssetId |
integer | |
startedAt |
||
status |
JobStatus |
ObservationAssetAnalysisRunHeaderCore
| Name | Type | Description |
|---|---|---|
airmass |
||
binX |
||
binY |
||
bitpix |
||
bscale |
||
bzero |
||
ccdTemperatureC |
||
decTelescopeDeg |
||
exposureTimeSec |
||
filterId |
||
gainElectronsPerCount |
||
midExposureMjd |
||
naxis |
||
naxis1 |
||
naxis2 |
||
raTelescopeDeg |
||
readNoiseElectrons |
||
takenAtEndUtc |
||
takenAtStartUtc |
||
wcsCd11 |
||
wcsCd12 |
||
wcsCd21 |
||
wcsCd22 |
||
wcsCrota2 |
||
wcsCrpix1 |
||
wcsCrpix2 |
||
wcsCrval1 |
||
wcsCrval2 |
||
wcsInHeader |
||
wcsPixelScaleArcsecPerPx |
ObservationAssetAnalysisRunImageQualityMetrics
| Name | Type | Description |
|---|---|---|
backgroundCounts |
||
ellipticity |
||
fwhmArcsec |
||
sourceCount |
ObservationAssetDetail
| Name | Type | Description |
|---|---|---|
currentAnalysisRun |
||
currentAnalysisRunId |
||
currentProcessingOutput |
||
currentProcessingOutputId |
||
currentProcessingRun |
||
currentProcessingRunId |
||
currentRenderRun |
||
currentRenderRunId |
||
file |
||
fileId |
string(uuid) | |
id |
integer | |
instrumentId |
integer | |
instrumentUid |
||
isTransferrable |
boolean | |
lastTransferAttempt |
||
nextEligibleRenderAt |
||
observationId |
integer | |
observationUid |
||
previewFile |
||
previewFileId |
||
processingFlags |
||
reductionInfo |
||
remoteFilePath |
||
renderDirtyAt |
||
role |
||
rootObservationAssetId |
||
rootObservationAssetUid |
||
taskInfo |
||
taskResultProcessingOutputs |
||
thumbnailFile |
||
thumbnailFileId |
||
transferError |
||
transferProgressFraction |
||
transferState |
||
uid |
string(uuid) |
ObservationAssetPipelineOutputKind
Type: string
ObservationAssetProcessingFlag
Type: string
ObservationAssetProcessingOutput
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
isCanonical |
boolean | |
outputObservationAsset |
||
outputObservationAssetId |
integer | |
processingRunId |
string(uuid) | |
productKind |
ObservationAssetPipelineOutputKind |
ObservationAssetProcessingOutputSummary
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
isCanonical |
boolean | |
outputObservationAssetId |
integer | |
processingRunId |
string(uuid) | |
productKind |
ObservationAssetPipelineOutputKind |
ObservationAssetProcessingRun
| Name | Type | Description |
|---|---|---|
completedOn |
||
config |
||
errorMessages |
||
headerCore |
||
id |
string(uuid) | |
imageQualityMetrics |
||
observationAssetId |
integer | |
outputs |
Array<ObservationAssetProcessingOutput> | |
photometry |
||
pipelineVersion |
||
reductionInfo |
||
startedAt |
||
status |
JobStatus | |
wcsSolution |
ObservationAssetProcessingRunHeaderCore
| Name | Type | Description |
|---|---|---|
airmass |
||
binX |
||
binY |
||
bitpix |
||
bscale |
||
bzero |
||
ccdTemperatureC |
||
decTelescopeDeg |
||
exposureTimeSec |
||
filterId |
||
gainElectronsPerCount |
||
midExposureMjd |
||
naxis |
||
naxis1 |
||
naxis2 |
||
raTelescopeDeg |
||
readNoiseElectrons |
||
takenAtEndUtc |
||
takenAtStartUtc |
ObservationAssetProcessingRunImageQualityMetrics
| Name | Type | Description |
|---|---|---|
backgroundCounts |
||
ellipticity |
||
fwhmArcsec |
||
sourceCount |
ObservationAssetProcessingRunImageReductionInfo
| Name | Type | Description |
|---|---|---|
masterBiasId |
||
masterDarkId |
||
masterFlatId |
||
rawAssetId |
ObservationAssetProcessingRunPhotometry
| Name | Type | Description |
|---|---|---|
zeroPointErrorMag |
||
zeroPointMag |
ObservationAssetProcessingRunWcsSolution
| Name | Type | Description |
|---|---|---|
cd11 |
||
cd12 |
||
cd21 |
||
cd22 |
||
cdelt1 |
||
cdelt2 |
||
crota2 |
||
crpix1 |
||
crpix2 |
||
crval1 |
||
crval2 |
||
dateSolved |
||
decDeg |
||
deltaDecDeg |
||
deltaRaDeg |
||
foundSolution |
||
heightPx |
||
mirrored |
||
nField |
||
pixelScaleArcsecPerPx |
||
pointingErrorArcsec |
||
raDeg |
||
rotationDeg |
||
scienceHduIndex |
||
widthPx |
ObservationAssetReductionInfo
| Name | Type | Description |
|---|---|---|
biasId |
||
darkId |
||
flatId |
||
observationAssetId |
||
observationAssetUid |
||
rawFileId |
||
uid |
string(uuid) |
ObservationAssetRenderRun
| Name | Type | Description |
|---|---|---|
completedOn |
||
config |
||
configHash |
||
createdOn |
string(date-time) | |
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
errorMessages |
||
id |
string(uuid) | |
iterations |
integer | |
observationAssetId |
integer | |
priority |
integer | |
rendererVersion |
||
startedOn |
||
status |
JobStatus | |
totalStages |
||
version |
ObservationAssetRole
Type: string
ObservationAssetSortField
Type: string
ObservationAssetSummary
| Name | Type | Description |
|---|---|---|
currentAnalysisRun |
||
currentAnalysisRunId |
||
currentProcessingOutput |
||
currentProcessingOutputId |
||
currentProcessingRun |
||
currentProcessingRunId |
||
currentRenderRun |
||
currentRenderRunId |
||
file |
||
fileId |
string(uuid) | |
id |
integer | |
instrumentId |
integer | |
instrumentUid |
||
isTransferrable |
boolean | |
lastTransferAttempt |
||
nextEligibleRenderAt |
||
observationId |
integer | |
observationUid |
||
previewFile |
||
previewFileId |
||
processingFlags |
||
reductionInfo |
||
remoteFilePath |
||
renderDirtyAt |
||
role |
||
rootObservationAssetId |
||
rootObservationAssetUid |
||
taskInfo |
||
taskResultProcessingOutputs |
||
thumbnailFile |
||
thumbnailFileId |
||
transferError |
||
transferProgressFraction |
||
transferState |
||
uid |
string(uuid) |
ObservationAssetView
Type: string
ObservationDetail
| Name | Type | Description |
|---|---|---|
cancelOn |
||
completedOn |
||
createdOn |
string(date-time) | Creation timestamp. |
creator |
||
creatorId |
integer | User who created it. |
creatorUid |
||
currentIteration |
integer | |
galleryItems |
||
groupUid |
||
id |
integer | Unique identifier of the observation. |
instrumentAssignmentMode |
InstrumentAssignmentMode | |
instrumentIds |
||
instrumentLockTimeoutSec |
number | |
instrumentMode |
InstrumentAccessMode | |
interruptLowerPriority |
boolean | Interrupt lower priority. |
isDeleted |
boolean | Flag indicating if deleted. |
isPublic |
boolean | |
iterationInterval |
number | |
iterationIntervalType |
IterationIntervalType | |
iterations |
integer | |
kind |
ObservationKind | |
lastActivityOn |
||
name |
string | Name of the observation. |
observabilityLastUpdatedOn |
Timestamp of the last observability refresh. | |
observingBlockPolicy |
ObservingBlockPolicy | How observation tasks should be grouped into uninterrupted scheduling blocks. |
observingGrantIds |
||
observingGrants |
||
opticalImagingConfiguration |
||
originalId |
Unique identifier of the observation forked from. | |
originalUid |
||
owner |
||
ownerId |
integer | Entity that funds this observation. |
ownerUid |
||
priority |
integer | |
progressFraction |
number | |
radioMappingConfiguration |
||
radioTrackingConfiguration |
||
renderSettings |
||
requestTypes |
Array<ObservationType> | |
startAfter |
||
status |
ObservationStatus | |
target |
||
targetId |
Unique identifier of the target associated with the observation. | |
targetUid |
||
uid |
string(uuid) | |
updatedOn |
string(date-time) | Update timestamp. |
ObservationGalleryItem
| Name | Type | Description |
|---|---|---|
file |
||
fileId |
string(uuid) | |
id |
integer | |
observationId |
integer | |
observationUid |
||
order |
||
visibility |
boolean |
ObservationKind
Type: string
ObservationPositionOffsetFrame
Type: string
ObservationRequestSortField
Type: string
ObservationRequestStatus
Type: string
ObservationSortField
Type: string
ObservationStatus
Type: string
ObservationSummary
| Name | Type | Description |
|---|---|---|
cancelOn |
||
completedOn |
||
createdOn |
string(date-time) | Creation timestamp. |
creator |
||
creatorId |
integer | User who created it. |
creatorUid |
||
currentIteration |
integer | |
galleryItems |
||
groupUid |
||
id |
integer | Unique identifier of the observation. |
instrumentAssignmentMode |
InstrumentAssignmentMode | |
instrumentIds |
||
instrumentLockTimeoutSec |
number | |
instrumentMode |
InstrumentAccessMode | |
interruptLowerPriority |
boolean | Interrupt lower priority. |
isDeleted |
boolean | Flag indicating if deleted. |
isPublic |
boolean | |
iterationInterval |
number | |
iterationIntervalType |
IterationIntervalType | |
iterations |
integer | |
kind |
ObservationKind | |
lastActivityOn |
||
name |
string | Name of the observation. |
observabilityLastUpdatedOn |
Timestamp of the last observability refresh. | |
observingBlockPolicy |
ObservingBlockPolicy | How observation tasks should be grouped into uninterrupted scheduling blocks. |
observingGrantIds |
||
opticalImagingConfiguration |
||
originalId |
Unique identifier of the observation forked from. | |
originalUid |
||
owner |
||
ownerId |
integer | Entity that funds this observation. |
ownerUid |
||
priority |
integer | |
progressFraction |
number | |
radioMappingConfiguration |
||
radioTrackingConfiguration |
||
requestTypes |
Array<ObservationType> | |
startAfter |
||
status |
ObservationStatus | |
target |
||
targetId |
Unique identifier of the target associated with the observation. | |
targetUid |
||
uid |
string(uuid) | |
updatedOn |
string(date-time) | Update timestamp. |
ObservationTaskResultDetail
| Name | Type | Description |
|---|---|---|
currentProcessingRun |
||
currentProcessingRunId |
||
dirtyFromRevision |
||
id |
integer | |
lastBuiltRevision |
||
nextEligibleRunAt |
||
status |
DataProductStatus | |
task |
||
taskId |
integer | |
taskUid |
||
uid |
string(uuid) |
ObservationTaskResultPipelineOutputKind
Type: string
ObservationTaskResultProcessingRun
| Name | Type | Description |
|---|---|---|
id |
integer | |
inputAssets |
Array<ObservationAsset> | |
outputs |
Array<ObservationTaskResultProcessingRunOutput> | |
resultId |
integer | |
status |
JobStatus |
ObservationTaskResultProcessingRunOutput
| Name | Type | Description |
|---|---|---|
id |
integer | |
observationAsset |
||
observationAssetId |
integer | |
outputKind |
ObservationTaskResultPipelineOutputKind | |
processingRunId |
integer | |
tileId |
ObservationTaskResultProcessingRunOutputSummary
| Name | Type | Description |
|---|---|---|
id |
integer | |
observationAssetId |
integer | |
outputKind |
ObservationTaskResultPipelineOutputKind | |
processingRunId |
integer | |
tileId |
ObservationTaskSortField
Type: string
ObservationTaskStatus
Type: string
ObservationTrackingMode
Type: string
ObservationType
Type: string
ObservationUpdate
| Name | Type | Description |
|---|---|---|
cancelOn |
||
completedOn |
||
instrumentAssignmentMode |
||
instrumentIds |
||
instrumentLockTimeoutSec |
||
instrumentMode |
||
interruptLowerPriority |
||
isDeleted |
||
isPublic |
||
iterationInterval |
||
iterationIntervalType |
||
iterations |
||
kind |
||
lastActivityOn |
||
name |
||
observabilityLastUpdatedOn |
||
observingBlockPolicy |
||
observingGrantIds |
||
opticalImagingConfiguration |
||
originalId |
||
ownerId |
||
priority |
||
progressFraction |
||
radioMappingConfiguration |
||
radioTrackingConfiguration |
||
renderSettings |
||
startAfter |
||
status |
ObservatoryGalleryItem
| Name | Type | Description |
|---|---|---|
file |
||
fileId |
string(uuid) | |
id |
integer | |
observatoryId |
integer | |
order |
||
visibility |
boolean |
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 |
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> |
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) |
ObservingBlockPolicy
Type: string
ObservingDataPolicy
Type: string
ObservingGrantQuota
| Name | Type | Description |
|---|---|---|
anchorAt |
||
createdOn |
string(date-time) | |
creditsRemainingInWindow |
number | |
creditsUsedInWindow |
number | |
currentWindowEnd |
||
currentWindowStart |
||
enabled |
boolean | |
grantId |
integer | |
id |
integer | |
maxCredits |
number | |
periodType |
ObservingQuotaPeriodType | |
startsAtLocalTime |
||
timezone |
string | |
updatedOn |
string(date-time) |
ObservingPlan
| Name | Type | Description |
|---|---|---|
allRequestsObservable |
boolean | |
anyRequestsObservable |
boolean | |
constraints |
Array<string> | |
instrument |
||
isObservable |
boolean | |
legendColor |
string | |
observabilityWindows |
Array<ObservabilityWindow> | |
observationId |
integer | |
opticalImagingConfigurationPlan |
||
radioMappingConfigurationPlan |
||
radioTrackingConfigurationPlan |
||
requestPlanMap |
||
telescope |
TelescopeDetail |
ObservingPolicySummary
| Name | Type | Description |
|---|---|---|
allowedCatalogObjectTypes |
||
allowedCoordinateTypes |
||
allowedDataPolicies |
Array<ObservingDataPolicy> | |
allowedRequestTypes |
Array<ObservationType> | |
allowedTargetPositionTypes |
||
allowHiddenObservation |
boolean | |
allowHiddenTelemetry |
boolean | |
dataPublicAfter |
||
description |
||
id |
integer | |
name |
string | |
organizationId |
integer |
ObservingQueueAccessGrantSummary
| Name | Type | Description |
|---|---|---|
effectiveOrder |
integer | |
id |
integer | |
observingPolicyId |
||
order |
integer | |
queue |
||
queueId |
integer | |
revoked |
boolean | |
telescopeAccessGrant |
||
telescopeAccessGrantId |
integer | |
timeContested |
number | |
timeUsed |
number | |
timeWaiting |
number |
ObservingQueueAccessPrioritization
Type: string
ObservingQueueSummary
| Name | Type | Description |
|---|---|---|
accessPrioritization |
ObservingQueueAccessPrioritization | |
canInterrupt |
boolean | |
description |
string | |
enabled |
boolean | |
id |
integer | |
name |
string | |
order |
integer | |
slug |
string | |
telescope |
||
telescopeId |
integer |
ObservingQuotaPeriodType
Type: string
OperationalConstraintAction
| Name | Type | Description |
|---|---|---|
action |
OperationalConstraintActionType | |
deviceId |
integer | |
deviceUid |
||
id |
||
operationalConstraintId |
integer | |
priority |
integer | |
triggerOnStabilizing |
boolean | |
triggerOnUnknown |
boolean | |
triggerOnUnsafe |
boolean | |
uid |
string(uuid) |
OperationalConstraintActionType
Type: string
OpticalImagerCalibrationConfiguration
| Name | Type | Description |
|---|---|---|
biasMaxSunElevationDeg |
number | Maximum allowed Sun elevation for bias calibrations (degrees) |
biasMinSunElevationDeg |
number | Minimum allowed Sun elevation for bias calibrations (degrees) |
calibrationIntervalHours |
number | Desired interval between calibration observations (hours) |
darkExposureTimes |
Array<number> | Dark exposure times to collect, in seconds. |
darkMaxSunElevationDeg |
number | Maximum allowed Sun elevation for dark calibrations (degrees) |
darkMinSunElevationDeg |
number | Minimum allowed Sun elevation for dark calibrations (degrees) |
flatFieldSource |
FlatFieldSource | Flat field illumination source |
flatToleranceFraction |
number | Fractional tolerance for flat-field average counts |
imagerId |
integer | Optical imager ID |
maxExposureTimeSec |
number | Maximum acceptable exposure time for flats (seconds) |
minExposureTimeSec |
number | Minimum acceptable exposure time for flats (seconds) |
numBiases |
integer | Number of bias frames |
numDarks |
integer | Number of dark frames |
numFlats |
integer | Number of flat frames |
screenFlatEnclosureAzimuthDeg |
Enclosure azimuth for enclosure-screen flats (degrees) | |
screenFlatMaxSunElevationDeg |
number | Maximum allowed Sun elevation for enclosure-screen flat calibrations (degrees) |
screenFlatMinSunElevationDeg |
number | Minimum allowed Sun elevation for enclosure-screen flat calibrations (degrees) |
screenFlatMountAltitudeDeg |
Mount altitude for enclosure-screen flats (degrees) | |
screenFlatMountAzimuthDeg |
Mount azimuth for enclosure-screen flats (degrees) | |
targetFullWellFraction |
number | Target fraction of full well depth for flats |
twilightFlatMaxSunElevationDeg |
number | Maximum allowed Sun elevation for twilight flat calibrations (degrees) |
twilightFlatMinSunElevationDeg |
number | Minimum allowed Sun elevation for twilight flat calibrations (degrees) |
OpticalImagerDetail
| Name | Type | Description |
|---|---|---|
calibrationConfiguration |
Calibration configuration | |
calibrationMasterStrategy |
CalibrationMasterStrategy | How calibration masters are produced |
camera |
Camera details | |
cameraId |
integer | Camera PK |
cameraUid |
Camera UID | |
configurationUpdatedOn |
string(date-time) | Timestamp of last scheduling-relevant configuration update |
configurationVersion |
integer | Monotonic scheduling configuration version |
filterCombinations |
Allowed filter combos | |
filterWheelIds |
Array<integer> | Filter Wheel PKs |
filterWheels |
Array<FilterWheelDetail> | |
filterWheelUids |
Filter Wheel UIDs | |
focuser |
Focuser details | |
focuserId |
Focuser PK | |
focuserUid |
Focuser UID | |
focusReferenceTemperatureC |
Reference temperature for focus calibration | |
focusTemperatureCompensationEnabled |
boolean | Whether focus temperature compensation is enabled |
focusTemperatureSlope |
Focus slope (position units per degree) | |
focusTemperatureSource |
Temperature source for focus compensation | |
focusZeroPoint |
Focuser position at reference temperature | |
fov |
FOV (width, height) in degrees | |
id |
Instrument PK | |
instrumentRotator |
Instrument rotator details | |
instrumentRotatorId |
Instrument rotator PK | |
instrumentRotatorUid |
Instrument rotator UID | |
instrumentType |
string | Optical imager |
isActive |
boolean | Is active? |
name |
string | Instrument name |
ota |
OTA details | |
otaId |
integer | OTA PK |
otaUid |
OTA UID | |
pixelScale |
Pixel scale (arcsec/pixel) | |
seeingArcsec |
number | Seeing (arcsec) |
skyParams |
Sky parameters | |
telescope |
Telescope | |
telescopeId |
integer | Owning telescope PK |
telescopeUid |
Owning telescope UID | |
uid |
string(uuid) | Instrument UID |
weatherSensorId |
Weather sensor PK for ambient focus compensation | |
weatherSensorUid |
Weather sensor UID for ambient focus compensation |
OpticalImagerWithoutTelescope
| Name | Type | Description |
|---|---|---|
calibrationConfiguration |
Calibration configuration | |
calibrationMasterStrategy |
CalibrationMasterStrategy | How calibration masters are produced |
camera |
Camera details | |
cameraId |
integer | Camera PK |
cameraUid |
Camera UID | |
configurationUpdatedOn |
string(date-time) | Timestamp of last scheduling-relevant configuration update |
configurationVersion |
integer | Monotonic scheduling configuration version |
filterCombinations |
Allowed filter combos | |
filterWheelIds |
Array<integer> | Filter Wheel PKs |
filterWheels |
Array<FilterWheelDetail> | |
filterWheelUids |
Filter Wheel UIDs | |
focuser |
Focuser details | |
focuserId |
Focuser PK | |
focuserUid |
Focuser UID | |
focusReferenceTemperatureC |
Reference temperature for focus calibration | |
focusTemperatureCompensationEnabled |
boolean | Whether focus temperature compensation is enabled |
focusTemperatureSlope |
Focus slope (position units per degree) | |
focusTemperatureSource |
Temperature source for focus compensation | |
focusZeroPoint |
Focuser position at reference temperature | |
fov |
FOV (width, height) in degrees | |
id |
Instrument PK | |
instrumentRotator |
Instrument rotator details | |
instrumentRotatorId |
Instrument rotator PK | |
instrumentRotatorUid |
Instrument rotator UID | |
instrumentType |
string | Optical imager |
isActive |
boolean | Is active? |
name |
string | Instrument name |
ota |
OTA details | |
otaId |
integer | OTA PK |
otaUid |
OTA UID | |
pixelScale |
Pixel scale (arcsec/pixel) | |
seeingArcsec |
number | Seeing (arcsec) |
skyParams |
Sky parameters | |
telescope |
Telescope | |
telescopeId |
integer | Owning telescope PK |
telescopeUid |
Owning telescope UID | |
uid |
string(uuid) | Instrument UID |
weatherSensorId |
Weather sensor PK for ambient focus compensation | |
weatherSensorUid |
Weather sensor UID for ambient focus compensation |
OpticalImagingBiasCalibrationRequest
| Name | Type | Description |
|---|---|---|
active |
boolean | |
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
currentIteration |
integer | |
expiresOn |
||
id |
integer | |
instrumentId |
||
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
ObservationRequestStatus | |
temperatureBand |
||
uid |
string(uuid) |
OpticalImagingBiasCalibrationRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
expiresOn |
||
instrumentId |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
||
temperatureBand |
OpticalImagingBiasCalibrationRequestDetail
| Name | Type | Description |
|---|---|---|
active |
boolean | |
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
currentIteration |
integer | |
currentTask |
||
expiresOn |
||
id |
integer | |
instrumentId |
||
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
ObservationRequestStatus | |
temperatureBand |
||
uid |
string(uuid) |
OpticalImagingBiasCalibrationRequestPlan
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
constraints |
Array<string> | |
expiresOn |
||
instrumentId |
integer | |
isObservable |
boolean | |
iterations |
integer | |
requestId |
integer | |
requestType |
string | |
requiredFrames |
integer |
OpticalImagingBiasCalibrationRequestSummary
| Name | Type | Description |
|---|---|---|
active |
boolean | |
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
currentIteration |
integer | |
expiresOn |
||
id |
integer | |
instrumentId |
||
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
ObservationRequestStatus | |
temperatureBand |
||
uid |
string(uuid) |
OpticalImagingBiasCalibrationRequestUpdate
| Name | Type | Description |
|---|---|---|
active |
||
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
expiresOn |
||
instrumentId |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
modifiedOn |
||
observationId |
||
order |
||
originalId |
||
readoutModeId |
||
requestType |
string | |
requiredFrames |
||
status |
||
temperatureBand |
OpticalImagingBiasCalibrationTask
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
cameraId |
||
cameraUid |
||
ccdTemperatureC |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
expiresOn |
||
id |
integer | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
masterFileId |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
readoutModeId |
||
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredFrames |
integer | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetId |
||
taskType |
string | |
temperatureBand |
||
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingBiasCalibrationTaskDetail
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
camera |
||
cameraId |
||
cameraUid |
||
ccdTemperatureC |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
expiresOn |
||
id |
integer | |
instrument |
OpticalImagerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
masterFileId |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
readoutMode |
||
readoutModeId |
||
request |
OpticalImagingBiasCalibrationRequestDetail | |
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredFrames |
integer | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
target |
||
targetId |
||
taskType |
string | |
temperatureBand |
||
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingBiasCalibrationTaskSummary
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
cameraId |
||
cameraUid |
||
ccdTemperatureC |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
expiresOn |
||
id |
integer | |
instrument |
OpticalImagerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
masterFileId |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
readoutModeId |
||
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredFrames |
integer | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetId |
||
taskType |
string | |
temperatureBand |
||
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingCalibrationObservationAssetTaskInfoDetail
| Name | Type | Description |
|---|---|---|
exposureTimeSec |
||
frameNumber |
||
observationAssetId |
||
observationAssetUid |
||
task |
||
taskId |
integer | |
taskType |
string | |
taskUid |
||
uid |
string(uuid) |
OpticalImagingConfiguration-Input
| Name | Type | Description |
|---|---|---|
brightnessModel |
||
brightnessModelId |
||
ditherPositionAngleDeg |
||
ditherSteps |
||
ditherStepSizeDeg |
||
ditherStrategy |
DitherStrategy | |
fieldLockedOn |
||
imageNormalizationSettingsId |
||
lunarPhaseDirection |
||
maxElevationDeg |
||
maxMoonPhaseFraction |
||
maxPixelScaleArcsecPerPx |
||
maxSunElevationDeg |
||
maxTiles |
integer | |
minElevationDeg |
||
minFovXArcmin |
||
minFovYArcmin |
||
minMoonPhaseFraction |
||
minMoonSeparationDeg |
||
minPixelScaleArcsecPerPx |
||
minSunElevationDeg |
||
positionAngleDeg |
||
recenteringThreshold |
||
saturationModel |
||
saturationModelId |
||
temporalOffsetSec |
number | |
tileOverlap |
number | |
trackingMode |
ObservationTrackingMode |
OpticalImagingConfiguration-Output
| Name | Type | Description |
|---|---|---|
brightnessModel |
||
brightnessModelId |
||
ditherPositionAngleDeg |
||
ditherSteps |
||
ditherStepSizeDeg |
||
ditherStrategy |
DitherStrategy | |
fieldLockedOn |
||
imageNormalizationSettingsId |
||
lunarPhaseDirection |
||
maxElevationDeg |
||
maxMoonPhaseFraction |
||
maxPixelScaleArcsecPerPx |
||
maxSunElevationDeg |
||
maxTiles |
integer | |
minElevationDeg |
||
minFovXArcmin |
||
minFovYArcmin |
||
minMoonPhaseFraction |
||
minMoonSeparationDeg |
||
minPixelScaleArcsecPerPx |
||
minSunElevationDeg |
||
positionAngleDeg |
||
recenteringThreshold |
||
saturationModel |
||
saturationModelId |
||
temporalOffsetSec |
number | |
tileOverlap |
number | |
trackingMode |
ObservationTrackingMode |
OpticalImagingConfigurationPlan
| Name | Type | Description |
|---|---|---|
dither |
Array<OpticalImagingOffset> | |
positionAngleDeg |
number | |
selectedFiltersByRequest |
||
tiles |
Array<OpticalImagingOffset> | |
totalExposures |
integer | |
totalExposureTimeSec |
number | |
xFov |
number | |
yFov |
number |
OpticalImagingDarkCalibrationRequest
| Name | Type | Description |
|---|---|---|
active |
boolean | |
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
currentIteration |
integer | |
expiresOn |
||
exposureTimeSec |
||
id |
integer | |
instrumentId |
||
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
ObservationRequestStatus | |
temperatureBand |
||
uid |
string(uuid) |
OpticalImagingDarkCalibrationRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
expiresOn |
||
exposureTimeSec |
||
instrumentId |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
||
temperatureBand |
OpticalImagingDarkCalibrationRequestDetail
| Name | Type | Description |
|---|---|---|
active |
boolean | |
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
currentIteration |
integer | |
currentTask |
||
expiresOn |
||
exposureTimeSec |
||
id |
integer | |
instrumentId |
||
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
ObservationRequestStatus | |
temperatureBand |
||
uid |
string(uuid) |
OpticalImagingDarkCalibrationRequestPlan
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
constraints |
Array<string> | |
expiresOn |
||
instrumentId |
integer | |
isObservable |
boolean | |
iterations |
integer | |
requestId |
integer | |
requestType |
string | |
requiredFrames |
integer |
OpticalImagingDarkCalibrationRequestSummary
| Name | Type | Description |
|---|---|---|
active |
boolean | |
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
currentIteration |
integer | |
expiresOn |
||
exposureTimeSec |
||
id |
integer | |
instrumentId |
||
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
ObservationRequestStatus | |
temperatureBand |
||
uid |
string(uuid) |
OpticalImagingDarkCalibrationRequestUpdate
| Name | Type | Description |
|---|---|---|
active |
||
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
expiresOn |
||
exposureTimeSec |
||
instrumentId |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
modifiedOn |
||
observationId |
||
order |
||
originalId |
||
readoutModeId |
||
requestType |
string | |
requiredFrames |
||
status |
||
temperatureBand |
OpticalImagingDarkCalibrationTask
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
cameraId |
||
cameraUid |
||
ccdTemperatureC |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
expiresOn |
||
exposureTimeSec |
||
id |
integer | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
masterFileId |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
readoutModeId |
||
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredFrames |
integer | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetId |
||
taskType |
string | |
temperatureBand |
||
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingDarkCalibrationTaskDetail
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
camera |
||
cameraId |
||
cameraUid |
||
ccdTemperatureC |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
expiresOn |
||
exposureTimeSec |
||
id |
integer | |
instrument |
OpticalImagerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
masterFileId |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
readoutMode |
||
readoutModeId |
||
request |
OpticalImagingDarkCalibrationRequestDetail | |
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredFrames |
integer | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
target |
||
targetId |
||
taskType |
string | |
temperatureBand |
||
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingDarkCalibrationTaskSummary
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
cameraId |
||
cameraUid |
||
ccdTemperatureC |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
expiresOn |
||
exposureTimeSec |
||
id |
integer | |
instrument |
OpticalImagerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
masterFileId |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
readoutModeId |
||
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredFrames |
integer | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetId |
||
taskType |
string | |
temperatureBand |
||
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingFlatCalibrationRequest
| Name | Type | Description |
|---|---|---|
active |
boolean | |
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
currentIteration |
integer | |
expiresOn |
||
filterIds |
Array<string> | |
id |
integer | |
instrumentId |
||
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
maxExposureTimeSec |
||
minExposureTimeSec |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
ObservationRequestStatus | |
targetFullWellFraction |
||
temperatureBand |
||
uid |
string(uuid) |
OpticalImagingFlatCalibrationRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
expiresOn |
||
filterIds |
||
instrumentId |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
maxExposureTimeSec |
||
minExposureTimeSec |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
||
targetFullWellFraction |
||
temperatureBand |
OpticalImagingFlatCalibrationRequestDetail
| Name | Type | Description |
|---|---|---|
active |
boolean | |
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
currentIteration |
integer | |
currentTask |
||
expiresOn |
||
filterIds |
Array<string> | |
filters |
Array<Filter> | |
id |
integer | |
instrumentId |
||
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
maxExposureTimeSec |
||
minExposureTimeSec |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
ObservationRequestStatus | |
targetFullWellFraction |
||
temperatureBand |
||
uid |
string(uuid) |
OpticalImagingFlatCalibrationRequestPlan
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
constraints |
Array<string> | |
expiresOn |
||
instrumentId |
integer | |
isObservable |
boolean | |
iterations |
integer | |
requestId |
integer | |
requestType |
string | |
requiredFrames |
integer |
OpticalImagingFlatCalibrationRequestSummary
| Name | Type | Description |
|---|---|---|
active |
boolean | |
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
currentIteration |
integer | |
expiresOn |
||
filterIds |
Array<string> | |
filters |
Array<Filter> | |
id |
integer | |
instrumentId |
||
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
maxExposureTimeSec |
||
minExposureTimeSec |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
readoutModeId |
||
requestType |
string | |
requiredFrames |
integer | |
status |
ObservationRequestStatus | |
targetFullWellFraction |
||
temperatureBand |
||
uid |
string(uuid) |
OpticalImagingFlatCalibrationRequestUpdate
| Name | Type | Description |
|---|---|---|
active |
||
cameraId |
||
ccdTemperatureC |
||
createdOn |
||
expiresOn |
||
filterIds |
||
instrumentId |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
maxExposureTimeSec |
||
minExposureTimeSec |
||
modifiedOn |
||
observationId |
||
order |
||
originalId |
||
readoutModeId |
||
requestType |
string | |
requiredFrames |
||
status |
||
targetFullWellFraction |
||
temperatureBand |
OpticalImagingFlatCalibrationTask
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
cameraId |
||
cameraUid |
||
ccdTemperatureC |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
expiresOn |
||
filterIds |
||
filterWheelPositionIds |
||
id |
integer | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
masterFileId |
||
maxExposureTimeSec |
||
minExposureTimeSec |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
readoutModeId |
||
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredFrames |
integer | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetFullWellFraction |
||
targetId |
||
taskType |
string | |
temperatureBand |
||
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingFlatCalibrationTaskDetail
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
camera |
||
cameraId |
||
cameraUid |
||
ccdTemperatureC |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
expiresOn |
||
filterIds |
||
filters |
Array<Filter> | |
filterWheelPositionIds |
||
filterWheelPositions |
Array<FilterWheelPosition> | |
id |
integer | |
instrument |
OpticalImagerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
masterFileId |
||
maxExposureTimeSec |
||
minExposureTimeSec |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
readoutMode |
||
readoutModeId |
||
request |
OpticalImagingFlatCalibrationRequestDetail | |
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredFrames |
integer | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
target |
||
targetFullWellFraction |
||
targetId |
||
taskType |
string | |
temperatureBand |
||
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingFlatCalibrationTaskSummary
| Name | Type | Description |
|---|---|---|
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
cameraId |
||
cameraUid |
||
ccdTemperatureC |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
expiresOn |
||
filterIds |
||
filterWheelPositionIds |
||
id |
integer | |
instrument |
OpticalImagerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
masterFileId |
||
maxExposureTimeSec |
||
minExposureTimeSec |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
readoutModeId |
||
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredFrames |
integer | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetFullWellFraction |
||
targetId |
||
taskType |
string | |
temperatureBand |
||
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingObservationAssetTaskInfoDetail
| Name | Type | Description |
|---|---|---|
exposureTimeSec |
||
frameNumber |
||
observationAssetId |
||
observationAssetUid |
||
task |
||
taskId |
integer | |
taskType |
string | |
taskUid |
||
tileId |
||
uid |
string(uuid) |
OpticalImagingOffset
| Name | Type | Description |
|---|---|---|
cs |
||
sn |
||
x |
number | |
y |
number |
OpticalImagingRequest
| Name | Type | Description |
|---|---|---|
active |
boolean | |
allowBinning |
||
allowCoadding |
boolean | |
allowRegistration |
boolean | |
createdOn |
||
currentIteration |
integer | |
electronicShutter |
||
exposureTimeSec |
||
fastReadout |
||
filterSpecifierIds |
Array<string> | |
globalShutter |
||
hdr |
||
highGain |
||
id |
integer | |
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
maxBitDepth |
||
minBitDepth |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
rbiFlood |
||
requestType |
string | |
status |
ObservationRequestStatus | |
targetFullWellFraction |
||
targetSnr |
||
uid |
string(uuid) |
OpticalImagingRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
allowBinning |
||
allowCoadding |
||
allowRegistration |
||
createdOn |
||
electronicShutter |
||
exposureTimeSec |
||
fastReadout |
||
filterSpecifierIds |
||
globalShutter |
||
hdr |
||
highGain |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
maxBitDepth |
||
minBitDepth |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
rbiFlood |
||
requestType |
string | |
status |
||
targetFullWellFraction |
||
targetSnr |
OpticalImagingRequestDetail
| Name | Type | Description |
|---|---|---|
active |
boolean | |
allowBinning |
||
allowCoadding |
boolean | |
allowRegistration |
boolean | |
createdOn |
||
currentIteration |
integer | |
currentTask |
||
electronicShutter |
||
exposureTimeSec |
||
fastReadout |
||
filterSpecifierIds |
Array<string> | |
filterSpecifiers |
Array<> | |
globalShutter |
||
hdr |
||
highGain |
||
id |
integer | |
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
maxBitDepth |
||
minBitDepth |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
rbiFlood |
||
requestType |
string | |
status |
ObservationRequestStatus | |
targetFullWellFraction |
||
targetSnr |
||
uid |
string(uuid) |
OpticalImagingRequestPlan
| Name | Type | Description |
|---|---|---|
constraints |
Array<string> | |
exposures |
integer | |
exposureTimeSec |
number | |
filters |
Array<Filter> | |
instrumentId |
integer | |
isObservable |
boolean | |
iterations |
integer | |
requestId |
integer | |
requestType |
string |
OpticalImagingRequestSummary
| Name | Type | Description |
|---|---|---|
active |
boolean | |
allowBinning |
||
allowCoadding |
boolean | |
allowRegistration |
boolean | |
createdOn |
||
currentIteration |
integer | |
electronicShutter |
||
exposureTimeSec |
||
fastReadout |
||
filterSpecifierIds |
Array<string> | |
filterSpecifiers |
Array<> | |
globalShutter |
||
hdr |
||
highGain |
||
id |
integer | |
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
maxBitDepth |
||
minBitDepth |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
progressFraction |
number | |
rbiFlood |
||
requestType |
string | |
status |
ObservationRequestStatus | |
targetFullWellFraction |
||
targetSnr |
||
uid |
string(uuid) |
OpticalImagingRequestUpdate
| Name | Type | Description |
|---|---|---|
active |
||
allowBinning |
||
allowCoadding |
||
allowRegistration |
||
createdOn |
||
electronicShutter |
||
exposureTimeSec |
||
fastReadout |
||
filterSpecifierIds |
||
globalShutter |
||
hdr |
||
highGain |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
maxBitDepth |
||
minBitDepth |
||
modifiedOn |
||
observationId |
||
order |
||
originalId |
||
rbiFlood |
||
requestType |
string | |
status |
||
targetFullWellFraction |
||
targetSnr |
OpticalImagingTask
| Name | Type | Description |
|---|---|---|
acquiredExposureTimeSec |
number | |
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
cameraId |
integer | |
cameraUid |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
filterIds |
Array<string> | |
filterWheelPositionIds |
Array<integer> | |
id |
integer | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
maxExposureTimeSec |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
otaId |
integer | |
otaUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredExposureTimeSec |
number | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetId |
||
taskType |
string | |
totalExposures |
integer | |
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingTaskDetail
| Name | Type | Description |
|---|---|---|
acquiredExposureTimeSec |
number | |
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
camera |
CameraDetail | |
cameraId |
integer | |
cameraUid |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
filterIds |
Array<string> | |
filters |
Array<Filter> | |
filterWheelPositionIds |
Array<integer> | |
filterWheelPositions |
Array<FilterWheelPosition> | |
id |
integer | |
instrument |
OpticalImagerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
maxExposureTimeSec |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
ota |
OtaDetail | |
otaId |
integer | |
otaUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
request |
OpticalImagingRequestDetail | |
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredExposureTimeSec |
number | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
target |
Target | |
targetId |
||
taskType |
string | |
tiles |
Array<OpticalImagingTaskTile> | |
totalExposures |
integer | |
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingTaskSummary
| Name | Type | Description |
|---|---|---|
acquiredExposureTimeSec |
number | |
acquiredFrames |
integer | |
actualEndTime |
||
actualStartTime |
||
assetsRevision |
integer | |
cameraId |
integer | |
cameraUid |
||
completedOn |
||
earliestStartTime |
||
expirationTime |
||
filterIds |
Array<string> | |
filters |
Array<Filter> | |
filterWheelPositionIds |
Array<integer> | |
id |
integer | |
instrument |
OpticalImagerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
maxExposureTimeSec |
||
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
otaId |
integer | |
otaUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
requiredExposureTimeSec |
number | |
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetId |
||
taskType |
string | |
totalExposures |
integer | |
totalPlannedDuration |
||
uid |
string(uuid) |
OpticalImagingTaskTile
| Name | Type | Description |
|---|---|---|
acquiredExposureTimeSec |
number | |
acquiredFrames |
integer | |
id |
integer | |
offsetXDeg |
number | |
offsetYDeg |
number | |
order |
integer | |
status |
ExposureStatus | |
taskId |
integer | |
totalExposureTimeSec |
number | |
totalFrames |
integer | |
uid |
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 |
OrbitalPositionUpdate
| Name | Type | Description |
|---|---|---|
argumentOfPerihelionDeg |
||
eccentricity |
||
epochJyear |
||
inclinationDeg |
||
longitudeOfAscendingNodeDeg |
||
meanAnomalyDeg |
||
orbitType |
||
positionType |
string | |
semilatusRectumAu |
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. |
location |
Location provided by the user or organization in their public profile | |
memberCount |
Number of members in the organization | |
name |
string | Name of the user/organization. |
observingPolicyIds |
Observing policy PKs configured for the organization. | |
profileImageId |
Profile image of the user/organization. | |
shortName |
Short name of the organization | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
websiteUrl |
Website URL provided by the user or organization in their public profile |
OrganizationPublic
| Name | Type | Description |
|---|---|---|
allowRequestToJoin |
boolean | Whether request-to-join is allowed |
country |
Country provided by the user or organization in their public profile | |
createdOn |
Creation time of this account | |
defaultRoleId |
Default role for users in this organization. | |
description |
Description/Bio provided by the user or organization in their public profile | |
entityType |
string | |
id |
integer | Unique identifier of the user/organization. |
location |
Location provided by the user or organization in their public profile | |
memberCount |
Number of members in the organization | |
name |
string | Name of the user/organization. |
observingPolicyIds |
Observing policy PKs configured for the organization. | |
profileImageId |
Profile image of the user/organization. | |
shortName |
Short name of the organization | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
websiteUrl |
Website URL provided by the user or organization in their public profile |
OrganizationSummary
| Name | Type | Description |
|---|---|---|
allowRequestToJoin |
boolean | Whether request-to-join is allowed |
country |
Country provided by the user or organization in their public profile | |
createdOn |
Creation time of this account | |
defaultRoleId |
Default role for users in this organization. | |
description |
Description/Bio provided by the user or organization in their public profile | |
entityType |
string | |
id |
integer | Unique identifier of the user/organization. |
location |
Location provided by the user or organization in their public profile | |
memberCount |
Number of members in the organization | |
name |
string | Name of the user/organization. |
observingPolicyIds |
Observing policy PKs configured for the organization. | |
profileImageId |
Profile image of the user/organization. | |
shortName |
Short name of the organization | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
websiteUrl |
Website URL provided by the user or organization in their public profile |
Ota
| Name | Type | Description |
|---|---|---|
apertureM |
number | Unobstructed aperture of the OTA in meters. |
deviceType |
string | |
focalLengthM |
number | Focal length of the OTA in meters. |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
offsetScalar |
Distance from mount pivot to OTA axis in meters along mount reference axis. | |
offsetXM |
X offset from parent OTA axis in meters. | |
offsetYM |
Y offset from parent OTA axis in meters. | |
offsetZM |
Z offset from parent OTA axis in meters. | |
operationalConstraintIds |
Operational constraint PKs | |
opticalDesign |
||
ownerId |
integer | The organization or user which owns the device. |
parentOta |
||
parentOtaId |
ID of the parent OTA if piggybacked. | |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
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 |
OwnerObservingGrantDetail
| Name | Type | Description |
|---|---|---|
account |
||
accountId |
integer | |
creditsUsed |
||
grantType |
string | |
id |
integer | |
quotas |
||
revoked |
boolean |
Page_Annotated_Union_OpticalImagingRequestPlan__OpticalImagingBiasCalibrationRequestPlan__OpticalImagingDarkCalibrationRequestPlan__OpticalImagingFlatCalibrationRequestPlan__RadioTrackingRequestPlan__RadioMappingRequestPlanFieldInfoannotation_NoneTyperequired_True__discriminator__request_type____
| Name | Type | Description |
|---|---|---|
items |
Array<> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_Annotated_Union_OpticalImagingRequestSummary__OpticalImagingBiasCalibrationRequestSummary__OpticalImagingDarkCalibrationRequestSummary__OpticalImagingFlatCalibrationRequestSummary__RadioTrackingRequestSummary__RadioMappingRequestSummaryFieldInfoannotation_NoneTyperequired_True__discriminator__request_type____
| Name | Type | Description |
|---|---|---|
items |
Array<> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_Annotated_Union_OpticalImagingTaskSummary__OpticalImagingBiasCalibrationTaskSummary__OpticalImagingDarkCalibrationTaskSummary__OpticalImagingFlatCalibrationTaskSummary__RadioTrackingTaskSummary__RadioMappingTaskSummaryFieldInfoannotation_NoneTyperequired_True__discriminator__task_type____
| Name | Type | Description |
|---|---|---|
items |
Array<> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_DataToolDefinitionWithInstances_
| Name | Type | Description |
|---|---|---|
items |
Array<DataToolDefinitionWithInstances> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_EventRead_
| Name | Type | Description |
|---|---|---|
items |
Array<EventRead> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_ObservabilityWindow_
| Name | Type | Description |
|---|---|---|
items |
Array<ObservabilityWindow> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_ObservationAssetSummary_
| Name | Type | Description |
|---|---|---|
items |
Array<ObservationAssetSummary> | |
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_ObservationTaskResultDetail_
| Name | Type | Description |
|---|---|---|
items |
Array<ObservationTaskResultDetail> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_ObservingPlan_
| Name | Type | Description |
|---|---|---|
items |
Array<ObservingPlan> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
Page_Target_
| Name | Type | Description |
|---|---|---|
items |
Array<Target> | |
page |
integer | |
pages |
integer | |
size |
integer | |
total |
integer |
PierSide
Type: string
PlanetarySatellite
| Name | Type | Description |
|---|---|---|
bsp |
string | Name of the SPK ephemeris file |
catalogObjectType |
string | |
id |
integer | Primary key of the catalog object |
name |
string | Name of the satellite |
number |
integer | The JPL number of the satellite |
planet |
JPLPlanetName | Central planet of the satellite |
uid |
string(uuid) | Stable UUID of the catalog object |
PolarizationType
Type: string
PowerLawSpectralComponent
| Name | Type | Description |
|---|---|---|
id |
integer | |
index |
number | The power law decay index. |
spectralComponentType |
string |
PowerLawTemporalComponent
| Name | Type | Description |
|---|---|---|
eventTime |
string(date-time) | UTC time of event. |
id |
integer | |
index |
number | The power law decay index. |
referenceTimeSec |
number | Characteristic fading time in seconds. |
temporalComponentType |
string |
RadioBackend
| Name | Type | Description |
|---|---|---|
description |
Description | |
deviceType |
string | |
id |
Radio backend PK | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
RadioBackendConfiguration
| Name | Type | Description |
|---|---|---|
bandwidthMhz |
number | |
centerFrequenciesMhz |
Array<number> | |
channels |
integer | |
filter |
||
integrationTimeMs |
number |
RadioBackendDetail
| Name | Type | Description |
|---|---|---|
description |
Description | |
deviceType |
string | |
id |
Radio backend PK | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintActions |
Array<OperationalConstraintAction> | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |
RadioBackendMode
| Name | Type | Description |
|---|---|---|
availableRadioFilters |
Array<RadioFilter> | Available radio filters |
bandwidthMhz |
number | Bandwidth (MHz) |
channelsExponent |
integer | Channels exponent |
frequencyWindows |
integer | Number of frequency windows |
id |
integer | Radio backend mode PK |
integrationTimesMs |
Integration times (ms) | |
isSimultaneous |
boolean | Is simultaneous? |
minimumIntegrationTimeMs |
Minimum integration time (ms) | |
name |
string | Mode name |
radioBackendId |
integer | Radio backend PK |
RadioCoordinateUnit
Type: string
RadioFilter
| Name | Type | Description |
|---|---|---|
id |
integer | Radio filter PK |
name |
Filter name |
RadioMappingConfiguration
| Name | Type | Description |
|---|---|---|
coordinateUnit |
RadioCoordinateUnit | |
daisyDiameter |
||
densityAlongSweeps |
number | |
densityBetweenSweeps |
||
integrationTimeSec |
||
mappingStrategy |
RadioMappingStrategy | |
maxSunElevationDeg |
number | |
minElevationDeg |
number | |
minSunSeparationDeg |
number | |
rasterSizeXDeg |
||
rasterSizeYDeg |
||
slewSpeedDegPerSec |
||
sweepDirection |
RadioMappingConfigurationPlan
| Name | Type | Description |
|---|---|---|
densityAlongSweepsDeg |
||
densityBetweenSweepsDeg |
||
integrationTimeSec |
||
mappingStrategy |
RadioMappingStrategy | |
samplePoints |
Array<RadioMappingSamplePoint> | |
slewSpeedDegPerSec |
RadioMappingRasterDirection
Type: string
RadioMappingRequest
| Name | Type | Description |
|---|---|---|
active |
boolean | |
createdOn |
||
currentIteration |
integer | |
id |
integer | |
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
minResolutionMhz |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
polarization |
||
progressFraction |
number | |
requestType |
string | |
spectroscopyWindowIds |
Array<integer> | |
status |
ObservationRequestStatus | |
uid |
string(uuid) |
RadioMappingRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
createdOn |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
minResolutionMhz |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
polarization |
||
requestType |
string | |
spectroscopyWindows |
||
status |
RadioMappingRequestDetail
| Name | Type | Description |
|---|---|---|
active |
boolean | |
createdOn |
||
currentIteration |
integer | |
currentTask |
||
id |
integer | |
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
minResolutionMhz |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
polarization |
||
progressFraction |
number | |
requestType |
string | |
spectroscopyWindowIds |
Array<integer> | |
spectroscopyWindows |
Array<RadioSpectroscopyWindow> | |
status |
ObservationRequestStatus | |
uid |
string(uuid) |
RadioMappingRequestPlan
| Name | Type | Description |
|---|---|---|
backendConfiguration |
RadioBackendConfiguration | |
constraints |
Array<string> | |
daisyDiameterDeg |
||
densityAlongSweepsDeg |
number | |
densityBetweenPathsDeg |
number | |
instrumentId |
integer | |
isObservable |
boolean | |
iterations |
integer | |
requestId |
integer | |
requestType |
string | |
sizeXDeg |
||
sizeYDeg |
||
slewSpeedDegPerSec |
number |
RadioMappingRequestSummary
| Name | Type | Description |
|---|---|---|
active |
boolean | |
createdOn |
||
currentIteration |
integer | |
id |
integer | |
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
minResolutionMhz |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
polarization |
||
progressFraction |
number | |
requestType |
string | |
spectroscopyWindowIds |
Array<integer> | |
spectroscopyWindows |
Array<RadioSpectroscopyWindow> | |
status |
ObservationRequestStatus | |
uid |
string(uuid) |
RadioMappingRequestUpdate
| Name | Type | Description |
|---|---|---|
active |
||
createdOn |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
minResolutionMhz |
||
modifiedOn |
||
observationId |
||
order |
||
originalId |
||
polarization |
||
requestType |
string | |
spectroscopyWindows |
||
status |
RadioMappingSamplePoint
| Name | Type | Description |
|---|---|---|
index |
integer | |
x |
number | |
y |
number |
RadioMappingStrategy
Type: string
RadioMappingTask
| Name | Type | Description |
|---|---|---|
actualEndTime |
||
actualStartTime |
||
antennaId |
integer | |
antennaUid |
||
assetsRevision |
integer | |
centralFrequenciesMhz |
Array<number> | |
completedOn |
||
daisyDurationSec |
||
daisyRadialPeriodSec |
||
daisyRadiusDeg |
||
earliestStartTime |
||
expirationTime |
||
id |
integer | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
integrationTimeMs |
number | |
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
radioBackendId |
integer | |
radioBackendModeId |
integer | |
radioBackendUid |
||
radioFilterId |
||
receiverChannelIds |
Array<integer> | |
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetId |
||
taskType |
string | |
totalPlannedDuration |
||
uid |
string(uuid) |
RadioMappingTaskDetail
| Name | Type | Description |
|---|---|---|
actualEndTime |
||
actualStartTime |
||
antenna |
Antenna | |
antennaId |
integer | |
antennaUid |
||
assetsRevision |
integer | |
centralFrequenciesMhz |
Array<number> | |
channels |
Array<ReceiverChannel> | |
completedOn |
||
daisyDurationSec |
||
daisyRadialPeriodSec |
||
daisyRadiusDeg |
||
earliestStartTime |
||
expirationTime |
||
id |
integer | |
instrument |
RadioSpectrometerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
integrationTimeMs |
number | |
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
radioBackend |
RadioBackend | |
radioBackendId |
integer | |
radioBackendMode |
RadioBackendMode | |
radioBackendModeId |
integer | |
radioBackendUid |
||
radioFilter |
||
radioFilterId |
||
request |
RadioMappingRequestDetail | |
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
target |
Target | |
targetId |
||
taskType |
string | |
totalPlannedDuration |
||
uid |
string(uuid) |
RadioMappingTaskSummary
| Name | Type | Description |
|---|---|---|
actualEndTime |
||
actualStartTime |
||
antennaId |
integer | |
antennaUid |
||
assetsRevision |
integer | |
centralFrequenciesMhz |
Array<number> | |
completedOn |
||
daisyDurationSec |
||
daisyRadialPeriodSec |
||
daisyRadiusDeg |
||
earliestStartTime |
||
expirationTime |
||
id |
integer | |
instrument |
RadioSpectrometerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
integrationTimeMs |
number | |
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
radioBackendId |
integer | |
radioBackendModeId |
integer | |
radioBackendUid |
||
radioFilterId |
||
receiverChannelIds |
Array<integer> | |
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetId |
||
taskType |
string | |
totalPlannedDuration |
||
uid |
string(uuid) |
RadioReceiverBand
Type: string
RadioReceiverChannelBackendConnection
| Name | Type | Description |
|---|---|---|
id |
integer | Connection PK |
isActive |
boolean | Is active? |
radioBackendId |
integer | Radio backend PK |
receiverChannelId |
integer | Receiver channel PK |
RadioSpectrometerDetail
| Name | Type | Description |
|---|---|---|
antenna |
Antenna details | |
antennaId |
Antenna PK | |
antennaUid |
Antenna UID | |
beamwidth |
Beamwidth (degrees) | |
channelBackendConnections |
Array<RadioReceiverChannelBackendConnection> | Receiver channel to backend connections |
configurationUpdatedOn |
string(date-time) | Timestamp of last scheduling-relevant configuration update |
configurationVersion |
integer | Monotonic scheduling configuration version |
id |
Instrument PK | |
instrumentType |
string | Radio spectrometer |
isActive |
boolean | Is active? |
name |
string | Instrument name |
receiverIds |
Receiver PKs | |
receivers |
Receivers | |
telescope |
Telescope | |
telescopeId |
integer | Owning telescope PK |
telescopeUid |
Owning telescope UID | |
uid |
string(uuid) | Instrument UID |
RadioSpectrometerWithoutTelescope
| Name | Type | Description |
|---|---|---|
antenna |
Antenna details | |
antennaId |
Antenna PK | |
antennaUid |
Antenna UID | |
beamwidth |
Beamwidth (degrees) | |
channelBackendConnections |
Array<RadioReceiverChannelBackendConnection> | Receiver channel to backend connections |
configurationUpdatedOn |
string(date-time) | Timestamp of last scheduling-relevant configuration update |
configurationVersion |
integer | Monotonic scheduling configuration version |
id |
Instrument PK | |
instrumentType |
string | Radio spectrometer |
isActive |
boolean | Is active? |
name |
string | Instrument name |
receiverIds |
Receiver PKs | |
receivers |
Receivers | |
telescope |
Telescope | |
telescopeId |
integer | Owning telescope PK |
telescopeUid |
Owning telescope UID | |
uid |
string(uuid) | Instrument UID |
RadioSpectroscopyWindow
| Name | Type | Description |
|---|---|---|
bandwidthMhz |
number | |
centerFrequencyMhz |
number | |
id |
integer | |
requestId |
integer |
RadioSpectroscopyWindowCreate
| Name | Type | Description |
|---|---|---|
bandwidthMhz |
number | |
centerFrequencyMhz |
number |
RadioSpectroscopyWindowUpdate
| Name | Type | Description |
|---|---|---|
bandwidthMhz |
||
centerFrequencyMhz |
||
id |
RadioTrackingConfiguration
| Name | Type | Description |
|---|---|---|
coordinateUnit |
||
maxSunElevationDeg |
number | |
minElevationDeg |
number | |
minSunSeparationDeg |
number | |
offOffsetX |
||
offOffsetY |
||
trackingStrategy |
RadioTrackingStrategy |
RadioTrackingConfigurationPlan
| Name | Type | Description |
|---|---|---|
offOffsetX |
||
offOffsetY |
RadioTrackingContinuumDataTool
| Name | Type | Description |
|---|---|---|
completedOn |
||
createdOn |
string(date-time) | |
creatorId |
integer | |
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
id |
integer | |
name |
string | |
observationId |
||
priority |
integer | |
projectId |
||
startedOn |
||
status |
JobStatus | |
totalStages |
RadioTrackingContinuumDataToolCreate
| Name | Type | Description |
|---|---|---|
dataToolType |
string | |
name |
string | |
observationId |
||
priority |
||
projectId |
RadioTrackingContinuumDataToolUpdate
| Name | Type | Description |
|---|---|---|
completedOn |
||
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
name |
||
observationId |
||
priority |
||
projectId |
||
startedOn |
||
status |
||
totalStages |
RadioTrackingObservationAssetTaskInfoDetail
| Name | Type | Description |
|---|---|---|
durationSec |
||
observationAssetId |
||
observationAssetUid |
||
task |
||
taskId |
integer | |
taskType |
string | |
taskUid |
||
uid |
string(uuid) |
RadioTrackingRequest
| Name | Type | Description |
|---|---|---|
active |
boolean | |
createdOn |
||
currentIteration |
integer | |
durationSec |
number | |
id |
integer | |
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
maxIntegrationTimeMs |
||
minResolutionMhz |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
polarization |
||
progressFraction |
number | |
requestType |
string | |
requireContinuum |
boolean | |
spectroscopyWindowIds |
Array<integer> | |
status |
ObservationRequestStatus | |
uid |
string(uuid) |
RadioTrackingRequestCreate
| Name | Type | Description |
|---|---|---|
active |
||
createdOn |
||
duration |
number | |
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
maxIntegrationTimeMs |
||
minResolutionMhz |
||
modifiedOn |
||
observationId |
||
order |
integer | |
originalId |
||
polarization |
||
requestType |
string | |
requireContinuum |
boolean | |
spectroscopyWindows |
||
status |
RadioTrackingRequestDetail
| Name | Type | Description |
|---|---|---|
active |
boolean | |
createdOn |
||
currentIteration |
integer | |
currentTask |
||
durationSec |
number | |
id |
integer | |
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
maxIntegrationTimeMs |
||
minResolutionMhz |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
polarization |
||
progressFraction |
number | |
requestType |
string | |
requireContinuum |
boolean | |
spectroscopyWindowIds |
Array<integer> | |
spectroscopyWindows |
Array<RadioSpectroscopyWindow> | |
status |
ObservationRequestStatus | |
uid |
string(uuid) |
RadioTrackingRequestPlan
| Name | Type | Description |
|---|---|---|
backendConfiguration |
RadioBackendConfiguration | |
constraints |
Array<string> | |
durationSec |
number | |
instrumentId |
integer | |
isObservable |
boolean | |
iterations |
integer | |
requestId |
integer | |
requestType |
string |
RadioTrackingRequestSummary
| Name | Type | Description |
|---|---|---|
active |
boolean | |
createdOn |
||
currentIteration |
integer | |
durationSec |
number | |
id |
integer | |
instrumentMode |
InstrumentAccessMode | |
isDeleted |
boolean | |
iterations |
integer | |
kind |
ObservationKind | |
maxIntegrationTimeMs |
||
minResolutionMhz |
||
modifiedOn |
||
observationId |
integer | |
observationUid |
||
order |
integer | |
originalId |
||
originalUid |
||
polarization |
||
progressFraction |
number | |
requestType |
string | |
requireContinuum |
boolean | |
spectroscopyWindowIds |
Array<integer> | |
spectroscopyWindows |
Array<RadioSpectroscopyWindow> | |
status |
ObservationRequestStatus | |
uid |
string(uuid) |
RadioTrackingRequestUpdate
| Name | Type | Description |
|---|---|---|
active |
||
createdOn |
||
duration |
||
instrumentMode |
||
isDeleted |
||
iterations |
||
kind |
||
maxIntegrationTimeMs |
||
minResolutionMhz |
||
modifiedOn |
||
observationId |
||
order |
||
originalId |
||
polarization |
||
requestType |
string | |
requireContinuum |
||
spectroscopyWindows |
||
status |
RadioTrackingSpectrumDataTool
| Name | Type | Description |
|---|---|---|
completedOn |
||
createdOn |
string(date-time) | |
creatorId |
integer | |
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
id |
integer | |
name |
string | |
observationId |
||
priority |
integer | |
projectId |
||
startedOn |
||
status |
JobStatus | |
totalStages |
RadioTrackingSpectrumDataToolCreate
| Name | Type | Description |
|---|---|---|
dataToolType |
string | |
name |
string | |
observationId |
||
priority |
||
projectId |
RadioTrackingSpectrumDataToolUpdate
| Name | Type | Description |
|---|---|---|
completedOn |
||
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
name |
||
observationId |
||
priority |
||
projectId |
||
startedOn |
||
status |
||
totalStages |
RadioTrackingStrategy
Type: string
RadioTrackingTask
| Name | Type | Description |
|---|---|---|
actualEndTime |
||
actualStartTime |
||
antennaId |
integer | |
antennaUid |
||
assetsRevision |
integer | |
centralFrequenciesMhz |
Array<number> | |
completedOn |
||
durationSec |
number | |
earliestStartTime |
||
expirationTime |
||
id |
integer | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
integrationTimeMs |
number | |
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
radioBackendId |
integer | |
radioBackendModeId |
integer | |
radioBackendUid |
||
radioFilterId |
||
receiverChannelIds |
Array<integer> | |
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetId |
||
taskType |
string | |
totalPlannedDuration |
||
uid |
string(uuid) |
RadioTrackingTaskDetail
| Name | Type | Description |
|---|---|---|
actualEndTime |
||
actualStartTime |
||
antenna |
Antenna | |
antennaId |
integer | |
antennaUid |
||
assetsRevision |
integer | |
centralFrequenciesMhz |
Array<number> | |
channels |
Array<ReceiverChannel> | |
completedOn |
||
durationSec |
number | |
earliestStartTime |
||
expirationTime |
||
id |
integer | |
instrument |
RadioSpectrometerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
integrationTimeMs |
number | |
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
radioBackend |
RadioBackend | |
radioBackendId |
integer | |
radioBackendMode |
RadioBackendMode | |
radioBackendModeId |
integer | |
radioBackendUid |
||
radioFilter |
||
radioFilterId |
||
receivers |
Array<ReceiverDetail> | |
request |
RadioTrackingRequestDetail | |
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
target |
Target | |
targetId |
||
taskType |
string | |
totalPlannedDuration |
||
uid |
string(uuid) |
RadioTrackingTaskSummary
| Name | Type | Description |
|---|---|---|
actualEndTime |
||
actualStartTime |
||
antennaId |
integer | |
antennaUid |
||
assetsRevision |
integer | |
centralFrequenciesMhz |
Array<number> | |
completedOn |
||
durationSec |
number | |
earliestStartTime |
||
expirationTime |
||
id |
integer | |
instrument |
RadioSpectrometerDetail | |
instrumentConfigurationVersion |
||
instrumentId |
integer | |
instrumentUid |
||
integrationTimeMs |
number | |
modifiedOn |
string(date-time) | |
observationId |
integer | |
observationIteration |
integer | |
observationUid |
||
observingGrantId |
integer | |
observingGrantUid |
||
plannedDuration |
||
plannedStartTime |
||
progressFraction |
number | |
queueAccessGrantId |
||
queueAccessGrantUid |
||
radioBackendId |
integer | |
radioBackendModeId |
integer | |
radioBackendUid |
||
radioFilterId |
||
receiverChannelIds |
Array<integer> | |
requestId |
integer | |
requestIteration |
integer | |
requestUid |
||
schedulerRunId |
||
schedulerRunUid |
||
status |
ObservationTaskStatus | |
targetId |
||
taskType |
string | |
totalPlannedDuration |
||
uid |
string(uuid) |
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 |
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. |
RemoteAssetTransferState
Type: string
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. |
SiteSummary
| Name | Type | Description |
|---|---|---|
countryCode |
string | |
elevationM |
number | |
iauCode |
||
id |
||
latitudeDeg |
number | |
location |
string | |
longitudeDeg |
number | |
name |
string | |
owner |
||
ownerId |
||
slug |
string | |
uid |
string(uuid) |
SkyBrightnessModel
| Name | Type | Description |
|---|---|---|
id |
integer | Primary key |
modelType |
string |
SkynetStorageType
Type: string
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 |
SpectralComposerTool
| Name | Type | Description |
|---|---|---|
completedOn |
||
createdOn |
string(date-time) | |
creatorId |
integer | |
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
id |
integer | |
name |
string | |
observationId |
||
priority |
integer | |
projectId |
||
startedOn |
||
status |
JobStatus | |
totalStages |
SpectralComposerToolCreate
| Name | Type | Description |
|---|---|---|
dataToolType |
string | |
name |
string | |
observationId |
||
priority |
||
projectId |
SpectralComposerToolUpdate
| Name | Type | Description |
|---|---|---|
completedOn |
||
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
name |
||
observationId |
||
priority |
||
projectId |
||
startedOn |
||
status |
||
totalStages |
StreamKind
Type: string
StreamQuality
Type: string
SunAltitudeOpenCondition
Type: string
Target
| Name | Type | Description |
|---|---|---|
id |
integer | Primary key for the Target |
isDeleted |
boolean | Flag indicating if the target is deleted |
kind |
ObservationKind | Lifecycle classification for the target |
name |
string | Name of the Target |
originalId |
Original target id | |
positionId |
Primary key of the target's position. Resolved through the graph bundle's `target_positions` map. | |
positionOffsetFrame |
ObservationPositionOffsetFrame | |
positionOffsetReferenceTime |
||
positionOffsetXDeg |
number | |
positionOffsetYDeg |
number | |
status |
TargetStatus | Status of the target |
targetPosition |
TargetCreate
| Name | Type | Description |
|---|---|---|
isDeleted |
||
kind |
||
name |
string | |
originalId |
||
position |
||
positionOffsetFrame |
ObservationPositionOffsetFrame | |
positionOffsetReferenceTime |
||
positionOffsetXDeg |
number | |
positionOffsetYDeg |
number | |
status |
TargetEphemeris
| Name | Type | Description |
|---|---|---|
entries |
Array<TargetEphemerisEntry> | |
frame |
||
representation |
TargetEphemerisEntry
| Name | Type | Description |
|---|---|---|
distanceAu |
||
epoch |
string(date-time) | |
latDeg |
number | |
lonDeg |
number |
TargetPositionType
Type: string
TargetSortField
Type: string
TargetStatus
Type: string
TargetUpdate
| Name | Type | Description |
|---|---|---|
isDeleted |
||
kind |
||
name |
||
originalId |
||
position |
||
positionOffsetFrame |
||
positionOffsetReferenceTime |
||
positionOffsetXDeg |
||
positionOffsetYDeg |
||
status |
TelescopeAccessGrant
| Name | Type | Description |
|---|---|---|
entityId |
||
id |
integer | |
revoked |
boolean | |
shares |
number | |
telescopeId |
integer | |
timeContested |
number | |
timeUsed |
number | |
timeWaiting |
number |
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) |
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) |
TimeLapseCreatorTool
| Name | Type | Description |
|---|---|---|
completedOn |
||
createdOn |
string(date-time) | |
creatorId |
integer | |
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
id |
integer | |
name |
string | |
observationId |
||
priority |
integer | |
projectId |
||
startedOn |
||
status |
JobStatus | |
totalStages |
TimeLapseCreatorToolCreate
| Name | Type | Description |
|---|---|---|
dataToolType |
string | |
name |
string | |
observationId |
||
priority |
||
projectId |
TimeLapseCreatorToolUpdate
| Name | Type | Description |
|---|---|---|
completedOn |
||
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
name |
||
observationId |
||
priority |
||
projectId |
||
startedOn |
||
status |
||
totalStages |
TimeSeriesPhotometryTool
| Name | Type | Description |
|---|---|---|
completedOn |
||
createdOn |
string(date-time) | |
creatorId |
integer | |
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
id |
integer | |
name |
string | |
objects |
Array<TimeSeriesPhotometryToolObject> | |
observationId |
||
priority |
integer | |
projectId |
||
stacks |
Array<TimeSeriesPhotometryToolExposureStack> | |
startedOn |
||
status |
JobStatus | |
totalStages |
TimeSeriesPhotometryToolCreate
| Name | Type | Description |
|---|---|---|
dataToolType |
string | |
name |
string | |
observationId |
||
priority |
||
projectId |
TimeSeriesPhotometryToolExposureStack
| Name | Type | Description |
|---|---|---|
dataToolId |
integer | |
effectiveTime |
||
id |
integer |
TimeSeriesPhotometryToolObject
| Name | Type | Description |
|---|---|---|
catalogObjectId |
||
dataToolId |
integer | |
decDeg |
number | |
epoch |
||
id |
integer | |
name |
string | |
parallaxMas |
||
pmDecMasPerYear |
||
pmRaMasPerYear |
||
raDeg |
number | |
radialVelocityKmPerSec |
TimeSeriesPhotometryToolUpdate
| Name | Type | Description |
|---|---|---|
completedOn |
||
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
name |
||
observationId |
||
priority |
||
projectId |
||
startedOn |
||
status |
||
totalStages |
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 |
TopocentricCoordinatesUpdate
| Name | Type | Description |
|---|---|---|
coordinateType |
string | Type of the coordinate system |
decDeg |
Topocentric or observed declination in degrees | |
epoch |
Epoch of observation | |
haDeg |
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 |
Coordinates need correction for refraction? False = observed (refraction-corrected), true = topocentric |
TransientDetectorTool
| Name | Type | Description |
|---|---|---|
completedOn |
||
createdOn |
string(date-time) | |
creatorId |
integer | |
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
id |
integer | |
name |
string | |
observationId |
||
priority |
integer | |
projectId |
||
startedOn |
||
status |
JobStatus | |
totalStages |
TransientDetectorToolCreate
| Name | Type | Description |
|---|---|---|
dataToolType |
string | |
name |
string | |
observationId |
||
priority |
||
projectId |
TransientDetectorToolUpdate
| Name | Type | Description |
|---|---|---|
completedOn |
||
currentStage |
||
currentStageIndex |
||
currentStageProgressFraction |
||
dataToolType |
string | |
errorMessages |
||
name |
||
observationId |
||
priority |
||
projectId |
||
startedOn |
||
status |
||
totalStages |
User
| Name | Type | Description |
|---|---|---|
affiliation |
Affiliation provided by the user in their public profile | |
age |
Age of the user | |
birthdate |
Birthdate provided by the user in their public profile | |
country |
Country provided by the user or organization in their public profile | |
createdOn |
Creation time of this account | |
description |
Description/Bio provided by the user or organization in their public profile | |
email |
string | Email address of the user |
entityType |
string | |
facebookId |
Facebook ID provided by the user in their public profile | |
firstName |
First name of the user | |
githubId |
GitHub ID provided by the user in their public profile | |
id |
integer | Unique identifier of the user/organization. |
language |
Language provided by the user or organization in their public profile | |
lastName |
Last name of the user | |
linkedinId |
LinkedIn ID provided by the user in their public profile | |
location |
Location provided by the user or organization in their public profile | |
name |
string | Name of the user/organization. |
orcidId |
ORCID ID provided by the user in their public profile | |
profileImageId |
Profile image of the user/organization. | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
title |
Title provided by the user in their public profile | |
twitterId |
Twitter ID provided by the user in their public profile | |
username |
string | Username of the user |
websiteUrl |
Website URL provided by the user or organization in their public profile |
UserPublic
| Name | Type | Description |
|---|---|---|
affiliation |
Affiliation provided by the user in their public profile | |
age |
Age of the user | |
birthdate |
Birthdate provided by the user in their public profile | |
country |
Country provided by the user or organization in their public profile | |
createdOn |
Creation time of this account | |
description |
Description/Bio provided by the user or organization in their public profile | |
email |
string | Email address of the user |
entityType |
string | |
facebookId |
Facebook ID provided by the user in their public profile | |
firstName |
First name of the user | |
githubId |
GitHub ID provided by the user in their public profile | |
id |
integer | Unique identifier of the user/organization. |
language |
Language provided by the user or organization in their public profile | |
lastName |
Last name of the user | |
linkedinId |
LinkedIn ID provided by the user in their public profile | |
location |
Location provided by the user or organization in their public profile | |
name |
string | Name of the user/organization. |
orcidId |
ORCID ID provided by the user in their public profile | |
profileImageId |
Profile image of the user/organization. | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
title |
Title provided by the user in their public profile | |
twitterId |
Twitter ID provided by the user in their public profile | |
username |
string | Username of the user |
websiteUrl |
Website URL provided by the user or organization in their public profile |
UserSummary
| Name | Type | Description |
|---|---|---|
affiliation |
Affiliation provided by the user in their public profile | |
age |
Age of the user | |
birthdate |
Birthdate provided by the user in their public profile | |
country |
Country provided by the user or organization in their public profile | |
createdOn |
Creation time of this account | |
description |
Description/Bio provided by the user or organization in their public profile | |
email |
string | Email address of the user |
entityType |
string | |
facebookId |
Facebook ID provided by the user in their public profile | |
firstName |
First name of the user | |
githubId |
GitHub ID provided by the user in their public profile | |
id |
integer | Unique identifier of the user/organization. |
language |
Language provided by the user or organization in their public profile | |
lastName |
Last name of the user | |
linkedinId |
LinkedIn ID provided by the user in their public profile | |
location |
Location provided by the user or organization in their public profile | |
name |
string | Name of the user/organization. |
orcidId |
ORCID ID provided by the user in their public profile | |
profileImageId |
Profile image of the user/organization. | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
title |
Title provided by the user in their public profile | |
twitterId |
Twitter ID provided by the user in their public profile | |
username |
string | Username of the user |
websiteUrl |
Website URL provided by the user or organization in their public profile |
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 |
ORCID ID provided by the user in their public profile | |
profileImageId |
Profile image of the user/organization. | |
slug |
string | Unique identifier used in URLs referencing the user/organization. |
title |
Title provided by the user in their public profile | |
twitterId |
Twitter ID provided by the user in their public profile | |
username |
string | Username of the user |
websiteUrl |
Website URL provided by the user or organization in their public profile |
ValidationError
| Name | Type | Description |
|---|---|---|
ctx |
||
input |
||
loc |
Array<> | |
msg |
string | |
type |
string |
WeatherSensor
| Name | Type | Description |
|---|---|---|
deviceType |
string | |
hasAmbientTemperature |
boolean | |
hasCloudTemperatureDeltaC |
boolean | |
hasHumidity |
boolean | |
hasLightLevel |
boolean | |
hasPressure |
boolean | |
hasRainRate |
boolean | |
hasRainStorm |
boolean | |
hasSurfaceWetness |
boolean | |
hasWindDirection |
boolean | |
hasWindSpeedAvg10Min |
boolean | |
hasWindSpeedAvg1Min |
boolean | |
hasWindSpeedAvg2Min |
boolean | |
hasWindSpeedInstantaneous |
boolean | |
hasWindSpeedPeak10Min |
boolean | |
hasWindSpeedPeak1Min |
boolean | |
hasWindSpeedPeak2Min |
boolean | |
id |
The unique identifier for the device. | |
imageId |
Image asset ID for the device. | |
manufacturer |
||
modelId |
||
name |
The name of the device. | |
observatoryId |
The observatory ID this device belongs to. | |
observatoryUid |
The observatory UID this device belongs to. | |
operationalConstraintIds |
Operational constraint PKs | |
ownerId |
integer | The organization or user which owns the device. |
serialNumber |
Serial number for the device. | |
telescopeId |
The telescope ID this device belongs to. | |
telescopeUid |
The telescope UID this device belongs to. | |
uid |
string(uuid) | The unique UID for the device. |