API docs by Redocly

Configuration Database (2.1.1)

Download OpenAPI specification:Download

Observatory Configuration Database is a simple frontend to a relational database where we attempt to represent the physical state of a Telescope Network. It provides a RESTful API as well as HTML views of the data. This is used by other applications in the observatory control system to understand what components make up the observatory, and to allow for automated validation of component properties.This API documentation outlines the RESTful access, creation and modification of the components of the Configuration Database.

Sites

listSites

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

name
string

Site name

code
string

3-letter site code

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

createSite

Request Body schema:
name
string <= 200 characters

Site name

code
required
string <= 3 characters

3-letter site code

active
boolean

Whether the site is active and able to accept observations

timezone
required
integer [ -12 .. 14 ]

Offset from UTC in hours

restart
string

Daily restart time in UTC

tz
string <= 64 characters

Timezone Name

lat
number [ -90 .. 90 ]

Site latitude in decimal degrees

long
number [ -180 .. 180 ]

Site longitude in decimal degrees

elevation
required
integer [ -500 .. 100000 ]

Site elevation in meters

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "str",
  • "active": true,
  • "timezone": -12,
  • "restart": "string",
  • "tz": "string",
  • "lat": -90,
  • "long": -180,
  • "elevation": -500
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "str",
  • "active": true,
  • "timezone": -12,
  • "restart": "string",
  • "tz": "string",
  • "lat": -90,
  • "long": -180,
  • "elevation": -500,
  • "enclosure_set": [
    ],
  • "__str__": "string"
}

retrieveSite

path Parameters
id
required
string

A unique integer value identifying this site.

query Parameters
name
string

Site name

code
string

3-letter site code

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "str",
  • "active": true,
  • "timezone": -12,
  • "restart": "string",
  • "tz": "string",
  • "lat": -90,
  • "long": -180,
  • "elevation": -500,
  • "enclosure_set": [
    ],
  • "__str__": "string"
}

updateSite

path Parameters
id
required
string

A unique integer value identifying this site.

query Parameters
name
string

Site name

code
string

3-letter site code

Request Body schema:
name
string <= 200 characters

Site name

code
required
string <= 3 characters

3-letter site code

active
boolean

Whether the site is active and able to accept observations

timezone
required
integer [ -12 .. 14 ]

Offset from UTC in hours

restart
string

Daily restart time in UTC

tz
string <= 64 characters

Timezone Name

lat
number [ -90 .. 90 ]

Site latitude in decimal degrees

long
number [ -180 .. 180 ]

Site longitude in decimal degrees

elevation
required
integer [ -500 .. 100000 ]

Site elevation in meters

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "str",
  • "active": true,
  • "timezone": -12,
  • "restart": "string",
  • "tz": "string",
  • "lat": -90,
  • "long": -180,
  • "elevation": -500
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "str",
  • "active": true,
  • "timezone": -12,
  • "restart": "string",
  • "tz": "string",
  • "lat": -90,
  • "long": -180,
  • "elevation": -500,
  • "enclosure_set": [
    ],
  • "__str__": "string"
}

partialUpdateSite

path Parameters
id
required
string

A unique integer value identifying this site.

query Parameters
name
string

Site name

code
string

3-letter site code

Request Body schema:
name
string <= 200 characters

Site name

code
required
string <= 3 characters

3-letter site code

active
boolean

Whether the site is active and able to accept observations

timezone
required
integer [ -12 .. 14 ]

Offset from UTC in hours

restart
string

Daily restart time in UTC

tz
string <= 64 characters

Timezone Name

lat
number [ -90 .. 90 ]

Site latitude in decimal degrees

long
number [ -180 .. 180 ]

Site longitude in decimal degrees

elevation
required
integer [ -500 .. 100000 ]

Site elevation in meters

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "str",
  • "active": true,
  • "timezone": -12,
  • "restart": "string",
  • "tz": "string",
  • "lat": -90,
  • "long": -180,
  • "elevation": -500
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "str",
  • "active": true,
  • "timezone": -12,
  • "restart": "string",
  • "tz": "string",
  • "lat": -90,
  • "long": -180,
  • "elevation": -500,
  • "enclosure_set": [
    ],
  • "__str__": "string"
}

destroySite

path Parameters
id
required
string

A unique integer value identifying this site.

query Parameters
name
string

Site name

code
string

3-letter site code

Responses

Enclosures

listEnclosures

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

name
string

Enclosure name

code
string

Enclosure code

site
string

Site where this enclosure is located

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

createEnclosure

Request Body schema:
name
string <= 200 characters

Enclosure name

code
required
string <= 200 characters

Enclosure code

active
boolean

Whether the enclosure is active and able to accept observations

site_id
required
integer

Model ID number for the site this enclosure belongs to

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "site_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "site": "string",
  • "telescope_set": [
    ],
  • "__str__": "string"
}

retrieveEnclosure

path Parameters
id
required
string

A unique integer value identifying this enclosure.

query Parameters
name
string

Enclosure name

code
string

Enclosure code

site
string

Site where this enclosure is located

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "site": "string",
  • "telescope_set": [
    ],
  • "__str__": "string"
}

updateEnclosure

path Parameters
id
required
string

A unique integer value identifying this enclosure.

query Parameters
name
string

Enclosure name

code
string

Enclosure code

site
string

Site where this enclosure is located

Request Body schema:
name
string <= 200 characters

Enclosure name

code
required
string <= 200 characters

Enclosure code

active
boolean

Whether the enclosure is active and able to accept observations

site_id
required
integer

Model ID number for the site this enclosure belongs to

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "site_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "site": "string",
  • "telescope_set": [
    ],
  • "__str__": "string"
}

partialUpdateEnclosure

path Parameters
id
required
string

A unique integer value identifying this enclosure.

query Parameters
name
string

Enclosure name

code
string

Enclosure code

site
string

Site where this enclosure is located

Request Body schema:
name
string <= 200 characters

Enclosure name

