API docs by Redocly

Observation Portal (4.8.4)

Download OpenAPI specification:Download

Requests

listRequests

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

state
string
Enum: "PENDING" "COMPLETED" "WINDOW_EXPIRED" "FAILURE_LIMIT_REACHED" "CANCELED"

state

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": [
    ]
}

retrieveRequest

path Parameters
id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

state
string
Enum: "PENDING" "COMPLETED" "WINDOW_EXPIRED" "FAILURE_LIMIT_REACHED" "CANCELED"

state

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "location": {
    },
  • "configurations": [
    ],
  • "windows": [
    ],
  • "duration": "string",
  • "observation_note": "string",
  • "optimization_type": "TIME",
  • "state": "PENDING",
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "acceptability_threshold": 100,
  • "configuration_repeats": 1,
  • "extra_params": { }
}

airmassForRequest

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "airmass_data": {
    },
  • "airmass_limit": 2
}

observationsForRequest

path Parameters
id
required
string
query Parameters
exclude_canceled
boolean
Default: false

Exclude canceled observations

Responses

Response samples

Content type
application/json
[
  • {
    }
]

expandMosaic

Request Body schema:
pattern
required
string
Enum: "line" "grid"
num_points
integer
point_spacing
number
line_spacing
number
orientation
number
Default: 0
num_rows
integer
num_columns
integer
center
boolean
Default: false
required
object
point_overlap_percent
number [ 0 .. 100 ]
line_overlap_percent
number [ 0 .. 100 ]

Responses

Request samples

Content type
{
  • "pattern": "line",
  • "num_points": 0,
  • "point_spacing": 0,
  • "line_spacing": 0,
  • "orientation": 0,
  • "num_rows": 0,
  • "num_columns": 0,
  • "center": false,
  • "request": {
    },
  • "point_overlap_percent": 100,
  • "line_overlap_percent": 100
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "location": {
    },
  • "configurations": [
    ],
  • "windows": [
    ],
  • "duration": "string",
  • "observation_note": "string",
  • "optimization_type": "TIME",
  • "state": "PENDING",
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "acceptability_threshold": 100,
  • "configuration_repeats": 1,
  • "extra_params": { }
}

getAirmass

Gets the airmasses for the request at available sites

Request Body schema:
required
object
required
Array of objects
required
Array of objects
object
observation_note
string <= 255 characters

Text describing this Request

optimization_type
string
Enum: "TIME" "AIRMASS"

Optimization emphasis, either TIME for as soon as possible, or AIRMASS for best airmass

acceptability_threshold
number [ 0 .. 100 ]

The percentage of this Request that must be completed to mark it as complete and avert rescheduling. The percentage should be set to the lowest value for which the amount of data is acceptable to meet the science goal of the Request. Defaults to 100 for FLOYDS observations and 90 for all other observations.

configuration_repeats
integer [ 1 .. 2147483647 ]

The number of times to repeat the set of Configurations in this Request. This is normally used to nod between two or more separate Targets. This field must be set to a value greater than 0.

extra_params
object

Extra Request parameters

Responses

Request samples

Content type
{
  • "location": {
    },
  • "configurations": [
    ],
  • "windows": [
    ],
  • "cadence": {
    },
  • "observation_note": "string",
  • "optimization_type": "TIME",
  • "acceptability_threshold": 100,
  • "configuration_repeats": 1,
  • "extra_params": { }
}

Response samples

Content type
application/json
{
  • "airmass_data": {
    },
  • "airmass_limit": 3.19
}

RequestGroups

listRequestGroups

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

id
string

id

submitter
string

submitter

proposal
string

proposal

name
string

Name contains

observation_type
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

observation_type

operator
string
Enum: "SINGLE" "MANY"

operator

ipp_value
string

ipp_value

exclude_state
string
Enum: "PENDING" "COMPLETED" "WINDOW_EXPIRED" "FAILURE_LIMIT_REACHED" "CANCELED"

Exclude State

state
string
Enum: "PENDING" "COMPLETED" "WINDOW_EXPIRED" "FAILURE_LIMIT_REACHED" "CANCELED"

state

created_after
string

Submitted after

created_before
string

Submitted before

user
string

Username contains

modified_after
string

Modified After

modified_before
string

Modified Before

request_id
string

request_id

telescope_class
string
Enum: "2m0" "1m0"

telescope_class

target
string

Target name contains

order
string
Enum: "name" "-name" "modified" "-modified" "created" "-created" "end" "-end"

RequestGroup ordering

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": [
    ]
}

createRequestGroup

Request Body schema:
required
Array of objects
submitter_id
string
name
required
string <= 50 characters

Descriptive name for this RequestGroup. This string will be placed in the FITS header as the GROUPID keyword value for all FITS frames originating from this RequestGroup.

observation_type
required
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

The type of observations under this RequestGroup. Requests submitted with RAPID_RESPONSE bypass normal scheduling and are executed immediately. Requests submitted with TIME_CRITICAL are scheduled normally but with a high priority. These modes are only available if the Proposal was granted special time. More information is located here.

operator
required
string
Enum: "SINGLE" "MANY"

Operator that describes how child Requests are scheduled. Use SINGLE if you have only one Request and MANY if you have more than one.

ipp_value
required
number >= 0

A multiplier to the base priority of the Proposal for this RequestGroup and all child Requests. A value > 1.0 will raise the priority and debit the Proposal ipp_time_available upon submission. If a Request does not complete, the time debited for that Request is returned. A value < 1.0 will lower the priority and credit the ipp_time_available of the Proposal up to the ipp_limit on the successful completion of a Request. The value is generally set to 1.05. More information can be found here.

proposal
required
string

The Proposal under which the observations for this RequestGroup are made

Responses

Request samples

Content type
{
  • "requests": [
    ],
  • "submitter_id": "string",
  • "name": "string",
  • "observation_type": "NORMAL",
  • "operator": "SINGLE",
  • "ipp_value": 0,
  • "proposal": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "requests": [
    ],
  • "submitter": "string",
  • "name": "string",
  • "observation_type": "NORMAL",
  • "operator": "SINGLE",
  • "ipp_value": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "state": "PENDING",
  • "modified": "2019-08-24T14:15:22Z",
  • "proposal": "string"
}