code
required
string <= 200 characters

Enclosure code

active
boolean

Whether the enclosure is active and able to accept observations

site_id
required
integer

Model ID number for the site this enclosure belongs to

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "site_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "site": "string",
  • "telescope_set": [
    ],
  • "__str__": "string"
}

destroyEnclosure

path Parameters
id
required
string

A unique integer value identifying this enclosure.

query Parameters
name
string

Enclosure name

code
string

Enclosure code

site
string

Site where this enclosure is located

Responses

Telescopes

listTelescopes

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

name
string

Telescome name

code
string

Telescope code

lat
string

Telescope latitude in decimal degrees

long
string

Telescope longitude in decimal degrees

horizon
string

Minimum distance from horizion telescope can point without field of view being obscured, in degrees

enclosure
string

Enclosure which contains this telescope

aperture
string

The aperture of this telescope in meters. This is used to group telescopes by aperture class

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

createTelescope

Request Body schema:
serial_number
string <= 50 characters

Unique telescope serial number

name
string <= 200 characters

Telescome name

code
required
string <= 200 characters

Telescope code

active
boolean

Whether the telescope is active and able to accept observations

aperture
number >= 0

The aperture of this telescope in meters. This is used to group telescopes by aperture class

lat
required
number [ -90 .. 90 ]

Telescope latitude in decimal degrees

enclosure_id
required
integer

Model ID number for the enclosure that this telescope belongs to

slew_rate
number >= 0

The rate in sec/arcsec at which the telescope slews between targets within a single observation

minimum_slew_overhead
number >= 0

The minimum amount of time a slew can take in seconds for targets within a single observation

instrument_change_overhead
number >= 0

The maximum amount of time it takes to switch instruments on this telescope

long
required
number [ -180 .. 180 ]

Telescope longitude in decimal degrees

horizon
required
number [ 0 .. 90 ]

Minimum distance from horizion telescope can point without field of view being obscured, in degrees

ha_limit_pos
required
number [ 0 .. 12 ]

Positive hour-angle limit in hours

ha_limit_neg
required
number [ -12 .. 0 ]

Negative hour-angle limit in hours

telescope_front_padding
number >= 0

Setup time for taking on observation on this telescope, applied once per observation. This is for an average of tasks like initial slewing and opening the enclosure.

zenith_blind_spot
number [ 0 .. 180 ]

For AltAz telescopes, radius of zenith blind spot in degrees

Responses

Request samples

Content type
{
  • "serial_number": "string",
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "aperture": 0,
  • "lat": -90,
  • "enclosure_id": 0,
  • "slew_rate": 0,
  • "minimum_slew_overhead": 0,
  • "instrument_change_overhead": 0,
  • "long": -180,
  • "horizon": 90,
  • "ha_limit_pos": 12,
  • "ha_limit_neg": -12,
  • "telescope_front_padding": 0,
  • "zenith_blind_spot": 180
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "serial_number": "string",
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "aperture": 0,
  • "lat": -90,
  • "slew_rate": 0,
  • "minimum_slew_overhead": 0,
  • "instrument_change_overhead": 0,
  • "long": -180,
  • "enclosure": "string",
  • "horizon": 90,
  • "ha_limit_pos": 12,
  • "ha_limit_neg": -12,
  • "telescope_front_padding": 0,
  • "zenith_blind_spot": 180,
  • "instrument_set": [
    ],
  • "__str__": "string"
}

retrieveTelescope

path Parameters
id
required
string

A unique integer value identifying this telescope.

query Parameters
name
string

Telescome name

code
string

Telescope code

lat
string

Telescope latitude in decimal degrees

long
string

Telescope longitude in decimal degrees

horizon
string

Minimum distance from horizion telescope can point without field of view being obscured, in degrees

enclosure
string

Enclosure which contains this telescope

aperture
string

The aperture of this telescope in meters. This is used to group telescopes by aperture class

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "serial_number": "string",
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "aperture": 0,
  • "lat": -90,
  • "slew_rate": 0,
  • "minimum_slew_overhead": 0,
  • "instrument_change_overhead": 0,
  • "long": -180,
  • "enclosure": "string",
  • "horizon": 90,
  • "ha_limit_pos": 12,
  • "ha_limit_neg": -12,
  • "telescope_front_padding": 0,
  • "zenith_blind_spot": 180,
  • "instrument_set": [
    ],
  • "__str__": "string"
}

updateTelescope

path Parameters
id
required
string

A unique integer value identifying this telescope.

query Parameters
name
string

Telescome name

code
string

Telescope code

lat
string

Telescope latitude in decimal degrees

long
string

Telescope longitude in decimal degrees

horizon
string

Minimum distance from horizion telescope can point without field of view being obscured, in degrees

enclosure
string

Enclosure which contains this telescope

aperture
string

The aperture of this telescope in meters. This is used to group telescopes by aperture class

Request Body schema:
serial_number
string <= 50 characters

Unique telescope serial number

name
string <= 200 characters

Telescome name

code
required
string <= 200 characters

Telescope code

active
boolean

Whether the telescope is active and able to accept observations

aperture
number >= 0

The aperture of this telescope in meters. This is used to group telescopes by aperture class

lat
required
number [ -90 .. 90 ]

Telescope latitude in decimal degrees

enclosure_id
required
integer

Model ID number for the enclosure that this telescope belongs to

slew_rate
number >= 0

The rate in sec/arcsec at which the telescope slews between targets within a single observation

minimum_slew_overhead
number >= 0

The minimum amount of time a slew can take in seconds for targets within a single observation

instrument_change_overhead
number >= 0

The maximum amount of time it takes to switch instruments on this telescope

long
required
number [ -180 .. 180 ]

Telescope longitude in decimal degrees

horizon
required
number [ 0 .. 90 ]

Minimum distance from horizion telescope can point without field of view being obscured, in degrees

ha_limit_pos
required
number [ 0 .. 12 ]

Positive hour-angle limit in hours

ha_limit_neg
required
number [ -12 .. 0 ]

Negative hour-angle limit in hours

telescope_front_padding
number >= 0

Setup time for taking on observation on this telescope, applied once per observation. This is for an average of tasks like initial slewing and opening the enclosure.

zenith_blind_spot
number [ 0 .. 180 ]

For AltAz telescopes, radius of zenith blind spot in degrees

Responses

Request samples

Content type
{
  • "serial_number": "string",
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "aperture": 0,
  • "lat": -90,
  • "enclosure_id": 0,
  • "slew_rate": 0,
  • "minimum_slew_overhead": 0,
  • "instrument_change_overhead": 0,
  • "long": -180,
  • "horizon": 90,
  • "ha_limit_pos": 12,
  • "ha_limit_neg": -12,
  • "telescope_front_padding": 0,
  • "zenith_blind_spot": 180
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "serial_number": "string",
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "aperture": 0,
  • "lat": -90,
  • "slew_rate": 0,
  • "minimum_slew_overhead": 0,
  • "instrument_change_overhead": 0,
  • "long": -180,
  • "enclosure": "string",
  • "horizon": 90,
  • "ha_limit_pos": 12,
  • "ha_limit_neg": -12,
  • "telescope_front_padding": 0,
  • "zenith_blind_spot": 180,
  • "instrument_set": [
    ],
  • "__str__": "string"
}

partialUpdateTelescope

path Parameters
id
required
string

A unique integer value identifying this telescope.

query Parameters
name
string

Telescome name

code
string

Telescope code

lat
string

Telescope latitude in decimal degrees

long
string

Telescope longitude in decimal degrees

horizon
string

Minimum distance from horizion telescope can point without field of view being obscured, in degrees

enclosure
string

Enclosure which contains this telescope

aperture
string

The aperture of this telescope in meters. This is used to group telescopes by aperture class

Request Body schema:
serial_number
string <= 50 characters

Unique telescope serial number

name
string <= 200 characters

Telescome name

code
required
string <= 200 characters

Telescope code

active
boolean

Whether the telescope is active and able to accept observations

aperture
number >= 0

The aperture of this telescope in meters. This is used to group telescopes by aperture class

lat
required
number [ -90 .. 90 ]

Telescope latitude in decimal degrees

enclosure_id
required
integer

Model ID number for the enclosure that this telescope belongs to

slew_rate
number >= 0

The rate in sec/arcsec at which the telescope slews between targets within a single observation

minimum_slew_overhead
number >= 0

The minimum amount of time a slew can take in seconds for targets within a single observation

instrument_change_overhead
number >= 0

The maximum amount of time it takes to switch instruments on this telescope

long
required
number [ -180 .. 180 ]

Telescope longitude in decimal degrees

horizon
required
number [ 0 .. 90 ]

Minimum distance from horizion telescope can point without field of view being obscured, in degrees

ha_limit_pos
required
number [ 0 .. 12 ]

Positive hour-angle limit in hours

ha_limit_neg
required
number [ -12 .. 0 ]

Negative hour-angle limit in hours

telescope_front_padding
number >= 0

Setup time for taking on observation on this telescope, applied once per observation. This is for an average of tasks like initial slewing and opening the enclosure.

zenith_blind_spot
number [ 0 .. 180 ]

For AltAz telescopes, radius of zenith blind spot in degrees

Responses

Request samples

Content type
{
  • "serial_number": "string",
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "aperture": 0,
  • "lat": -90,
  • "enclosure_id": 0,
  • "slew_rate": 0,
  • "minimum_slew_overhead": 0,
  • "instrument_change_overhead": 0,
  • "long": -180,
  • "horizon": 90,
  • "ha_limit_pos": 12,
  • "ha_limit_neg": -12,
  • "telescope_front_padding": 0,
  • "zenith_blind_spot": 180
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "serial_number": "string",
  • "name": "string",
  • "code": "string",
  • "active": true,
  • "aperture": 0,
  • "lat": -90,
  • "slew_rate": 0,
  • "minimum_slew_overhead": 0,
  • "instrument_change_overhead": 0,
  • "long": -180,
  • "enclosure": "string",
  • "horizon": 90,
  • "ha_limit_pos": 12,
  • "ha_limit_neg": -12,
  • "telescope_front_padding": 0,
  • "zenith_blind_spot": 180,
  • "instrument_set": [
    ],
  • "__str__": "string"
}

destroyTelescope

path Parameters
id
required
string

A unique integer value identifying this telescope.

query Parameters
name
string

Telescome name

code
string

Telescope code

lat
string

Telescope latitude in decimal degrees

long
string

Telescope longitude in decimal degrees

horizon
string

Minimum distance from horizion telescope can point without field of view being obscured, in degrees

enclosure
string

Enclosure which contains this telescope

aperture
string

The aperture of this telescope in meters. This is used to group telescopes by aperture class

Responses

Instruments

listInstruments

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

telescope
string

Telescope code

science_cameras
string

Science cameras that belong to this instrument

autoguider_camera
string

Autoguider camera for this instrument

instrument_type
string

Instrument type code

camera_type
string

Camera type code

site
string

Site code

enclosure
string

Enclosure code

state
string
Enum: "DISABLED" "MANUAL" "COMMISSIONING" "STANDBY" "SCHEDULABLE"

Instrument state

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

createInstrument

Request Body schema:
code
string <= 200 characters

Instrument code

state
required
string
Enum: "DISABLED" "MANUAL" "COMMISSIONING" "STANDBY" "SCHEDULABLE"

Instrument state

autoguider_camera_id
required
integer

Model ID number for the autoguider camera belonging to this instrument

telescope_id
required
integer

Model ID number for the telescope that this instrument belongs to

science_cameras_ids
required
Array of integers

Model ID numbers for the science cameras belonging to this instrument

instrument_type_id
required
integer

Model ID number for the instrument type of this instrument

Responses

Request samples