listSchedulableRequests

Gets the set of schedulable User requests for the scheduler. Needs a start and end time specified as the range of time to get requests in. Usually this is the entire semester for a scheduling run.

Responses

Response samples

Content type
application/json
{
  • "results": {
    }
}

retrieveRequestGroup

path Parameters
id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

id
string

id

submitter
string

submitter

proposal
string

proposal

name
string

Name contains

observation_type
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

observation_type

operator
string
Enum: "SINGLE" "MANY"

operator

ipp_value
string

ipp_value

exclude_state
string
Enum: "PENDING" "COMPLETED" "WINDOW_EXPIRED" "FAILURE_LIMIT_REACHED" "CANCELED"

Exclude State

state
string
Enum: "PENDING" "COMPLETED" "WINDOW_EXPIRED" "FAILURE_LIMIT_REACHED" "CANCELED"

state

created_after
string

Submitted after

created_before
string

Submitted before

user
string

Username contains

modified_after
string

Modified After

modified_before
string

Modified Before

request_id
string

request_id

telescope_class
string
Enum: "2m0" "1m0"

telescope_class

target
string

Target name contains

order
string
Enum: "name" "-name" "modified" "-modified" "created" "-created" "end" "-end"

RequestGroup ordering

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "requests": [
    ],
  • "submitter": "string",
  • "name": "string",
  • "observation_type": "NORMAL",
  • "operator": "SINGLE",
  • "ipp_value": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "state": "PENDING",
  • "modified": "2019-08-24T14:15:22Z",
  • "proposal": "string"
}

listDraftRequestGroups

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
{}

createDraftRequestGroup

Request Body schema:
title
required
string <= 50 characters
content
required
string
proposal
required
string

Responses

Request samples

Content type
{
  • "title": "string",
  • "content": "string",
  • "proposal": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "author": "string",
  • "title": "string",
  • "content": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "proposal": "string"
}

retrieveDraftRequestGroup

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "author": "string",
  • "title": "string",
  • "content": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "proposal": "string"
}

updateDraftRequestGroup

path Parameters
id
required
string
Request Body schema:
title
required
string <= 50 characters
content
required
string
proposal
required
string

Responses

Request samples

Content type
{
  • "title": "string",
  • "content": "string",
  • "proposal": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "author": "string",
  • "title": "string",
  • "content": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "proposal": "string"
}

partialUpdateDraftRequestGroup

path Parameters
id
required
string
Request Body schema:
title
required
string <= 50 characters
content
required
string
proposal
required
string

Responses

Request samples

Content type
{
  • "title": "string",
  • "content": "string",
  • "proposal": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "author": "string",
  • "title": "string",
  • "content": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "proposal": "string"
}

destroyDraftRequestGroup

path Parameters
id
required
string

Responses

getLastChangedTime

Returns the datetime of the last status of requests change or new requests addition

query Parameters
telescope_class
string
Enum: "2m0" "1m0"

telescope_class

Responses

Response samples

Content type
application/json
{
  • "last_change_time": "2019-08-24T14:15:22Z"
}

generateCadence

Given a well-formed RequestGroup containing a single Request, return a new RequestGroup containing many requests generated by the cadence function.

Request Body schema:
required
Array of objects
submitter_id
string
name
required
string <= 50 characters

Descriptive name for this RequestGroup. This string will be placed in the FITS header as the GROUPID keyword value for all FITS frames originating from this RequestGroup.

observation_type
required
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

The type of observations under this RequestGroup. Requests submitted with RAPID_RESPONSE bypass normal scheduling and are executed immediately. Requests submitted with TIME_CRITICAL are scheduled normally but with a high priority. These modes are only available if the Proposal was granted special time. More information is located here.

operator
required
string
Enum: "SINGLE" "MANY"

Operator that describes how child Requests are scheduled. Use SINGLE if you have only one Request and MANY if you have more than one.

ipp_value
required
number >= 0

A multiplier to the base priority of the Proposal for this RequestGroup and all child Requests. A value > 1.0 will raise the priority and debit the Proposal ipp_time_available upon submission. If a Request does not complete, the time debited for that Request is returned. A value < 1.0 will lower the priority and credit the ipp_time_available of the Proposal up to the ipp_limit on the successful completion of a Request. The value is generally set to 1.05. More information can be found here.

proposal
required
string

The Proposal under which the observations for this RequestGroup are made

Responses

Request samples

Content type
{
  • "requests": [
    ],
  • "submitter_id": "string",
  • "name": "string",
  • "observation_type": "NORMAL",
  • "operator": "SINGLE",
  • "ipp_value": 0,
  • "proposal": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "requests": [
    ],
  • "submitter": "string",
  • "name": "string",
  • "observation_type": "NORMAL",
  • "operator": "SINGLE",
  • "ipp_value": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "state": "PENDING",
  • "modified": "2019-08-24T14:15:22Z",
  • "proposal": "string"
}

getMaxAllowableIPP

Get the maximum allowable IPP for a RequestGroup

Request Body schema:
required
Array of objects
submitter_id
string
name
required
string <= 50 characters

Descriptive name for this RequestGroup. This string will be placed in the FITS header as the GROUPID keyword value for all FITS frames originating from this RequestGroup.

observation_type
required
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

The type of observations under this RequestGroup. Requests submitted with RAPID_RESPONSE bypass normal scheduling and are executed immediately. Requests submitted with TIME_CRITICAL are scheduled normally but with a high priority. These modes are only available if the Proposal was granted special time. More information is located here.

operator
required
string
Enum: "SINGLE" "MANY"

Operator that describes how child Requests are scheduled. Use SINGLE if you have only one Request and MANY if you have more than one.

ipp_value
required
number >= 0