Content type
{
  • "code": "string",
  • "state": "DISABLED",
  • "autoguider_camera_id": 0,
  • "telescope_id": 0,
  • "science_cameras_ids": [
    ],
  • "instrument_type_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "state": "DISABLED",
  • "telescope": "string",
  • "autoguider_camera": {
    },
  • "science_cameras": [
    ],
  • "instrument_type": {
    },
  • "__str__": "string"
}

retrieveInstrument

path Parameters
id
required
string

A unique integer value identifying this instrument.

query Parameters
telescope
string

Telescope code

science_cameras
string

Science cameras that belong to this instrument

autoguider_camera
string

Autoguider camera for this instrument

instrument_type
string

Instrument type code

camera_type
string

Camera type code

site
string

Site code

enclosure
string

Enclosure code

state
string
Enum: "DISABLED" "MANUAL" "COMMISSIONING" "STANDBY" "SCHEDULABLE"

Instrument state

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "state": "DISABLED",
  • "telescope": "string",
  • "autoguider_camera": {
    },
  • "science_cameras": [
    ],
  • "instrument_type": {
    },
  • "__str__": "string"
}

updateInstrument

path Parameters
id
required
string

A unique integer value identifying this instrument.

query Parameters
telescope
string

Telescope code

science_cameras
string

Science cameras that belong to this instrument

autoguider_camera
string

Autoguider camera for this instrument

instrument_type
string

Instrument type code

camera_type
string

Camera type code

site
string

Site code

enclosure
string

Enclosure code

state
string
Enum: "DISABLED" "MANUAL" "COMMISSIONING" "STANDBY" "SCHEDULABLE"

Instrument state

ordering
string

Which field to use when ordering the results.

Request Body schema:
code
string <= 200 characters

Instrument code

state
required
string
Enum: "DISABLED" "MANUAL" "COMMISSIONING" "STANDBY" "SCHEDULABLE"

Instrument state

autoguider_camera_id
required
integer

Model ID number for the autoguider camera belonging to this instrument

telescope_id
required
integer

Model ID number for the telescope that this instrument belongs to

science_cameras_ids
required
Array of integers

Model ID numbers for the science cameras belonging to this instrument

instrument_type_id
required
integer

Model ID number for the instrument type of this instrument

Responses

Request samples

Content type
{
  • "code": "string",
  • "state": "DISABLED",
  • "autoguider_camera_id": 0,
  • "telescope_id": 0,
  • "science_cameras_ids": [
    ],
  • "instrument_type_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "state": "DISABLED",
  • "telescope": "string",
  • "autoguider_camera": {
    },
  • "science_cameras": [
    ],
  • "instrument_type": {
    },
  • "__str__": "string"
}

partialUpdateInstrument

path Parameters
id
required
string

A unique integer value identifying this instrument.

query Parameters
telescope
string

Telescope code

science_cameras
string

Science cameras that belong to this instrument

autoguider_camera
string

Autoguider camera for this instrument

instrument_type
string

Instrument type code

camera_type
string

Camera type code

site
string

Site code

enclosure
string

Enclosure code

state
string
Enum: "DISABLED" "MANUAL" "COMMISSIONING" "STANDBY" "SCHEDULABLE"

Instrument state

ordering
string

Which field to use when ordering the results.

Request Body schema:
code
string <= 200 characters

Instrument code

state
required
string
Enum: "DISABLED" "MANUAL" "COMMISSIONING" "STANDBY" "SCHEDULABLE"

Instrument state

autoguider_camera_id
required
integer

Model ID number for the autoguider camera belonging to this instrument

telescope_id
required
integer

Model ID number for the telescope that this instrument belongs to

science_cameras_ids
required
Array of integers

Model ID numbers for the science cameras belonging to this instrument

instrument_type_id
required
integer

Model ID number for the instrument type of this instrument

Responses

Request samples

Content type
{
  • "code": "string",
  • "state": "DISABLED",
  • "autoguider_camera_id": 0,
  • "telescope_id": 0,
  • "science_cameras_ids": [
    ],
  • "instrument_type_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "state": "DISABLED",
  • "telescope": "string",
  • "autoguider_camera": {
    },
  • "science_cameras": [
    ],
  • "instrument_type": {
    },
  • "__str__": "string"
}

destroyInstrument

path Parameters
id
required
string

A unique integer value identifying this instrument.

query Parameters
telescope
string

Telescope code

science_cameras
string

Science cameras that belong to this instrument

autoguider_camera
string

Autoguider camera for this instrument

instrument_type
string

Instrument type code

camera_type
string

Camera type code

site
string

Site code

enclosure
string

Enclosure code

state
string
Enum: "DISABLED" "MANUAL" "COMMISSIONING" "STANDBY" "SCHEDULABLE"

Instrument state

ordering
string

Which field to use when ordering the results.

Responses

Cameras

listCameras

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

code
string

Camera code

camera_type
string

Camera type

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

createCamera

Request Body schema:
code
required
string <= 200 characters

Camera code

camera_type_id
required
integer

Model ID number that corresponds to this camera's type

orientation
number [ 0 .. 360 ]

The orientation of the Cameras ccd in degrees measured counterclockwise from North (y-axis)

host
string <= 200 characters

The physical machine hostname that this camera is connected to

Responses

Request samples

Content type
{
  • "code": "string",
  • "camera_type_id": 0,
  • "orientation": 360,
  • "host": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "camera_type": {
    },
  • "orientation": 360,
  • "optical_elements": "string",
  • "optical_element_groups": [
    ],
  • "host": "string"
}

retrieveCamera

path Parameters
id
required
string

A unique integer value identifying this camera.

query Parameters
code
string

Camera code

camera_type
string

Camera type

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "camera_type": {
    },
  • "orientation": 360,
  • "optical_elements": "string",
  • "optical_element_groups": [
    ],
  • "host": "string"
}

updateCamera

path Parameters
id
required
string

A unique integer value identifying this camera.

query Parameters
code
string