A multiplier to the base priority of the Proposal for this RequestGroup and all child Requests. A value > 1.0 will raise the priority and debit the Proposal ipp_time_available upon submission. If a Request does not complete, the time debited for that Request is returned. A value < 1.0 will lower the priority and credit the ipp_time_available of the Proposal up to the ipp_limit on the successful completion of a Request. The value is generally set to 1.05. More information can be found here.

proposal
required
string

The Proposal under which the observations for this RequestGroup are made

Responses

Request samples

Content type
{
  • "requests": [
    ],
  • "submitter_id": "string",
  • "name": "string",
  • "observation_type": "NORMAL",
  • "operator": "SINGLE",
  • "ipp_value": 0,
  • "proposal": "string"
}

Response samples

Content type
application/json
{
  • "2021B": {
    }
}

validateRequestGroup

Validate a RequestGrouo

Request Body schema:
required
Array of objects
submitter_id
string
name
required
string <= 50 characters

Descriptive name for this RequestGroup. This string will be placed in the FITS header as the GROUPID keyword value for all FITS frames originating from this RequestGroup.

observation_type
required
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

The type of observations under this RequestGroup. Requests submitted with RAPID_RESPONSE bypass normal scheduling and are executed immediately. Requests submitted with TIME_CRITICAL are scheduled normally but with a high priority. These modes are only available if the Proposal was granted special time. More information is located here.

operator
required
string
Enum: "SINGLE" "MANY"

Operator that describes how child Requests are scheduled. Use SINGLE if you have only one Request and MANY if you have more than one.

ipp_value
required
number >= 0

A multiplier to the base priority of the Proposal for this RequestGroup and all child Requests. A value > 1.0 will raise the priority and debit the Proposal ipp_time_available upon submission. If a Request does not complete, the time debited for that Request is returned. A value < 1.0 will lower the priority and credit the ipp_time_available of the Proposal up to the ipp_limit on the successful completion of a Request. The value is generally set to 1.05. More information can be found here.

proposal
required
string

The Proposal under which the observations for this RequestGroup are made

Responses

Request samples

Content type
{
  • "requests": [
    ],
  • "submitter_id": "string",
  • "name": "string",
  • "observation_type": "NORMAL",
  • "operator": "SINGLE",
  • "ipp_value": 0,
  • "proposal": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "requests": [
    ],
  • "submitter": "string",
  • "name": "string",
  • "observation_type": "NORMAL",
  • "operator": "SINGLE",
  • "ipp_value": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "state": "PENDING",
  • "modified": "2019-08-24T14:15:22Z",
  • "proposal": "string"
}

cancelRequestGroup

Cancel a RequestGroup

path Parameters
id
required
string
Request Body schema:
required
Array of objects
submitter_id
string
name
required
string <= 50 characters

Descriptive name for this RequestGroup. This string will be placed in the FITS header as the GROUPID keyword value for all FITS frames originating from this RequestGroup.

observation_type
required
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

The type of observations under this RequestGroup. Requests submitted with RAPID_RESPONSE bypass normal scheduling and are executed immediately. Requests submitted with TIME_CRITICAL are scheduled normally but with a high priority. These modes are only available if the Proposal was granted special time. More information is located here.

operator
required
string
Enum: "SINGLE" "MANY"

Operator that describes how child Requests are scheduled. Use SINGLE if you have only one Request and MANY if you have more than one.

ipp_value
required
number >= 0

A multiplier to the base priority of the Proposal for this RequestGroup and all child Requests. A value > 1.0 will raise the priority and debit the Proposal ipp_time_available upon submission. If a Request does not complete, the time debited for that Request is returned. A value < 1.0 will lower the priority and credit the ipp_time_available of the Proposal up to the ipp_limit on the successful completion of a Request. The value is generally set to 1.05. More information can be found here.

proposal
required
string

The Proposal under which the observations for this RequestGroup are made

Responses

Request samples

Content type
{
  • "requests": [
    ],
  • "submitter_id": "string",
  • "name": "string",
  • "observation_type": "NORMAL",
  • "operator": "SINGLE",
  • "ipp_value": 0,
  • "proposal": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "requests": [
    ],
  • "submitter": "string",
  • "name": "string",
  • "observation_type": "NORMAL",
  • "operator": "SINGLE",
  • "ipp_value": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "state": "PENDING",
  • "modified": "2019-08-24T14:15:22Z",
  • "proposal": "string"
}

expandDitherPattern

Request Body schema:
pattern
required
string
Enum: "line" "grid" "spiral"
num_points
integer
point_spacing
required
number
line_spacing
number
orientation
number
Default: 0
num_rows
integer
num_columns
integer
center
boolean
Default: false
required
object

Responses

Request samples

Content type
{
  • "pattern": "line",
  • "num_points": 0,
  • "point_spacing": 0,
  • "line_spacing": 0,
  • "orientation": 0,
  • "num_rows": 0,
  • "num_columns": 0,
  • "center": false,
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "constraints": {
    },
  • "instrument_configs": [
    ],
  • "acquisition_config": {
    },
  • "guiding_config": {
    },
  • "target": {
    },
  • "instrument_type": "1M0-INSTRUMENT-A",
  • "type": "EXPOSE",
  • "extra_params": {
    }
}

Proposals

listProposals

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

active
string
Enum: false true

active

semester
string

Semester

id
string

id

tac_rank
string

tac_rank

tac_priority
string

tac_priority

public
string

public

title
string

title

tags
string

Comma separated list of tags

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": [
    ]
}

getProposalTags

Get tags for a proposal

Responses

Response samples

Content type
application/json
[
  • "tagA",
  • "tagB",
  • "tagC"
]

retrieveProposal

path Parameters
id
required
string
query Parameters
active
string
Enum: false true

active

semester
string

Semester

id
string

id

tac_rank
string

tac_rank

tac_priority
string

tac_priority

public
string

public

title
string

title

tags
string

Comma separated list of tags

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "timeallocation_set": [
    ],
  • "pi": "string",
  • "active": true,
  • "title": "string",
  • "abstract": "string",
  • "tac_priority": 2147483647,
  • "tac_rank": 2147483647,
  • "public": true,
  • "non_science": true,
  • "tags": [
    ],
  • "notes": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "sca": "string",
  • "users": [
    ]
}