Camera code

camera_type
string

Camera type

Request Body schema:
code
required
string <= 200 characters

Camera code

camera_type_id
required
integer

Model ID number that corresponds to this camera's type

orientation
number [ 0 .. 360 ]

The orientation of the Cameras ccd in degrees measured counterclockwise from North (y-axis)

host
string <= 200 characters

The physical machine hostname that this camera is connected to

Responses

Request samples

Content type
{
  • "code": "string",
  • "camera_type_id": 0,
  • "orientation": 360,
  • "host": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "camera_type": {
    },
  • "orientation": 360,
  • "optical_elements": "string",
  • "optical_element_groups": [
    ],
  • "host": "string"
}

partialUpdateCamera

path Parameters
id
required
string

A unique integer value identifying this camera.

query Parameters
code
string

Camera code

camera_type
string

Camera type

Request Body schema:
code
required
string <= 200 characters

Camera code

camera_type_id
required
integer

Model ID number that corresponds to this camera's type

orientation
number [ 0 .. 360 ]

The orientation of the Cameras ccd in degrees measured counterclockwise from North (y-axis)

host
string <= 200 characters

The physical machine hostname that this camera is connected to

Responses

Request samples

Content type
{
  • "code": "string",
  • "camera_type_id": 0,
  • "orientation": 360,
  • "host": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "camera_type": {
    },
  • "orientation": 360,
  • "optical_elements": "string",
  • "optical_element_groups": [
    ],
  • "host": "string"
}

destroyCamera

path Parameters
id
required
string

A unique integer value identifying this camera.

query Parameters
code
string

Camera code

camera_type
string

Camera type

Responses

Camera Types

listCameraTypes

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

name
string

Camera type name

pscale
string

Pixel scale in arcseconds/pixel

Responses

Response samples

Content type
application/json
{}

createCameraType

Request Body schema:
size
required
string <= 200 characters

Field of view in arcminutes

pscale
required
number >= 0

Pixel scale in arcseconds/pixel

name
required
string <= 200 characters

Camera type name

code
required
string <= 200 characters

Camera type code

pixels_x
integer [ 0 .. 2147483647 ]

Number of pixels on x-axis

pixels_y
integer [ 0 .. 2147483647 ]

Number of pixels on y-axis

max_rois
integer [ 0 .. 2147483647 ]

Maximum regions of interest that this camera type supports

Responses

Request samples

Content type
{
  • "size": "string",
  • "pscale": 0,
  • "name": "string",
  • "code": "string",
  • "pixels_x": 2147483647,
  • "pixels_y": 2147483647,
  • "max_rois": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "size": "string",
  • "pscale": 0,
  • "name": "string",
  • "code": "string",
  • "pixels_x": 2147483647,
  • "pixels_y": 2147483647,
  • "max_rois": 2147483647
}

retrieveCameraType

path Parameters
id
required
string

A unique integer value identifying this camera type.

query Parameters
name
string

Camera type name

pscale
string

Pixel scale in arcseconds/pixel

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "size": "string",
  • "pscale": 0,
  • "name": "string",
  • "code": "string",
  • "pixels_x": 2147483647,
  • "pixels_y": 2147483647,
  • "max_rois": 2147483647
}

updateCameraType

path Parameters
id
required
string

A unique integer value identifying this camera type.

query Parameters
name
string

Camera type name

pscale
string

Pixel scale in arcseconds/pixel

Request Body schema:
size
required
string <= 200 characters

Field of view in arcminutes

pscale
required
number >= 0

Pixel scale in arcseconds/pixel

name
required
string <= 200 characters

Camera type name

code
required
string <= 200 characters

Camera type code

pixels_x
integer [ 0 .. 2147483647 ]

Number of pixels on x-axis

pixels_y
integer [ 0 .. 2147483647 ]

Number of pixels on y-axis

max_rois
integer [ 0 .. 2147483647 ]

Maximum regions of interest that this camera type supports

Responses

Request samples

Content type
{
  • "size": "string",
  • "pscale": 0,
  • "name": "string",
  • "code": "string",
  • "pixels_x": 2147483647,
  • "pixels_y": 2147483647,
  • "max_rois": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "size": "string",
  • "pscale": 0,
  • "name": "string",
  • "code": "string",
  • "pixels_x": 2147483647,
  • "pixels_y": 2147483647,
  • "max_rois": 2147483647
}

partialUpdateCameraType

path Parameters
id
required
string

A unique integer value identifying this camera type.

query Parameters
name
string

Camera type name

pscale
string

Pixel scale in arcseconds/pixel

Request Body schema:
size
required
string <= 200 characters

Field of view in arcminutes

pscale
required
number >= 0

Pixel scale in arcseconds/pixel

name
required
string <= 200 characters

Camera type name

code
required
string <= 200 characters

Camera type code

pixels_x
integer [ 0 .. 2147483647 ]

Number of pixels on x-axis

pixels_y
integer [ 0 .. 2147483647 ]

Number of pixels on y-axis

max_rois
integer [ 0 .. 2147483647 ]

Maximum regions of interest that this camera type supports

Responses

Request samples

Content type
{
  • "size": "string",
  • "pscale": 0,
  • "name": "string",
  • "code": "string",
  • "pixels_x": 2147483647,
  • "pixels_y": 2147483647,
  • "max_rois": 2147483647
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "size": "string",
  • "pscale": 0,
  • "name": "string",
  • "code": "string",
  • "pixels_x": 2147483647,
  • "pixels_y": 2147483647,
  • "max_rois": 2147483647
}

destroyCameraType

path Parameters
id
required
string

A unique integer value identifying this camera type.

query Parameters
name
string

Camera type name

pscale
string

Pixel scale in arcseconds/pixel

Responses

Instrument Types

listInstrumentTypes

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

name
string

Instrument type name

code
string

Instrument type code

instrument_category
string

The category of this instrument type, like IMAGE or SPECTRO.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

createInstrumentType

Request Body schema:
name
required
string <= 200 characters

Instrument type name

code
required
string <= 200 characters

Instrument type code

fixed_overhead_per_exposure
number >= 0

A per exposure overhead to be applied. This accounts for any per exposure setup or delays found in the camera or instrument control software.

instrument_category
string or null

The category of this instrument type, like IMAGE or SPECTRO.

observation_front_padding
number >= 0

Setup time for taking on observation on this instrument, applied once per observation. This is for tasks like initial slewing and instrument configuration.

acquire_exposure_time
number >= 0

The default exposure time to use for acquisition exposures with this instrument type.

default_configuration_type
string or null

The default configuration type shown on the frontend or used if none is specified for this instrument type.

Array of objects

Set of generic modes that this instrument type supports

default_acceptability_threshold
number [ 0 .. 100 ]

The default acceptability threshold to use for Requests submitted on this instrument type. Acceptability threshold is the minimum percentage of data an Observation must take before causing its Request to be counted as complete.

config_front_padding
number >= 0

Setup time for each configuration of an observation on this instrument. This is for things like configuration specific setup time.

allow_self_guiding
boolean

Whether to allow instruments of this type to be used for self-guiding

validation_schema
object

Cerberus styled validation schema used to validate instrument configs using this instrument type

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "fixed_overhead_per_exposure": 0,
  • "instrument_category": "string",
  • "observation_front_padding": 0,
  • "acquire_exposure_time": 0,
  • "default_configuration_type": "string",
  • "mode_types": [
    ],
  • "default_acceptability_threshold": 100,
  • "config_front_padding": 0,
  • "allow_self_guiding": true,
  • "validation_schema": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "fixed_overhead_per_exposure": 0,
  • "instrument_category": "string",
  • "observation_front_padding": 0,
  • "acquire_exposure_time": 0,
  • "default_configuration_type": "string",
  • "mode_types": [
    ],
  • "default_acceptability_threshold": 100,
  • "config_front_padding": 0,
  • "allow_self_guiding": true,
  • "configuration_types": [
    ],
  • "validation_schema": { }
}

retrieveInstrumentType

path Parameters
id
required
string

A unique integer value identifying this instrument type.

query Parameters
name
string

Instrument type name

code
string

Instrument type code

instrument_category
string

The category of this instrument type, like IMAGE or SPECTRO.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "fixed_overhead_per_exposure": 0,
  • "instrument_category": "string",
  • "observation_front_padding": 0,
  • "acquire_exposure_time": 0,
  • "default_configuration_type": "string",
  • "mode_types": [
    ],
  • "default_acceptability_threshold": 100,
  • "config_front_padding": 0,
  • "allow_self_guiding": true,
  • "configuration_types": [
    ],
  • "validation_schema": { }
}

updateInstrumentType

path Parameters
id
required
string

A unique integer value identifying this instrument type.

query Parameters
name
string

Instrument type name

code
string

Instrument type code

instrument_category
string

The category of this instrument type, like IMAGE or SPECTRO.

Request Body schema:
name
required
string <= 200 characters

Instrument type name

code
required
string <= 200 characters

Instrument type code

fixed_overhead_per_exposure
number >= 0

A per exposure overhead to be applied. This accounts for any per exposure setup or delays found in the camera or instrument control software.

instrument_category
string or null

The category of this instrument type, like IMAGE or SPECTRO.

observation_front_padding
number >= 0

Setup time for taking on observation on this instrument, applied once per observation. This is for tasks like initial slewing and instrument configuration.

acquire_exposure_time
number >= 0

The default exposure time to use for acquisition exposures with this instrument type.

default_configuration_type
string or null

The default configuration type shown on the frontend or used if none is specified for this instrument type.

Array of objects

Set of generic modes that this instrument type supports

default_acceptability_threshold
number [ 0 .. 100 ]

The default acceptability threshold to use for Requests submitted on this instrument type. Acceptability threshold is the minimum percentage of data an Observation must take before causing its Request to be counted as complete.

config_front_padding
number >= 0

Setup time for each configuration of an observation on this instrument. This is for things like configuration specific setup time.

allow_self_guiding
boolean

Whether to allow instruments of this type to be used for self-guiding

validation_schema
object

Cerberus styled validation schema used to validate instrument configs using this instrument type

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "fixed_overhead_per_exposure": 0,
  • "instrument_category": "string",
  • "observation_front_padding": 0,
  • "acquire_exposure_time": 0,
  • "default_configuration_type": "string",
  • "mode_types": [
    ],
  • "default_acceptability_threshold": 100,
  • "config_front_padding": 0,
  • "allow_self_guiding": true,
  • "validation_schema": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "fixed_overhead_per_exposure": 0,
  • "instrument_category": "string",
  • "observation_front_padding": 0,
  • "acquire_exposure_time": 0,
  • "default_configuration_type": "string",
  • "mode_types": [
    ],
  • "default_acceptability_threshold": 100,
  • "config_front_padding": 0,
  • "allow_self_guiding": true,
  • "configuration_types": [
    ],
  • "validation_schema": { }
}

partialUpdateInstrumentType

path Parameters
id
required
string

A unique integer value identifying this instrument type.

query Parameters
name
string

Instrument type name

code
string

Instrument type code

instrument_category
string

The category of this instrument type, like IMAGE or SPECTRO.

Request Body schema:
name
required
string <= 200 characters

Instrument type name

code
required
string <= 200 characters

Instrument type code

fixed_overhead_per_exposure
number >= 0

A per exposure overhead to be applied. This accounts for any per exposure setup or delays found in the camera or instrument control software.

instrument_category
string or null

The category of this instrument type, like IMAGE or SPECTRO.

observation_front_padding
number >= 0

Setup time for taking on observation on this instrument, applied once per observation. This is for tasks like initial slewing and instrument configuration.

acquire_exposure_time
number >= 0

The default exposure time to use for acquisition exposures with this instrument type.

default_configuration_type
string or null