listSemesters

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

semester_contains
string

Contains Date

start
string

start

end
string

end

id
string

id

start_lte
string

start_lte

end_gt
string

end_gt

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{}

retrieveSemester

path Parameters
id
required
string

A unique value identifying this semester.

query Parameters
semester_contains
string

Contains Date

start
string

start

end
string

end

id
string

id

start_lte
string

start_lte

end_gt
string

end_gt

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z"
}

proposalsSemester

Get proposals in a given semester.

path Parameters
id
required
string

A unique value identifying this semester.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

timeallocationsSemester

Get TimeAllocations for a given semester.

path Parameters
id
required
string

A unique value identifying this semester.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

listMemberships

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

first_name
string

First name contains

last_name
string

Last name contains

username
string

UserId contains

email
string

Email contains

proposal
string

proposal

role
string
Enum: "PI" "CI"

role

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{}

retrieveMembership

path Parameters
id
required
string
query Parameters
first_name
string

First name contains

last_name
string

Last name contains

username
string

UserId contains

email
string

Email contains

proposal
string

proposal

role
string
Enum: "PI" "CI"

role

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "proposal": "string",
  • "role": "PI",
  • "user": 0,
  • "time_limit": -2147483648
}

destroyMembership

path Parameters
id
required
string
query Parameters
first_name
string

First name contains

last_name
string

Last name contains

username
string

UserId contains

email
string

Email contains

proposal
string

proposal

role
string
Enum: "PI" "CI"

role

ordering
string

Which field to use when ordering the results.

Responses

listProposalInvites

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

proposal
string

proposal

pending
string

pending

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{}

retrieveProposalInvite

path Parameters
id
required
string
query Parameters
proposal
string

proposal

pending
string

pending

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "role": "PI",
  • "email": "user@example.com",
  • "sent": "2019-08-24T14:15:22Z",
  • "used": "2019-08-24T14:15:22Z",
  • "proposal": "string"
}

destroyProposalInvite

path Parameters
id
required
string
query Parameters
proposal
string

proposal

pending
string

pending

ordering
string

Which field to use when ordering the results.

Responses

setTimeLimit

Set global time limit for Co-Investigators. Must be a Principle Investigator

path Parameters
id
required
string
Request Body schema:
time_limit_hours
required
number

Responses

Request samples

Content type
{
  • "time_limit_hours": 0
}

Response samples

Content type
application/json
{
  • "message": "All CI time limits set"
}

createProposalInvite

Invite a Co-Investigator to the proposal. Must be a Principle Investigator.

path Parameters
id
required
string
Request Body schema:
sent
string or null <date-time>
used
string or null <date-time>
emails
required
Array of strings <email>

Responses

Request samples

Content type
{
  • "sent": "2019-08-24T14:15:22Z",
  • "used": "2019-08-24T14:15:22Z",
  • "emails": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Co Investigator(s) invited"
}

createProposalNotification

Subscribe to notifications

path Parameters
id
required
string
Request Body schema:
enabled
required
boolean

Responses

Request samples

Content type
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "message": "Preferences saved"
}

limitMembership

Set time limit for a member of a proposal.

path Parameters
id
required
string
Request Body schema:
time_limit_hours
required
number

Responses

Request samples

Content type
{
  • "time_limit_hours": 0
}

Response samples

Content type
application/json
{
  • "message": "All CI time limits set"
}

Science Applications

listCalls

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

only_open
string

only_open

Responses

Response samples

Content type
application/json
{}

retrieveCall

path Parameters
id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

only_open
string

only_open

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "semester": "string",
  • "eligible_semesters": "string",
  • "proposal_type": "SCI",
  • "proposal_type_display": "string",
  • "eligibility_short": "string",
  • "eligibility": "string",
  • "deadline": "2019-08-24T14:15:22Z",
  • "instruments": "string",
  • "time_requested": "string"
}

listScienceApplications

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

call
string

call

status
string
Enum: "DRAFT" "SUBMITTED" "ACCEPTED" "REJECTED" "PORTED"

status

exclude_status
string
Enum: "DRAFT" "SUBMITTED" "ACCEPTED" "REJECTED" "PORTED"

exclude_status

proposal_type
string
Enum: "SCI" "DDT" "KEY" "NAOC" "COLAB"

proposal_type

exclude_proposal_type
string
Enum: "SCI" "DDT" "KEY" "NAOC" "COLAB"

exclude_proposal_type

only_authored
string

only_authored

tags
string

Comma separated list of tags

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": [
    ]
}

createScienceApplication

Request Body schema:
title
required
string
abstract
string
status
required
string
tac_rank
integer [ 0 .. 2147483647 ]
call_id
required
string
pi
string <email> <= 254 characters
pi_first_name
string <= 255 characters
pi_last_name
string <= 255 characters
pi_institution
string <= 255 characters
Array of objects
tags
Array of strings
Array of objects
pdf
string <binary>
clear_pdf
boolean
Default: false

Responses

Request samples

Content type
{
  • "title": "string",
  • "abstract": "string",
  • "status": "string",
  • "tac_rank": 2147483647,
  • "call_id": "string",
  • "pi": "user@example.com",
  • "pi_first_name": "string",
  • "pi_last_name": "string",
  • "pi_institution": "string",
  • "timerequest_set": [
    ],
  • "tags": [
    ],
  • "coinvestigator_set": [
    ],
  • "pdf": "string",
  • "clear_pdf": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "abstract": "string",
  • "status": "string",
  • "tac_rank": 2147483647,
  • "call": "string",
  • "pi": "user@example.com",
  • "pi_first_name": "string",
  • "pi_last_name": "string",
  • "pi_institution": "string",
  • "timerequest_set": [
    ],
  • "tags": [
    ],
  • "coinvestigator_set": [
    ],
  • "pdf": "string",
  • "sca": "string",
  • "submitter": "string",
  • "submitted": "2019-08-24T14:15:22Z"
}

retrieveScienceApplication

path Parameters
id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

call
string

call

status
string
Enum: "DRAFT" "SUBMITTED" "ACCEPTED" "REJECTED" "PORTED"

status

exclude_status
string
Enum: "DRAFT" "SUBMITTED" "ACCEPTED" "REJECTED" "PORTED"

exclude_status

proposal_type
string
Enum: "SCI" "DDT" "KEY" "NAOC" "COLAB"

proposal_type

exclude_proposal_type
string
Enum: "SCI" "DDT" "KEY" "NAOC" "COLAB"

exclude_proposal_type

only_authored
string

only_authored

tags
string

Comma separated list of tags

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "abstract": "string",
  • "status": "string",
  • "tac_rank": 2147483647,
  • "call": "string",
  • "pi": "user@example.com",
  • "pi_first_name": "string",
  • "pi_last_name": "string",
  • "pi_institution": "string",
  • "timerequest_set": [
    ],
  • "tags": [
    ],
  • "coinvestigator_set": [
    ],
  • "pdf": "string",
  • "sca": "string",
  • "submitter": "string",
  • "submitted": "2019-08-24T14:15:22Z"
}

updateScienceApplication

path Parameters
id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

call
string

call

status
string
Enum: "DRAFT" "SUBMITTED" "ACCEPTED" "REJECTED" "PORTED"

status

exclude_status
string
Enum: "DRAFT" "SUBMITTED" "ACCEPTED" "REJECTED" "PORTED"

exclude_status

proposal_type
string
Enum: "SCI" "DDT" "KEY" "NAOC" "COLAB"

proposal_type

exclude_proposal_type
string
Enum: "SCI" "DDT" "KEY" "NAOC" "COLAB"

exclude_proposal_type

only_authored
string

only_authored

tags
string

Comma separated list of tags

Request Body schema:
title
required
string
abstract
string
status
required
string
tac_rank
integer [ 0 .. 2147483647 ]
call_id
required
string
pi
string <email> <= 254 characters
pi_first_name
string <= 255 characters
pi_last_name
string <= 255 characters
pi_institution
string <= 255 characters
Array of objects
tags
Array of strings
Array of objects
pdf
string <binary>
clear_pdf
boolean
Default: false

Responses

Request samples

Content type
{
  • "title": "string",
  • "abstract": "string",
  • "status": "string",
  • "tac_rank": 2147483647,
  • "call_id": "string",
  • "pi": "user@example.com",
  • "pi_first_name": "string",
  • "pi_last_name": "string",
  • "pi_institution": "string",
  • "timerequest_set": [
    ],
  • "tags": [
    ],
  • "coinvestigator_set": [
    ],
  • "pdf": "string",
  • "clear_pdf": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "abstract": "string",
  • "status": "string",
  • "tac_rank": 2147483647,
  • "call": "string",
  • "pi": "user@example.com",
  • "pi_first_name": "string",
  • "pi_last_name": "string",
  • "pi_institution": "string",
  • "timerequest_set": [
    ],
  • "tags": [
    ],
  • "coinvestigator_set": [
    ],
  • "pdf": "string",
  • "sca": "string",
  • "submitter": "string",
  • "submitted": "2019-08-24T14:15:22Z"
}

destroyScienceApplication

path Parameters
id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

call
string

call

status
string
Enum: "DRAFT" "SUBMITTED" "ACCEPTED" "REJECTED" "PORTED"

status

exclude_status
string
Enum: "DRAFT" "SUBMITTED" "ACCEPTED" "REJECTED" "PORTED"

exclude_status

proposal_type
string
Enum: "SCI" "DDT" "KEY" "NAOC" "COLAB"

proposal_type

exclude_proposal_type
string
Enum: "SCI" "DDT" "KEY" "NAOC" "COLAB"

exclude_proposal_type

only_authored
string

only_authored

tags
string

Comma separated list of tags

Responses

copyScienceApplication

Copy a science application's information for a new call

path Parameters
id
required
string
Request Body schema:
title
required
string
abstract
string
status
required
string
tac_rank
integer [ 0 .. 2147483647 ]
call_id
required
string
pi
string <email> <= 254 characters
pi_first_name
string <= 255 characters
pi_last_name
string <= 255 characters
pi_institution
string <= 255 characters
Array of objects
tags
Array of strings
Array of objects
pdf
string <binary>
clear_pdf
boolean
Default: false

Responses

Request samples

Content type
{
  • "title": "string",
  • "abstract": "string",
  • "status": "string",
  • "tac_rank": 2147483647,
  • "call_id": "string",
  • "pi": "user@example.com",
  • "pi_first_name": "string",
  • "pi_last_name": "string",
  • "pi_institution": "string",
  • "timerequest_set": [
    ],
  • "tags": [
    ],
  • "coinvestigator_set": [
    ],
  • "pdf": "string",
  • "clear_pdf": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "abstract": "string",
  • "status": "string",
  • "tac_rank": 2147483647,
  • "call": "string",
  • "pi": "user@example.com",
  • "pi_first_name": "string",
  • "pi_last_name": "string",
  • "pi_institution": "string",
  • "timerequest_set": [
    ],
  • "tags": [
    ],
  • "coinvestigator_set": [
    ],
  • "pdf": "string",
  • "sca": "string",
  • "submitter": "string",
  • "submitted": "2019-08-24T14:15:22Z"
}

Observations

listObservations

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

site
string
Enum: "mba" "tst"

site

enclosure
string
Enum: "doma" "domb" "domc" "domd"

enclosure

telescope
string
Enum: "1m0a" "2m0a"

telescope

priority
string

priority

state
string
Enum: "PENDING" "IN_PROGRESS" "NOT_ATTEMPTED" "COMPLETED" "CANCELED" "ABORTED" "FAILED"

state

time_span
string
Enum: "today" "yesterday" "week" "month" "year"

Time Span

start_after
string

Start After (Inclusive)

start_before
string

Start Before

end_after
string

End After (Inclusive)

end_before
string

End Before

modified_after
string