The default configuration type shown on the frontend or used if none is specified for this instrument type.

Array of objects

Set of generic modes that this instrument type supports

default_acceptability_threshold
number [ 0 .. 100 ]

The default acceptability threshold to use for Requests submitted on this instrument type. Acceptability threshold is the minimum percentage of data an Observation must take before causing its Request to be counted as complete.

config_front_padding
number >= 0

Setup time for each configuration of an observation on this instrument. This is for things like configuration specific setup time.

allow_self_guiding
boolean

Whether to allow instruments of this type to be used for self-guiding

validation_schema
object

Cerberus styled validation schema used to validate instrument configs using this instrument type

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "fixed_overhead_per_exposure": 0,
  • "instrument_category": "string",
  • "observation_front_padding": 0,
  • "acquire_exposure_time": 0,
  • "default_configuration_type": "string",
  • "mode_types": [
    ],
  • "default_acceptability_threshold": 100,
  • "config_front_padding": 0,
  • "allow_self_guiding": true,
  • "validation_schema": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "fixed_overhead_per_exposure": 0,
  • "instrument_category": "string",
  • "observation_front_padding": 0,
  • "acquire_exposure_time": 0,
  • "default_configuration_type": "string",
  • "mode_types": [
    ],
  • "default_acceptability_threshold": 100,
  • "config_front_padding": 0,
  • "allow_self_guiding": true,
  • "configuration_types": [
    ],
  • "validation_schema": { }
}

destroyInstrumentType

path Parameters
id
required
string

A unique integer value identifying this instrument type.

query Parameters
name
string

Instrument type name

code
string

Instrument type code

instrument_category
string

The category of this instrument type, like IMAGE or SPECTRO.

Responses

Optical Element Groups

listOpticalElementGroups

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

name
string

Optical element group name

type
string

Optical element group type

optical_elements
string

Optical elements belonging to this optical element group

Responses

Response samples

Content type
application/json
{}

createOpticalElementGroup

Request Body schema:
name
required
string <= 200 characters

Optical element group name

type
required
string <= 200 characters

Optical element group type

required
Array of objects

Optical elements belonging to this optical element group

element_change_overhead
number >= 0

Overhead in seconds when changing between optical elements within this optical element group

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "string",
  • "optical_elements": [
    ],
  • "element_change_overhead": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "optical_elements": [
    ],
  • "element_change_overhead": 0,
  • "default": "string"
}

retrieveOpticalElementGroup

path Parameters
id
required
string

A unique integer value identifying this optical element group.

query Parameters
name
string

Optical element group name

type
string

Optical element group type

optical_elements
string

Optical elements belonging to this optical element group

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "optical_elements": [
    ],
  • "element_change_overhead": 0,
  • "default": "string"
}

updateOpticalElementGroup

path Parameters
id
required
string

A unique integer value identifying this optical element group.

query Parameters
name
string

Optical element group name

type
string

Optical element group type

optical_elements
string

Optical elements belonging to this optical element group

Request Body schema:
name
required
string <= 200 characters

Optical element group name

type
required
string <= 200 characters

Optical element group type

required
Array of objects

Optical elements belonging to this optical element group

element_change_overhead
number >= 0

Overhead in seconds when changing between optical elements within this optical element group

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "string",
  • "optical_elements": [
    ],
  • "element_change_overhead": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "optical_elements": [
    ],
  • "element_change_overhead": 0,
  • "default": "string"
}

partialUpdateOpticalElementGroup

path Parameters
id
required
string

A unique integer value identifying this optical element group.

query Parameters
name
string

Optical element group name

type
string

Optical element group type

optical_elements
string

Optical elements belonging to this optical element group

Request Body schema:
name
required
string <= 200 characters

Optical element group name

type
required
string <= 200 characters

Optical element group type

required
Array of objects

Optical elements belonging to this optical element group

element_change_overhead
number >= 0

Overhead in seconds when changing between optical elements within this optical element group

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "string",
  • "optical_elements": [
    ],
  • "element_change_overhead": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "optical_elements": [
    ],
  • "element_change_overhead": 0,
  • "default": "string"
}

destroyOpticalElementGroup

path Parameters
id
required
string

A unique integer value identifying this optical element group.

query Parameters
name
string

Optical element group name

type
string

Optical element group type

optical_elements
string

Optical elements belonging to this optical element group

Responses

Optical Elements

listOpticalElements

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

id
string
name
string

Optical element name

code
string

Optical element code

schedulable
string

Whether this optical element should be usable by scheduled observations, or only via direct submission.

Responses

Response samples

Content type
application/json
{}

createOpticalElement

Request Body schema:
name
required
string <= 200 characters

Optical element name

code
required
string <= 200 characters

Optical element code

schedulable
boolean

Whether this optical element should be usable by scheduled observations, or only via direct submission.

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "schedulable": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "schedulable": true
}

retrieveOpticalElement

path Parameters
id
required
string

A unique integer value identifying this optical element.

query Parameters
id
string
name
string

Optical element name

code
string

Optical element code

schedulable
string

Whether this optical element should be usable by scheduled observations, or only via direct submission.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "schedulable": true
}

updateOpticalElement

path Parameters
id
required
string

A unique integer value identifying this optical element.

query Parameters
id
string
name
string

Optical element name

code
string

Optical element code

schedulable
string

Whether this optical element should be usable by scheduled observations, or only via direct submission.

Request Body schema:
name
required
string <= 200 characters

Optical element name

code
required
string <= 200 characters

Optical element code

schedulable
boolean

Whether this optical element should be usable by scheduled observations, or only via direct submission.

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "schedulable": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "schedulable": true
}

partialUpdateOpticalElement

path Parameters
id
required
string

A unique integer value identifying this optical element.

query Parameters
id
string
name
string

Optical element name

code
string

Optical element code

schedulable
string

Whether this optical element should be usable by scheduled observations, or only via direct submission.

Request Body schema:
name
required
string <= 200 characters