Modified After (Inclusive)

created_after
string

Created After (Inclusive)

created_before
string

Created Before

request_id
string

request_id

request_group_id
string

Request Group ID

observation_type
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

Observation Type

request_state
string
Enum: "PENDING" "COMPLETED" "WINDOW_EXPIRED" "FAILURE_LIMIT_REACHED" "CANCELED"

Request State

proposal
string

Proposal

instrument_type
string
Enum: "1M0-INSTRUMENT-A" "1M0-INSTRUMENT-B" "2M0-INSTRUMENT-A"

Instrument Type

configuration_type
string
Enum: "BIAS" "DARK" "EXPOSE" "REPEAT_EXPOSE" "SKY_FLAT"

Configuration Type

ordering
string
Enum: "start" "-start" "end" "-end" "modified" "-modified" "created" "-created" "state" "-state"

Observation ordering

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": [
    ]
}

createObservation

This overrides the create mixin create method, but does the same thing minus the serializing of the data into the response at the end

Request Body schema:
site
required
string <= 10 characters

3 character site code

enclosure
required
string <= 10 characters

4 character enclosure code

telescope
required
string <= 10 characters

4 character telescope code

start
required
string <date-time>

Start time of observation

end
required
string <date-time>

End time of observation

priority
integer [ 0 .. 2147483647 ]

Priority (lower is better) for overlapping observations

required
Array of objects
request
required
integer

Responses

Request samples

Content type
{
  • "site": "string",
  • "enclosure": "string",
  • "telescope": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "priority": 2147483647,
  • "configuration_statuses": [
    ],
  • "request": 0
}

Response samples

Content type
application/json
{
  • "site": "string",
  • "enclosure": "string",
  • "telescope": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "priority": 2147483647,
  • "configuration_statuses": [
    ],
  • "request": 0,
  • "state": "PENDING",
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}

getObservationFilters

Endpoint for querying the currently available observation filters

Responses

Response samples

Content type
application/json
{
  • "fields": [
    ],
  • "choice_fields": [
    ]
}

retrieveObservation

path Parameters
id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

site
string
Enum: "mba" "tst"

site

enclosure
string
Enum: "doma" "domb" "domc" "domd"

enclosure

telescope
string
Enum: "1m0a" "2m0a"

telescope

priority
string

priority

state
string
Enum: "PENDING" "IN_PROGRESS" "NOT_ATTEMPTED" "COMPLETED" "CANCELED" "ABORTED" "FAILED"

state

time_span
string
Enum: "today" "yesterday" "week" "month" "year"

Time Span

start_after
string

Start After (Inclusive)

start_before
string

Start Before

end_after
string

End After (Inclusive)

end_before
string

End Before

modified_after
string

Modified After (Inclusive)

created_after
string

Created After (Inclusive)

created_before
string

Created Before

request_id
string

request_id

request_group_id
string

Request Group ID

observation_type
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

Observation Type

request_state
string
Enum: "PENDING" "COMPLETED" "WINDOW_EXPIRED" "FAILURE_LIMIT_REACHED" "CANCELED"

Request State

proposal
string

Proposal

instrument_type
string
Enum: "1M0-INSTRUMENT-A" "1M0-INSTRUMENT-B" "2M0-INSTRUMENT-A"

Instrument Type

configuration_type
string
Enum: "BIAS" "DARK" "EXPOSE" "REPEAT_EXPOSE" "SKY_FLAT"

Configuration Type

ordering
string
Enum: "start" "-start" "end" "-end" "modified" "-modified" "created" "-created" "state" "-state"

Observation ordering

Responses

Response samples

Content type
application/json
{
  • "site": "string",
  • "enclosure": "string",
  • "telescope": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "priority": 2147483647,
  • "configuration_statuses": [
    ],
  • "request": 0,
  • "state": "PENDING",
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}

partialUpdateObservation

path Parameters
id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

site
string
Enum: "mba" "tst"

site

enclosure
string
Enum: "doma" "domb" "domc" "domd"

enclosure

telescope
string
Enum: "1m0a" "2m0a"

telescope

priority
string

priority

state
string
Enum: "PENDING" "IN_PROGRESS" "NOT_ATTEMPTED" "COMPLETED" "CANCELED" "ABORTED" "FAILED"

state

time_span
string
Enum: "today" "yesterday" "week" "month" "year"

Time Span

start_after
string

Start After (Inclusive)

start_before
string

Start Before

end_after
string

End After (Inclusive)

end_before
string

End Before

modified_after
string

Modified After (Inclusive)

created_after
string

Created After (Inclusive)

created_before
string

Created Before

request_id
string

request_id

request_group_id
string

Request Group ID

observation_type
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

Observation Type

request_state
string
Enum: "PENDING" "COMPLETED" "WINDOW_EXPIRED" "FAILURE_LIMIT_REACHED" "CANCELED"

Request State

proposal
string

Proposal

instrument_type
string
Enum: "1M0-INSTRUMENT-A" "1M0-INSTRUMENT-B" "2M0-INSTRUMENT-A"

Instrument Type

configuration_type
string
Enum: "BIAS" "DARK" "EXPOSE" "REPEAT_EXPOSE" "SKY_FLAT"

Configuration Type

ordering
string
Enum: "start" "-start" "end" "-end" "modified" "-modified" "created" "-created" "state" "-state"

Observation ordering

Request Body schema:
site
required
string <= 10 characters

3 character site code

enclosure
required
string <= 10 characters

4 character enclosure code

telescope
required
string <= 10 characters

4 character telescope code

start
required
string <date-time>

Start time of observation

end
required
string <date-time>

End time of observation

priority
integer [ 0 .. 2147483647 ]

Priority (lower is better) for overlapping observations

required
Array of objects
request
required
integer

Responses

Request samples

Content type
{
  • "site": "string",
  • "enclosure": "string",
  • "telescope": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "priority": 2147483647,
  • "configuration_statuses": [
    ],
  • "request": 0
}

Response samples

Content type
application/json
{
  • "site": "string",
  • "enclosure": "string",
  • "telescope": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "priority": 2147483647,
  • "configuration_statuses": [
    ],
  • "request": 0,
  • "state": "PENDING",
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}

listSchedules

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

site
string
Enum: "mba" "tst"

site

enclosure
string
Enum: "doma" "domb" "domc" "domd"

enclosure

telescope
string
Enum: "1m0a" "2m0a"

telescope

priority
string

priority

state
string
Enum: "PENDING" "IN_PROGRESS" "NOT_ATTEMPTED" "COMPLETED" "CANCELED" "ABORTED" "FAILED"

state

time_span
string
Enum: "today" "yesterday" "week" "month" "year"

Time Span

start_after
string

Start After (Inclusive)

start_before
string

Start Before

end_after
string

End After (Inclusive)

end_before
string

End Before

modified_after
string

Modified After (Inclusive)

created_after
string

Created After (Inclusive)

created_before
string

Created Before

request_id
string

request_id

request_group_id
string

Request Group ID

observation_type
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

Observation Type

request_state
string
Enum: "PENDING" "COMPLETED" "WINDOW_EXPIRED" "FAILURE_LIMIT_REACHED" "CANCELED"

Request State

proposal
string

Proposal

instrument_type
string
Enum: "1M0-INSTRUMENT-A" "1M0-INSTRUMENT-B" "2M0-INSTRUMENT-A"

Instrument Type

configuration_type
string
Enum: "BIAS" "DARK" "EXPOSE" "REPEAT_EXPOSE" "SKY_FLAT"

Configuration Type

ordering
string
Enum: "start" "-start" "end" "-end" "modified" "-modified" "created" "-created" "state" "-state"

Observation ordering

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

createSchedule

This sets the last scheduled time on a site when any directly submitted request is submitted for that site

Request Body schema:
site
required
string
Enum: "tst" "mba"
enclosure
required
string
Enum: "doma" "domd" "domb" "domc"
telescope
required
string
Enum: "1m0a" "2m0a"
start
required
string <date-time>

Start time of observation

end
required
string <date-time>

End time of observation

required
object
proposal
required
string
priority
integer [ 0 .. 2147483647 ]

Priority (lower is better) for overlapping observations

name
required
string

Responses

Request samples

Content type
{
  • "site": "tst",
  • "enclosure": "doma",
  • "telescope": "1m0a",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "request": {
    },
  • "proposal": "string",
  • "priority": 2147483647,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "site": "tst",
  • "enclosure": "doma",
  • "telescope": "1m0a",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "state": "string",
  • "configuration_statuses": [
    ],
  • "request": {
    },
  • "priority": 2147483647,
  • "id": 0,
  • "modified": "2019-08-24T14:15:22Z"
}

retrieveSchedule

path Parameters
id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

site
string
Enum: "mba" "tst"

site

enclosure
string
Enum: "doma" "domb" "domc" "domd"

enclosure

telescope
string
Enum: "1m0a" "2m0a"

telescope

priority
string

priority

state
string
Enum: "PENDING" "IN_PROGRESS" "NOT_ATTEMPTED" "COMPLETED" "CANCELED" "ABORTED" "FAILED"

state

time_span
string
Enum: "today" "yesterday" "week" "month" "year"

Time Span

start_after
string

Start After (Inclusive)

start_before
string

Start Before

end_after
string

End After (Inclusive)

end_before
string

End Before

modified_after
string

Modified After (Inclusive)

created_after
string

Created After (Inclusive)

created_before
string

Created Before

request_id
string

request_id

request_group_id
string

Request Group ID

observation_type
string
Enum: "NORMAL" "RAPID_RESPONSE" "TIME_CRITICAL" "DIRECT"

Observation Type

request_state
string
Enum: "PENDING" "COMPLETED" "WINDOW_EXPIRED" "FAILURE_LIMIT_REACHED" "CANCELED"

Request State

proposal
string

Proposal

instrument_type
string
Enum: "1M0-INSTRUMENT-A" "1M0-INSTRUMENT-B" "2M0-INSTRUMENT-A"

Instrument Type

configuration_type
string
Enum: "BIAS" "DARK" "EXPOSE" "REPEAT_EXPOSE" "SKY_FLAT"

Configuration Type

ordering
string
Enum: "start" "-start" "end" "-end" "modified" "-modified" "created" "-created" "state" "-state"

Observation ordering

Responses

Response samples

Content type
application/json
{
  • "site": "tst",
  • "enclosure": "doma",
  • "telescope": "1m0a",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "state": "string",
  • "configuration_statuses": [
    ],
  • "request": {
    },
  • "priority": 2147483647,
  • "id": 0,
  • "modified": "2019-08-24T14:15:22Z"
}

listConfigurationStatus

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

guide_camera_name
string

guide_camera_name

instrument_name
string
Enum: "ib01" "ia01" "ia02"

instrument_name

state
string
Enum: "PENDING" "ATTEMPTED" "NOT_ATTEMPTED" "COMPLETED" "FAILED"

state

site
string
Enum: "tst" "mba"

site

Responses

Response samples

Content type
application/json
{}

retrieveConfigurationStatus

path Parameters
id
required
string

A unique integer value identifying this configuration status.

query Parameters
ordering
string

Which field to use when ordering the results.

guide_camera_name
string

guide_camera_name

instrument_name
string
Enum: "ib01" "ia01" "ia02"

instrument_name

state
string
Enum: "PENDING" "ATTEMPTED" "NOT_ATTEMPTED" "COMPLETED" "FAILED"

state

site
string
Enum: "tst" "mba"

site

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "summary": {
    },
  • "instrument_name": "string",
  • "guide_camera_name": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "exposures_start_at": "2019-08-24T14:15:22Z",
  • "state": "PENDING",
  • "configuration": 0
}

partialUpdateConfigurationStatus

path Parameters
id
required
string

A unique integer value identifying this configuration status.

query Parameters
ordering
string

Which field to use when ordering the results.

guide_camera_name
string

guide_camera_name

instrument_name
string
Enum: "ib01" "ia01" "ia02"