Optical element name

code
required
string <= 200 characters

Optical element code

schedulable
boolean

Whether this optical element should be usable by scheduled observations, or only via direct submission.

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "schedulable": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "schedulable": true
}

destroyOpticalElement

path Parameters
id
required
string

A unique integer value identifying this optical element.

query Parameters
id
string
name
string

Optical element name

code
string

Optical element code

schedulable
string

Whether this optical element should be usable by scheduled observations, or only via direct submission.

Responses

Generic Mode Groups

listGenericModeGroups

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{}

createGenericModeGroup

Request Body schema:
type
string or null

Generic mode group type

required
Array of objects

Set of modes belonging to this generic mode group

Responses

Request samples

Content type
{
  • "type": "string",
  • "modes": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "modes": [
    ],
  • "default": "string"
}

retrieveGenericModeGroup

path Parameters
id
required
string

A unique integer value identifying this generic mode group.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "modes": [
    ],
  • "default": "string"
}

updateGenericModeGroup

path Parameters
id
required
string

A unique integer value identifying this generic mode group.

Request Body schema:
type
string or null

Generic mode group type

required
Array of objects

Set of modes belonging to this generic mode group

Responses

Request samples

Content type
{
  • "type": "string",
  • "modes": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "modes": [
    ],
  • "default": "string"
}

partialUpdateGenericModeGroup

path Parameters
id
required
string

A unique integer value identifying this generic mode group.

Request Body schema:
type
string or null

Generic mode group type

required
Array of objects

Set of modes belonging to this generic mode group

Responses

Request samples

Content type
{
  • "type": "string",
  • "modes": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "modes": [
    ],
  • "default": "string"
}

destroyGenericModeGroup

path Parameters
id
required
string

A unique integer value identifying this generic mode group.

Responses

Generic Modes

listGenericModes

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

name
string

Generic mode name

code
string

Generic mode code

schedulable
string

Whether this mode should be usable by scheduled observations, or only via direct submission.

Responses

Response samples

Content type
application/json
{}

createGenericMode

Request Body schema:
name
required
string <= 200 characters

Generic mode name

overhead
required
number >= 0

Overhead associated with the generic mode. Where this overhead is applied depends on what type of generic mode this is for. For example, a readout mode is applied per exposure, while an acquisition overhead is applied for the acquisition step at the beginning of an observation.

code
required
string <= 200 characters

Generic mode code

schedulable
boolean

Whether this mode should be usable by scheduled observations, or only via direct submission.

validation_schema
required
object

Cerberus styled validation schema used to validate instrument configs using this generic mode

Responses

Request samples

Content type
{
  • "name": "string",
  • "overhead": 0,
  • "code": "string",
  • "schedulable": true,
  • "validation_schema": { }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "overhead": 0,
  • "code": "string",
  • "schedulable": true,
  • "validation_schema": { }
}

retrieveGenericMode

path Parameters
id
required
string

A unique integer value identifying this generic mode.

query Parameters
name
string

Generic mode name

code
string

Generic mode code

schedulable
string

Whether this mode should be usable by scheduled observations, or only via direct submission.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "overhead": 0,
  • "code": "string",
  • "schedulable": true,
  • "validation_schema": { }
}

updateGenericMode

path Parameters
id
required
string

A unique integer value identifying this generic mode.

query Parameters
name
string

Generic mode name

code
string

Generic mode code

schedulable
string

Whether this mode should be usable by scheduled observations, or only via direct submission.

Request Body schema:
name
required
string <= 200 characters

Generic mode name

overhead
required
number >= 0

Overhead associated with the generic mode. Where this overhead is applied depends on what type of generic mode this is for. For example, a readout mode is applied per exposure, while an acquisition overhead is applied for the acquisition step at the beginning of an observation.

code
required
string <= 200 characters

Generic mode code

schedulable
boolean

Whether this mode should be usable by scheduled observations, or only via direct submission.

validation_schema
required
object

Cerberus styled validation schema used to validate instrument configs using this generic mode

Responses

Request samples

Content type
{
  • "name": "string",
  • "overhead": 0,
  • "code": "string",
  • "schedulable": true,
  • "validation_schema": { }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "overhead": 0,
  • "code": "string",
  • "schedulable": true,
  • "validation_schema": { }
}

partialUpdateGenericMode

path Parameters
id
required
string

A unique integer value identifying this generic mode.

query Parameters
name
string

Generic mode name

code
string

Generic mode code

schedulable
string

Whether this mode should be usable by scheduled observations, or only via direct submission.

Request Body schema:
name
required
string <= 200 characters

Generic mode name

overhead
required
number >= 0

Overhead associated with the generic mode. Where this overhead is applied depends on what type of generic mode this is for. For example, a readout mode is applied per exposure, while an acquisition overhead is applied for the acquisition step at the beginning of an observation.

code
required
string <= 200 characters

Generic mode code

schedulable
boolean

Whether this mode should be usable by scheduled observations, or only via direct submission.

validation_schema
required
object

Cerberus styled validation schema used to validate instrument configs using this generic mode

Responses

Request samples

Content type
{
  • "name": "string",
  • "overhead": 0,
  • "code": "string",
  • "schedulable": true,
  • "validation_schema": { }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "overhead": 0,
  • "code": "string",
  • "schedulable": true,
  • "validation_schema": { }
}

destroyGenericMode

path Parameters
id
required
string

A unique integer value identifying this generic mode.

query Parameters
name
string

Generic mode name

code
string

Generic mode code

schedulable
string

Whether this mode should be usable by scheduled observations, or only via direct submission.

Responses

authprofile

createAddUpdateUser

This view is meant to be called by the Oauth Server when a new user account is created. This will create the corresponding user account within this Oauth client app and give it the same api-token, so the user can access this application with their api-token without needing to initially login with their password. This should also be called on token change or on any user info change.

Request Body schema:
any

Responses

Request samples

Content type
null

Response samples

Content type
application/json
null