instrument_name

state
string
Enum: "PENDING" "ATTEMPTED" "NOT_ATTEMPTED" "COMPLETED" "FAILED"

state

site
string
Enum: "tst" "mba"

site

Request Body schema:
object
instrument_name
string
guide_camera_name
string
end
string <date-time>
exposures_start_at
string <date-time>
state
string
Enum: "PENDING" "ATTEMPTED" "NOT_ATTEMPTED" "COMPLETED" "FAILED"

Current state of this Configuration Status

configuration
required
integer

Responses

Request samples

Content type
{
  • "summary": {
    },
  • "instrument_name": "string",
  • "guide_camera_name": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "exposures_start_at": "2019-08-24T14:15:22Z",
  • "state": "PENDING",
  • "configuration": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "summary": {
    },
  • "instrument_name": "string",
  • "guide_camera_name": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "exposures_start_at": "2019-08-24T14:15:22Z",
  • "state": "PENDING",
  • "configuration": 0
}

getLastScheduled

Returns the datetime of the last time new observations were submitted. This endpoint is expected to be polled frequently (~every 5 seconds) to for a client to decide if it needs to pull down the schedule or not.

We are only updating when observations are submitted, and not when they are cancelled, because a site should not really care if the only change was removing things from it's schedule.

query Parameters
site
string
Enum: "tst" "mba"

Site to retrieve last scheduled time for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

cancelObservation

Filters a set of observations based on the parameters provided, and then either deletes them if they are scheduled >72 hours in the future, cancels them if they are in the future, or aborts them if they are currently in progress.

Request Body schema:
ids
Array of integers non-empty
start
string <date-time>
end
string <date-time>
site
string
enclosure
string
telescope
string
include_normal
boolean
Default: true
include_rr
boolean
Default: false
include_direct
boolean
Default: false
preemption_enabled
boolean
Default: false

Responses

Request samples

Content type
{
  • "ids": [
    ],
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "site": "string",
  • "enclosure": "string",
  • "telescope": "string",
  • "include_normal": true,
  • "include_rr": false,
  • "include_direct": false,
  • "preemption_enabled": false
}

Response samples

Content type
application/json
{
  • "canceled": 0
}

Accounts

retrieveUser

Responses

Response samples

Content type
application/json
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "profile": {
    },
  • "is_staff": true,
  • "is_superuser": true,
  • "proposals": "string",
  • "available_instrument_types": "string",
  • "tokens": "string",
  • "proposal_notifications": "string"
}

updateUser

Request Body schema:
username
required
string <= 150 characters ^[\w.@+-]+\z

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_name
string <= 150 characters
last_name
string <= 150 characters
email
string <email> <= 254 characters
object
is_superuser
boolean

Designates that this user has all permissions without explicitly assigning them.

Responses

Request samples

Content type
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "profile": {
    },
  • "is_superuser": true
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "profile": {
    },
  • "is_staff": true,
  • "is_superuser": true,
  • "proposals": "string",
  • "available_instrument_types": "string",
  • "tokens": "string",
  • "proposal_notifications": "string"
}

partialUpdateUser

Request Body schema:
username
required
string <= 150 characters ^[\w.@+-]+\z

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_name
string <= 150 characters
last_name
string <= 150 characters
email
string <email> <= 254 characters
object
is_superuser
boolean

Designates that this user has all permissions without explicitly assigning them.

Responses

Request samples

Content type
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "profile": {
    },
  • "is_superuser": true
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "profile": {
    },
  • "is_staff": true,
  • "is_superuser": true,
  • "proposals": "string",
  • "available_instrument_types": "string",
  • "tokens": "string",
  • "proposal_notifications": "string"
}

createUsersBulk

API endpoint to create users in bulk

Request Body schema:
required
Array of objects <= 50 items

Responses

Request samples

Content type
{
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "users": [
    ]
}

acceptTerms

A simple POST request (empty request body) with user authentication information in the HTTP header will accept the terms of use for the Observation Portal.

Responses

Response samples

Content type
application/json
{
  • "message": "Terms accepted"
}

revokeApiToken

A simple POST request (empty request body) with user authentication information in the HTTP header will revoke a user's API Token.

Responses

Response samples

Content type
application/json
{
  • "message": "API token revoked."
}

requestAccountRemoval

View to request account removal.

Request Body schema:
reason
required
string <= 1000 characters

Responses

Request samples

Content type
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "message": "Account removal request successfully submitted."
}

Utility

getInstruments

Gets information about current instruments from the ConfigDB.

query Parameters
site
string
Enum: "tst" "mba"

Site code

enclosure
string
Enum: "doma" "domd" "domb" "domc"

Enclosure code

telescope_class
string
Enum: "2m0" "1m0"

Telescope class

telescope
string
Enum: "1m0a" "2m0a"

Telescope code

Responses

Response samples

Content type
application/json
{
  • "2M0-INSTRUMENT-A": {
    }
}

getContention

Retrieve the contention for a given instrument type binned by RA hour. For every RA hour, the time currently requested on this instrument type for the next 24 hours is returned.

path Parameters
instrument_type
required
string

Responses

Response samples

Content type
application/json
{
  • "ra_hours": [
    ],
  • "instrument_type": "2M0-INSTRUMENT-A",
  • "time_calculated": "2021-10-26T23:14:30.275247Z",
  • "contention_data": [
    ]
}

getPressure

Retrieves the pressure for a given site and instrument for the next 24 hours, binned into 15-minute intervals. The pressure for an observation is defined as its length divided by the total length of time during which it is visible.

query Parameters
site
required
string

Site

instrument
required
string

Instrument Type

Responses

Response samples

Content type
application/json
{
  • "site_nights": [
    ],
  • "time_bins": [
    ],
  • "instrument_type": "2M0-INSTRUMENT-A",
  • "site": "mba",
  • "time_calculated": "2021-10-26T23:38:24.763467Z",
  • "pressure_data": [
    ]
}

api

createAuthToken

Request Body schema:
username
required
string
password
required
string

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "token": "string"
}