diff --git a/_images/erd.png b/_images/erd.png index b305433..e62109f 100644 Binary files a/_images/erd.png and b/_images/erd.png differ diff --git a/_sources/followup.md.txt b/_sources/followup.md.txt index 17b5d64..f1220ad 100644 --- a/_sources/followup.md.txt +++ b/_sources/followup.md.txt @@ -3,6 +3,7 @@ The vast majority of follow-up instruments will require some form of authentication. All such information is passed through the `altdata` variable of the `Allocation`s API. We briefly describe the authentication form the available telescopes take below: * ATLAS Forced Photometry: A user account must be made on https://fallingstar-data.com/forcedphot/, at which point the authentication takes the form `{"api_token": "testtoken"}`. +* GENERIC: There are three generic methods for distributing follow-up requests. The first is through API, where the user provides {"endpoint": "API_ENDPOINT", "api_token": "token"} where API_ENDPOINT is the telescope API endpoint. The second is through slack, where the user provides {"type": "slack", "slack_workspace": "XXX", "slack_channel": "YYY", "slack_token": "ZZZ"}. The third is by email, where the user provides {"type": "email", "email": "email_1@gmail.com,email_2@gmail.com"}. Both slack and email also allow for "comment":"True" to indicate that comment text should also be shared in the message. * KAIT: A username and password are passed as `{"username": "username", "password": "password"}`. * LCO: A user account must be made on https://lco.global/, at which point the authentication takes the form `{"PROPOSAL_ID": "your_proposal_ID", "API_TOKEN": "testtoken", "API_ARCHIVE_TOKEN": "testarchivetoken"}`. The submission token is available directly from https://observe.lco.global while the archive token can be aquired by API: ar = requests.post('https://archive-api.lco.global/api-token-auth/', diff --git a/api.html b/api.html index 5e69c2d..c114b71 100644 --- a/api.html +++ b/api.html @@ -409,7 +409,7 @@ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">

SkyPortal (0.9.dev0+git20230523.eb9e726)

Download OpenAPI specification:Download

SkyPortal provides an API to access most of its underlying + " fill="currentColor">

SkyPortal (0.9.dev0+git20230523.6a5981d)

Download OpenAPI specification:Download

SkyPortal provides an API to access most of its underlying functionality. To use it, you will need an API token. This can be generated via the web application from your profile page or, if you are an admin, you may use the system provisioned token stored @@ -542,8 +542,8 @@

Pagination

allocations

Produce a report on allocations for an instrument

Produce a report on allocations for an instrument

path Parameters
instrument_id
required
integer
query Parameters
output_format
string

Output format for analysis. Can be png or pdf

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve an allocation

Retrieve an allocation

-
path Parameters
allocation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update an allocation on a robotic instrument

Update an allocation on a robotic instrument

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve an allocation

Retrieve an allocation

+
path Parameters
allocation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update an allocation on a robotic instrument

Update an allocation on a robotic instrument

path Parameters
allocation_id
required
integer
Request Body schema: application/json
requests
Array of any
default_requests
Array of any
default_observation_plans
Array of any
catalog_queries
Array of any
observation_plans
Array of any
group
any or null

The Group the allocation is associated with.

instrument
any or null

The Instrument the allocation is associated with.

allocation_users
Array of any
gcn_triggers
Array of any
pi
string or null

The PI of the allocation's proposal.

@@ -553,10 +553,10 @@

Pagination

hours_allocated
required
number

The number of hours allocated.

default_share_group_ids
any or null
group_id
required
integer

The ID of the Group the allocation is associated with.

instrument_id
required
integer

The ID of the Instrument the allocation is associated with.

-
_altdata
string or null

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ],
  • "default_requests": [
    ],
  • "default_observation_plans": [
    ],
  • "catalog_queries": [
    ],
  • "observation_plans": [
    ],
  • "group": null,
  • "instrument": null,
  • "allocation_users": [
    ],
  • "gcn_triggers": [
    ],
  • "pi": "string",
  • "proposal_id": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "hours_allocated": 0,
  • "default_share_group_ids": null,
  • "group_id": 0,
  • "instrument_id": 0,
  • "_altdata": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete allocation.

Delete allocation.

-
path Parameters
allocation_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all allocations

Retrieve all allocations

+
_altdata
string or null

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ],
  • "default_requests": [
    ],
  • "default_observation_plans": [
    ],
  • "catalog_queries": [
    ],
  • "observation_plans": [
    ],
  • "group": null,
  • "instrument": null,
  • "allocation_users": [
    ],
  • "gcn_triggers": [
    ],
  • "pi": "string",
  • "proposal_id": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "hours_allocated": 0,
  • "default_share_group_ids": null,
  • "group_id": 0,
  • "instrument_id": 0,
  • "_altdata": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete allocation.

Delete allocation.

+
path Parameters
allocation_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all allocations

Retrieve all allocations

query Parameters
instrument_id
number

Instrument ID to retrieve allocations for

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Post new allocation on a robotic instrument

Post new allocation on a robotic instrument

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Post new allocation on a robotic instrument

Post new allocation on a robotic instrument

Request Body schema: application/json
requests
Array of any
default_requests
Array of any
default_observation_plans
Array of any
catalog_queries
Array of any
observation_plans
Array of any
group
any or null

The Group the allocation is associated with.

instrument
any or null

The Instrument the allocation is associated with.

allocation_users
Array of any
gcn_triggers
Array of any
pi
string or null

The PI of the allocation's proposal.

@@ -566,33 +566,33 @@

Pagination

hours_allocated
required
number

The number of hours allocated.

default_share_group_ids
any or null
group_id
required
integer

The ID of the Group the allocation is associated with.

instrument_id
required
integer

The ID of the Instrument the allocation is associated with.

-
_altdata
string or null

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ],
  • "default_requests": [
    ],
  • "default_observation_plans": [
    ],
  • "catalog_queries": [
    ],
  • "observation_plans": [
    ],
  • "group": null,
  • "instrument": null,
  • "allocation_users": [
    ],
  • "gcn_triggers": [
    ],
  • "pi": "string",
  • "proposal_id": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "hours_allocated": 0,
  • "default_share_group_ids": null,
  • "group_id": 0,
  • "instrument_id": 0,
  • "_altdata": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve all observation analyses

Retrieve all observation analyses

+
_altdata
string or null

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ],
  • "default_requests": [
    ],
  • "default_observation_plans": [
    ],
  • "catalog_queries": [
    ],
  • "observation_plans": [
    ],
  • "group": null,
  • "instrument": null,
  • "allocation_users": [
    ],
  • "gcn_triggers": [
    ],
  • "pi": "string",
  • "proposal_id": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "hours_allocated": 0,
  • "default_share_group_ids": null,
  • "group_id": 0,
  • "instrument_id": 0,
  • "_altdata": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve all observation analyses

Retrieve all observation analyses

query Parameters
gcnevent_id
number

GcnEvent ID to retrieve observation efficiency analyses for

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve all observation plan efficiency analyses

Retrieve all observation plan efficiency analyses

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve all observation plan efficiency analyses

Retrieve all observation plan efficiency analyses

query Parameters
observation_plan_id
number

EventObservationPlan ID to retrieve observation plan efficiency analyses for

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve a default analysis

Retrieve a default analysis

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve a default analysis

Retrieve a default analysis

path Parameters
analysis_service_id
required
any

Analysis service ID

default_analysis_id
required
any

Default analysis ID

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a default analysis

Delete a default analysis

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a default analysis

Delete a default analysis

path Parameters
analysis_service_id
required
integer

Analysis service ID

default_analysis_id
required
integer

Default analysis ID

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all default analyses

Retrieve all default analyses

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all default analyses

Retrieve all default analyses

path Parameters
analysis_service_id
required
any

Analysis service ID, if not provided, return all default analyses for all analysis services

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Get Swift LSXPS objects and post them as sources. +

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Get Swift LSXPS objects and post them as sources.

Get Swift LSXPS objects and post them as sources. Repeated posting will skip the existing source.

Request Body schema: application/json
telescope_name
integer

Name of telescope to assign this catalog to. Use the same name as your nickname for the Neil Gehrels Swift Observatory. Defaults to Swift.

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Get Gaia Photometric Alert objects and post them a

Get Gaia Photometric Alert objects and post them as sources. +

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Get Gaia Photometric Alert objects and post them a

Get Gaia Photometric Alert objects and post them as sources. Repeated posting will skip the existing source.

Request Body schema: application/json
telescope_name
string

Name of telescope to assign this catalog to. Use the same name as your nickname for Gaia. Defaults to Gaia.

startDate
str

Arrow parsable string. Filter by start date.

endDate
str

Arrow parsable string. Filter by end date.

-

Responses

Request samples

Content type
application/json
{
  • "telescope_name": "string",
  • "startDate": null,
  • "endDate": null
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

/api/earthquake/event_id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

get Gaia parallax and magnitudes and post them as

get Gaia parallax and magnitudes and post them as an annotation, +

Responses

Request samples

Content type
application/json
{
  • "telescope_name": "string",
  • "startDate": null,
  • "endDate": null
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

/api/earthquake/event_id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

get Gaia parallax and magnitudes and post them as

get Gaia parallax and magnitudes and post them as an annotation, based on cross-match to the Gaia DR3.

path Parameters
obj_id
required
string

ID of the object to retrieve Gaia colors for

Request Body schema: application/json
catalog
string

The name of the catalog key, associated with a @@ -611,7 +611,7 @@

Pagination

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view annotation. Defaults to all of requesting user's groups.

-

Responses

Request samples

Content type
application/json
{
  • "catalog": "string",
  • "crossmatchRadius": 0,
  • "crossmatchLimmag": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

get WISE colors and post them as an annotation +

Responses

Request samples

Content type
application/json
{
  • "catalog": "string",
  • "crossmatchRadius": 0,
  • "crossmatchLimmag": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

get WISE colors and post them as an annotation bas

get WISE colors and post them as an annotation based on cross-matches to some catalog (default is allwise_p3as_psd).

path Parameters
obj_id
required
string

ID of the object to retrieve WISE colors for

@@ -624,7 +624,7 @@

Pagination

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view annotation. Defaults to all of requesting user's groups.

-

Responses

Request samples

Content type
application/json
{
  • "catalog": "string",
  • "crossmatchRadius": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

get cross-match with Vizier and post them as an an

get cross-match with Vizier and post them as an annotation +

Responses

Request samples

Content type
application/json
{
  • "catalog": "string",
  • "crossmatchRadius": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

get cross-match with Vizier and post them as an an

get cross-match with Vizier and post them as an annotation based on cross-matches to some catalog (default is VII/290, i.e. the million quasar catalog).

path Parameters
obj_id
required
string

ID of the object to retrieve the Vizier crossmatch for

@@ -637,7 +637,7 @@

Pagination

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view annotation. Defaults to all of requesting user's groups.

-

Responses

Request samples

Content type
application/json
{
  • "catalog": "string",
  • "crossmatchRadius": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Generate a PDF/PNG finding chart for a position or

Generate a PDF/PNG finding chart for a position or Gaia ID

+

Responses

Request samples

Content type
application/json
{
  • "catalog": "string",
  • "crossmatchRadius": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Generate a PDF/PNG finding chart for a position or

Generate a PDF/PNG finding chart for a position or Gaia ID

query Parameters
location_type
required
string
Enum: "gaia_dr3" "gaia_dr2" "pos"

What is the type of the search? From gaia or by position? If pos then ra and dec should be given. If otherwise, the catalog is queried for id catalog_id and the position information is @@ -658,10 +658,10 @@

Pagination

type
string
Enum: "png" "pdf"

Output datafile type. Defaults to pdf.

num_offset_stars
integer [ 0 .. 4 ]

Number of offset stars to determine and show [0,4] (default: 3)

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "status": "error",
  • "message": "string"
}

analysis_services

Retrieve an Analysis Service by id

Retrieve an Analysis Service by id

-
path Parameters
analysis_service_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete an Analysis Service.

Delete an Analysis Service.

-
path Parameters
analysis_service_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all Analysis Services

Retrieve all Analysis Services

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

analysis

Upload an upload_only analysis result

Upload an upload_only analysis result

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { },
  • "status": "error"
}

analysis_services

Retrieve an Analysis Service by id

Retrieve an Analysis Service by id

+
path Parameters
analysis_service_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete an Analysis Service.

Delete an Analysis Service.

+
path Parameters
analysis_service_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all Analysis Services

Retrieve all Analysis Services

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

analysis

Upload an upload_only analysis result

Upload an upload_only analysis result

path Parameters
analysis_resource_type
required
string

What underlying data the analysis is on: must be "obj" (more to be added in the future)

resource_id
required
string

The ID of the underlying data. @@ -674,7 +674,7 @@

Pagination

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view analysis results. Defaults to all of requesting user's groups.

-

Responses

Request samples

Content type
application/json
{
  • "results": { },
  • "show_parameters": true,
  • "show_plots": true,
  • "show_corner": true,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve an Analysis by id

Retrieve an Analysis by id

+

Responses

Request samples

Content type
application/json
{
  • "results": { },
  • "show_parameters": true,
  • "show_plots": true,
  • "show_corner": true,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve an Analysis by id

Retrieve an Analysis by id

path Parameters
analysis_resource_type
required
string

What underlying data the analysis is on: must be "obj" (more to be added in the future)

analysis_id
required
int

ID of the analysis to return.

@@ -689,9 +689,9 @@

Pagination

Defaults to false.

includeFilename
boolean

Boolean indicating whether to include the filename of the data associated with the analysis in the response. Defaults to false.

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete an Analysis.

Delete an Analysis.

-
path Parameters
analysis_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all Analyses

Retrieve all Analyses

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Begin an analysis run

Begin an analysis run

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete an Analysis.

Delete an Analysis.

+
path Parameters
analysis_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all Analyses

Retrieve all Analyses

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Begin an analysis run

Begin an analysis run

path Parameters
analysis_resource_type
required
string

What underlying data the analysis is on: must be "obj" (more to be added in the future)

resource_id
required
string

The ID of the underlying data. @@ -704,7 +704,7 @@

Pagination

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view analysis results. Defaults to all of requesting user's groups.

-

Responses

Request samples

Content type
application/json
{
  • "show_parameters": true,
  • "show_plots": true,
  • "show_corner": true,
  • "analysis_parameters": {
    },
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve an Analysis by id

Retrieve an Analysis by id

+

Responses

Request samples

Content type
application/json
{
  • "show_parameters": true,
  • "show_plots": true,
  • "show_corner": true,
  • "analysis_parameters": {
    },
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve an Analysis by id

Retrieve an Analysis by id

path Parameters
analysis_resource_type
required
string

What underlying data the analysis is on: must be "obj" (more to be added in the future)

analysis_id
required
int

ID of the analysis to return.

@@ -719,9 +719,9 @@

Pagination

Defaults to false.

includeFilename
boolean

Boolean indicating whether to include the filename of the data associated with the analysis in the response. Defaults to false.

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete an Analysis.

Delete an Analysis.

-
path Parameters
analysis_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all Analyses

Retrieve all Analyses

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Begin an analysis run

Begin an analysis run

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete an Analysis.

Delete an Analysis.

+
path Parameters
analysis_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all Analyses

Retrieve all Analyses

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Begin an analysis run

Begin an analysis run

path Parameters
analysis_resource_type
required
string

What underlying data the analysis is on: must be "obj" (more to be added in the future)

resource_id
required
string

The ID of the underlying data. @@ -734,7 +734,7 @@

Pagination

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view analysis results. Defaults to all of requesting user's groups.

-

Responses

Request samples

Content type
application/json
{
  • "show_parameters": true,
  • "show_plots": true,
  • "show_corner": true,
  • "analysis_parameters": {
    },
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve primary data associated with an Analysis.

Retrieve primary data associated with an Analysis.

+

Responses

Request samples

Content type
application/json
{
  • "show_parameters": true,
  • "show_plots": true,
  • "show_corner": true,
  • "analysis_parameters": {
    },
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve primary data associated with an Analysis.

Retrieve primary data associated with an Analysis.

path Parameters
analysis_resource_type
required
string

What underlying data the analysis is on: must be "obj" (more to be added in the future)

analysis_id
required
integer
product_type
required
string

What type of data to retrieve: @@ -747,7 +747,7 @@

Pagination

if new plots are to be generated (e.g. with corner plots)

Responses

Request samples

Content type
application/json
{
  • "download": null,
  • "plot_kwargs": {
    }
}

Response samples

Content type
application/json
{ }

assignments

Retrieve an observing run assignment

Retrieve an observing run assignment

-
path Parameters
assignment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update an assignment

Update an assignment

+
path Parameters
assignment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update an assignment

Update an assignment

path Parameters
assignment_id
required
integer
Request Body schema: application/json
requester
any or null

The User who created this assignment.

last_modified_by
any or null
obj
any or null

The assigned Obj.

spectra
Array of any
photometry
Array of any
photometric_series
Array of any
run
any or null

The ObservingRun this target was assigned to.

@@ -757,19 +757,19 @@

Pagination

status
string

Status of the assignment [done, not done, pending].

priority
required
string <= 1 characters
Enum: "1" "2" "3" "4" "5"

Priority of the request (1 = lowest, 5 = highest).

run_id
required
integer

ID of the ObservingRun this target was assigned to.

-

Responses

Request samples

Content type
application/json
{
  • "requester": null,
  • "last_modified_by": null,
  • "obj": null,
  • "spectra": [
    ],
  • "photometry": [
    ],
  • "photometric_series": [
    ],
  • "run": null,
  • "requester_id": 0,
  • "obj_id": "string",
  • "comment": "string",
  • "status": "string",
  • "priority": "1",
  • "run_id": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete assignment.

Delete assignment.

-
path Parameters
assignment_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all observing run assignments

Retrieve all observing run assignments

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Post new target assignment to observing run

Post new target assignment to observing run

-
Request Body schema: application/json
run_id
required
integer
obj_id
required
string

The ID of the object to observe.

-
priority
required
any
Enum: "1" "2" "3" "4" "5"

Priority of the request, (lowest = 1, highest = 5).

-
status
string

The status of the request

-
comment
string

An optional comment describing the request.

-

Responses

Request samples

Content type
application/json
{
  • "run_id": 0,
  • "obj_id": "string",
  • "priority": "1",
  • "status": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

candidates

Retrieve a candidate

Retrieve a candidate

+

Responses

Request samples

Content type
application/json
{
  • "requester": null,
  • "last_modified_by": null,
  • "obj": null,
  • "spectra": [
    ],
  • "photometry": [
    ],
  • "photometric_series": [
    ],
  • "run": null,
  • "requester_id": 0,
  • "obj_id": "string",
  • "comment": "string",
  • "status": "string",
  • "priority": "1",
  • "run_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete assignment.

Delete assignment.

+
path Parameters
assignment_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all observing run assignments

Retrieve all observing run assignments

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Post new target assignment to observing run

Post new target assignment to observing run

+
Request Body schema: application/json
status
string

The status of the request

+
run_id
required
integer
obj_id
required
string

The ID of the object to observe.

+
comment
string

An optional comment describing the request.

+
priority
required
any
Enum: "1" "2" "3" "4" "5"

Priority of the request, (lowest = 1, highest = 5).

+

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "run_id": 0,
  • "obj_id": "string",
  • "comment": "string",
  • "priority": "1"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

candidates

Retrieve a candidate

Retrieve a candidate

path Parameters
obj_id
required
string
query Parameters
includeComments
boolean

Boolean indicating whether to include associated comments. Defaults to false.

includeAlerts
boolean

Boolean indicating whether to include associated alerts. Defaults to false.

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Check if a Candidate exists

Check if a Candidate exists

-
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete candidate(s)

Delete candidate(s)

-
path Parameters
obj_id
required
string
filter_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all candidates

Retrieve all candidates

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Check if a Candidate exists

Check if a Candidate exists

+
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete candidate(s)

Delete candidate(s)

+
path Parameters
obj_id
required
string
filter_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all candidates

Retrieve all candidates

query Parameters
numPerPage
integer

Number of candidates to return per paginated request. Defaults to 25. Capped at 500.

pageNumber
integer

Page number for paginated query results. Defaults to 1

@@ -828,7 +828,7 @@

Pagination

/api/localization endpoint or skymap name in GcnEvent page table.

localizationCumprob
number

Cumulative probability up to which to include sources

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Create new candidate(s) (one per filter).

Create new candidate(s) (one per filter).

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Create new candidate(s) (one per filter).

Create new candidate(s) (one per filter).

Request Body schema: application/json
host
any or null

The Galaxy associated with this source.

comments
Array of any
reminders
Array of any
comments_on_spectra
Array of any
reminders_on_spectra
Array of any
annotations
Array of any
annotations_on_spectra
Array of any
annotations_on_photometry
Array of any
classifications
Array of any
photometry
Array of any
photstats
Array of any
photometric_series
Array of any
spectra
Array of any
thumbnails
Array of any
followup_requests
Array of any
assignments
Array of any
obj_notifications
Array of any
obj_analyses
Array of any
sources_in_gcns
Array of any
id
required
string

Name of the object.

ra_dis
number or null

J2000 Right Ascension at discovery time [deg].

@@ -859,7 +859,7 @@

Pagination

ra
number or null
dec
number or null
candidates
Array of any
sources
Array of any
users
Array of any
filter_ids
required
Array of integers

List of associated filter IDs

passing_alert_id
integer or null

ID of associated filter that created candidate

passed_at
required
string or null

Arrow-parseable datetime string indicating when passed filter.

-

Responses

Request samples

Content type
application/json
{
  • "host": null,
  • "comments": [
    ],
  • "reminders": [
    ],
  • "comments_on_spectra": [
    ],
  • "reminders_on_spectra": [
    ],
  • "annotations": [
    ],
  • "annotations_on_spectra": [
    ],
  • "annotations_on_photometry": [
    ],
  • "classifications": [
    ],
  • "photometry": [
    ],
  • "photstats": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "thumbnails": [
    ],
  • "followup_requests": [
    ],
  • "assignments": [
    ],
  • "obj_notifications": [
    ],
  • "obj_analyses": [
    ],
  • "sources_in_gcns": [
    ],
  • "id": "string",
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "redshift_error": 0,
  • "redshift_origin": "string",
  • "host_id": 0,
  • "summary": "string",
  • "summary_history": null,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "mpc_name": "string",
  • "tns_name": "string",
  • "tns_info": null,
  • "score": 0,
  • "origin": "string",
  • "alias": null,
  • "healpix": 0,
  • "detect_photometry_count": 0,
  • "ra": 0,
  • "dec": 0,
  • "candidates": [
    ],
  • "sources": [
    ],
  • "users": [
    ],
  • "filter_ids": [
    ],
  • "passing_alert_id": 0,
  • "passed_at": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Create new candidate(s) (one per filter).

Create new candidate(s) (one per filter).

+

Responses

Request samples

Content type
application/json
{
  • "host": null,
  • "comments": [
    ],
  • "reminders": [
    ],
  • "comments_on_spectra": [
    ],
  • "reminders_on_spectra": [
    ],
  • "annotations": [
    ],
  • "annotations_on_spectra": [
    ],
  • "annotations_on_photometry": [
    ],
  • "classifications": [
    ],
  • "photometry": [
    ],
  • "photstats": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "thumbnails": [
    ],
  • "followup_requests": [
    ],
  • "assignments": [
    ],
  • "obj_notifications": [
    ],
  • "obj_analyses": [
    ],
  • "sources_in_gcns": [
    ],
  • "id": "string",
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "redshift_error": 0,
  • "redshift_origin": "string",
  • "host_id": 0,
  • "summary": "string",
  • "summary_history": null,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "mpc_name": "string",
  • "tns_name": "string",
  • "tns_info": null,
  • "score": 0,
  • "origin": "string",
  • "alias": null,
  • "healpix": 0,
  • "detect_photometry_count": 0,
  • "ra": 0,
  • "dec": 0,
  • "candidates": [
    ],
  • "sources": [
    ],
  • "users": [
    ],
  • "filter_ids": [
    ],
  • "passing_alert_id": 0,
  • "passed_at": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Create new candidate(s) (one per filter).

Create new candidate(s) (one per filter).

Request Body schema: application/json
host
any or null

The Galaxy associated with this source.

comments
Array of any
reminders
Array of any
comments_on_spectra
Array of any
reminders_on_spectra
Array of any
annotations
Array of any
annotations_on_spectra
Array of any
annotations_on_photometry
Array of any
classifications
Array of any
photometry
Array of any
photstats
Array of any
photometric_series
Array of any
spectra
Array of any
thumbnails
Array of any
followup_requests
Array of any
assignments
Array of any
obj_notifications
Array of any
obj_analyses
Array of any
sources_in_gcns
Array of any
id
required
string

Name of the object.

ra_dis
number or null

J2000 Right Ascension at discovery time [deg].

@@ -890,19 +890,19 @@

Pagination

ra
number or null
dec
number or null
candidates
Array of any
sources
Array of any
users
Array of any
filter_ids
required
Array of integers

List of associated filter IDs

passing_alert_id
integer or null

ID of associated filter that created candidate

passed_at
required
string or null

Arrow-parseable datetime string indicating when passed filter.

-

Responses

Request samples

Content type
application/json
{
  • "host": null,
  • "comments": [
    ],
  • "reminders": [
    ],
  • "comments_on_spectra": [
    ],
  • "reminders_on_spectra": [
    ],
  • "annotations": [
    ],
  • "annotations_on_spectra": [
    ],
  • "annotations_on_photometry": [
    ],
  • "classifications": [
    ],
  • "photometry": [
    ],
  • "photstats": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "thumbnails": [
    ],
  • "followup_requests": [
    ],
  • "assignments": [
    ],
  • "obj_notifications": [
    ],
  • "obj_analyses": [
    ],
  • "sources_in_gcns": [
    ],
  • "id": "string",
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "redshift_error": 0,
  • "redshift_origin": "string",
  • "host_id": 0,
  • "summary": "string",
  • "summary_history": null,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "mpc_name": "string",
  • "tns_name": "string",
  • "tns_info": null,
  • "score": 0,
  • "origin": "string",
  • "alias": null,
  • "healpix": 0,
  • "detect_photometry_count": 0,
  • "ra": 0,
  • "dec": 0,
  • "candidates": [
    ],
  • "sources": [
    ],
  • "users": [
    ],
  • "filter_ids": [
    ],
  • "passing_alert_id": 0,
  • "passed_at": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete candidate(s)

Delete candidate(s)

-
path Parameters
obj_id
required
string
filter_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

catalog_queries

Submit catalog queries

Submit catalog queries

-
Request Body schema: application/json
allocation_id
required
integer

Catalog query request allocation ID.

+

Responses

Request samples

Content type
application/json
{
  • "host": null,
  • "comments": [
    ],
  • "reminders": [
    ],
  • "comments_on_spectra": [
    ],
  • "reminders_on_spectra": [
    ],
  • "annotations": [
    ],
  • "annotations_on_spectra": [
    ],
  • "annotations_on_photometry": [
    ],
  • "classifications": [
    ],
  • "photometry": [
    ],
  • "photstats": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "thumbnails": [
    ],
  • "followup_requests": [
    ],
  • "assignments": [
    ],
  • "obj_notifications": [
    ],
  • "obj_analyses": [
    ],
  • "sources_in_gcns": [
    ],
  • "id": "string",
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "redshift_error": 0,
  • "redshift_origin": "string",
  • "host_id": 0,
  • "summary": "string",
  • "summary_history": null,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "mpc_name": "string",
  • "tns_name": "string",
  • "tns_info": null,
  • "score": 0,
  • "origin": "string",
  • "alias": null,
  • "healpix": 0,
  • "detect_photometry_count": 0,
  • "ra": 0,
  • "dec": 0,
  • "candidates": [
    ],
  • "sources": [
    ],
  • "users": [
    ],
  • "filter_ids": [
    ],
  • "passing_alert_id": 0,
  • "passed_at": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete candidate(s)

Delete candidate(s)

+
path Parameters
obj_id
required
string
filter_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

catalog_queries

Submit catalog queries

Submit catalog queries

+
Request Body schema: application/json
target_group_ids
Array of integers

IDs of groups to share the results of the observation plan request with.

+
payload
any

Content of the catalog query request.

status
string
Default: "pending submission"

The status of the request.

-
target_group_ids
Array of integers

IDs of groups to share the results of the observation plan request with.

-
payload
any

Content of the catalog query request.

-

Responses

Request samples

Content type
application/json
{
  • "allocation_id": 0,
  • "status": "pending submission",
  • "target_group_ids": [
    ],
  • "payload": null
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

classifications

Vote for a classification.

Vote for a classification.

+
allocation_id
required
integer

Catalog query request allocation ID.

+

Responses

Request samples

Content type
application/json
{
  • "target_group_ids": [
    ],
  • "payload": null,
  • "status": "pending submission",
  • "allocation_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

classifications

Vote for a classification.

Vote for a classification.

path Parameters
classification_id
required
string

ID of classification to indicate the vote for

Request Body schema: application/json
vote
required
integer

Upvote or downvote a classification

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete classification vote.

Delete classification vote.

-
path Parameters
classification_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve a classification

Retrieve a classification

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete classification vote.

Delete classification vote.

+
path Parameters
classification_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve a classification

Retrieve a classification

path Parameters
classification_id
required
integer
query Parameters
includeTaxonomy
boolean

Return associated taxonomy.

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update a classification

Update a classification

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update a classification

Update a classification

path Parameters
classification
required
integer
Request Body schema: application/json
taxonomy
any or null

Taxonomy in which this Classification was made.

author
any or null

The User that made this classification.

obj
any or null

The Classification's Obj.

@@ -914,9 +914,9 @@

Pagination

obj_id
required
string

ID of the Classification's Obj.

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view classification.

-

Responses

Request samples

Content type
application/json
{
  • "taxonomy": null,
  • "author": null,
  • "obj": null,
  • "groups": [
    ],
  • "votes": [
    ],
  • "classification": "string",
  • "taxonomy_id": 0,
  • "probability": 0,
  • "author_id": 0,
  • "author_name": "string",
  • "obj_id": "string",
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a classification

Delete a classification

+

Responses

Request samples

Content type
application/json
{
  • "taxonomy": null,
  • "author": null,
  • "obj": null,
  • "groups": [
    ],
  • "votes": [
    ],
  • "classification": "string",
  • "taxonomy_id": 0,
  • "probability": 0,
  • "author_id": 0,
  • "author_name": "string",
  • "obj_id": "string",
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a classification

Delete a classification

path Parameters
classification_id
required
integer
Request Body schema: application/json
label
boolean or null

Add label associated with classification.

-

Responses

Request samples

Content type
application/json
{
  • "label": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all classifications

Retrieve all classifications

+

Responses

Request samples

Content type
application/json
{
  • "label": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all classifications

Retrieve all classifications

query Parameters
startDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by created_at >= startDate

endDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by @@ -924,7 +924,7 @@

Pagination

includeTaxonomy
boolean

Return associated taxonomy.

numPerPage
integer

Number of sources to return per paginated request. Defaults to 100. Max 500.

pageNumber
integer

Page number for paginated query results. Defaults to 1

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Post a classification

Post a classification

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Post a classification

Post a classification

Request Body schema: application/json
obj_id
required
string
classification
required
string
taxonomy_id
required
integer
probability
float or null [ 0 .. 1 ]

User-assigned probability of this classification on this taxonomy. If multiple classifications are given for the same source by the same user, the sum of the @@ -935,61 +935,61 @@

Pagination

requesting user's groups.

vote
boolean or null

Add vote associated with classification.

label
boolean or null

Add label associated with classification.

-

Responses

Request samples

Content type
application/json
{
  • "obj_id": "string",
  • "classification": "string",
  • "taxonomy_id": 0,
  • "probability": null,
  • "group_ids": [
    ],
  • "vote": true,
  • "label": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve an object's classifications

Retrieve an object's classifications

-
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Delete all of an object's classifications

Delete all of an object's classifications

+

Responses

Request samples

Content type
application/json
{
  • "obj_id": "string",
  • "classification": "string",
  • "taxonomy_id": 0,
  • "probability": null,
  • "group_ids": [
    ],
  • "vote": true,
  • "label": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve an object's classifications

Retrieve an object's classifications

+
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Delete all of an object's classifications

Delete all of an object's classifications

path Parameters
classification_id
required
integer
Request Body schema: application/json
label
boolean or null

Add label associated with classification.

-

Responses

Request samples

Content type
application/json
{
  • "label": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

classification_votes

Vote for a classification.

Vote for a classification.

+

Responses

Request samples

Content type
application/json
{
  • "label": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

classification_votes

Vote for a classification.

Vote for a classification.

path Parameters
classification_id
required
string

ID of classification to indicate the vote for

Request Body schema: application/json
vote
required
integer

Upvote or downvote a classification

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete classification vote.

Delete classification vote.

-
path Parameters
classification_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

source

find the sources with classifications

find the sources with classifications

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete classification vote.

Delete classification vote.

+
path Parameters
classification_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

source

find the sources with classifications

find the sources with classifications

query Parameters
startDate
string

Arrow-parseable date string (e.g. 2020-01-01) for when the classification was made. If provided, filter by created_at >= startDate

endDate
string

Arrow-parseable date string (e.g. 2020-01-01) for when the classification was made. If provided, filter by created_at <= endDate

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": [
    ]
}

find the number of sources with and without a Heal

find the number of sources with and without a Healpix value

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

system_info

Retrieve enum types in the DB

Retrieve enum types in the DB

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve basic DB statistics

Retrieve basic DB statistics

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve system/deployment info

Retrieve system/deployment info

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

default_followup_requests

Retrieve a single default follow-up request

Retrieve a single default follow-up request

-
path Parameters
default_followup_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

filters

Delete a default follow-up request

Delete a default follow-up request

-
path Parameters
default_followup_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all default follow-up requests

Retrieve all default follow-up requests

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Delete a default observation plan

Delete a default observation plan

-
path Parameters
default_observation_plan_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all default observation plans

Retrieve all default observation plans

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Delete a default survey efficiency

Delete a default survey efficiency

-
path Parameters
default_survey_efficiency_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all default survey efficiencies

Retrieve all default survey efficiencies

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve a filter

Retrieve a filter

-
path Parameters
filter_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a filter

Delete a filter

-
path Parameters
filter_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update filter name

Update filter name

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": [
    ]
}

find the number of sources with and without a Heal

find the number of sources with and without a Healpix value

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

system_info

Retrieve enum types in the DB

Retrieve enum types in the DB

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve basic DB statistics

Retrieve basic DB statistics

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve system/deployment info

Retrieve system/deployment info

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

default_followup_requests

Retrieve a single default follow-up request

Retrieve a single default follow-up request

+
path Parameters
default_followup_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

filters

Delete a default follow-up request

Delete a default follow-up request

+
path Parameters
default_followup_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all default follow-up requests

Retrieve all default follow-up requests

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Delete a default observation plan

Delete a default observation plan

+
path Parameters
default_observation_plan_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all default observation plans

Retrieve all default observation plans

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Delete a default survey efficiency

Delete a default survey efficiency

+
path Parameters
default_survey_efficiency_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all default survey efficiencies

Retrieve all default survey efficiencies

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve a filter

Retrieve a filter

+
path Parameters
filter_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a filter

Delete a filter

+
path Parameters
filter_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update filter name

Update filter name

path Parameters
filter_id
required
integer
Request Body schema: application/json
stream
any or null

The Filter's Stream.

group
any or null

The Filter's Group.

candidates
Array of any
name
required
string

Filter name.

stream_id
required
integer

ID of the Filter's Stream.

group_id
required
integer

ID of the Filter's Group.

-

Responses

Request samples

Content type
application/json
{
  • "stream": null,
  • "group": null,
  • "candidates": [
    ],
  • "name": "string",
  • "stream_id": 0,
  • "group_id": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all filters

Retrieve all filters

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

POST a new filter.

POST a new filter.

+

Responses

Request samples

Content type
application/json
{
  • "stream": null,
  • "group": null,
  • "candidates": [
    ],
  • "name": "string",
  • "stream_id": 0,
  • "group_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all filters

Retrieve all filters

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

POST a new filter.

POST a new filter.

Request Body schema: application/json
stream
any or null

The Filter's Stream.

group
any or null

The Filter's Group.

candidates
Array of any
name
required
string

Filter name.

stream_id
required
integer

ID of the Filter's Stream.

group_id
required
integer

ID of the Filter's Group.

-

Responses

Request samples

Content type
application/json
{
  • "stream": null,
  • "group": null,
  • "candidates": [
    ],
  • "name": "string",
  • "stream_id": 0,
  • "group_id": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

default_followup_request

Create default follow-up request.

Create default follow-up request.

-
Request Body schema: application/json
allocation_id
required
integer

Follow-up request allocation ID.

-
target_group_ids
Array of integers

IDs of groups to share the results of the default follow-up request with.

-
payload
any

Content of the default follow-up request.

-

Responses

Request samples

Content type
application/json
{
  • "allocation_id": 0,
  • "target_group_ids": [
    ],
  • "payload": null
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

default_observation_plans

Retrieve a single default observation plan

Retrieve a single default observation plan

-
path Parameters
default_observation_plan_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

default_observation_plan

Create default observation plan requests.

Create default observation plan requests.

-
Request Body schema: application/json
allocation_id
required
integer

Observation plan request allocation ID.

-
target_group_ids
Array of integers

IDs of groups to share the results of the default observation plan request with.

-
payload
any

Content of the default observation plan request.

-

Responses

Request samples

Content type
application/json
{
  • "allocation_id": 0,
  • "target_group_ids": [
    ],
  • "payload": null
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

default_survey_efficiencys

Retrieve a single default survey efficiency

Retrieve a single default survey efficiency

-
path Parameters
default_survey_efficiency_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

default_survey_efficiency

Create default survey efficiency requests.

Create default survey efficiency requests.

-
Request Body schema: application/json
default_observationplan_request_id
required
integer

Default observation plan request ID.

-
payload
any

Content of the default survey efficiency analysis.

-

Responses

Request samples

Content type
application/json
{
  • "default_observationplan_request_id": 0,
  • "payload": null
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

facility

Post a message from a remote facility

Post a message from a remote facility

-
Request Body schema: application/json
One of
new_status
required
string
followup_request_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "new_status": "string",
  • "followup_request_id": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

followup_requests

Add follow-up request to watch list

Add follow-up request to watch list

-
path Parameters
followup_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete follow-up request from watch list

Delete follow-up request from watch list

-
path Parameters
followup_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve followup requests schedule

Retrieve followup requests schedule

+

Responses

Request samples

Content type
application/json
{
  • "stream": null,
  • "group": null,
  • "candidates": [
    ],
  • "name": "string",
  • "stream_id": 0,
  • "group_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

default_followup_request

Create default follow-up request.

Create default follow-up request.

+
Request Body schema: application/json
target_group_ids
Array of integers

IDs of groups to share the results of the default follow-up request with.

+
payload
any

Content of the default follow-up request.

+
allocation_id
required
integer

Follow-up request allocation ID.

+

Responses

Request samples

Content type
application/json
{
  • "target_group_ids": [
    ],
  • "payload": null,
  • "allocation_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

default_observation_plans

Retrieve a single default observation plan

Retrieve a single default observation plan

+
path Parameters
default_observation_plan_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

default_observation_plan

Create default observation plan requests.

Create default observation plan requests.

+
Request Body schema: application/json
target_group_ids
Array of integers

IDs of groups to share the results of the default observation plan request with.

+
payload
any

Content of the default observation plan request.

+
allocation_id
required
integer

Observation plan request allocation ID.

+

Responses

Request samples

Content type
application/json
{
  • "target_group_ids": [
    ],
  • "payload": null,
  • "allocation_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

default_survey_efficiencys

Retrieve a single default survey efficiency

Retrieve a single default survey efficiency

+
path Parameters
default_survey_efficiency_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

default_survey_efficiency

Create default survey efficiency requests.

Create default survey efficiency requests.

+
Request Body schema: application/json
payload
any

Content of the default survey efficiency analysis.

+
default_observationplan_request_id
required
integer

Default observation plan request ID.

+

Responses

Request samples

Content type
application/json
{
  • "payload": null,
  • "default_observationplan_request_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

facility

Post a message from a remote facility

Post a message from a remote facility

+
Request Body schema: application/json
One of
new_status
required
string
followup_request_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "new_status": "string",
  • "followup_request_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

followup_requests

Add follow-up request to watch list

Add follow-up request to watch list

+
path Parameters
followup_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete follow-up request from watch list

Delete follow-up request from watch list

+
path Parameters
followup_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve followup requests schedule

Retrieve followup requests schedule

query Parameters
sourceID
string

Portion of ID to filter on

startDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by created_at >= startDate

@@ -1007,35 +1007,35 @@

Pagination

magnitudeRange
list

lowest and highest magnitude to return, e.g. "(12,9)"

output_format
string

Output format for schedule. Can be png, pdf, or csv

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "status": "error",
  • "message": "string"
}

Reprioritize followup requests schedule automatica

Reprioritize followup requests schedule automatically based on +

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { },
  • "status": "error"
}

Reprioritize followup requests schedule automatica

Reprioritize followup requests schedule automatically based on either magnitude or location within skymap.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a follow-up request

Update a follow-up request

-
path Parameters
request_id
required
string
Request Body schema: application/json
allocation_id
required
integer

Followup request allocation ID.

-
obj_id
required
string

ID of the target Obj.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a follow-up request

Update a follow-up request

+
path Parameters
request_id
required
string
Request Body schema: application/json
payload
any

Content of the followup request.

+
allocation_id
required
integer

Followup request allocation ID.

+
target_group_ids
Array of integers

IDs of groups to share the results of the followup request with.

status
string
Default: "pending submission"

The status of the request.

-
payload
any

Content of the followup request.

-
target_group_ids
Array of integers

IDs of groups to share the results of the followup request with.

-

Responses

Request samples

Content type
application/json
{
  • "allocation_id": 0,
  • "obj_id": "string",
  • "status": "pending submission",
  • "payload": null,
  • "target_group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete follow-up request.

Delete follow-up request.

-
path Parameters
request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Submit follow-up request.

Submit follow-up request.

-
Request Body schema: application/json
allocation_id
required
integer

Followup request allocation ID.

-
obj_id
required
string

ID of the target Obj.

+
obj_id
required
string

ID of the target Obj.

+

Responses

Request samples

Content type
application/json
{
  • "payload": null,
  • "allocation_id": 0,
  • "target_group_ids": [
    ],
  • "status": "pending submission",
  • "obj_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete follow-up request.

Delete follow-up request.

+
path Parameters
request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Submit follow-up request.

Submit follow-up request.

+
Request Body schema: application/json
payload
any

Content of the followup request.

+
allocation_id
required
integer

Followup request allocation ID.

+
target_group_ids
Array of integers

IDs of groups to share the results of the followup request with.

status
string
Default: "pending submission"

The status of the request.

-
payload
any

Content of the followup request.

-
target_group_ids
Array of integers

IDs of groups to share the results of the followup request with.

-

Responses

Request samples

Content type
application/json
{
  • "allocation_id": 0,
  • "obj_id": "string",
  • "status": "pending submission",
  • "payload": null,
  • "target_group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Get photometry request.

Get photometry request.

-
path Parameters
request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

galaxys

Upload galaxies from GLADE+ catalog. If no file_na

Upload galaxies from GLADE+ catalog. If no file_name or file_url is provided, will look for the GLADE+ catalog in the data directory. If it can't be found, it will download it.

+
obj_id
required
string

ID of the target Obj.

+

Responses

Request samples

Content type
application/json
{
  • "payload": null,
  • "allocation_id": 0,
  • "target_group_ids": [
    ],
  • "status": "pending submission",
  • "obj_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Get photometry request.

Get photometry request.

+
path Parameters
request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

galaxys

Upload galaxies from GLADE+ catalog. If no file_na

Upload galaxies from GLADE+ catalog. If no file_name or file_url is provided, will look for the GLADE+ catalog in the data directory. If it can't be found, it will download it.

Request Body schema: application/json
file_name
string

Name of the file containing the galaxies (in the data directory)

file_url
string

URL of the file containing the galaxies

-

Responses

Request samples

Content type
application/json
{
  • "file_name": "string",
  • "file_url": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Upload galaxies from ASCII file

Upload galaxies from ASCII file

+

Responses

Request samples

Content type
application/json
{
  • "file_name": "string",
  • "file_url": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Upload galaxies from ASCII file

Upload galaxies from ASCII file

Request Body schema: application/json
catalogData
any

Catalog data Ascii string

catalogName
string

Galaxy catalog name.

-

Responses

Request samples

Content type
application/json
{
  • "catalogData": null,
  • "catalogName": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Set an object's host galaxy

Set an object's host galaxy

+

Responses

Request samples

Content type
application/json
{
  • "catalogData": null,
  • "catalogName": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Set an object's host galaxy

Set an object's host galaxy

path Parameters
obj_id
required
string
Request Body schema: application/json
galaxyName
required
string

Name of the galaxy to associate with the object

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete an object's host galaxy

Delete an object's host galaxy

-
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Upload spatial catalog from ASCII file

Upload spatial catalog from ASCII file

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete an object's host galaxy

Delete an object's host galaxy

+
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Upload spatial catalog from ASCII file

Upload spatial catalog from ASCII file

Request Body schema: application/json
catalogData
any

Catalog data Ascii string

catalogName
string

Spatial catalog name.

-

Responses

Request samples

Content type
application/json
{
  • "catalogData": null,
  • "catalogName": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

galaxies

Retrieve all galaxies

Retrieve all galaxies

+

Responses

Request samples

Content type
application/json
{
  • "catalogData": null,
  • "catalogName": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

galaxies

Retrieve all galaxies

Retrieve all galaxies

query Parameters
catalog_name
string

Filter by catalog name (exact match)

minDistance
number

If provided, return only galaxies with a distance of at least this value

maxDistance
number

If provided, return only galaxies with a distance of at most this value

@@ -1051,18 +1051,18 @@

Pagination

pageNumber
integer

Page number for paginated query results. Defaults to 1

catalogNamesOnly
boolean

Boolean indicating whether to just return catalog names. Defaults to false.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Ingest a Galaxy catalog

Ingest a Galaxy catalog

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Ingest a Galaxy catalog

Ingest a Galaxy catalog

Request Body schema: application/json
catalog_name
string

Galaxy catalog name.

catalog_data
Array of any

Galaxy catalog data

-

Responses

Request samples

Content type
application/json
{
  • "catalog_name": "string",
  • "catalog_data": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Ingest a Spatial Catalog

Ingest a Spatial Catalog

+

Responses

Request samples

Content type
application/json
{
  • "catalog_name": "string",
  • "catalog_data": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Ingest a Spatial Catalog

Ingest a Spatial Catalog

Request Body schema: application/json
catalog_name
string

Spatial catalog name.

catalog_data
Array of any

Spatial catalog data

-

Responses

Request samples

Content type
application/json
{
  • "catalog_name": "string",
  • "catalog_data": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

instruments

Delete a galaxy catalog

Delete a galaxy catalog

-
path Parameters
catalog_name
required
str

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Compute instrument field probabilities for a skyma

Compute instrument field probabilities for a skymap

+

Responses

Request samples

Content type
application/json
{
  • "catalog_name": "string",
  • "catalog_data": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

instruments

Delete a galaxy catalog

Delete a galaxy catalog

+
path Parameters
catalog_name
required
str

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Compute instrument field probabilities for a skyma

Compute instrument field probabilities for a skymap

path Parameters
dateobs
required
string
Instrument ID
required
integer
query Parameters
localization_name
required
string

Localization map name

integrated_probability
float

Cumulative integrated probability threshold

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete fields associated with an instrument

Delete fields associated with an instrument

-
path Parameters
instrument_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve an instrument

Retrieve an instrument

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete fields associated with an instrument

Delete fields associated with an instrument

+
path Parameters
instrument_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve an instrument

Retrieve an instrument

path Parameters
instrument_id
required
integer
query Parameters
includeGeoJSON
boolean

Boolean indicating whether to include associated GeoJSON. Defaults to false.

includeGeoJSONSummary
boolean

Boolean indicating whether to include associated GeoJSON summary bounding box. Defaults to @@ -1082,7 +1082,7 @@

Pagination

table.

localizationCumprob
number

Cumulative probability up to which to include fields. Defaults to 0.95.

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update instrument

Update instrument

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update instrument

Update instrument

path Parameters
instrument_id
required
integer
Request Body schema: application/json
telescope
any or null

The Telescope that hosts the Instrument.

photometry
Array of any
photometric_series
Array of any
spectra
Array of any
allocations
Array of any
observing_runs
Array of any
observations
Array of any
queued_observations
Array of any
fields
Array of any
tiles
Array of any
plans
Array of any
name
required
string

Instrument name.

type
required
string <= 20 characters
Enum: "imager" "spectrograph" "imaging spectrograph"

Instrument type, one of Imager, Spectrograph, or Imaging Spectrograph.

@@ -1099,10 +1099,10 @@

Pagination

region
string or null

Instrument astropy.regions representation.

has_fields
boolean

Whether the instrument has fields or not.

has_region
boolean

Whether the instrument has a region or not.

-

Responses

Request samples

Content type
application/json
{
  • "telescope": null,
  • "photometry": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "allocations": [
    ],
  • "observing_runs": [
    ],
  • "observations": [
    ],
  • "queued_observations": [
    ],
  • "fields": [
    ],
  • "tiles": [
    ],
  • "plans": [
    ],
  • "name": "string",
  • "type": "imager",
  • "band": "string",
  • "telescope_id": 0,
  • "filters": [
    ],
  • "sensitivity_data": null,
  • "configuration_data": null,
  • "api_classname": "MMAAPI",
  • "api_classname_obsplan": "MMAAPI",
  • "listener_classname": "SEDMListener",
  • "treasuremap_id": 0,
  • "tns_id": 0,
  • "region": "string",
  • "has_fields": true,
  • "has_region": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete an instrument

Delete an instrument

+

Responses

Request samples

Content type
application/json
{
  • "telescope": null,
  • "photometry": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "allocations": [
    ],
  • "observing_runs": [
    ],
  • "observations": [
    ],
  • "queued_observations": [
    ],
  • "fields": [
    ],
  • "tiles": [
    ],
  • "plans": [
    ],
  • "name": "string",
  • "type": "imager",
  • "band": "string",
  • "telescope_id": 0,
  • "filters": [
    ],
  • "sensitivity_data": null,
  • "configuration_data": null,
  • "api_classname": "MMAAPI",
  • "api_classname_obsplan": "MMAAPI",
  • "listener_classname": "SEDMListener",
  • "treasuremap_id": 0,
  • "tns_id": 0,
  • "region": "string",
  • "has_fields": true,
  • "has_region": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete an instrument

Delete an instrument

path Parameters
instrument_id
required
integer
query Parameters
fieldsOnly
boolean

Boolean indicating whether to just delete the associated fields. Defaults to false.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all instruments

Retrieve all instruments

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all instruments

Retrieve all instruments

query Parameters
name
string

Filter by name (exact match)

includeGeoJSON
boolean

Boolean indicating whether to include associated GeoJSON. Defaults to false.

@@ -1126,7 +1126,7 @@

Pagination

airmassTime
string

Time to use for airmass calculation in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sss). Defaults to localizationDateobs if not supplied.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Add a new instrument

Add a new instrument

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Add a new instrument

Add a new instrument

Request Body schema: application/json
telescope
any or null

The Telescope that hosts the Instrument.

photometry
Array of any
photometric_series
Array of any
spectra
Array of any
allocations
Array of any
observing_runs
Array of any
observations
Array of any
queued_observations
Array of any
fields
Array of any
tiles
Array of any
plans
Array of any
name
required
string

Instrument name.

type
required
string <= 20 characters
Enum: "imager" "spectrograph" "imaging spectrograph"

Instrument type, one of Imager, Spectrograph, or Imaging Spectrograph.

@@ -1155,15 +1155,15 @@

Pagination

Single float radius in degrees in case of circle or list of two floats (height and width) in case of a rectangle.

-

Responses

Request samples

Content type
application/json
{
  • "telescope": null,
  • "photometry": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "allocations": [
    ],
  • "observing_runs": [
    ],
  • "observations": [
    ],
  • "queued_observations": [
    ],
  • "fields": [
    ],
  • "tiles": [
    ],
  • "plans": [
    ],
  • "name": "string",
  • "type": "imager",
  • "band": "string",
  • "telescope_id": 0,
  • "filters": [
    ],
  • "sensitivity_data": {
    },
  • "configuration_data": {
    },
  • "api_classname": "MMAAPI",
  • "api_classname_obsplan": "MMAAPI",
  • "listener_classname": "SEDMListener",
  • "treasuremap_id": 0,
  • "tns_id": 0,
  • "region": "string",
  • "has_fields": true,
  • "has_region": true,
  • "field_data": null,
  • "field_region": null,
  • "references": null,
  • "field_fov_type": null,
  • "field_fov_attributes": null
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete a spatial catalog

Delete a spatial catalog

-
path Parameters
catalog_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

earthquakeevents

Perform a prediction analysis for the earthquake.

Perform a prediction analysis for the earthquake.

-
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve a ground velocity measurement for the ear

Retrieve a ground velocity measurement for the earthquake.

-
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Provide a ground velocity measurement for the eart

Provide a ground velocity measurement for the earthquake.

-
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a ground velocity measurement for the earth

Delete a ground velocity measurement for the earthquake.

-
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a ground velocity measurement for the earth

Update a ground velocity measurement for the earthquake.

-
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Get all Earthquake status tags

Get all Earthquake status tags

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete an Earthquake event

Delete an Earthquake event

-
path Parameters
event_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve multiple Earthquake events

Retrieve multiple Earthquake events

+

Responses

Request samples

Content type
application/json
{
  • "telescope": null,
  • "photometry": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "allocations": [
    ],
  • "observing_runs": [
    ],
  • "observations": [
    ],
  • "queued_observations": [
    ],
  • "fields": [
    ],
  • "tiles": [
    ],
  • "plans": [
    ],
  • "name": "string",
  • "type": "imager",
  • "band": "string",
  • "telescope_id": 0,
  • "filters": [
    ],
  • "sensitivity_data": {
    },
  • "configuration_data": {
    },
  • "api_classname": "MMAAPI",
  • "api_classname_obsplan": "MMAAPI",
  • "listener_classname": "SEDMListener",
  • "treasuremap_id": 0,
  • "tns_id": 0,
  • "region": "string",
  • "has_fields": true,
  • "has_region": true,
  • "field_data": null,
  • "field_region": null,
  • "references": null,
  • "field_fov_type": null,
  • "field_fov_attributes": null
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete a spatial catalog

Delete a spatial catalog

+
path Parameters
catalog_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

earthquakeevents

Perform a prediction analysis for the earthquake.

Perform a prediction analysis for the earthquake.

+
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve a ground velocity measurement for the ear

Retrieve a ground velocity measurement for the earthquake.

+
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Provide a ground velocity measurement for the eart

Provide a ground velocity measurement for the earthquake.

+
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a ground velocity measurement for the earth

Delete a ground velocity measurement for the earthquake.

+
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a ground velocity measurement for the earth

Update a ground velocity measurement for the earthquake.

+
path Parameters
earthquake_id
required
string
mma_detector_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Get all Earthquake status tags

Get all Earthquake status tags

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete an Earthquake event

Delete an Earthquake event

+
path Parameters
event_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve multiple Earthquake events

Retrieve multiple Earthquake events

query Parameters
startDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by date >= startDate

endDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by @@ -1176,13 +1176,13 @@

Pagination

Request Body schema: application/json
sent_by
any or null

The user that saved this EarthquakeEvent

notices
Array of any
predictions
Array of any
measurements
Array of any
comments
Array of any
reminders
Array of any
sent_by_id
required
integer

The ID of the User who created this GcnTag.

event_id
required
string
event_uri
string or null
status
string

The status of the earthquake event.

-

Responses

Request samples

Content type
application/json
{
  • "sent_by": null,
  • "notices": [
    ],
  • "predictions": [
    ],
  • "measurements": [
    ],
  • "comments": [
    ],
  • "reminders": [
    ],
  • "sent_by_id": 0,
  • "event_id": "string",
  • "event_uri": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

comments

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+

Responses

Request samples

Content type
application/json
{
  • "sent_by": null,
  • "notices": [
    ],
  • "predictions": [
    ],
  • "measurements": [
    ],
  • "comments": [
    ],
  • "reminders": [
    ],
  • "sent_by_id": 0,
  • "event_id": "string",
  • "event_uri": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

comments

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Update a comment

Update a comment

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Update a comment

Update a comment

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectrum" "gcn_event" "shift"

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event" "shift"

The ID of the source or spectrum @@ -1201,7 +1201,7 @@

Pagination

author_id
required
integer

ID of the Comment author's User instance.

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view comment.

-

Responses

Request samples

Content type
application/json
{
  • "obj": null,
  • "author": null,
  • "groups": [
    ],
  • "obj_id": "string",
  • "text": "string",
  • "attachment_name": "string",
  • "_attachment_path": "string",
  • "origin": "string",
  • "bot": true,
  • "attachment_bytes": "string",
  • "author_id": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Post a comment

Post a comment

+

Responses

Request samples

Content type
application/json
{
  • "obj": null,
  • "author": null,
  • "groups": [
    ],
  • "obj_id": "string",
  • "text": "string",
  • "attachment_name": "string",
  • "_attachment_path": "string",
  • "origin": "string",
  • "bot": true,
  • "attachment_bytes": "string",
  • "author_id": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Post a comment

Post a comment

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectrum" "gcn_event" "earthquake" "shift"

What underlying data the comment is on: "source" or "spectrum" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event" "earthquake" "shift"

The ID of the source or spectrum @@ -1211,21 +1211,21 @@

Pagination

Request Body schema: application/json
text
required
string
group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view comment. Defaults to all of requesting user's groups.

-
object

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "group_ids": [
    ],
  • "attachment": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete a comment

Delete a comment

+
object

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "group_ids": [
    ],
  • "attachment": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete a comment

Delete a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source or spectrum that the comment is posted to. This would be a string for a source ID or an integer for a spectrum or gcn_event.

-
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve a comment

Retrieve a comment

+
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve a comment

Retrieve a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source, spectrum, gcn_event, earthquake, or shift that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update a comment

Update a comment

+
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update a comment

Update a comment

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectrum" "gcn_event" "shift"

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event" "shift"

The ID of the source or spectrum @@ -1244,14 +1244,14 @@

Pagination

author_id
required
integer

ID of the Comment author's User instance.

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view comment.

-

Responses

Request samples

Content type
application/json
{
  • "obj": null,
  • "author": null,
  • "groups": [
    ],
  • "obj_id": "string",
  • "text": "string",
  • "attachment_name": "string",
  • "_attachment_path": "string",
  • "origin": "string",
  • "bot": true,
  • "attachment_bytes": "string",
  • "author_id": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a comment

Delete a comment

+

Responses

Request samples

Content type
application/json
{
  • "obj": null,
  • "author": null,
  • "groups": [
    ],
  • "obj_id": "string",
  • "text": "string",
  • "attachment_name": "string",
  • "_attachment_path": "string",
  • "origin": "string",
  • "bot": true,
  • "attachment_bytes": "string",
  • "author_id": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a comment

Delete a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source or spectrum that the comment is posted to. This would be a string for a source ID or an integer for a spectrum or gcn_event.

-
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Download comment attachment

Download comment attachment

+
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Download comment attachment

Download comment attachment

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectrum" "gcn_event"

What underlying data the comment is on: "sources" or "spectra".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source or spectrum @@ -1270,42 +1270,42 @@

Pagination

comment_id
required
integer
query Parameters
download
boolean

If true, download the attachment; else return file data as text. True by default.

preview
boolean

If true, return an attachment preview. False by default.

Responses

Response samples

Content type
No sample

find the number of comments with and without attac

find the number of comments with and without attachment_bytes

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

create attachments for a batch of comments with at

create attachments for a batch of comments with attachment_bytes

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

create attachments for a batch of comments with at

create attachments for a batch of comments with attachment_bytes

query Parameters
numPerPage
integer

Number of comments to check for updates. Defaults to 100. Max 500.

pageNumber
integer

Page number for iterating through all comments. Defaults to 1

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

spectra

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

spectra

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve a comment

Retrieve a comment

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve a comment

Retrieve a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source, spectrum, gcn_event, earthquake, or shift that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Retrieve a reminder

Retrieve a reminder

+
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Retrieve a reminder

Retrieve a reminder

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift" "earthquake"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake"

resource_id
required
string

The ID of the source, spectrum, gcn_event or shift that the reminder is posted to. This would be a string for a source ID or an integer for a spectrum or gcn_event

-
reminder_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

+
reminder_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum or gcn_event.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve all spectra associated with an Object

Retrieve all spectra associated with an Object

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve all spectra associated with an Object

Retrieve all spectra associated with an Object

path Parameters
obj_id
required
string

ID of the object to retrieve spectra for

query Parameters
normalization
string

what normalization is needed for the spectra (e.g., "median"). If omitted, returns the original spectrum. @@ -1313,41 +1313,41 @@

Pagination

  • median: normalize the flux to have median==1
-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve an annotation

Retrieve an annotation

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve an annotation

Retrieve an annotation

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra" "photometry"

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Retrieve a spectrum

Retrieve a spectrum

-
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update spectrum

Update spectrum

-
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'.

+
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Retrieve a spectrum

Retrieve a spectrum

+
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update spectrum

Update spectrum

+
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
external_reducer
string or null
Default: null

Free text provided as an external reducer

+
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

+
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

+
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

+
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

+
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

external_observer
string or null
Default: null

Free text provided as an external observer

-
obj_id
required
string

ID of this Spectrum's Obj.

-
errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

origin
string

Origin of the spectrum.

-
altdata
any

Miscellaneous alternative metadata.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. + Defaults to 'fsource'.

units
string

Units of the fluxes/errors. Options are Jy, AB, or erg/s/cm/cm/AA).

-
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

+
errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

+
altdata
any

Miscellaneous alternative metadata.

instrument_id
required
integer

ID of the Instrument that acquired the Spectrum.

-
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

-
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

-
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

-
external_reducer
string or null
Default: null

Free text provided as an external reducer

-
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

-
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

-
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

-

Responses

Request samples

Content type
application/json
{
  • "type": "source",
  • "external_observer": null,
  • "obj_id": "string",
  • "errors": [
    ],
  • "origin": "string",
  • "altdata": null,
  • "observed_by": [ ],
  • "units": "string",
  • "assignment_id": 0,
  • "reduced_by": [ ],
  • "instrument_id": 0,
  • "wavelengths": [
    ],
  • "followup_request_id": 0,
  • "fluxes": [
    ],
  • "external_reducer": null,
  • "group_ids": [ ],
  • "label": "string",
  • "observed_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a spectrum

Delete a spectrum

-
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve multiple spectra with given criteria

Retrieve multiple spectra with given criteria

+
obj_id
required
string

ID of this Spectrum's Obj.

+

Responses

Request samples

Content type
application/json
{
  • "external_reducer": null,
  • "observed_by": [ ],
  • "wavelengths": [
    ],
  • "observed_at": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "group_ids": [ ],
  • "fluxes": [
    ],
  • "assignment_id": 0,
  • "external_observer": null,
  • "origin": "string",
  • "followup_request_id": 0,
  • "type": "source",
  • "units": "string",
  • "reduced_by": [ ],
  • "errors": [
    ],
  • "altdata": null,
  • "instrument_id": 0,
  • "obj_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a spectrum

Delete a spectrum

+
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve multiple spectra with given criteria

Retrieve multiple spectra with given criteria

query Parameters
minimalPayload
boolean

If true, return only the minimal metadata about each spectrum, instead of returning the potentially large payload that includes @@ -1386,26 +1386,26 @@

Pagination

commentsFilterAfter
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, only return sources that have comments after this time.

Upload spectrum

Upload spectrum

-
Request Body schema: application/json
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'.

+
Request Body schema: application/json
external_reducer
string or null
Default: null

Free text provided as an external reducer

+
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

+
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

+
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

+
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

+
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

external_observer
string or null
Default: null

Free text provided as an external observer

-
obj_id
required
string

ID of this Spectrum's Obj.

-
errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

origin
string

Origin of the spectrum.

-
altdata
any

Miscellaneous alternative metadata.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. + Defaults to 'fsource'.

units
string

Units of the fluxes/errors. Options are Jy, AB, or erg/s/cm/cm/AA).

-
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

+
errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

+
altdata
any

Miscellaneous alternative metadata.

instrument_id
required
integer

ID of the Instrument that acquired the Spectrum.

-
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

-
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

-
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

-
external_reducer
string or null
Default: null

Free text provided as an external reducer

-
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

-
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

-
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

-

Responses

Request samples

Content type
application/json
{
  • "type": "source",
  • "external_observer": null,
  • "obj_id": "string",
  • "errors": [
    ],
  • "origin": "string",
  • "altdata": null,
  • "observed_by": [ ],
  • "units": "string",
  • "assignment_id": 0,
  • "reduced_by": [ ],
  • "instrument_id": 0,
  • "wavelengths": [
    ],
  • "followup_request_id": 0,
  • "fluxes": [
    ],
  • "external_reducer": null,
  • "group_ids": [ ],
  • "label": "string",
  • "observed_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Parse spectrum from ASCII file

Parse spectrum from ASCII file

+
obj_id
required
string

ID of this Spectrum's Obj.

+

Responses

Request samples

Content type
application/json
{
  • "external_reducer": null,
  • "observed_by": [ ],
  • "wavelengths": [
    ],
  • "observed_at": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "group_ids": [ ],
  • "fluxes": [
    ],
  • "assignment_id": 0,
  • "external_observer": null,
  • "origin": "string",
  • "followup_request_id": 0,
  • "type": "source",
  • "units": "string",
  • "reduced_by": [ ],
  • "errors": [
    ],
  • "altdata": null,
  • "instrument_id": 0,
  • "obj_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Parse spectrum from ASCII file

Parse spectrum from ASCII file

Request Body schema: application/json
ascii
required
string

The content of the ASCII file to be parsed.

The file can optionally contain a header which will be parsed and stored.

The lines that make up the ASCII header must appear at the beginning of the file and all be formatted the same way within a single file. They can be formatted in one of two ways.

@@ -1498,17 +1498,7 @@

Pagination

fluxerr_column
integer or null
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

Responses

Request samples

Content type
application/json
{
  • "ascii": "string",
  • "wave_column": 0,
  • "fluxerr_column": null,
  • "flux_column": 1
}

Response samples

Content type
application/json
{
  • "obj": null,
  • "instrument": null,
  • "groups": [
    ],
  • "reducers": [
    ],
  • "observers": [
    ],
  • "followup_request": null,
  • "assignment": null,
  • "owner": null,
  • "comments": [
    ],
  • "reminders": [
    ],
  • "annotations": [
    ],
  • "wavelengths": [
    ],
  • "fluxes": [
    ],
  • "errors": [
    ],
  • "units": "string",
  • "obj_id": "string",
  • "observed_at": "2019-08-24T14:15:22Z",
  • "origin": "string",
  • "type": "source",
  • "label": "string",
  • "instrument_id": 0,
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "altdata": null,
  • "original_file_string": "string",
  • "original_file_filename": "string"
}

Upload spectrum from ASCII file

Upload spectrum from ASCII file

-
Request Body schema: application/json
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source', 'host', 'host_center'. - Defaults to 'fsource'.

-
external_observer
string or null
Default: null

Free text provided as an external observer

-
obj_id
required
string

The ID of the object that the spectrum is of.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

-
fluxerr_column
integer or null
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

-
filename
required
string

The original filename (for bookkeeping purposes).

-
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

-
reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

-
instrument_id
required
integer

The ID of the instrument that took the spectrum.

-
ascii
required
string

The content of the ASCII file to be parsed.

+
Request Body schema: application/json
ascii
required
string

The content of the ASCII file to be parsed.

The file can optionally contain a header which will be parsed and stored.

The lines that make up the ASCII header must appear at the beginning of the file and all be formatted the same way within a single file. They can be formatted in one of two ways.

1) # KEY: VALUE
@@ -1596,45 +1586,55 @@ 
Pagination

 7985.20 0.732859
 7994.40 1.236514
-
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

-
wave_column
integer
Default: 0

The 0-based index of the ASCII column corresponding to the wavelength values of the spectrum (default 0).

external_reducer
string or null
Default: null

Free text provided as an external reducer

-
group_ids
Array of integers

The IDs of the groups to share this spectrum with.

+
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

label
string

User defined label to be placed in plot legends, instead of the default -.

observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

-
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

-

Responses

Request samples

Content type
application/json
{
  • "type": "source",
  • "external_observer": null,
  • "obj_id": "string",
  • "observed_by": [ ],
  • "fluxerr_column": null,
  • "filename": "string",
  • "assignment_id": 0,
  • "reduced_by": [ ],
  • "instrument_id": 0,
  • "ascii": "string",
  • "followup_request_id": 0,
  • "wave_column": 0,
  • "external_reducer": null,
  • "group_ids": [
    ],
  • "label": "string",
  • "observed_at": "2019-08-24T14:15:22Z",
  • "flux_column": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Create synthetic photometry from a spectrum

Create synthetic photometry from a spectrum

+
group_ids
Array of integers

The IDs of the groups to share this spectrum with.

+
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

+
external_observer
string or null
Default: null

Free text provided as an external observer

+
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

+
wave_column
integer
Default: 0

The 0-based index of the ASCII column corresponding to the wavelength values of the spectrum (default 0).

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source', 'host', 'host_center'. + Defaults to 'fsource'.

+
fluxerr_column
integer or null
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

+
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

+
reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

+
filename
required
string

The original filename (for bookkeeping purposes).

+
instrument_id
required
integer

The ID of the instrument that took the spectrum.

+
obj_id
required
string

The ID of the object that the spectrum is of.

+

Responses

Request samples

Content type
application/json
{
  • "ascii": "string",
  • "external_reducer": null,
  • "observed_by": [ ],
  • "label": "string",
  • "observed_at": "2019-08-24T14:15:22Z",
  • "group_ids": [
    ],
  • "assignment_id": 0,
  • "external_observer": null,
  • "followup_request_id": 0,
  • "wave_column": 0,
  • "type": "source",
  • "fluxerr_column": null,
  • "flux_column": 1,
  • "reduced_by": [ ],
  • "filename": "string",
  • "instrument_id": 0,
  • "obj_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Create synthetic photometry from a spectrum

Create synthetic photometry from a spectrum

path Parameters
spectrum_id
required
integer
query Parameters
filters
required
list

List of filters

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Retrieve spectra for given instrument within date

Retrieve spectra for given instrument within date range

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Retrieve spectra for given instrument within date

Retrieve spectra for given instrument within date range

query Parameters
instrument_ids
list of integers

Instrument id numbers of spectrum. If None, retrieve for all instruments.

min_date
ISO UTC date string

Minimum UTC date of range in ISOT format. If None, open ended range.

max_date
ISO UTC date string

Maximum UTC date of range in ISOT format. If None, open ended range.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve a spectrum

Retrieve a spectrum

-
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update spectrum

Update spectrum

-
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve a spectrum

Retrieve a spectrum

+
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update spectrum

Update spectrum

+
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
external_reducer
string or null
Default: null

Free text provided as an external reducer

+
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

+
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

+
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

+
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

+
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

external_observer
string or null
Default: null

Free text provided as an external observer

-
obj_id
required
string

ID of this Spectrum's Obj.

-
errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

origin
string

Origin of the spectrum.

-
altdata
any

Miscellaneous alternative metadata.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. + Defaults to 'fsource'.

units
string

Units of the fluxes/errors. Options are Jy, AB, or erg/s/cm/cm/AA).

-
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

+
errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

+
altdata
any

Miscellaneous alternative metadata.

instrument_id
required
integer

ID of the Instrument that acquired the Spectrum.

-
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

-
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

-
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

-
external_reducer
string or null
Default: null

Free text provided as an external reducer

-
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

-
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

-
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

-

Responses

Request samples

Content type
application/json
{
  • "type": "source",
  • "external_observer": null,
  • "obj_id": "string",
  • "errors": [
    ],
  • "origin": "string",
  • "altdata": null,
  • "observed_by": [ ],
  • "units": "string",
  • "assignment_id": 0,
  • "reduced_by": [ ],
  • "instrument_id": 0,
  • "wavelengths": [
    ],
  • "followup_request_id": 0,
  • "fluxes": [
    ],
  • "external_reducer": null,
  • "group_ids": [ ],
  • "label": "string",
  • "observed_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a spectrum

Delete a spectrum

-
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve multiple spectra with given criteria

Retrieve multiple spectra with given criteria

+
obj_id
required
string

ID of this Spectrum's Obj.

+

Responses

Request samples

Content type
application/json
{
  • "external_reducer": null,
  • "observed_by": [ ],
  • "wavelengths": [
    ],
  • "observed_at": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "group_ids": [ ],
  • "fluxes": [
    ],
  • "assignment_id": 0,
  • "external_observer": null,
  • "origin": "string",
  • "followup_request_id": 0,
  • "type": "source",
  • "units": "string",
  • "reduced_by": [ ],
  • "errors": [
    ],
  • "altdata": null,
  • "instrument_id": 0,
  • "obj_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a spectrum

Delete a spectrum

+
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve multiple spectra with given criteria

Retrieve multiple spectra with given criteria

query Parameters
minimalPayload
boolean

If true, return only the minimal metadata about each spectrum, instead of returning the potentially large payload that includes @@ -1673,26 +1673,26 @@

Pagination

commentsFilterAfter
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, only return sources that have comments after this time.

Upload spectrum

Upload spectrum

-
Request Body schema: application/json
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'.

+
Request Body schema: application/json
external_reducer
string or null
Default: null

Free text provided as an external reducer

+
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

+
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

+
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

+
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

+
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

+
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

external_observer
string or null
Default: null

Free text provided as an external observer

-
obj_id
required
string

ID of this Spectrum's Obj.

-
errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

origin
string

Origin of the spectrum.

-
altdata
any

Miscellaneous alternative metadata.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

+
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source''host''host_center'. + Defaults to 'fsource'.

units
string

Units of the fluxes/errors. Options are Jy, AB, or erg/s/cm/cm/AA).

-
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

+
errors
Array of numbers

Errors on the fluxes of the spectrum [F_lambda, same units as fluxes.]

+
altdata
any

Miscellaneous alternative metadata.

instrument_id
required
integer

ID of the Instrument that acquired the Spectrum.

-
wavelengths
required
Array of numbers

Wavelengths of the spectrum [Angstrom].

-
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

-
fluxes
required
Array of numbers

Flux of the Spectrum [F_lambda, arbitrary units].

-
external_reducer
string or null
Default: null

Free text provided as an external reducer

-
group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

-
label
string

User defined label (can be used to replace default instrument/date labeling on plot legends).

-
observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

-

Responses

Request samples

Content type
application/json
{
  • "type": "source",
  • "external_observer": null,
  • "obj_id": "string",
  • "errors": [
    ],
  • "origin": "string",
  • "altdata": null,
  • "observed_by": [ ],
  • "units": "string",
  • "assignment_id": 0,
  • "reduced_by": [ ],
  • "instrument_id": 0,
  • "wavelengths": [
    ],
  • "followup_request_id": 0,
  • "fluxes": [
    ],
  • "external_reducer": null,
  • "group_ids": [ ],
  • "label": "string",
  • "observed_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Parse spectrum from ASCII file

Parse spectrum from ASCII file

+
obj_id
required
string

ID of this Spectrum's Obj.

+

Responses

Request samples

Content type
application/json
{
  • "external_reducer": null,
  • "observed_by": [ ],
  • "wavelengths": [
    ],
  • "observed_at": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "group_ids": [ ],
  • "fluxes": [
    ],
  • "assignment_id": 0,
  • "external_observer": null,
  • "origin": "string",
  • "followup_request_id": 0,
  • "type": "source",
  • "units": "string",
  • "reduced_by": [ ],
  • "errors": [
    ],
  • "altdata": null,
  • "instrument_id": 0,
  • "obj_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Parse spectrum from ASCII file

Parse spectrum from ASCII file

Request Body schema: application/json
ascii
required
string

The content of the ASCII file to be parsed.

The file can optionally contain a header which will be parsed and stored.

The lines that make up the ASCII header must appear at the beginning of the file and all be formatted the same way within a single file. They can be formatted in one of two ways.

@@ -1785,17 +1785,7 @@

Pagination

fluxerr_column
integer or null
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

Responses

Request samples

Content type
application/json
{
  • "ascii": "string",
  • "wave_column": 0,
  • "fluxerr_column": null,
  • "flux_column": 1
}

Response samples

Content type
application/json
{
  • "obj": null,
  • "instrument": null,
  • "groups": [
    ],
  • "reducers": [
    ],
  • "observers": [
    ],
  • "followup_request": null,
  • "assignment": null,
  • "owner": null,
  • "comments": [
    ],
  • "reminders": [
    ],
  • "annotations": [
    ],
  • "wavelengths": [
    ],
  • "fluxes": [
    ],
  • "errors": [
    ],
  • "units": "string",
  • "obj_id": "string",
  • "observed_at": "2019-08-24T14:15:22Z",
  • "origin": "string",
  • "type": "source",
  • "label": "string",
  • "instrument_id": 0,
  • "followup_request_id": 0,
  • "assignment_id": 0,
  • "altdata": null,
  • "original_file_string": "string",
  • "original_file_filename": "string"
}

Upload spectrum from ASCII file

Upload spectrum from ASCII file

-
Request Body schema: application/json
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source', 'host', 'host_center'. - Defaults to 'fsource'.

-
external_observer
string or null
Default: null

Free text provided as an external observer

-
obj_id
required
string

The ID of the object that the spectrum is of.

-
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

-
fluxerr_column
integer or null
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

-
filename
required
string

The original filename (for bookkeeping purposes).

-
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

-
reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

-
instrument_id
required
integer

The ID of the instrument that took the spectrum.

-
ascii
required
string

The content of the ASCII file to be parsed.

+
Request Body schema: application/json
ascii
required
string

The content of the ASCII file to be parsed.

The file can optionally contain a header which will be parsed and stored.

The lines that make up the ASCII header must appear at the beginning of the file and all be formatted the same way within a single file. They can be formatted in one of two ways.

1) # KEY: VALUE
@@ -1883,21 +1873,31 @@ 
Pagination

 7985.20 0.732859
 7994.40 1.236514
-
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

-
wave_column
integer
Default: 0

The 0-based index of the ASCII column corresponding to the wavelength values of the spectrum (default 0).

external_reducer
string or null
Default: null

Free text provided as an external reducer

-
group_ids
Array of integers

The IDs of the groups to share this spectrum with.

+
observed_by
Array of integers
Default: []

IDs of the Users who observed this Spectrum, or to use as points of contact given an external observer.

label
string

User defined label to be placed in plot legends, instead of the default -.

observed_at
required
string <date-time>

The ISO UTC time the spectrum was taken.

-
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

-

Responses

Request samples

Content type
application/json
{
  • "type": "source",
  • "external_observer": null,
  • "obj_id": "string",
  • "observed_by": [ ],
  • "fluxerr_column": null,
  • "filename": "string",
  • "assignment_id": 0,
  • "reduced_by": [ ],
  • "instrument_id": 0,
  • "ascii": "string",
  • "followup_request_id": 0,
  • "wave_column": 0,
  • "external_reducer": null,
  • "group_ids": [
    ],
  • "label": "string",
  • "observed_at": "2019-08-24T14:15:22Z",
  • "flux_column": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve spectra for given instrument within date

Retrieve spectra for given instrument within date range

+
group_ids
Array of integers

The IDs of the groups to share this spectrum with.

+
assignment_id
integer

ID of the classical assignment that generated this spectrum, if any.

+
external_observer
string or null
Default: null

Free text provided as an external observer

+
followup_request_id
integer

ID of the Followup request that generated this spectrum, if any.

+
wave_column
integer
Default: 0

The 0-based index of the ASCII column corresponding to the wavelength values of the spectrum (default 0).

+
type
string
Enum: "source" "host" "host_center"

Type of spectrum. One of: 'source', 'host', 'host_center'. + Defaults to 'fsource'.

+
fluxerr_column
integer or null
Default: null

The 0-based index of the ASCII column corresponding to the flux error values of the spectrum (default None). If a column for errors is provided, set to the corresponding 0-based column number, otherwise, it will be ignored.

+
flux_column
integer
Default: 1

The 0-based index of the ASCII column corresponding to the flux values of the spectrum (default 1).

+
reduced_by
Array of integers
Default: []

IDs of the Users who reduced this Spectrum, or to use as points of contact given an external reducer.

+
filename
required
string

The original filename (for bookkeeping purposes).

+
instrument_id
required
integer

The ID of the instrument that took the spectrum.

+
obj_id
required
string

The ID of the object that the spectrum is of.

+

Responses

Request samples

Content type
application/json
{
  • "ascii": "string",
  • "external_reducer": null,
  • "observed_by": [ ],
  • "label": "string",
  • "observed_at": "2019-08-24T14:15:22Z",
  • "group_ids": [
    ],
  • "assignment_id": 0,
  • "external_observer": null,
  • "followup_request_id": 0,
  • "wave_column": 0,
  • "type": "source",
  • "fluxerr_column": null,
  • "flux_column": 1,
  • "reduced_by": [ ],
  • "filename": "string",
  • "instrument_id": 0,
  • "obj_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve spectra for given instrument within date

Retrieve spectra for given instrument within date range

query Parameters
instrument_ids
list of integers

Instrument id numbers of spectrum. If None, retrieve for all instruments.

min_date
ISO UTC date string

Minimum UTC date of range in ISOT format. If None, open ended range.

max_date
ISO UTC date string

Maximum UTC date of range in ISOT format. If None, open ended range.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Submit a (classification) spectrum to TNS

Submit a (classification) spectrum to TNS

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Submit a (classification) spectrum to TNS

Submit a (classification) spectrum to TNS

path Parameters
spectrum_id
required
integer
query Parameters
tnsrobotID
required
int

SkyPortal TNS Robot ID

classificationID
string

Classification ID (see TNS documentation at https://www.wis-tns.org/content/tns-getting-started @@ -1907,55 +1907,55 @@

Pagination

['object', 'host', 'sky', 'arcs', 'synthetic']

spectrumComment
string

Comment on the spectrum.

classificationComment
string

Comment on the classification.

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

sources

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

sources

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve a comment

Retrieve a comment

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve a comment

Retrieve a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source, spectrum, gcn_event, earthquake, or shift that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Retrieve a reminder

Retrieve a reminder

+
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Retrieve a reminder

Retrieve a reminder

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift" "earthquake"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake"

resource_id
required
string

The ID of the source, spectrum, gcn_event or shift that the reminder is posted to. This would be a string for a source ID or an integer for a spectrum or gcn_event

-
reminder_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

+
reminder_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum or gcn_event.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

calculate healpix values for a batch of sources wi

calculate healpix values for a batch of sources without a Healpix value

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

calculate healpix values for a batch of sources wi

calculate healpix values for a batch of sources without a Healpix value

query Parameters
numPerPage
integer

Number of sources to check for updates. Defaults to 100. Max 500.

pageNumber
integer

Page number for iterating through all sources. Defaults to 1

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

path Parameters
shift_id
required
integer
query Parameters
startDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by shift.start_date >= startDate

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Copy all photometry points from one source to anot

Copy all photometry points from one source to another

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Copy all photometry points from one source to anot

Copy all photometry points from one source to another

path Parameters
target_id
required
string

The obj_id of the target Source (to which the photometry is being copied to)

Request Body schema: application/json
group_ids
required
Array of integers

List of IDs of groups to give photometry access to

origin_id
required
string

The ID of the Source's Obj the photometry is being copied from

-

Responses

Request samples

Content type
application/json
{
  • "group_ids": [
    ],
  • "origin_id": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve offset stars to aid in spectroscopy

Retrieve offset stars to aid in spectroscopy

+

Responses

Request samples

Content type
application/json
{
  • "group_ids": [
    ],
  • "origin_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve offset stars to aid in spectroscopy

Retrieve offset stars to aid in spectroscopy

path Parameters
obj_id
required
string
query Parameters
facility
string
Enum: "Keck" "Shane" "P200"

Which facility to generate the starlist for

num_offset_stars
integer [ 0 .. 10 ]

Requested number of offset stars (set to zero to get starlist of just the source itself)

obstime
string

datetime of observation in isoformat (e.g. 2020-12-30T12:34:10)

use_ztfref
boolean

Use ZTFref catalog for offset star positions, otherwise Gaia DR3

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Generate a PDF/PNG finding chart to aid in spectro

Generate a PDF/PNG finding chart to aid in spectroscopy

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Generate a PDF/PNG finding chart to aid in spectro

Generate a PDF/PNG finding chart to aid in spectroscopy

path Parameters
obj_id
required
string
query Parameters
imsize
float [ 2 .. 15 ]

Image size in arcmin (square)

facility
string
Enum: "Keck" "Shane" "P200"
image_source
string
Enum: "desi" "dss" "ztfref" "ps1"

Source of the image used in the finding chart. Defaults to ps1

use_ztfref
boolean

Use ZTFref catalog for offset star positions, otherwise DR3

@@ -1963,28 +1963,28 @@

Pagination

type
string
Enum: "png" "pdf"

output type

num_offset_stars
integer [ 0 .. 4 ]

output desired number of offset stars [0,5] (default: 3)

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "status": "error",
  • "message": "string"
}

Retrieve an object's classifications

Retrieve an object's classifications

-
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Delete all of an object's classifications

Delete all of an object's classifications

+

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { },
  • "status": "error"
}

Retrieve an object's classifications

Retrieve an object's classifications

+
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Delete all of an object's classifications

Delete all of an object's classifications

path Parameters
classification_id
required
integer
Request Body schema: application/json
label
boolean or null

Add label associated with classification.

-

Responses

Request samples

Content type
application/json
{
  • "label": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve basic info on Groups that an Obj is saved

Retrieve basic info on Groups that an Obj is saved to

-
path Parameters
obj_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Note that a source has been labelled.

Note that a source has been labelled.

+

Responses

Request samples

Content type
application/json
{
  • "label": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve basic info on Groups that an Obj is saved

Retrieve basic info on Groups that an Obj is saved to

+
path Parameters
obj_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Note that a source has been labelled.

Note that a source has been labelled.

path Parameters
obj_id
required
string

ID of object to indicate source labelling for

Request Body schema: application/json
groupIds
required
Array of integers

List of IDs of groups to indicate labelling for

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete source labels

Delete source labels

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete source labels

Delete source labels

path Parameters
obj_id
required
string
Request Body schema: application/json
groupIds
required
Array of integers

List of IDs of groups to indicate scanning for

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve an annotation

Retrieve an annotation

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve an annotation

Retrieve an annotation

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra" "photometry"

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Retrieve a source

Retrieve a source

+
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Retrieve a source

Retrieve a source

path Parameters
obj_id
required
string
query Parameters
includePhotometry
boolean

Boolean indicating whether to include associated photometry. Defaults to false.

includeComments
boolean

Boolean indicating whether to include comment metadata in response. @@ -1996,9 +1996,9 @@

Pagination

includeCommentExists
boolean

Boolean indicating whether to return if a source has a comment. Defaults to false.

includePeriodExists
boolean

Boolean indicating whether to return if a source has a period set. Defaults to false.

includeThumbnails
boolean

Boolean indicating whether to include associated thumbnails. Defaults to false.

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a source

Delete a source

-
path Parameters
obj_id
required
string
group_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Check if a Source exists

Check if a Source exists

-
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a source

Update a source

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a source

Delete a source

+
path Parameters
obj_id
required
string
group_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Check if a Source exists

Check if a Source exists

+
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a source

Update a source

path Parameters
obj_id
required
string
Request Body schema: application/json
host
any or null

The Galaxy associated with this source.

comments
Array of any
reminders
Array of any
comments_on_spectra
Array of any
reminders_on_spectra
Array of any
annotations
Array of any
annotations_on_spectra
Array of any
annotations_on_photometry
Array of any
classifications
Array of any
photometry
Array of any
photstats
Array of any
photometric_series
Array of any
spectra
Array of any
thumbnails
Array of any
followup_requests
Array of any
assignments
Array of any
obj_notifications
Array of any
obj_analyses
Array of any
sources_in_gcns
Array of any
ra_dis
number or null

J2000 Right Ascension at discovery time [deg].

dec_dis
number or null

J2000 Declination at discovery time [deg].

@@ -2027,7 +2027,7 @@

Pagination

alias
any or null

Alternative names for this object.

internal_key
string

Internal key used for secure websocket messaging.

detect_photometry_count
integer or null

How many times the object was detected above :math:S/N = phot_detection_threshold (3.0 by default).

-
ra
number or null
dec
number or null
candidates
Array of any
sources
Array of any
users
Array of any

Responses

Request samples

Content type
application/json
{
  • "host": null,
  • "comments": [
    ],
  • "reminders": [
    ],
  • "comments_on_spectra": [
    ],
  • "reminders_on_spectra": [
    ],
  • "annotations": [
    ],
  • "annotations_on_spectra": [
    ],
  • "annotations_on_photometry": [
    ],
  • "classifications": [
    ],
  • "photometry": [
    ],
  • "photstats": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "thumbnails": [
    ],
  • "followup_requests": [
    ],
  • "assignments": [
    ],
  • "obj_notifications": [
    ],
  • "obj_analyses": [
    ],
  • "sources_in_gcns": [
    ],
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "redshift_error": 0,
  • "redshift_origin": "string",
  • "redshift_history": null,
  • "host_id": 0,
  • "summary": "string",
  • "summary_history": null,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "mpc_name": "string",
  • "tns_name": "string",
  • "tns_info": null,
  • "score": 0,
  • "origin": "string",
  • "alias": null,
  • "internal_key": "string",
  • "detect_photometry_count": 0,
  • "ra": 0,
  • "dec": 0,
  • "candidates": [
    ],
  • "sources": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all sources

Retrieve all sources

+
ra
number or null
dec
number or null
candidates
Array of any
sources
Array of any
users
Array of any

Responses

Request samples

Content type
application/json
{
  • "host": null,
  • "comments": [
    ],
  • "reminders": [
    ],
  • "comments_on_spectra": [
    ],
  • "reminders_on_spectra": [
    ],
  • "annotations": [
    ],
  • "annotations_on_spectra": [
    ],
  • "annotations_on_photometry": [
    ],
  • "classifications": [
    ],
  • "photometry": [
    ],
  • "photstats": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "thumbnails": [
    ],
  • "followup_requests": [
    ],
  • "assignments": [
    ],
  • "obj_notifications": [
    ],
  • "obj_analyses": [
    ],
  • "sources_in_gcns": [
    ],
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "redshift_error": 0,
  • "redshift_origin": "string",
  • "redshift_history": null,
  • "host_id": 0,
  • "summary": "string",
  • "summary_history": null,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "mpc_name": "string",
  • "tns_name": "string",
  • "tns_info": null,
  • "score": 0,
  • "origin": "string",
  • "alias": null,
  • "internal_key": "string",
  • "detect_photometry_count": 0,
  • "ra": 0,
  • "dec": 0,
  • "candidates": [
    ],
  • "sources": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all sources

Retrieve all sources

query Parameters
ra
number

RA for spatial filtering (in decimal degrees)

dec
number

Declination for spatial filtering (in decimal degrees)

radius
number

Radius for spatial filtering if ra & dec are provided (in decimal degrees)

@@ -2142,7 +2142,7 @@

Pagination

spatialCatalogEntryName
string

Name of spatial catalog entry to use. spatialCatalogName must also be defined for use.

includeGeoJSON
boolean

Boolean indicating whether to include associated GeoJSON. Defaults to false.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Add a new source

Add a new source

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Add a new source

Add a new source

Request Body schema: application/json
host
any or null

The Galaxy associated with this source.

comments
Array of any
reminders
Array of any
comments_on_spectra
Array of any
reminders_on_spectra
Array of any
annotations
Array of any
annotations_on_spectra
Array of any
annotations_on_photometry
Array of any
classifications
Array of any
photometry
Array of any
photstats
Array of any
photometric_series
Array of any
spectra
Array of any
thumbnails
Array of any
followup_requests
Array of any
assignments
Array of any
obj_notifications
Array of any
obj_analyses
Array of any
sources_in_gcns
Array of any
id
required
string

Name of the object.

ra_dis
number or null

J2000 Right Ascension at discovery time [deg].

@@ -2173,7 +2173,7 @@

Pagination

ra
number or null
dec
number or null
candidates
Array of any
sources
Array of any
users
Array of any
group_ids
Array of integers

List of associated group IDs. If not specified, all of the user or token's groups will be used.

refresh_source
bool

Refresh source upon post. Defaults to True.

-

Responses

Request samples

Content type
application/json
{
  • "host": null,
  • "comments": [
    ],
  • "reminders": [
    ],
  • "comments_on_spectra": [
    ],
  • "reminders_on_spectra": [
    ],
  • "annotations": [
    ],
  • "annotations_on_spectra": [
    ],
  • "annotations_on_photometry": [
    ],
  • "classifications": [
    ],
  • "photometry": [
    ],
  • "photstats": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "thumbnails": [
    ],
  • "followup_requests": [
    ],
  • "assignments": [
    ],
  • "obj_notifications": [
    ],
  • "obj_analyses": [
    ],
  • "sources_in_gcns": [
    ],
  • "id": "string",
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "redshift_error": 0,
  • "redshift_origin": "string",
  • "host_id": 0,
  • "summary": "string",
  • "summary_history": null,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "mpc_name": "string",
  • "tns_name": "string",
  • "tns_info": null,
  • "score": 0,
  • "origin": "string",
  • "alias": null,
  • "healpix": 0,
  • "detect_photometry_count": 0,
  • "ra": 0,
  • "dec": 0,
  • "candidates": [
    ],
  • "sources": [
    ],
  • "users": [
    ],
  • "group_ids": [
    ],
  • "refresh_source": null
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve a source

Retrieve a source

+

Responses

Request samples

Content type
application/json
{
  • "host": null,
  • "comments": [
    ],
  • "reminders": [
    ],
  • "comments_on_spectra": [
    ],
  • "reminders_on_spectra": [
    ],
  • "annotations": [
    ],
  • "annotations_on_spectra": [
    ],
  • "annotations_on_photometry": [
    ],
  • "classifications": [
    ],
  • "photometry": [
    ],
  • "photstats": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "thumbnails": [
    ],
  • "followup_requests": [
    ],
  • "assignments": [
    ],
  • "obj_notifications": [
    ],
  • "obj_analyses": [
    ],
  • "sources_in_gcns": [
    ],
  • "id": "string",
  • "ra_dis": 0,
  • "dec_dis": 0,
  • "ra_err": 0,
  • "dec_err": 0,
  • "offset": 0,
  • "redshift": 0,
  • "redshift_error": 0,
  • "redshift_origin": "string",
  • "host_id": 0,
  • "summary": "string",
  • "summary_history": null,
  • "altdata": null,
  • "dist_nearest_source": 0,
  • "mag_nearest_source": 0,
  • "e_mag_nearest_source": 0,
  • "transient": true,
  • "varstar": true,
  • "is_roid": true,
  • "mpc_name": "string",
  • "tns_name": "string",
  • "tns_info": null,
  • "score": 0,
  • "origin": "string",
  • "alias": null,
  • "healpix": 0,
  • "detect_photometry_count": 0,
  • "ra": 0,
  • "dec": 0,
  • "candidates": [
    ],
  • "sources": [
    ],
  • "users": [
    ],
  • "group_ids": [
    ],
  • "refresh_source": null
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve a source

Retrieve a source

path Parameters
obj_id
required
string

Retrieve all sources

Retrieve all sources

query Parameters
ra
number

RA for spatial filtering (in decimal degrees)

dec
number

Declination for spatial filtering (in decimal degrees)

@@ -2182,45 +2182,45 @@

Pagination

Request Body schema: application/json
objId
required
string

ID of the object in question.

inviteGroupIds
required
Array of integers

List of group IDs to save or invite to save specified source.

unsaveGroupIds
Array of integers

List of group IDs from which specified source is to be unsaved.

-

Responses

Request samples

Content type
application/json
{
  • "objId": "string",
  • "inviteGroupIds": [
    ],
  • "unsaveGroupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a Source table row

Update a Source table row

-
path Parameters
obj_id
required
integer
Request Body schema: application/json
groupID
required
integer
active
required
boolean
requested
required
boolean

Responses

Request samples

Content type
application/json
{
  • "groupID": 0,
  • "active": true,
  • "requested": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

gcn_events

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+

Responses

Request samples

Content type
application/json
{
  • "objId": "string",
  • "inviteGroupIds": [
    ],
  • "unsaveGroupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a Source table row

Update a Source table row

+
path Parameters
obj_id
required
integer
Request Body schema: application/json
groupID
required
integer
active
required
boolean
requested
required
boolean

Responses

Request samples

Content type
application/json
{
  • "groupID": 0,
  • "active": true,
  • "requested": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

gcn_events

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

earthquakes

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

earthquakes

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve a comment

Retrieve a comment

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve a comment

Retrieve a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source, spectrum, gcn_event, earthquake, or shift that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

shifts

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

+
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

shifts

Retrieve all comments associated with specified re

Retrieve all comments associated with specified resource

path Parameters
associated_resource_type
required
string
Value: "sources"

What underlying data the comment is on, e.g., "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum, gcn_event, earthquake, or shift.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve a comment

Retrieve a comment

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve a comment

Retrieve a comment

path Parameters
associated_resource_type
required
string

What underlying data the comment is on: "sources" or "spectra" or "gcn_event" or "earthquake" or "shift".

resource_id
required
string
Enum: "sources" "spectra" "gcn_event"

The ID of the source, spectrum, gcn_event, earthquake, or shift that the comment is posted to. This would be a string for a source ID or an integer for a spectrum, gcn_event, earthquake, or shift.

-
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

+
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

path Parameters
shift_id
required
integer
query Parameters
startDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by shift.start_date >= startDate

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve shifts

Retrieve shifts

-
path Parameters
shift_id
required
integer
query Parameters
group_id
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Delete a shift

Delete a shift

-
path Parameters
shift_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a shift

Update a shift

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve shifts

Retrieve shifts

+
path Parameters
shift_id
required
integer
query Parameters
group_id
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Delete a shift

Delete a shift

+
path Parameters
shift_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a shift

Update a shift

path Parameters
shift_id
required
integer
Request Body schema: application/json
group
any or null

The Shift's Group.

users
Array of any
shift_users
Array of any
comments
Array of any
reminders
Array of any
name
string or null

Name of the shift.

description
string or null

Longer description of the shift.

@@ -2228,7 +2228,7 @@

Pagination

end_date
required
string <date-time>

The end time of this shift.

group_id
required
integer

ID of the Shift's Group.

required_users_number
integer or null

The number of users required to join this shift for it to be considered full

-

Responses

Request samples

Content type
application/json
{
  • "group": null,
  • "users": [
    ],
  • "shift_users": [
    ],
  • "comments": [
    ],
  • "reminders": [
    ],
  • "name": "string",
  • "description": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "group_id": 0,
  • "required_users_number": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Add a new shift

Add a new shift

+

Responses

Request samples

Content type
application/json
{
  • "group": null,
  • "users": [
    ],
  • "shift_users": [
    ],
  • "comments": [
    ],
  • "reminders": [
    ],
  • "name": "string",
  • "description": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "group_id": 0,
  • "required_users_number": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Add a new shift

Add a new shift

Request Body schema: application/json
group
any or null

The Shift's Group.

users
Array of any
shift_users
Array of any
comments
Array of any
reminders
Array of any
name
string or null

Name of the shift.

description
string or null

Longer description of the shift.

@@ -2238,24 +2238,24 @@

Pagination

required_users_number
integer or null

The number of users required to join this shift for it to be considered full

shift_admins
Array of integers

List of IDs of users to be shift admins. Current user will automatically be added as a shift admin.

-

Responses

Request samples

Content type
application/json
{
  • "group": null,
  • "users": [
    ],
  • "shift_users": [
    ],
  • "comments": [
    ],
  • "reminders": [
    ],
  • "name": "string",
  • "description": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "group_id": 0,
  • "required_users_number": 0,
  • "shift_admins": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Add a shift user

Add a shift user

-
path Parameters
shift_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
required
boolean

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete a shift user

Delete a shift user

-
path Parameters
shift_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a shift user's admin status, or needs_repla

Update a shift user's admin status, or needs_replacement status

+

Responses

Request samples

Content type
application/json
{
  • "group": null,
  • "users": [
    ],
  • "shift_users": [
    ],
  • "comments": [
    ],
  • "reminders": [
    ],
  • "name": "string",
  • "description": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "group_id": 0,
  • "required_users_number": 0,
  • "shift_admins": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Add a shift user

Add a shift user

+
path Parameters
shift_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
required
boolean

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete a shift user

Delete a shift user

+
path Parameters
shift_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a shift user's admin status, or needs_repla

Update a shift user's admin status, or needs_replacement status

path Parameters
shift_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
boolean

Boolean indicating whether user is shift admin.

needs_replacement
boolean

Boolean indicating whether user needs replacement or not

-

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "needs_replacement": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

annotations

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "needs_replacement": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

annotations

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Update an annotation

Update an annotation

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Update an annotation

Update an annotation

path Parameters
associated_resource_type
required
string

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. @@ -2269,7 +2269,7 @@

Pagination

obj_id
required
string

ID of the Annotation's Obj.

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view the annotation.

-

Responses

Request samples

Content type
application/json
{
  • "author": null,
  • "obj": null,
  • "groups": [
    ],
  • "data": null,
  • "origin": "string",
  • "author_id": 0,
  • "obj_id": "string",
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Post an annotation

Post an annotation

+

Responses

Request samples

Content type
application/json
{
  • "author": null,
  • "obj": null,
  • "groups": [
    ],
  • "data": null,
  • "origin": "string",
  • "author_id": 0,
  • "obj_id": "string",
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Post an annotation

Post an annotation

path Parameters
associated_resource_type
required
string

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. @@ -2287,19 +2287,19 @@

Pagination

data
required
object
group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view annotation. Defaults to all of requesting user's groups.

-

Responses

Request samples

Content type
application/json
{
  • "origin": "string",
  • "data": { },
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete an annotation

Delete an annotation

+

Responses

Request samples

Content type
application/json
{
  • "origin": "string",
  • "data": { },
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete an annotation

Delete an annotation

path Parameters
associated_resource_type
required
string

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for a spectrum.

-
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve an annotation

Retrieve an annotation

+
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve an annotation

Retrieve an annotation

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra" "photometry"

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update an annotation

Update an annotation

+
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update an annotation

Update an annotation

path Parameters
associated_resource_type
required
string

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. @@ -2313,29 +2313,29 @@

Pagination

obj_id
required
string

ID of the Annotation's Obj.

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view the annotation.

-

Responses

Request samples

Content type
application/json
{
  • "author": null,
  • "obj": null,
  • "groups": [
    ],
  • "data": null,
  • "origin": "string",
  • "author_id": 0,
  • "obj_id": "string",
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete an annotation

Delete an annotation

+

Responses

Request samples

Content type
application/json
{
  • "author": null,
  • "obj": null,
  • "groups": [
    ],
  • "data": null,
  • "origin": "string",
  • "author_id": 0,
  • "obj_id": "string",
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete an annotation

Delete an annotation

path Parameters
associated_resource_type
required
string

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for a spectrum.

-
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

photometry

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

photometry

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Get all GCN Event tags

Get all GCN Event tags

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Get all GCN Event properties

Get all GCN Event properties

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

retrieve the PhotStat associated with the obj_id.

retrieve the PhotStat associated with the obj_id.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Get all GCN Event tags

Get all GCN Event tags

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Get all GCN Event properties

Get all GCN Event properties

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

retrieve the PhotStat associated with the obj_id.

retrieve the PhotStat associated with the obj_id.

path Parameters
obj_id
required
string

object ID to get statistics on

Responses

Response samples

Content type
application/json
{
  • "obj": null,
  • "last_update": "2019-08-24T14:15:22Z",
  • "last_full_update": "2019-08-24T14:15:22Z",
  • "obj_id": "string",
  • "num_obs_global": 0,
  • "num_obs_per_filter": null,
  • "num_det_global": 0,
  • "num_det_per_filter": null,
  • "first_detected_mjd": 0,
  • "first_detected_mag": 0,
  • "first_detected_filter": "string",
  • "last_detected_mjd": 0,
  • "last_detected_mag": 0,
  • "last_detected_filter": "string",
  • "recent_obs_mjd": 0,
  • "predetection_mjds": null,
  • "last_non_detection_mjd": 0,
  • "time_to_non_detection": 0,
  • "mean_mag_global": 0,
  • "mean_mag_per_filter": null,
  • "mean_color": null,
  • "peak_mjd_global": 0,
  • "peak_mjd_per_filter": null,
  • "peak_mag_global": 0,
  • "peak_mag_per_filter": null,
  • "faintest_mag_global": 0,
  • "faintest_mag_per_filter": null,
  • "deepest_limit_global": 0,
  • "deepest_limit_per_filter": null,
  • "rise_rate": 0,
  • "decay_rate": 0,
  • "mag_rms_global": 0,
  • "mag_rms_per_filter": null,
  • "id": 0
}

create or update the PhotStat associated with the

create or update the PhotStat associated with the obj_id.

path Parameters
obj_id
required
string

object ID to get statistics on

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

create a new PhotStat to be associated with the ob

create a new PhotStat to be associated with the obj_id.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

create a new PhotStat to be associated with the ob

create a new PhotStat to be associated with the obj_id.

path Parameters
obj_id
required
string

object ID to get statistics on

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

delete the PhotStat associated with the obj_id.

delete the PhotStat associated with the obj_id.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

delete the PhotStat associated with the obj_id.

delete the PhotStat associated with the obj_id.

path Parameters
obj_id
required
string

object ID to get statistics on

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

find the number of sources with and without a Phot

find the number of sources with and without a PhotStat object

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

find the number of sources with and without a Phot

find the number of sources with and without a PhotStat object

query Parameters
createdAtStartTime
string

arrow parseable string, only objects that have been created after this time will be checked for missing/existing PhotStats.

@@ -2356,7 +2356,7 @@

Pagination

fullUpdateEndTime
string

arrow parseable string, any object's PhotStat that has been fully updated before this time will be counted.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

calculate photometric stats for a batch of sources

calculate photometric stats for a batch of sources without a PhotStat

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

calculate photometric stats for a batch of sources

calculate photometric stats for a batch of sources without a PhotStat

query Parameters
numPerPage
integer

Number of sources to check for updates. Defaults to 100. Max 500.

pageNumber
integer

Page number for iterating through all sources. Defaults to 1

createdAtStartTime
string

arrow parseable string, only objects @@ -2365,7 +2365,7 @@

Pagination

createdAtEndTime
string

arrow parseable string, only objects that have been created before this time will be checked for missing PhotStats.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

manually recalculate the photometric stats for a b

manually recalculate the photometric stats for a batch of sources

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

manually recalculate the photometric stats for a b

manually recalculate the photometric stats for a batch of sources

query Parameters
numPerPage
integer

Number of sources to check for updates. Defaults to 100. Max 500.

pageNumber
integer

Page number for iterating through all sources. Defaults to 1

createdAtStartTime
string

arrow parseable string, only objects @@ -2388,60 +2388,60 @@

Pagination

fullUpdateEndTime
string

arrow parseable string, any object's PhotStat that has been fully updated before this time will be recalculated.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Get all Localization tags

Get all Localization tags

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Get all Localization properties

Get all Localization properties

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve photometry

Retrieve photometry

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Get all Localization tags

Get all Localization tags

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Get all Localization properties

Get all Localization properties

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve photometry

Retrieve photometry

path Parameters
photometry_id
required
integer
query Parameters
format
string
Enum: "mag" "flux"

Return the photometry in flux or magnitude space? If a value for this query parameter is not provided, the result will be returned in magnitude space.

magsys
string
Enum: "jla1" "ab" "vega" "bd17" "csp" "ab-b12"

The magnitude or zeropoint system of the output. (Default AB)

-

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete photometry

Delete photometry

-
path Parameters
photometry_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update photometry

Update photometry

-
path Parameters
photometry_id
required
integer
Request Body schema: application/json
One of
dec_unc
number or null
Default: null

Uncertainty on dec [arcsec].

+

Responses

Response samples

Content type
application/json
Example
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete photometry

Delete photometry

+
path Parameters
photometry_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update photometry

Update photometry

+
path Parameters
photometry_id
required
integer
Request Body schema: application/json
One of
magsys
required
any
Enum: "jla1" "ab" "vega" "bd17" "csp" "ab-b12"

The magnitude system to which the flux and the zeropoint are tied.

+
ra_unc
number or null
Default: null

Uncertainty on RA [arcsec].

+
ra
number or null
Default: null

ICRS Right Ascension of the centroid of the photometric aperture [deg].

+
magref
any or null
Default: null

Magnitude of the reference image. in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed if no reference is given.

+
mjd
required
number

MJD of the observation.

dec
number or null
Default: null

ICRS Declination of the centroid of the photometric aperture [deg].

-
obj_id
required
string

ID of the Object to which the photometry will be attached.

-
magsys
required
any
Enum: "jla1" "ab" "vega" "bd17" "csp" "ab-b12"

The magnitude system to which the flux and the zeropoint are tied.

+
assignment_id
integer or null
Default: null

ID of the classical assignment which generated the photometry

+
mag
number or null
Default: null

Magnitude of the observation in the magnitude system magsys. Can be null in the case of a non-detection.

origin
any or null
Default: null

Provenance of the Photometry. If a record is already present with identical origin, only the groups or streams list will be updated (other data assumed identical). Defaults to None.

-
altdata
object or null
Default: null

Misc. alternative metadata stored in JSON format, e.g. {'calibration': {'source': 'ps1','color_term': 0.012}, 'photometry_method': 'allstar', 'method_reference': 'Masci et al. (2015)'}

+
dec_unc
number or null
Default: null

Uncertainty on dec [arcsec].

limiting_mag
required
number

Limiting magnitude of the image in the magnitude system magsys.

-
ra_unc
number or null
Default: null

Uncertainty on RA [arcsec].

-
assignment_id
integer or null
Default: null

ID of the classical assignment which generated the photometry

-
e_magref
any or null
Default: null

Gaussian error on the reference magnitude. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

filter
required
any
Enum: "bessellux" "bessellb" "bessellv" "bessellr" "besselli" "standard::u" "standard::b" "standard::v" "standard::r" "standard::i" "desu" "desg" "desr" "desi" "desz" "desy" "sdssu" "sdssg" "sdssr" "sdssi" "sdssz" "f435w" "f475w" "f555w" "f606w" "f625w" "f775w" "f850lp" "nicf110w" "nicf160w" "f098m" "f105w" "f110w" "f125w" "f127m" "f139m" "f140w" "f153m" "f160w" "f218w" "f225w" "f275w" "f300x" "f336w" "f350lp" "f390w" "f689m" "f763m" "f845m" "f438w" "uvf475w" "uvf555w" "uvf606w" "uvf625w" "uvf775w" "uvf814w" "uvf850lp" "kepler" "cspb" "csphs" "csphd" "cspjs" "cspjd" "cspv3009" "cspv3014" "cspv9844" "cspys" "cspyd" "cspg" "cspi" "cspk" "cspr" "cspu" "f070w" "f090w" "f115w" "f150w" "f200w" "f277w" "f356w" "f444w" "f140m" "f162m" "f182m" "f210m" "f250m" "f300m" "f335m" "f360m" "f410m" "f430m" "f460m" "f480m" "f560w" "f770w" "f1000w" "f1130w" "f1280w" "f1500w" "f1800w" "f2100w" "f2550w" "f1065c" "f1140c" "f1550c" "f2300c" "lsstu" "lsstg" "lsstr" "lssti" "lsstz" "lssty" "keplercam::us" "keplercam::b" "keplercam::v" "keplercam::r" "keplercam::i" "4shooter2::us" "4shooter2::b" "4shooter2::v" "4shooter2::r" "4shooter2::i" "f062" "f087" "f106" "f129" "f158" "f184" "f213" "f146" "ztfg" "ztfr" "ztfi" "uvot::b" "uvot::u" "uvot::uvm2" "uvot::uvw1" "uvot::uvw2" "uvot::v" "uvot::white" "ps1::open" "ps1::g" "ps1::r" "ps1::i" "ps1::z" "ps1::y" "ps1::w" "atlasc" "atlaso" "2massj" "2massh" "2massks" "gaia::gbp" "gaia::g" "gaia::grp" "gaia::grvs" "tess" "swiftxrt" "nicerxti"

The bandpass of the observation.

+
magerr
number or null
Default: null

Magnitude error of the observation in the magnitude system magsys. Can be null in the case of a non-detection.

+
altdata
object or null
Default: null

Misc. alternative metadata stored in JSON format, e.g. {'calibration': {'source': 'ps1','color_term': 0.012}, 'photometry_method': 'allstar', 'method_reference': 'Masci et al. (2015)'}

instrument_id
required
integer

ID of the instrument with which the observation was carried out.

-
mag
number or null
Default: null

Magnitude of the observation in the magnitude system magsys. Can be null in the case of a non-detection.

+
obj_id
required
string

ID of the Object to which the photometry will be attached.

alert_id
integer or null
Default: null

Corresponding alert ID. If a record is already present with identical alert ID, only the groups list will be updated (other alert data assumed identical). Defaults to None.

-
ra
number or null
Default: null

ICRS Right Ascension of the centroid of the photometric aperture [deg].

-
mjd
required
number

MJD of the observation.

+
e_magref
any or null
Default: null

Gaussian error on the reference magnitude. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

+

Responses

Request samples

Content type
application/json
Example
{
  • "magsys": "jla1",
  • "ra_unc": null,
  • "ra": null,
  • "magref": null,
  • "mjd": 0,
  • "dec": null,
  • "assignment_id": null,
  • "mag": null,
  • "origin": null,
  • "dec_unc": null,
  • "limiting_mag": 0,
  • "filter": "bessellux",
  • "magerr": null,
  • "altdata": null,
  • "instrument_id": 0,
  • "obj_id": "string",
  • "alert_id": null,
  • "e_magref": null
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update and/or upload photometry, resolving potenti

Update and/or upload photometry, resolving potential duplicates

+
Request Body schema: application/json
One of
limiting_mag_nsigma
any
Default: 3

Number of standard deviations above the background that the limiting magnitudes correspond to. Null values not allowed. Default = 3.0.

+
e_magref
any or null
Default: null

Gaussian error on the reference magnitude. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

+
ra_unc
any or null
Default: null

Uncertainty on RA [arcsec]. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

magref
any or null
Default: null

Magnitude of the reference image. in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed if no reference is given.

-
magerr
number or null
Default: null

Magnitude error of the observation in the magnitude system magsys. Can be null in the case of a non-detection.

-

Responses

Request samples

Content type
application/json
Example
{
  • "dec_unc": null,
  • "dec": null,
  • "obj_id": "string",
  • "magsys": "jla1",
  • "origin": null,
  • "altdata": null,
  • "limiting_mag": 0,
  • "ra_unc": null,
  • "assignment_id": null,
  • "e_magref": null,
  • "filter": "bessellux",
  • "instrument_id": 0,
  • "mag": null,
  • "alert_id": null,
  • "ra": null,
  • "mjd": 0,
  • "magref": null,
  • "magerr": null
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update and/or upload photometry, resolving potenti

Update and/or upload photometry, resolving potential duplicates

-
Request Body schema: application/json
One of
dec
any or null
Default: null

ICRS Declination of the centroid of the photometric aperture [deg]. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

-
filter
required
any

The bandpass of the observation(s). Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed. Allowed values: bessellux, bessellb, bessellv, bessellr, besselli, standard::u, standard::b, standard::v, standard::r, standard::i, desu, desg, desr, desi, desz, desy, sdssu, sdssg, sdssr, sdssi, sdssz, f435w, f475w, f555w, f606w, f625w, f775w, f850lp, nicf110w, nicf160w, f098m, f105w, f110w, f125w, f127m, f139m, f140w, f153m, f160w, f218w, f225w, f275w, f300x, f336w, f350lp, f390w, f689m, f763m, f845m, f438w, uvf475w, uvf555w, uvf606w, uvf625w, uvf775w, uvf814w, uvf850lp, kepler, cspb, csphs, csphd, cspjs, cspjd, cspv3009, cspv3014, cspv9844, cspys, cspyd, cspg, cspi, cspk, cspr, cspu, f070w, f090w, f115w, f150w, f200w, f277w, f356w, f444w, f140m, f162m, f182m, f210m, f250m, f300m, f335m, f360m, f410m, f430m, f460m, f480m, f560w, f770w, f1000w, f1130w, f1280w, f1500w, f1800w, f2100w, f2550w, f1065c, f1140c, f1550c, f2300c, lsstu, lsstg, lsstr, lssti, lsstz, lssty, keplercam::us, keplercam::b, keplercam::v, keplercam::r, keplercam::i, 4shooter2::us, 4shooter2::b, 4shooter2::v, 4shooter2::r, 4shooter2::i, f062, f087, f106, f129, f158, f184, f213, f146, ztfg, ztfr, ztfi, uvot::b, uvot::u, uvot::uvm2, uvot::uvw1, uvot::uvw2, uvot::v, uvot::white, ps1::open, ps1::g, ps1::r, ps1::i, ps1::z, ps1::y, ps1::w, atlasc, atlaso, 2massj, 2massh, 2massks, gaia::gbp, gaia::g, gaia::grp, gaia::grvs, tess, swiftxrt, nicerxti

-
mag
any or null
Default: null

Magnitude of the observation in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed for non-detections. If mag is null, the corresponding magerr must also be null.

-
mjd
required
any

MJD of the observation(s). Can be a given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed.

-
limiting_mag
required
any

Limiting magnitude of the image in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed.

-
origin
any or null
Default: null

Provenance of the Photometry. If a record is already present with identical origin, only the groups or streams list will be updated (other data assumed identical). Defaults to None.

-
ra
any or null
Default: null

ICRS Right Ascension of the centroid of the photometric aperture [deg]. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

group_ids
any
Default: []

List of group IDs to which photometry points will be visible. If 'all', will be shared with site-wide public group (visible to all users who can view associated source).

-
obj_id
required
any

ID of the Obj(s) to which the photometry will be attached. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values are not allowed.

-
magsys
required
any

The magnitude system to which the magnitude, magnitude error, and limiting magnitude are tied. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed. Allowed values: jla1, ab, vega, bd17, csp, ab-b12

-
e_magref
any or null
Default: null

Gaussian error on the reference magnitude. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

+
mjd
required
any

MJD of the observation(s). Can be a given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed.

dec_unc
any or null
Default: null

Uncertainty on dec [arcsec]. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

stream_ids
any
Default: []

List of stream IDs to which photometry points will be visible.

altdata
any or null
Default: null

Misc. alternative metadata stored in JSON format, e.g. {'calibration': {'source': 'ps1','color_term': 0.012}, 'photometry_method': 'allstar', 'method_reference': 'Masci et al. (2015)'}. Can be a list of dicts or a single dict which will be broadcast to all values.

-
ra_unc
any or null
Default: null

Uncertainty on RA [arcsec]. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

-
assignment_id
integer or null
Default: null

ID of the classical assignment which generated the photometry

-
limiting_mag_nsigma
any
Default: 3

Number of standard deviations above the background that the limiting magnitudes correspond to. Null values not allowed. Default = 3.0.

instrument_id
required
any

ID of the Instrument(s) with which the photometry was acquired. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values are not allowed.

-
magref
any or null
Default: null

Magnitude of the reference image. in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed if no reference is given.

-
magerr
any or null
Default: null

Error on the magnitude in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed for non-detections. If magerr is null, the corresponding mag must also be null.

-

Responses

Request samples

Content type
application/json
Example
{
  • "dec": null,
  • "filter": null,
  • "mag": null,
  • "mjd": null,
  • "limiting_mag": null,
  • "origin": null,
  • "ra": null,
  • "group_ids": [ ],
  • "obj_id": null,
  • "magsys": null,
  • "e_magref": null,
  • "dec_unc": null,
  • "stream_ids": [ ],
  • "altdata": null,
  • "ra_unc": null,
  • "assignment_id": null,
  • "limiting_mag_nsigma": 3,
  • "instrument_id": null,
  • "magref": null,
  • "magerr": null
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve a photometric series

Retrieve a photometric series

+
magsys
required
any

The magnitude system to which the magnitude, magnitude error, and limiting magnitude are tied. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed. Allowed values: jla1, ab, vega, bd17, csp, ab-b12

+
origin
any or null
Default: null

Provenance of the Photometry. If a record is already present with identical origin, only the groups or streams list will be updated (other data assumed identical). Defaults to None.

+
limiting_mag
required
any

Limiting magnitude of the image in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed.

+
filter
required
any

The bandpass of the observation(s). Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values not allowed. Allowed values: bessellux, bessellb, bessellv, bessellr, besselli, standard::u, standard::b, standard::v, standard::r, standard::i, desu, desg, desr, desi, desz, desy, sdssu, sdssg, sdssr, sdssi, sdssz, f435w, f475w, f555w, f606w, f625w, f775w, f850lp, nicf110w, nicf160w, f098m, f105w, f110w, f125w, f127m, f139m, f140w, f153m, f160w, f218w, f225w, f275w, f300x, f336w, f350lp, f390w, f689m, f763m, f845m, f438w, uvf475w, uvf555w, uvf606w, uvf625w, uvf775w, uvf814w, uvf850lp, kepler, cspb, csphs, csphd, cspjs, cspjd, cspv3009, cspv3014, cspv9844, cspys, cspyd, cspg, cspi, cspk, cspr, cspu, f070w, f090w, f115w, f150w, f200w, f277w, f356w, f444w, f140m, f162m, f182m, f210m, f250m, f300m, f335m, f360m, f410m, f430m, f460m, f480m, f560w, f770w, f1000w, f1130w, f1280w, f1500w, f1800w, f2100w, f2550w, f1065c, f1140c, f1550c, f2300c, lsstu, lsstg, lsstr, lssti, lsstz, lssty, keplercam::us, keplercam::b, keplercam::v, keplercam::r, keplercam::i, 4shooter2::us, 4shooter2::b, 4shooter2::v, 4shooter2::r, 4shooter2::i, f062, f087, f106, f129, f158, f184, f213, f146, ztfg, ztfr, ztfi, uvot::b, uvot::u, uvot::uvm2, uvot::uvw1, uvot::uvw2, uvot::v, uvot::white, ps1::open, ps1::g, ps1::r, ps1::i, ps1::z, ps1::y, ps1::w, atlasc, atlaso, 2massj, 2massh, 2massks, gaia::gbp, gaia::g, gaia::grp, gaia::grvs, tess, swiftxrt, nicerxti

+
magerr
any or null
Default: null

Error on the magnitude in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed for non-detections. If magerr is null, the corresponding mag must also be null.

+
ra
any or null
Default: null

ICRS Right Ascension of the centroid of the photometric aperture [deg]. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

+
dec
any or null
Default: null

ICRS Declination of the centroid of the photometric aperture [deg]. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed.

+
mag
any or null
Default: null

Magnitude of the observation in the magnitude system magsys. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values allowed for non-detections. If mag is null, the corresponding magerr must also be null.

+
assignment_id
integer or null
Default: null

ID of the classical assignment which generated the photometry

+
obj_id
required
any

ID of the Obj(s) to which the photometry will be attached. Can be given as a scalar or a 1D list. If a scalar, will be broadcast to all values given as lists. Null values are not allowed.

+

Responses

Request samples

Content type
application/json
Example
{
  • "limiting_mag_nsigma": 3,
  • "e_magref": null,
  • "ra_unc": null,
  • "magref": null,
  • "group_ids": [ ],
  • "mjd": null,
  • "dec_unc": null,
  • "stream_ids": [ ],
  • "altdata": null,
  • "instrument_id": null,
  • "magsys": null,
  • "origin": null,
  • "limiting_mag": null,
  • "filter": null,
  • "magerr": null,
  • "ra": null,
  • "dec": null,
  • "mag": null,
  • "assignment_id": null,
  • "obj_id": null
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve a photometric series

Retrieve a photometric series

path Parameters
photometric_series_id
required
integer
query Parameters
dataFormat
string
Enum: "json" "hdf5" "none"

Format of the data to return. If none, the data will not be returned. If hdf5, the data will be returned as a bytestream in HDF5 format. (to see how to unpack this data format, look at photometric_series.md) If json, the data will be returned as a JSON object, where each key is a list of values for that column.

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a photometric series

Delete a photometric series

-
path Parameters
photometric_series_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all photometric series, based on various

Retrieve all photometric series, based on various cuts.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a photometric series

Delete a photometric series

+
path Parameters
photometric_series_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all photometric series, based on various

Retrieve all photometric series, based on various cuts.

query Parameters
dataFormat
string
Enum: "json" "hdf5" "none"

Format of the data to return. If none, the data will not be returned. If hdf5, the data will be returned as a bytestream in HDF5 format. (to see how to unpack this data format, look at photometric_series.md) @@ -2560,57 +2560,57 @@

Pagination

numPerPage
integer

Number of sources to return per paginated request. Defaults to 100. Max 500.

pageNumber
integer

Page number for paginated query results. Defaults to 1

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete bulk-uploaded photometry set

Delete bulk-uploaded photometry set

-
path Parameters
upload_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Get photometry taken by specific instruments over

Get photometry taken by specific instruments over a date range

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete bulk-uploaded photometry set

Delete bulk-uploaded photometry set

+
path Parameters
upload_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Get photometry taken by specific instruments over

Get photometry taken by specific instruments over a date range

query Parameters
format
string
Enum: "mag" "flux"

Return the photometry in flux or magnitude space? If a value for this query parameter is not provided, the result will be returned in magnitude space.

magsys
string
Enum: "jla1" "ab" "vega" "bd17" "csp" "ab-b12"

The magnitude or zeropoint system of the output. (Default AB)

-
Request Body schema: application/json
min_date
string or null <date-time>
Default: null

Query for photometry taken after this UT DateTime. For an open-ended interval use None.

-
max_date
string or null <date-time>
Default: null

Query for photometry taken before this UT DateTime. For an open-ended interval use None.

-
instrument_ids
Array of integers or null
Default: null

IDs of the instruments to query for photometry from. If None, queries all instruments.

-

Responses

Request samples

Content type
application/json
{
  • "min_date": null,
  • "max_date": null,
  • "instrument_ids": null
}

Response samples

Content type
application/json
Example
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Get all photometry origins

Get all photometry origins

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Copy all photometry points from one source to anot

Copy all photometry points from one source to another

+
Request Body schema: application/json
max_date
string or null <date-time>
Default: null

Query for photometry taken before this UT DateTime. For an open-ended interval use None.

+
instrument_ids
Array of integers or null
Default: null

IDs of the instruments to query for photometry from. If None, queries all instruments.

+
min_date
string or null <date-time>
Default: null

Query for photometry taken after this UT DateTime. For an open-ended interval use None.

+

Responses

Request samples

Content type
application/json
{
  • "max_date": null,
  • "instrument_ids": null,
  • "min_date": null
}

Response samples

Content type
application/json
Example
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Get all photometry origins

Get all photometry origins

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Copy all photometry points from one source to anot

Copy all photometry points from one source to another

path Parameters
target_id
required
string

The obj_id of the target Source (to which the photometry is being copied to)

Request Body schema: application/json
group_ids
required
Array of integers

List of IDs of groups to give photometry access to

origin_id
required
string

The ID of the Source's Obj the photometry is being copied from

-

Responses

Request samples

Content type
application/json
{
  • "group_ids": [
    ],
  • "origin_id": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all photometry associated with an Object

Retrieve all photometry associated with an Object

+

Responses

Request samples

Content type
application/json
{
  • "group_ids": [
    ],
  • "origin_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all photometry associated with an Object

Retrieve all photometry associated with an Object

path Parameters
obj_id
required
string

ID of the object to retrieve photometry for

query Parameters
format
string
Enum: "mag" "flux"

Return the photometry in flux or magnitude space? If a value for this query parameter is not provided, the result will be returned in magnitude space.

magsys
string
Enum: "jla1" "ab" "vega" "bd17" "csp" "ab-b12"

The magnitude or zeropoint system of the output. (Default AB)

individualOrSeries
string
Enum: "individual" "series" "both"

Whether to return individual photometry points, photometric series, or both (Default).

phaseFoldData
boolean

Boolean indicating whether to phase fold the light curve. Defaults to false.

-

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Delete object photometry

Delete object photometry

-
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

+

Responses

Response samples

Content type
application/json
Example
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Delete object photometry

Delete object photometry

+
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all annotations associated with specified

Retrieve all annotations associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra"

What underlying data the annotation is on: must be one of either "sources" or "spectra".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve an annotation

Retrieve an annotation

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve an annotation

Retrieve an annotation

path Parameters
associated_resource_type
required
string
Enum: "sources" "spectra" "photometry"

What underlying data the annotation is on: must be one of "sources", "spectra", or "photometry."

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectra.

-
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

gcnevents

Get observation plan requests of the GcnEvent.

Get observation plan requests of the GcnEvent.

-
path Parameters
gcnevent_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Get survey efficiency analyses of the GcnEvent.

Get survey efficiency analyses of the GcnEvent.

-
path Parameters
gcnevent_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Get catalog queries of the GcnEvent.

Get catalog queries of the GcnEvent.

-
path Parameters
gcnevent_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Post a GCN Event alias

Post a GCN Event alias

+
annotation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

gcnevents

Get observation plan requests of the GcnEvent.

Get observation plan requests of the GcnEvent.

+
path Parameters
gcnevent_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Get survey efficiency analyses of the GcnEvent.

Get survey efficiency analyses of the GcnEvent.

+
path Parameters
gcnevent_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Get catalog queries of the GcnEvent.

Get catalog queries of the GcnEvent.

+
path Parameters
gcnevent_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Post a GCN Event alias

Post a GCN Event alias

path Parameters
dateobs
required
string

The dateobs of the event, as an arrow parseable string

Request Body schema: application/json
alias
required
string

Alias to add to the event

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a GCN event alias

Delete a GCN event alias

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a GCN event alias

Delete a GCN event alias

path Parameters
dateobs
required
dateobs
Request Body schema: application/json
alias
required
string

Alias to remove from the event

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a GCN event tag

Delete a GCN event tag

-
path Parameters
dateobs
required
dateobs
query Parameters
tag
required
tag

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Ingest GCN xml file

Ingest GCN xml file

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a GCN event tag

Delete a GCN event tag

+
path Parameters
dateobs
required
dateobs
query Parameters
tag
required
tag

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Ingest GCN xml file

Ingest GCN xml file

Request Body schema: application/json
xml
string

VOEvent XML content.

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a GCN event

Delete a GCN event

-
path Parameters
dateobs
required
dateobs

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

reminders

Retrieve a reminder

Retrieve a reminder

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a GCN event

Delete a GCN event

+
path Parameters
dateobs
required
dateobs

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

reminders

Retrieve a reminder

Retrieve a reminder

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift" "earthquake"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake"

resource_id
required
string

The ID of the source, spectrum, gcn_event or shift that the reminder is posted to. This would be a string for a source ID or an integer for a spectrum or gcn_event

-
reminder_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Post a reminder

Post a reminder

+
reminder_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Post a reminder

Post a reminder

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift".

resource_id
required
string

The ID of the source or spectrum @@ -2620,14 +2620,14 @@

Pagination

Request Body schema: application/json
text
required
string
group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view reminder. Defaults to all of requesting user's groups.

-

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete a reminder

Delete a reminder

+

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete a reminder

Delete a reminder

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift".

resource_id
required
string

The ID of the source or spectrum that the reminder is posted to. This would be a string for a source ID or an integer for a spectrum or gcn_event.

-
reminder_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a reminder

Update a reminder

+
reminder_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a reminder

Update a reminder

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift".

resource_id
required
string

The ID of the source or spectrum @@ -2646,73 +2646,73 @@

Pagination

user_id
required
integer

ID of the Reminder User instance.

group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view reminder.

-

Responses

Request samples

Content type
application/json
{
  • "obj": null,
  • "user": null,
  • "groups": [
    ],
  • "obj_id": "string",
  • "text": "string",
  • "origin": "string",
  • "bot": true,
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "reminder_delay": 0,
  • "number_of_reminders": 0,
  • "user_id": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

+

Responses

Request samples

Content type
application/json
{
  • "obj": null,
  • "user": null,
  • "groups": [
    ],
  • "obj_id": "string",
  • "text": "string",
  • "origin": "string",
  • "bot": true,
  • "next_reminder": "2019-08-24T14:15:22Z",
  • "reminder_delay": 0,
  • "number_of_reminders": 0,
  • "user_id": 0,
  • "group_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum or gcn_event.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

gcn_event

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

gcn_event

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum or gcn_event.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Scrape data of a GCN Event from GraceDB

Scrape data of a GCN Event from GraceDB

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Scrape data of a GCN Event from GraceDB

Scrape data of a GCN Event from GraceDB

path Parameters
dateobs
required
string

The dateobs of the event, as an arrow parseable string

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Scrape aliases of a GCN Event from GCNs notice/cir

Scrape aliases of a GCN Event from GCNs notice/circulars

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Scrape aliases of a GCN Event from GCNs notice/cir

Scrape aliases of a GCN Event from GCNs notice/circulars

path Parameters
dateobs
required
string

The dateobs of the event, as an arrow parseable string

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

earthquake

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

earthquake

Retrieve all reminders associated with specified r

Retrieve all reminders associated with specified resource

path Parameters
associated_resource_type
required
string
Enum: "source" "spectra" "gcn_event" "shift"

What underlying data the reminder is on: "sources" or "spectra" or "gcn_event" or "shift" or "earthquake".

resource_id
required
string

The ID of the underlying data. This would be a string for a source ID or an integer for other data types like spectrum or gcn_event.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

earthquakenotices

Ingest EarthquakeEvent

Ingest EarthquakeEvent

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

earthquakenotices

Ingest EarthquakeEvent

Ingest EarthquakeEvent

Request Body schema: application/json
sent_by
any or null

The user that saved this EarthquakeEvent

notices
Array of any
predictions
Array of any
measurements
Array of any
comments
Array of any
reminders
Array of any
sent_by_id
required
integer

The ID of the User who created this GcnTag.

event_id
required
string
event_uri
string or null
status
string

The status of the earthquake event.

-

Responses

Request samples

Content type
application/json
{
  • "sent_by": null,
  • "notices": [
    ],
  • "predictions": [
    ],
  • "measurements": [
    ],
  • "comments": [
    ],
  • "reminders": [
    ],
  • "sent_by_id": 0,
  • "event_id": "string",
  • "event_uri": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

gcn

Retrieve a GCN summary

Retrieve a GCN summary

-
path Parameters
dateobs
required
string
summary_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a GCN summary

Delete a GCN summary

-
path Parameters
summary_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

+

Responses

Request samples

Content type
application/json
{
  • "sent_by": null,
  • "notices": [
    ],
  • "predictions": [
    ],
  • "measurements": [
    ],
  • "comments": [
    ],
  • "reminders": [
    ],
  • "sent_by_id": 0,
  • "event_id": "string",
  • "event_uri": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

gcn

Retrieve a GCN summary

Retrieve a GCN summary

+
path Parameters
dateobs
required
string
summary_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a GCN summary

Delete a GCN summary

+
path Parameters
summary_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

path Parameters
shift_id
required
integer
query Parameters
startDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by shift.start_date >= startDate

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

gcnsummarys

Post a summary of a GCN event.

Post a summary of a GCN event.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": "string"
}

localizations

Compute instrument field probabilities for a skyma

Compute instrument field probabilities for a skymap

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

gcnsummarys

Post a summary of a GCN event.

Post a summary of a GCN event.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": "string"
}

localizations

Compute instrument field probabilities for a skyma

Compute instrument field probabilities for a skymap

path Parameters
dateobs
required
string
Instrument ID
required
integer
query Parameters
localization_name
required
string

Localization map name

integrated_probability
float

Cumulative integrated probability threshold

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Ingest GCN xml file

Ingest GCN xml file

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Ingest GCN xml file

Ingest GCN xml file

Request Body schema: application/json
xml
string

VOEvent XML content.

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Create a summary plot for the observability for a

Create a summary plot for the observability for a given event.

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Create a summary plot for the observability for a

Create a summary plot for the observability for a given event.

path Parameters
localization_id
required
integer

ID of localization to generate observability plot for

query Parameters
maximumAirmass
number

Maximum airmass to consider. Defaults to 2.5.

twilight
string

Twilight definition. Choices are astronomical (-18 degrees), nautical (-12 degrees), and civil (-6 degrees).

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Create a summary plot for the observability for a

Create a summary plot for the observability for a given event.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Create a summary plot for the observability for a

Create a summary plot for the observability for a given event.

path Parameters
localization_id
required
integer

ID of localization to generate map for

query Parameters
maximumAirmass
number

Maximum airmass to consider. Defaults to 2.5.

twilight
string

Twilight definition. Choices are astronomical (-18 degrees), nautical (-12 degrees), and civil (-6 degrees).

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Download a GCN localization skymap

Download a GCN localization skymap

-
path Parameters
dateobs
required
string
localization_name
required
string

Responses

Response samples

Content type
application/json
{
  • "contour": null,
  • "flat_2d": [
    ],
  • "dateobs": "string",
  • "localization_name": "string"
}

Retrieve a GCN localization

Retrieve a GCN localization

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Download a GCN localization skymap

Download a GCN localization skymap

+
path Parameters
dateobs
required
string
localization_name
required
string

Responses

Response samples

Content type
application/json
{
  • "flat_2d": [
    ],
  • "localization_name": "string",
  • "dateobs": "string",
  • "contour": null
}

Retrieve a GCN localization

Retrieve a GCN localization

path Parameters
dateobs
required
dateobs
localization_name
required
localization_name
query Parameters
include2DMap
boolean

Boolean indicating whether to include flatted skymap. Defaults to false.

-

Responses

Response samples

Content type
application/json
{
  • "contour": null,
  • "flat_2d": [
    ],
  • "dateobs": "string",
  • "localization_name": "string"
}

Delete a GCN localization

Delete a GCN localization

-
path Parameters
dateobs
required
string
localization_name
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

A fits file corresponding to the intersection of t

A fits file corresponding to the intersection of the input fits files.

-
path Parameters
dateobs
required
dateobs
localization_name
required
localization_name

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "status": "error",
  • "message": "string"
}

Post a skymap-based trigger

Post a skymap-based trigger

-
Request Body schema: application/json
allocation_id
required
integer

Followup request allocation ID.

-
integrated_probability
number

Integrated probability within skymap.

-
localization_id
required
integer

Localization ID.

-

Responses

Request samples

Content type
application/json
{
  • "allocation_id": 0,
  • "integrated_probability": 0,
  • "localization_id": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Create a summary plot for the observability for a

Create a summary plot for the observability for a given source.

+

Responses

Response samples

Content type
application/json
{
  • "flat_2d": [
    ],
  • "localization_name": "string",
  • "dateobs": "string",
  • "contour": null
}

Delete a GCN localization

Delete a GCN localization

+
path Parameters
dateobs
required
string
localization_name
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

A fits file corresponding to the intersection of t

A fits file corresponding to the intersection of the input fits files.

+
path Parameters
dateobs
required
dateobs
localization_name
required
localization_name

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { },
  • "status": "error"
}

Post a skymap-based trigger

Post a skymap-based trigger

+
Request Body schema: application/json
integrated_probability
number

Integrated probability within skymap.

+
localization_id
required
integer

Localization ID.

+
allocation_id
required
integer

Followup request allocation ID.

+

Responses

Request samples

Content type
application/json
{
  • "integrated_probability": 0,
  • "localization_id": 0,
  • "allocation_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Create a summary plot for the observability for a

Create a summary plot for the observability for a given source.

path Parameters
obj_id
required
string

ID of object to generate observability plot for

query Parameters
maximumAirmass
number

Maximum airmass to consider. Defaults to 2.5.

twilight
string

Twilight definition. Choices are astronomical (-18 degrees), nautical (-12 degrees), and civil (-6 degrees).

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

gcntags

Post a GCN Event tag

Post a GCN Event tag

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

gcntags

Post a GCN Event tag

Post a GCN Event tag

Request Body schema: application/json
dateobs
any

UTC event timestamp

text
any

GCN Event tag

-

Responses

Request samples

Content type
application/json
{
  • "dateobs": null,
  • "text": null
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Ingest GCN xml file

Ingest GCN xml file

+

Responses

Request samples

Content type
application/json
{
  • "dateobs": null,
  • "text": null
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Ingest GCN xml file

Ingest GCN xml file

Request Body schema: application/json
xml
string

VOEvent XML content.

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

gcnnotices

Ingest GCN xml file

Ingest GCN xml file

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

gcnnotices

Ingest GCN xml file

Ingest GCN xml file

Request Body schema: application/json
xml
string

VOEvent XML content.

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

sources_confirmed_in_gcn

Post sources that have been confirmed in a GCN to

Post sources that have been confirmed in a GCN to TNS

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

sources_confirmed_in_gcn

Post sources that have been confirmed in a GCN to

Post sources that have been confirmed in a GCN to TNS

path Parameters
dateobs
required
string

The dateobs of the event, as an arrow parseable string

Request Body schema: application/json
tnsrobotID
required
int

TNS Robot ID.

reporters
string

Reporters for the TNS report.

@@ -2720,21 +2720,21 @@

Pagination

If not provided, all sources confirmed in GCN will be posted.

confirmed
boolean

Only post sources noted as confirmed / highlighted. Defaults to True.

-

Responses

Request samples

Content type
application/json
{
  • "tnsrobotID": null,
  • "reporters": "string",
  • "sourcesIDList": "string",
  • "confirmed": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve sources that have been confirmed/rejected

Retrieve sources that have been confirmed/rejected in a GCN

+

Responses

Request samples

Content type
application/json
{
  • "tnsrobotID": null,
  • "reporters": "string",
  • "sourcesIDList": "string",
  • "confirmed": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve sources that have been confirmed/rejected

Retrieve sources that have been confirmed/rejected in a GCN

path Parameters
dateobs
required
string

The dateobs of the event, as an arrow parseable string

query Parameters
sourcesIDList
string

A comma-separated list of source_id's to retrieve. If not provided, all sources confirmed or rejected in GCN will be returned.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": [
    ]
}

source_confirmed_in_gcn

Retrieve a source that has been confirmed or rejec

Retrieve a source that has been confirmed or rejected in a GCN

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": [
    ]
}

source_confirmed_in_gcn

Retrieve a source that has been confirmed or rejec

Retrieve a source that has been confirmed or rejected in a GCN

path Parameters
dateobs
required
string

The dateobs of the event, as an arrow parseable string

source_id
required
string

The source_id of the source to retrieve

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Deletes the confirmed or rejected status of source

Deletes the confirmed or rejected status of source in a GCN. +

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Deletes the confirmed or rejected status of source

Deletes the confirmed or rejected status of source in a GCN. Its status can be considered as 'undefined'.

-
path Parameters
dateobs
required
string
source_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Update the confirmed or rejected status of a sourc

Update the confirmed or rejected status of a source in a GCN

+
path Parameters
dateobs
required
string
source_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Update the confirmed or rejected status of a sourc

Update the confirmed or rejected status of a source in a GCN

path Parameters
dateobs
required
string
source_id
required
string
Request Body schema: application/json
confirmed
required
boolean

Whether the source is confirmed (True) or rejected (False)

-

Responses

Request samples

Content type
application/json
{
  • "confirmed": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve a source that has been confirmed or rejec

Retrieve a source that has been confirmed or rejected in a GCN

+

Responses

Request samples

Content type
application/json
{
  • "confirmed": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve a source that has been confirmed or rejec

Retrieve a source that has been confirmed or rejected in a GCN

path Parameters
dateobs
required
string

The dateobs of the event, as an arrow parseable string

source_id
required
string

The source_id of the source to retrieve

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Confirm or reject a source in a gcn

Confirm or reject a source in a gcn

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Confirm or reject a source in a gcn

Confirm or reject a source in a gcn

path Parameters
dateobs
required
string

The dateobs of the event, as an arrow parseable string

Request Body schema: application/json
localization_name
required
string

The name of the localization of the event

localization_cumprob
required
string

The cumprob of the localization of the event

@@ -2742,15 +2742,15 @@

Pagination

confirmed
required
boolean

Whether the source is confirmed (True) or rejected (False)

start_date
required
string

Choose sources with a first detection after start_date, as an arrow parseable string

end_date
required
string

Choose sources with a last detection before end_date, as an arrow parseable string

-

Responses

Request samples

Content type
application/json
{
  • "localization_name": "string",
  • "localization_cumprob": "string",
  • "source_id": "string",
  • "confirmed": true,
  • "start_date": "string",
  • "end_date": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Deletes the confirmed or rejected status of source

Deletes the confirmed or rejected status of source in a GCN. +

Responses

Request samples

Content type
application/json
{
  • "localization_name": "string",
  • "localization_cumprob": "string",
  • "source_id": "string",
  • "confirmed": true,
  • "start_date": "string",
  • "end_date": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Deletes the confirmed or rejected status of source

Deletes the confirmed or rejected status of source in a GCN. Its status can be considered as 'undefined'.

-
path Parameters
dateobs
required
string
source_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Update the confirmed or rejected status of a sourc

Update the confirmed or rejected status of a source in a GCN

+
path Parameters
dateobs
required
string
source_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Update the confirmed or rejected status of a sourc

Update the confirmed or rejected status of a source in a GCN

path Parameters
dateobs
required
string
source_id
required
string
Request Body schema: application/json
confirmed
required
boolean

Whether the source is confirmed (True) or rejected (False)

-

Responses

Request samples

Content type
application/json
{
  • "confirmed": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

gcn_associated_to_source

Get the GCNs associated with a source (GCNs for wh

Get the GCNs associated with a source (GCNs for which the source has been confirmed)

-
path Parameters
source_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

observation_plan_requests

Get an airmass chart for the GcnEvent

Get an airmass chart for the GcnEvent

+

Responses

Request samples

Content type
application/json
{
  • "confirmed": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

gcn_associated_to_source

Get the GCNs associated with a source (GCNs for wh

Get the GCNs associated with a source (GCNs for which the source has been confirmed)

+
path Parameters
source_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

observation_plan_requests

Get an airmass chart for the GcnEvent

Get an airmass chart for the GcnEvent

path Parameters
localization_id
required
integer

ID of localization to generate airmass chart for

telescope_id
required
integer

ID of telescope to generate airmass chart for

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Submit the observation plan to treasuremap.space

Submit the observation plan to treasuremap.space

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Submit the observation plan to treasuremap.space

Submit the observation plan to treasuremap.space

path Parameters
instrument_id
required
string

ID for the instrument to submit

query Parameters
startDate
required
string

Filter by start date

endDate
required
string

Filter by end date

@@ -2766,27 +2766,27 @@

Pagination

table.

localizationCumprob
number

Cumulative probability up to which to include fields. Defaults to 0.95.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Submit manual observation plan.

Submit manual observation plan.

-
Request Body schema: application/json
observation_plan_data
any

Observation plan data json

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Submit manual observation plan.

Submit manual observation plan.

+
Request Body schema: application/json
gcnevent_id
required
integer

ID of the GcnEvent.

allocation_id
required
integer

Observation plan request allocation ID.

-
status
string
Default: "pending submission"

The status of the request.

-
localization_id
required
integer

Localization ID.

target_group_ids
Array of integers

IDs of groups to share the results of the observation plan request with.

-
gcnevent_id
required
integer

ID of the GcnEvent.

-

Responses

Request samples

Content type
application/json
{
  • "observation_plan_data": null,
  • "allocation_id": 0,
  • "status": "pending submission",
  • "localization_id": 0,
  • "target_group_ids": [
    ],
  • "gcnevent_id": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Submit observation plan request.

Submit observation plan request.

-
Request Body schema: application/json
allocation_id
required
integer

Observation plan request allocation ID.

-
status
string
Default: "pending submission"

The status of the request.

-
payload
any

Content of the observation plan request.

localization_id
required
integer

Localization ID.

+
status
string
Default: "pending submission"

The status of the request.

+
observation_plan_data
any

Observation plan data json

+

Responses

Request samples

Content type
application/json
{
  • "gcnevent_id": 0,
  • "allocation_id": 0,
  • "target_group_ids": [
    ],
  • "localization_id": 0,
  • "status": "pending submission",
  • "observation_plan_data": null
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Submit observation plan request.

Submit observation plan request.

+
Request Body schema: application/json
payload
any

Content of the observation plan request.

+
gcnevent_id
required
integer

ID of the GcnEvent.

+
allocation_id
required
integer

Observation plan request allocation ID.

target_group_ids
Array of integers

IDs of groups to share the results of the observation plan request with.

-
gcnevent_id
required
integer

ID of the GcnEvent.

-

Responses

Request samples

Content type
application/json
{
  • "allocation_id": 0,
  • "status": "pending submission",
  • "payload": null,
  • "localization_id": 0,
  • "target_group_ids": [
    ],
  • "gcnevent_id": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete observation plan.

Delete observation plan.

-
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Submit the observation plan to treasuremap.space

Submit the observation plan to treasuremap.space

-
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Get a GCN-izable summary of the observation plan.

Get a GCN-izable summary of the observation plan.

-
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Submit an observation plan.

Submit an observation plan.

-
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Remove an observation plan from the queue.

Remove an observation plan from the queue.

-
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Get a movie summary of the observation plan.

Get a movie summary of the observation plan.

-
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Perform an efficiency analysis of the observation

Perform an efficiency analysis of the observation plan.

+
localization_id
required
integer

Localization ID.

+
status
string
Default: "pending submission"

The status of the request.

+

Responses

Request samples

Content type
application/json
{
  • "payload": null,
  • "gcnevent_id": 0,
  • "allocation_id": 0,
  • "target_group_ids": [
    ],
  • "localization_id": 0,
  • "status": "pending submission"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete observation plan.

Delete observation plan.

+
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Submit the observation plan to treasuremap.space

Submit the observation plan to treasuremap.space

+
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Get a GCN-izable summary of the observation plan.

Get a GCN-izable summary of the observation plan.

+
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Submit an observation plan.

Submit an observation plan.

+
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Remove an observation plan from the queue.

Remove an observation plan from the queue.

+
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Get a movie summary of the observation plan.

Get a movie summary of the observation plan.

+
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Perform an efficiency analysis of the observation

Perform an efficiency analysis of the observation plan.

path Parameters
observation_plan_id
required
string
query Parameters
numberInjections
number

Number of simulations to evaluate efficiency with. Defaults to 1000.

numberDetections
number

Number of detections required for detection. Defaults to 1.

detectionThreshold
number

Threshold (in sigmas) required for detection. Defaults to 5.

@@ -2796,38 +2796,38 @@

Pagination

optionalInjectionParameters
any
group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view the analyses. Defaults to all of requesting user's groups.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Get GeoJSON summary of the observation plan.

Get GeoJSON summary of the observation plan.

-
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Get survey efficiency analyses of the observation

Get survey efficiency analyses of the observation plan.

-
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Submit the fields in the observation plan to an ob

Submit the fields in the observation plan to an observing run

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Get GeoJSON summary of the observation plan.

Get GeoJSON summary of the observation plan.

+
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Get survey efficiency analyses of the observation

Get survey efficiency analyses of the observation plan.

+
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Submit the fields in the observation plan to an ob

Submit the fields in the observation plan to an observing run

path Parameters
observation_plan_id
required
integer

ID of observation plan request to create observing run for

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete selected fields from the observation plan.

Delete selected fields from the observation plan.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete selected fields from the observation plan.

Delete selected fields from the observation plan.

path Parameters
observation_plan_id
required
string
Request Body schema: application/json
fieldIds
Array of integers

List of field IDs to remove from the plan

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

groups

Retrieve the public group

Retrieve the public group

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Add alert stream access to group

Add alert stream access to group

-
path Parameters
group_id
required
integer
Request Body schema: application/json
stream_id
required
integer

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete an alert stream from group

Delete an alert stream from group

-
path Parameters
group_id
required
integer
stream_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Add a group user

Add a group user

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

groups

Retrieve the public group

Retrieve the public group

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Add alert stream access to group

Add alert stream access to group

+
path Parameters
group_id
required
integer
Request Body schema: application/json
stream_id
required
integer

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete an alert stream from group

Delete an alert stream from group

+
path Parameters
group_id
required
integer
stream_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Add a group user

Add a group user

path Parameters
group_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
required
boolean
canSave
boolean

Boolean indicating whether user can save sources to group. Defaults to true.

-

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "canSave": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Update a group user's admin or save access status

Update a group user's admin or save access status

+

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "canSave": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Update a group user's admin or save access status

Update a group user's admin or save access status

path Parameters
group_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
boolean

Boolean indicating whether user is group admin. Either this or canSave must be provided in request body.

canSave
boolean

Boolean indicating whether user can save sources to group. Either this or admin must be provided in request body.

-

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "canSave": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a group user

Delete a group user

-
path Parameters
group_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Add users from other group(s) to specified group

Add users from other group(s) to specified group

-
path Parameters
group_id
required
integer
Request Body schema: application/json
fromGroupIDs
required
boolean

Responses

Request samples

Content type
application/json
{
  • "fromGroupIDs": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve a group

Retrieve a group

+

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "canSave": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a group user

Delete a group user

+
path Parameters
group_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Add users from other group(s) to specified group

Add users from other group(s) to specified group

+
path Parameters
group_id
required
integer
Request Body schema: application/json
fromGroupIDs
required
boolean

Responses

Request samples

Content type
application/json
{
  • "fromGroupIDs": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve a group

Retrieve a group

path Parameters
group_id
required
integer
query Parameters
includeGroupUsers
boolean

Boolean indicating whether to include group users. Defaults to true.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Update a group

Update a group

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Update a group

Update a group

path Parameters
group_id
required
integer
Request Body schema: application/json
streams
Array of any
filters
Array of any
shifts
Array of any
users
Array of any
group_users
Array of any
observing_runs
Array of any
photometry
Array of any
photometric_series
Array of any
spectra
Array of any
mmadetector_spectra
Array of any
mmadetector_time_intervals
Array of any
allocations
Array of any
source_labels
Array of any
admission_requests
Array of any
tnsrobots
Array of any
gcnsummaries
Array of any
name
required
string

Name of the group.

nickname
string or null

Short group nickname.

description
string or null

Longer description of the group.

private
boolean

Boolean indicating whether group is invisible to non-members.

single_user_group
boolean or null

Flag indicating whether this group is a singleton group for one user only.

-

Responses

Request samples

Content type
application/json
{
  • "streams": [
    ],
  • "filters": [
    ],
  • "shifts": [
    ],
  • "users": [
    ],
  • "group_users": [
    ],
  • "observing_runs": [
    ],
  • "photometry": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "mmadetector_spectra": [
    ],
  • "mmadetector_time_intervals": [
    ],
  • "allocations": [
    ],
  • "source_labels": [
    ],
  • "admission_requests": [
    ],
  • "tnsrobots": [
    ],
  • "gcnsummaries": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "description": "string",
  • "private": true,
  • "single_user_group": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a group

Delete a group

-
path Parameters
group_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all groups

Retrieve all groups

+

Responses

Request samples

Content type
application/json
{
  • "streams": [
    ],
  • "filters": [
    ],
  • "shifts": [
    ],
  • "users": [
    ],
  • "group_users": [
    ],
  • "observing_runs": [
    ],
  • "photometry": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "mmadetector_spectra": [
    ],
  • "mmadetector_time_intervals": [
    ],
  • "allocations": [
    ],
  • "source_labels": [
    ],
  • "admission_requests": [
    ],
  • "tnsrobots": [
    ],
  • "gcnsummaries": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "description": "string",
  • "private": true,
  • "single_user_group": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a group

Delete a group

+
path Parameters
group_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all groups

Retrieve all groups

query Parameters
name
string

Fetch by name (exact match)

includeSingleUserGroups
boolean

Bool indicating whether to include single user groups. Defaults to false.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Create a new group

Create a new group

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Create a new group

Create a new group

Request Body schema: application/json
streams
Array of any
filters
Array of any
shifts
Array of any
users
Array of any
group_users
Array of any
observing_runs
Array of any
photometry
Array of any
photometric_series
Array of any
spectra
Array of any
mmadetector_spectra
Array of any
mmadetector_time_intervals
Array of any
allocations
Array of any
source_labels
Array of any
admission_requests
Array of any
tnsrobots
Array of any
gcnsummaries
Array of any
name
required
string

Name of the group.

nickname
string or null

Short group nickname.

description
string or null

Longer description of the group.

@@ -2835,61 +2835,61 @@

Pagination

single_user_group
boolean or null

Flag indicating whether this group is a singleton group for one user only.

group_admins
Array of integers

List of IDs of users to be group admins. Current user will automatically be added as a group admin.

-

Responses

Request samples

Content type
application/json
{
  • "streams": [
    ],
  • "filters": [
    ],
  • "shifts": [
    ],
  • "users": [
    ],
  • "group_users": [
    ],
  • "observing_runs": [
    ],
  • "photometry": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "mmadetector_spectra": [
    ],
  • "mmadetector_time_intervals": [
    ],
  • "allocations": [
    ],
  • "source_labels": [
    ],
  • "admission_requests": [
    ],
  • "tnsrobots": [
    ],
  • "gcnsummaries": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "description": "string",
  • "private": true,
  • "single_user_group": true,
  • "group_admins": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve a group admission request

Retrieve a group admission request

-
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a group admission request

Delete a group admission request

-
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a group admission request's status

Update a group admission request's status

+

Responses

Request samples

Content type
application/json
{
  • "streams": [
    ],
  • "filters": [
    ],
  • "shifts": [
    ],
  • "users": [
    ],
  • "group_users": [
    ],
  • "observing_runs": [
    ],
  • "photometry": [
    ],
  • "photometric_series": [
    ],
  • "spectra": [
    ],
  • "mmadetector_spectra": [
    ],
  • "mmadetector_time_intervals": [
    ],
  • "allocations": [
    ],
  • "source_labels": [
    ],
  • "admission_requests": [
    ],
  • "tnsrobots": [
    ],
  • "gcnsummaries": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "description": "string",
  • "private": true,
  • "single_user_group": true,
  • "group_admins": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve a group admission request

Retrieve a group admission request

+
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a group admission request

Delete a group admission request

+
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a group admission request's status

Update a group admission request's status

path Parameters
admission_request_id
required
integer
Request Body schema: application/json
status
required
string

One of either 'accepted', 'declined', or 'pending'.

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all group admission requests

Retrieve all group admission requests

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all group admission requests

Retrieve all group admission requests

query Parameters
groupID
integer

ID of group for which admission requests are desired

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Create a new group admission request

Create a new group admission request

-
Request Body schema: application/json
groupID
required
integer
userID
required
integer

Responses

Request samples

Content type
application/json
{
  • "groupID": 0,
  • "userID": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve basic info on Groups that an Obj is saved

Retrieve basic info on Groups that an Obj is saved to

-
path Parameters
obj_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Save or request group(s) to save source, and optio

Save or request group(s) to save source, and optionally unsave from group(s).

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Create a new group admission request

Create a new group admission request

+
Request Body schema: application/json
groupID
required
integer
userID
required
integer

Responses

Request samples

Content type
application/json
{
  • "groupID": 0,
  • "userID": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve basic info on Groups that an Obj is saved

Retrieve basic info on Groups that an Obj is saved to

+
path Parameters
obj_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Save or request group(s) to save source, and optio

Save or request group(s) to save source, and optionally unsave from group(s).

Request Body schema: application/json
objId
required
string

ID of the object in question.

inviteGroupIds
required
Array of integers

List of group IDs to save or invite to save specified source.

unsaveGroupIds
Array of integers

List of group IDs from which specified source is to be unsaved.

-

Responses

Request samples

Content type
application/json
{
  • "objId": "string",
  • "inviteGroupIds": [
    ],
  • "unsaveGroupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a Source table row

Update a Source table row

-
path Parameters
obj_id
required
integer
Request Body schema: application/json
groupID
required
integer
active
required
boolean
requested
required
boolean

Responses

Request samples

Content type
application/json
{
  • "groupID": 0,
  • "active": true,
  • "requested": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

streams

Add alert stream access to group

Add alert stream access to group

-
path Parameters
group_id
required
integer
Request Body schema: application/json
stream_id
required
integer

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete an alert stream from group

Delete an alert stream from group

-
path Parameters
group_id
required
integer
stream_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Grant stream access to a user

Grant stream access to a user

-
path Parameters
stream_id
required
integer
Request Body schema: application/json
user_id
required
integer

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete a stream user (revoke stream access for use

Delete a stream user (revoke stream access for user)

-
path Parameters
stream_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve a stream

Retrieve a stream

-
path Parameters
filter_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a stream

Delete a stream

-
path Parameters
stream_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a stream

Update a stream

-
path Parameters
stream_id
required
integer
Request Body schema: application/json
name
string
altdata
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "altdata": { }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all streams

Retrieve all streams

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

POST a new stream.

POST a new stream.

-
Request Body schema: application/json
name
required
string
altdata
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "altdata": { }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

users

Add a group user

Add a group user

+

Responses

Request samples

Content type
application/json
{
  • "objId": "string",
  • "inviteGroupIds": [
    ],
  • "unsaveGroupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a Source table row

Update a Source table row

+
path Parameters
obj_id
required
integer
Request Body schema: application/json
groupID
required
integer
active
required
boolean
requested
required
boolean

Responses

Request samples

Content type
application/json
{
  • "groupID": 0,
  • "active": true,
  • "requested": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

streams

Add alert stream access to group

Add alert stream access to group

+
path Parameters
group_id
required
integer
Request Body schema: application/json
stream_id
required
integer

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete an alert stream from group

Delete an alert stream from group

+
path Parameters
group_id
required
integer
stream_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Grant stream access to a user

Grant stream access to a user

+
path Parameters
stream_id
required
integer
Request Body schema: application/json
user_id
required
integer

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete a stream user (revoke stream access for use

Delete a stream user (revoke stream access for user)

+
path Parameters
stream_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve a stream

Retrieve a stream

+
path Parameters
filter_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a stream

Delete a stream

+
path Parameters
stream_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a stream

Update a stream

+
path Parameters
stream_id
required
integer
Request Body schema: application/json
name
string
altdata
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "altdata": { }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all streams

Retrieve all streams

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

POST a new stream.

POST a new stream.

+
Request Body schema: application/json
name
required
string
altdata
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "altdata": { }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

users

Add a group user

Add a group user

path Parameters
group_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
required
boolean
canSave
boolean

Boolean indicating whether user can save sources to group. Defaults to true.

-

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "canSave": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Update a group user's admin or save access status

Update a group user's admin or save access status

+

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "canSave": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Update a group user's admin or save access status

Update a group user's admin or save access status

path Parameters
group_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
boolean

Boolean indicating whether user is group admin. Either this or canSave must be provided in request body.

canSave
boolean

Boolean indicating whether user can save sources to group. Either this or admin must be provided in request body.

-

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "canSave": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a group user

Delete a group user

-
path Parameters
group_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Add users from other group(s) to specified group

Add users from other group(s) to specified group

-
path Parameters
group_id
required
integer
Request Body schema: application/json
fromGroupIDs
required
boolean

Responses

Request samples

Content type
application/json
{
  • "fromGroupIDs": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve a group admission request

Retrieve a group admission request

-
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a group admission request

Delete a group admission request

-
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a group admission request's status

Update a group admission request's status

+

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "canSave": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a group user

Delete a group user

+
path Parameters
group_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Add users from other group(s) to specified group

Add users from other group(s) to specified group

+
path Parameters
group_id
required
integer
Request Body schema: application/json
fromGroupIDs
required
boolean

Responses

Request samples

Content type
application/json
{
  • "fromGroupIDs": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve a group admission request

Retrieve a group admission request

+
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a group admission request

Delete a group admission request

+
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a group admission request's status

Update a group admission request's status

path Parameters
admission_request_id
required
integer
Request Body schema: application/json
status
required
string

One of either 'accepted', 'declined', or 'pending'.

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all group admission requests

Retrieve all group admission requests

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all group admission requests

Retrieve all group admission requests

query Parameters
groupID
integer

ID of group for which admission requests are desired

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Create a new group admission request

Create a new group admission request

-
Request Body schema: application/json
groupID
required
integer
userID
required
integer

Responses

Request samples

Content type
application/json
{
  • "groupID": 0,
  • "userID": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Create a new group admission request

Create a new group admission request

+
Request Body schema: application/json
groupID
required
integer
userID
required
integer

Responses

Request samples

Content type
application/json
{
  • "groupID": 0,
  • "userID": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Get a summary of all the activity of shift users o

Get a summary of all the activity of shift users on skyportal for a given period

path Parameters
shift_id
required
integer
query Parameters
startDate
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by shift.start_date >= startDate

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Add a shift user

Add a shift user

-
path Parameters
shift_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
required
boolean

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete a shift user

Delete a shift user

-
path Parameters
shift_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a shift user's admin status, or needs_repla

Update a shift user's admin status, or needs_replacement status

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Add a shift user

Add a shift user

+
path Parameters
shift_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
required
boolean

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete a shift user

Delete a shift user

+
path Parameters
shift_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a shift user's admin status, or needs_repla

Update a shift user's admin status, or needs_replacement status

path Parameters
shift_id
required
integer
Request Body schema: application/json
userID
required
integer
admin
boolean

Boolean indicating whether user is shift admin.

needs_replacement
boolean

Boolean indicating whether user needs replacement or not

-

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "needs_replacement": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Grant stream access to a user

Grant stream access to a user

-
path Parameters
stream_id
required
integer
Request Body schema: application/json
user_id
required
integer

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete a stream user (revoke stream access for use

Delete a stream user (revoke stream access for user)

-
path Parameters
stream_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve a user

Retrieve a user

-
path Parameters
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a user

Delete a user

-
path Parameters
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a User record

Update a User record

+

Responses

Request samples

Content type
application/json
{
  • "userID": 0,
  • "admin": true,
  • "needs_replacement": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Grant stream access to a user

Grant stream access to a user

+
path Parameters
stream_id
required
integer
Request Body schema: application/json
user_id
required
integer

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete a stream user (revoke stream access for use

Delete a stream user (revoke stream access for user)

+
path Parameters
stream_id
required
integer
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve a user

Retrieve a user

+
path Parameters
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a user

Delete a user

+
path Parameters
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a User record

Update a User record

path Parameters
user_id
required
integer
Request Body schema: application/json
expirationDate
string

Arrow-parseable date string (e.g. 2020-01-01). Set a user's expiration date, after which the user's account will be deactivated and will be unable to access the application.

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all users

Retrieve all users

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all users

Retrieve all users

query Parameters
numPerPage
integer

Number of candidates to return per paginated request. Defaults to all users

pageNumber
integer

Page number for paginated query results. Defaults to 1

firstName
string

Get users whose first name contains this string.

@@ -2900,16 +2900,16 @@

Pagination

acl
string

Get users with this ACL.

group
string

Get users part of the group with name given by this parameter.

stream
string

Get users with access to the stream with name given by this parameter.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Add a new user

Add a new user

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Add a new user

Add a new user

Request Body schema: application/json
username
required
string
first_name
string
last_name
string
affiliations
Array of strings
contact_email
string
oauth_uid
string
contact_phone
string
roles
Array of strings

List of user roles. Defaults to [Full user]. Will be overridden by groupIDsAndAdmin on a per-group basis.

groupIDsAndAdmin
Array of arrays

Array of 2-element arrays [groupID, admin] where groupID is the ID of a group that the new user will be added to and admin is a boolean indicating whether they will be an admin in that group, e.g. [[group_id_1, true], [group_id_2, false]]

-

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "affiliations": [
    ],
  • "contact_email": "string",
  • "oauth_uid": "string",
  • "contact_phone": "string",
  • "roles": [
    ],
  • "groupIDsAndAdmin": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

mmadetectors

Retrieve a Multimessenger Astronomical Detector (M

Retrieve a Multimessenger Astronomical Detector (MMADetector)

-
path Parameters
mmadetector_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a Multimessenger Astronomical Detector (MMA

Delete a Multimessenger Astronomical Detector (MMADetector)

-
path Parameters
mmadetector_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a Multimessenger Astronomical Detector (MMA

Update a Multimessenger Astronomical Detector (MMADetector)

+

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "affiliations": [
    ],
  • "contact_email": "string",
  • "oauth_uid": "string",
  • "contact_phone": "string",
  • "roles": [
    ],
  • "groupIDsAndAdmin": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

mmadetectors

Retrieve a Multimessenger Astronomical Detector (M

Retrieve a Multimessenger Astronomical Detector (MMADetector)

+
path Parameters
mmadetector_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a Multimessenger Astronomical Detector (MMA

Delete a Multimessenger Astronomical Detector (MMADetector)

+
path Parameters
mmadetector_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a Multimessenger Astronomical Detector (MMA

Update a Multimessenger Astronomical Detector (MMADetector)

path Parameters
mmadetector_id
required
integer
Request Body schema: application/json
events
Array of any
spectra
Array of any
time_intervals
Array of any
name
required
string

Unabbreviated facility name (e.g., LIGO Hanford Observatory.

nickname
required
string

Abbreviated facility name (e.g., H1).

type
required
string <= 18 characters
Enum: "gravitational-wave" "neutrino" "gamma-ray-burst"

MMA detector type, one of gravitational wave, neutrino, or gamma-ray burst.

@@ -2917,9 +2917,9 @@

Pagination

lon
number or null

Longitude in deg.

elevation
number or null

Elevation in meters.

fixed_location
boolean

Does this telescope have a fixed location (lon, lat, elev)?

-

Responses

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "spectra": [
    ],
  • "time_intervals": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "type": "gravitational-wave",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "fixed_location": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all Multimessenger Astronomical Detectors

Retrieve all Multimessenger Astronomical Detectors (MMADetectors)

+

Responses

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "spectra": [
    ],
  • "time_intervals": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "type": "gravitational-wave",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "fixed_location": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all Multimessenger Astronomical Detectors

Retrieve all Multimessenger Astronomical Detectors (MMADetectors)

query Parameters
name
string

Filter by name

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Create a Multimessenger Astronomical Detector (MMA

Create a Multimessenger Astronomical Detector (MMADetector)

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Create a Multimessenger Astronomical Detector (MMA

Create a Multimessenger Astronomical Detector (MMADetector)

Request Body schema: application/json
events
Array of any
spectra
Array of any
time_intervals
Array of any
name
required
string

Unabbreviated facility name (e.g., LIGO Hanford Observatory.

nickname
required
string

Abbreviated facility name (e.g., H1).

type
required
string <= 18 characters
Enum: "gravitational-wave" "neutrino" "gamma-ray-burst"

MMA detector type, one of gravitational wave, neutrino, or gamma-ray burst.

@@ -2927,16 +2927,16 @@

Pagination

lon
number or null

Longitude in deg.

elevation
number or null

Elevation in meters.

fixed_location
boolean

Does this telescope have a fixed location (lon, lat, elev)?

-

Responses

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "spectra": [
    ],
  • "time_intervals": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "type": "gravitational-wave",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "fixed_location": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

mmadetector_spectra

Retrieve an mmadetector spectrum

Retrieve an mmadetector spectrum

-
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete an mmadetector spectrum

Delete an mmadetector spectrum

-
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update mmadetector spectrum

Update mmadetector spectrum

-
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
end_time
required
string <date-time>

The ISO UTC end time the spectrum was taken.

+

Responses

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "spectra": [
    ],
  • "time_intervals": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "type": "gravitational-wave",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "fixed_location": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

mmadetector_spectra

Retrieve an mmadetector spectrum

Retrieve an mmadetector spectrum

+
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete an mmadetector spectrum

Delete an mmadetector spectrum

+
path Parameters
spectrum_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update mmadetector spectrum

Update mmadetector spectrum

+
path Parameters
spectrum_id
required
integer
Request Body schema: application/json
amplitudes
required
Array of numbers

Amplitude of the Spectrum [1/sqrt(Hz).

group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

-
amplitudes
required
Array of numbers

Amplitude of the Spectrum [1/sqrt(Hz).

-
start_time
required
string <date-time>

The ISO UTC start time the spectrum was taken.

detector_id
required
integer

ID of the MMADetector that acquired the Spectrum.

-
frequencies
required
Array of numbers

Frequencies of the spectrum [Hz].

-

Responses

Request samples

Content type
application/json
{
  • "end_time": "2019-08-24T14:15:22Z",
  • "group_ids": [ ],
  • "amplitudes": [
    ],
  • "start_time": "2019-08-24T14:15:22Z",
  • "detector_id": 0,
  • "frequencies": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve multiple spectra with given criteria

Retrieve multiple spectra with given criteria

+
frequencies
required
Array of numbers

Frequencies of the spectrum [Hz].

+
end_time
required
string <date-time>

The ISO UTC end time the spectrum was taken.

+
start_time
required
string <date-time>

The ISO UTC start time the spectrum was taken.

+

Responses

Request samples

Content type
application/json
{
  • "amplitudes": [
    ],
  • "group_ids": [ ],
  • "detector_id": 0,
  • "frequencies": [
    ],
  • "end_time": "2019-08-24T14:15:22Z",
  • "start_time": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve multiple spectra with given criteria

Retrieve multiple spectra with given criteria

query Parameters
observedBefore
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, return only spectra observed before this time.

observedAfter
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, @@ -2944,19 +2944,19 @@

Pagination

detectorIDs
any

If provided, filter only spectra observed with one of these mmadetector IDs.

groupIDs
list

If provided, filter only spectra saved to one of these group IDs.

Upload a Multimessenger Astronomical Detector (MMA

Upload a Multimessenger Astronomical Detector (MMADetector) spectrum

-
Request Body schema: application/json
end_time
required
string <date-time>

The ISO UTC end time the spectrum was taken.

+
Request Body schema: application/json
amplitudes
required
Array of numbers

Amplitude of the Spectrum [1/sqrt(Hz).

group_ids
any
Default: []

IDs of the Groups to share this spectrum with. Set to "all" to make this spectrum visible to all users.

-
amplitudes
required
Array of numbers

Amplitude of the Spectrum [1/sqrt(Hz).

-
start_time
required
string <date-time>

The ISO UTC start time the spectrum was taken.

detector_id
required
integer

ID of the MMADetector that acquired the Spectrum.

-
frequencies
required
Array of numbers

Frequencies of the spectrum [Hz].

-

Responses

Request samples

Content type
application/json
{
  • "end_time": "2019-08-24T14:15:22Z",
  • "group_ids": [ ],
  • "amplitudes": [
    ],
  • "start_time": "2019-08-24T14:15:22Z",
  • "detector_id": 0,
  • "frequencies": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

mmadetector_time_intervals

Retrieve an mmadetector time_interval

Retrieve an mmadetector time_interval

-
path Parameters
time_interval_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete an mmadetector time_interval

Delete an mmadetector time_interval

-
path Parameters
time_interval_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update mmadetector time_interval

Update mmadetector time_interval

+
frequencies
required
Array of numbers

Frequencies of the spectrum [Hz].

+
end_time
required
string <date-time>

The ISO UTC end time the spectrum was taken.

+
start_time
required
string <date-time>

The ISO UTC start time the spectrum was taken.

+

Responses

Request samples

Content type
application/json
{
  • "amplitudes": [
    ],
  • "group_ids": [ ],
  • "detector_id": 0,
  • "frequencies": [
    ],
  • "end_time": "2019-08-24T14:15:22Z",
  • "start_time": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

mmadetector_time_intervals

Retrieve an mmadetector time_interval

Retrieve an mmadetector time_interval

+
path Parameters
time_interval_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete an mmadetector time_interval

Delete an mmadetector time_interval

+
path Parameters
time_interval_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update mmadetector time_interval

Update mmadetector time_interval

path Parameters
time_interval_id
required
integer
Request Body schema: application/json
detector
any or null

The MMADetector that acquired the Time Interval.

groups
Array of any
owner
any or null

The User who uploaded the detector time interval.

detector_id
required
integer

ID of the MMADetector that acquired the Time Interval.

-

Responses

Request samples

Content type
application/json
{
  • "detector": null,
  • "groups": [
    ],
  • "owner": null,
  • "detector_id": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve multiple time_intervals with given criter

Retrieve multiple time_intervals with given criteria

+

Responses

Request samples

Content type
application/json
{
  • "detector": null,
  • "groups": [
    ],
  • "owner": null,
  • "detector_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve multiple time_intervals with given criter

Retrieve multiple time_intervals with given criteria

query Parameters
observedBefore
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, return only time_interval observed before this time.

observedAfter
string

Arrow-parseable date string (e.g. 2020-01-01). If provided, @@ -2967,11 +2967,11 @@

Pagination

Request Body schema: application/json
detector
any or null

The MMADetector that acquired the Time Interval.

groups
Array of any
owner
any or null

The User who uploaded the detector time interval.

detector_id
required
integer

ID of the MMADetector that acquired the Time Interval.

-

Responses

Request samples

Content type
application/json
{
  • "detector": null,
  • "groups": [
    ],
  • "owner": null,
  • "detector_id": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

listings

Retrieve sources from a user's lists

Retrieve sources from a user's lists

+

Responses

Request samples

Content type
application/json
{
  • "detector": null,
  • "groups": [
    ],
  • "owner": null,
  • "detector_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

listings

Retrieve sources from a user's lists

Retrieve sources from a user's lists

path Parameters
user_id
required
string
query Parameters
listName
string

name of the list to retrieve objects from. If not given will return all objects saved by the user to all lists.

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Add a listing.

Add a listing.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Add a listing.

Add a listing.

Request Body schema: application/json
user_id
integer

ID of user that you want to add the listing to. If not given, will default to the associated user object that is posting.

obj_id
string
list_name
string

Listing name for this item, e.g., "favorites". @@ -2985,28 +2985,28 @@

Pagination

and the number of candidates to return. The parameters are passed to the microservice that is responsible for processing the listing. The microservice will return a list of candidates that match the given parameters, and ingest them.

-

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "obj_id": "string",
  • "list_name": "string",
  • "params": { }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Remove an existing listing

Remove an existing listing

+

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "obj_id": "string",
  • "list_name": "string",
  • "params": { }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Remove an existing listing

Remove an existing listing

path Parameters
listing_id
required
integer

ID of the listing object. If not given, must supply the listing's obj_id and list_name (and user_id) to find the correct listing id from that info.

Request Body schema: application/json
user_id
integer

ID of user that you want to add the listing to. If not given, will default to the associated user object that is posting.

obj_id
string
list_name
string

Listing name for this item, e.g., "favorites".

-

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "obj_id": "string",
  • "list_name": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update an existing listing

Update an existing listing

+

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "obj_id": "string",
  • "list_name": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update an existing listing

Update an existing listing

path Parameters
listing_id
required
integer
Request Body schema: application/json
user_id
integer
obj_id
string
list_name
string

Listing name for this item, e.g., "favorites". Multiple objects can be saved by the same user to different lists, where the list names are user-defined. List name must be a non-empty string starting with an alphanumeric character or underscore. (it must match the regex: /^\w+/)

-

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "obj_id": "string",
  • "list_name": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

group_admission_requests

Retrieve a group admission request

Retrieve a group admission request

-
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a group admission request

Delete a group admission request

-
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a group admission request's status

Update a group admission request's status

+

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "obj_id": "string",
  • "list_name": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

group_admission_requests

Retrieve a group admission request

Retrieve a group admission request

+
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a group admission request

Delete a group admission request

+
path Parameters
admission_request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a group admission request's status

Update a group admission request's status

path Parameters
admission_request_id
required
integer
Request Body schema: application/json
status
required
string

One of either 'accepted', 'declined', or 'pending'.

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all group admission requests

Retrieve all group admission requests

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all group admission requests

Retrieve all group admission requests

query Parameters
groupID
integer

ID of group for which admission requests are desired

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Create a new group admission request

Create a new group admission request

-
Request Body schema: application/json
groupID
required
integer
userID
required
integer

Responses

Request samples

Content type
application/json
{
  • "groupID": 0,
  • "userID": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

invitations

Retrieve invitations

Retrieve invitations

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Create a new group admission request

Create a new group admission request

+
Request Body schema: application/json
groupID
required
integer
userID
required
integer

Responses

Request samples

Content type
application/json
{
  • "groupID": 0,
  • "userID": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

invitations

Retrieve invitations

Retrieve invitations

query Parameters
includeUsed
boolean

Bool indicating whether to include used invitations. Defaults to false.

numPerPage
integer

Number of candidates to return per paginated request. Defaults to 25

@@ -3015,7 +3015,7 @@

Pagination

group
string

Get invitations part of the group with name given by this parameter.

stream
string

Get invitations with access to the stream with name given by this parameter.

invitedBy
string

Get invitations invited by users whose username contains this string.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Invite a new user

Invite a new user

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Invite a new user

Invite a new user

Request Body schema: application/json
userEmail
required
string
role
string

The role the new user will have in the system. If provided, must be one of either "Full user" or "View only". Defaults to "Full user".

@@ -3032,12 +3032,12 @@

Pagination

userExpirationDate
string

Arrow-parseable date string (e.g. 2020-01-01). Set a user's expiration date, after which the user's account will be deactivated and will be unable to access the application.

-

Responses

Request samples

Content type
application/json
{
  • "userEmail": "string",
  • "role": "string",
  • "streamIDs": [
    ],
  • "groupIDs": [
    ],
  • "groupAdmin": [
    ],
  • "canSave": [
    ],
  • "userExpirationDate": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete an invitation

Delete an invitation

-
path Parameters
invitation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update a pending invitation

Update a pending invitation

+

Responses

Request samples

Content type
application/json
{
  • "userEmail": "string",
  • "role": "string",
  • "streamIDs": [
    ],
  • "groupIDs": [
    ],
  • "groupAdmin": [
    ],
  • "canSave": [
    ],
  • "userExpirationDate": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete an invitation

Delete an invitation

+
path Parameters
invitation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update a pending invitation

Update a pending invitation

Request Body schema: application/json
groupIDs
Array of integers
streamIDs
Array of integers
role
string
userExpirationDate
string

Arrow-parseable date string (e.g. 2020-01-01). Set a user's expiration date, after which the user's account will be deactivated and will be unable to access the application.

-

Responses

Request samples

Content type
application/json
{
  • "groupIDs": [
    ],
  • "streamIDs": [
    ],
  • "role": "string",
  • "userExpirationDate": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

observations

Retrieve all observations

Retrieve all observations

+

Responses

Request samples

Content type
application/json
{
  • "groupIDs": [
    ],
  • "streamIDs": [
    ],
  • "role": "string",
  • "userExpirationDate": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

observations

Retrieve all observations

Retrieve all observations

query Parameters
telescopeName
string

Filter by telescope name

instrumentName
string

Filter by instrument name

startDate
required
string

Filter by start date

@@ -3067,15 +3067,15 @@

Pagination

pageNumber
integer

Page number for paginated query results. Defaults to 1

sortBy
string

The field to sort by.

sortOrder
string

The sort order - either "asc" or "desc". Defaults to "asc"

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Ingest a set of ExecutedObservations

Ingest a set of ExecutedObservations

-
Request Body schema: application/json
observationData
any

Observation data dictionary list

-
instrumentName
required
string

The instrument name associated with the fields

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Ingest a set of ExecutedObservations

Ingest a set of ExecutedObservations

+
Request Body schema: application/json
instrumentName
required
string

The instrument name associated with the fields

+
observationData
any

Observation data dictionary list

telescopeName
required
string

The telescope name associated with the fields

-

Responses

Request samples

Content type
application/json
{
  • "observationData": null,
  • "instrumentName": "string",
  • "telescopeName": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete an observation

Delete an observation

-
path Parameters
observation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Upload observation from ASCII file

Upload observation from ASCII file

+

Responses

Request samples

Content type
application/json
{
  • "instrumentName": "string",
  • "observationData": null,
  • "telescopeName": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete an observation

Delete an observation

+
path Parameters
observation_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Upload observation from ASCII file

Upload observation from ASCII file

Request Body schema: application/json
observationData
any

Observation data Ascii string

instrumentID
required
string

The instrument ID associated with the fields

-

Responses

Request samples

Content type
application/json
{
  • "observationData": null,
  • "instrumentID": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Perform simsurvey efficiency calculation

Perform simsurvey efficiency calculation

+

Responses

Request samples

Content type
application/json
{
  • "observationData": null,
  • "instrumentID": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Perform simsurvey efficiency calculation

Perform simsurvey efficiency calculation

path Parameters
instrument_id
required
string

ID for the instrument to submit

query Parameters
startDate
required
string

Filter by start date

endDate
required
string

Filter by end date

@@ -3100,27 +3100,27 @@

Pagination

optionalInjectionParameters
any
group_ids
Array of integers

List of group IDs corresponding to which groups should be able to view the analyses. Defaults to all of requesting user's groups.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve queued observations from external API

Retrieve queued observations from external API

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve queued observations from external API

Retrieve queued observations from external API

path Parameters
allocation_id
required
string

ID for the allocation to retrieve

query Parameters
startDate
string

Filter by start date

endDate
string

Filter by end date

queuesOnly
bool

Return queue only (do not commit observations)

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve queued observations from external API

Retrieve queued observations from external API

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve queued observations from external API

Retrieve queued observations from external API

path Parameters
allocation_id
required
string

ID for the allocation to delete queue

query Parameters
queueName
required
string

Queue name to remove

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve observations from external API

Retrieve observations from external API

-
Request Body schema: application/json
end_date
required
any

end date of the request.

-
allocation_id
required
integer

Followup request allocation ID.

-
start_date
required
any

start date of the request.

-

Responses

Request samples

Content type
application/json
{
  • "end_date": null,
  • "allocation_id": 0,
  • "start_date": null
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Retrieve skymap-based trigger from external API

Retrieve skymap-based trigger from external API

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve observations from external API

Retrieve observations from external API

+
Request Body schema: application/json
start_date
required
any

start date of the request.

+
end_date
required
any

end date of the request.

+
allocation_id
required
integer

Followup request allocation ID.

+

Responses

Request samples

Content type
application/json
{
  • "start_date": null,
  • "end_date": null,
  • "allocation_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Retrieve skymap-based trigger from external API

Retrieve skymap-based trigger from external API

path Parameters
allocation_id
required
string

ID for the allocation to retrieve

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Delete skymap-based trigger from external API

Delete skymap-based trigger from external API

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Delete skymap-based trigger from external API

Delete skymap-based trigger from external API

path Parameters
allocation_id
required
string

ID for the allocation to delete queue

query Parameters
queueName
required
string

Queue name to remove

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

survey_efficiency_for_observations

Create a summary plot for a simsurvey efficiency c

Create a summary plot for a simsurvey efficiency calculation.

-
path Parameters
survey_efficiency_analysis_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Create a summary plot for a simsurvey efficiency c

Create a summary plot for a simsurvey efficiency calculation.

-
path Parameters
survey_efficiency_analysis_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve an observation efficiency analysis

Retrieve an observation efficiency analysis

-
path Parameters
survey_efficiency_analysis_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

observationplan_requests

Remove observations from treasuremap.space.

Remove observations from treasuremap.space.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

survey_efficiency_for_observations

Create a summary plot for a simsurvey efficiency c

Create a summary plot for a simsurvey efficiency calculation.

+
path Parameters
survey_efficiency_analysis_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Create a summary plot for a simsurvey efficiency c

Create a summary plot for a simsurvey efficiency calculation.

+
path Parameters
survey_efficiency_analysis_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve an observation efficiency analysis

Retrieve an observation efficiency analysis

+
path Parameters
survey_efficiency_analysis_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

observationplan_requests

Remove observations from treasuremap.space.

Remove observations from treasuremap.space.

path Parameters
instrument_id
required
string

ID for the instrument to submit

query Parameters
localizationDateobs
string

Event time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sss). Each localization is associated with a specific GCNEvent by @@ -3128,28 +3128,28 @@

Pagination

identifier. It can be therefore found as Localization.dateobs, queried from the /api/localization endpoint or dateobs in the GcnEvent page table.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Remove observation plan from treasuremap.space.

Remove observation plan from treasuremap.space.

-
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

observing_runs

Retrieve an observing run

Retrieve an observing run

-
path Parameters
run_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update observing run

Update observing run

-
path Parameters
run_id
required
integer
Request Body schema: application/json
group_id
integer

The ID of the group this run is associated with.

-
calendar_date
required
string <date>

The local calendar date of the run.

-
instrument_id
required
integer

The ID of the instrument to be used in this run.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Remove observation plan from treasuremap.space.

Remove observation plan from treasuremap.space.

+
path Parameters
observation_plan_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

observing_runs

Retrieve an observing run

Retrieve an observing run

+
path Parameters
run_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update observing run

Update observing run

+
path Parameters
run_id
required
integer
Request Body schema: application/json
calendar_date
required
string <date>

The local calendar date of the run.

observers
string

The names of the observers

-
pi
string

The PI of the observing run.

-

Responses

Request samples

Content type
application/json
{
  • "group_id": 0,
  • "calendar_date": "2019-08-24",
  • "instrument_id": 0,
  • "observers": "string",
  • "pi": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete an observing run

Delete an observing run

-
path Parameters
run_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all observing runs

Retrieve all observing runs

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Add a new observing run

Add a new observing run

-
Request Body schema: application/json
group_id
integer

The ID of the group this run is associated with.

-
calendar_date
required
string <date>

The local calendar date of the run.

-
instrument_id
required
integer

The ID of the instrument to be used in this run.

+
group_id
integer

The ID of the group this run is associated with.

+
pi
string

The PI of the observing run.

+
instrument_id
required
integer

The ID of the instrument to be used in this run.

+

Responses

Request samples

Content type
application/json
{
  • "calendar_date": "2019-08-24",
  • "observers": "string",
  • "group_id": 0,
  • "pi": "string",
  • "instrument_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete an observing run

Delete an observing run

+
path Parameters
run_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all observing runs

Retrieve all observing runs

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Add a new observing run

Add a new observing run

+
Request Body schema: application/json
calendar_date
required
string <date>

The local calendar date of the run.

observers
string

The names of the observers

-
pi
string

The PI of the observing run.

-

Responses

Request samples

Content type
application/json
{
  • "group_id": 0,
  • "calendar_date": "2019-08-24",
  • "instrument_id": 0,
  • "observers": "string",
  • "pi": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

observation_plans

Get all Observation Plan names

Get all Observation Plan names

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

objs

Delete an Obj

Delete an Obj

-
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Set an object's host galaxy

Set an object's host galaxy

+
group_id
integer

The ID of the group this run is associated with.

+
pi
string

The PI of the observing run.

+
instrument_id
required
integer

The ID of the instrument to be used in this run.

+

Responses

Request samples

Content type
application/json
{
  • "calendar_date": "2019-08-24",
  • "observers": "string",
  • "group_id": 0,
  • "pi": "string",
  • "instrument_id": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

observation_plans

Get all Observation Plan names

Get all Observation Plan names

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

objs

Delete an Obj

Delete an Obj

+
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Set an object's host galaxy

Set an object's host galaxy

path Parameters
obj_id
required
string
Request Body schema: application/json
galaxyName
required
string

Name of the galaxy to associate with the object

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete an object's host galaxy

Delete an object's host galaxy

-
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve an object's status from Minor Planet Cent

Retrieve an object's status from Minor Planet Center

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete an object's host galaxy

Delete an object's host galaxy

+
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve an object's status from Minor Planet Cent

Retrieve an object's status from Minor Planet Center

path Parameters
obj_id
required
string
Request Body schema: application/json
obscode
string

Minor planet center observatory code. Defaults to 500, corresponds to geocentric.

date
string

Time to check MPC for. @@ -3158,16 +3158,16 @@

Pagination

Defaults to 24.0.

search_radius
float

Search radius for MPC [in arcmin]. Defaults to 1 arcminute.

-

Responses

Request samples

Content type
application/json
{
  • "obscode": "string",
  • "date": "string",
  • "limiting_magnitude": null,
  • "search_radius": null
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve an Obj from TNS

Retrieve an Obj from TNS

-
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Post an Obj to TNS

Post an Obj to TNS

-
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

photometric series

Retrieve a photometric series

Retrieve a photometric series

+

Responses

Request samples

Content type
application/json
{
  • "obscode": "string",
  • "date": "string",
  • "limiting_magnitude": null,
  • "search_radius": null
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve an Obj from TNS

Retrieve an Obj from TNS

+
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Post an Obj to TNS

Post an Obj to TNS

+
path Parameters
obj_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

photometric series

Retrieve a photometric series

Retrieve a photometric series

path Parameters
photometric_series_id
required
integer
query Parameters
dataFormat
string
Enum: "json" "hdf5" "none"

Format of the data to return. If none, the data will not be returned. If hdf5, the data will be returned as a bytestream in HDF5 format. (to see how to unpack this data format, look at photometric_series.md) If json, the data will be returned as a JSON object, where each key is a list of values for that column.

-

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete a photometric series

Delete a photometric series

-
path Parameters
photometric_series_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all photometric series, based on various

Retrieve all photometric series, based on various cuts.

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete a photometric series

Delete a photometric series

+
path Parameters
photometric_series_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all photometric series, based on various

Retrieve all photometric series, based on various cuts.

query Parameters
dataFormat
string
Enum: "json" "hdf5" "none"

Format of the data to return. If none, the data will not be returned. If hdf5, the data will be returned as a bytestream in HDF5 format. (to see how to unpack this data format, look at photometric_series.md) @@ -3286,7 +3286,7 @@

Pagination

numPerPage
integer

Number of sources to return per paginated request. Defaults to 100. Max 500.

pageNumber
integer

Page number for paginated query results. Defaults to 1

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

summary

Get a list of sources with summaries matching the

Get a list of sources with summaries matching the query

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

summary

Get a list of sources with summaries matching the

Get a list of sources with summaries matching the query

query Parameters
q
string

The query string. E.g. "What sources are associated with an NGC galaxy?"

objID
string

The objID of the source which has a summary to be used as the query. @@ -3299,48 +3299,48 @@

Pagination

then no upper limit is applied.

classificationTypes
Array of strings

List of classification types to consider. If [] or missing, then all classification types are considered.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

data_sharing

Share data with additional groups/users

Share data with additional groups/users

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

data_sharing

Share data with additional groups/users

Share data with additional groups/users

Request Body schema: application/json
photometryIDs
Array of integers

IDs of the photometry data to be shared. If spectrumIDs is not provided, this is required.

spectrumIDs
Array of integers

IDs of the spectra to be shared. If photometryIDs is not provided, this is required.

groupIDs
required
Array of integers

List of IDs of groups data will be shared with. To share data with a single user, specify their single user group ID here.

-

Responses

Request samples

Content type
application/json
{
  • "photometryIDs": [
    ],
  • "spectrumIDs": [
    ],
  • "groupIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

recurring_apis

Retrieve an Recurring API by id

Retrieve an Recurring API by id

-
path Parameters
recurring_api_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete an Recurring API.

Delete an Recurring API.

-
path Parameters
recurring_api_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all Recurring APIs

Retrieve all Recurring APIs

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

POST a new Recurring APIs.

POST a new Recurring APIs.

+

Responses

Request samples

Content type
application/json
{
  • "photometryIDs": [
    ],
  • "spectrumIDs": [
    ],
  • "groupIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

recurring_apis

Retrieve an Recurring API by id

Retrieve an Recurring API by id

+
path Parameters
recurring_api_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete an Recurring API.

Delete an Recurring API.

+
path Parameters
recurring_api_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all Recurring APIs

Retrieve all Recurring APIs

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

POST a new Recurring APIs.

POST a new Recurring APIs.

Request Body schema: application/json
endpoint
required
string

Endpoint of the API call.

method
required
string

HTTP method of the API call.

next_call
required
datetime

Time of the next API call.

call_delay
required
number

Delay until next API call in days.

number_of_retries
integer

Number of retries before service is deactivated.

payload
required
object

Payload of the API call.

-

Responses

Request samples

Content type
application/json
{
  • "endpoint": "string",
  • "method": "string",
  • "next_call": null,
  • "call_delay": 0,
  • "number_of_retries": 0,
  • "payload": { }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

roles

Retrieve list of all Role IDs (strings)

Retrieve list of all Role IDs (strings)

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": [
    ]
}

Grant new Role(s) to a user

Grant new Role(s) to a user

+

Responses

Request samples

Content type
application/json
{
  • "endpoint": "string",
  • "method": "string",
  • "next_call": null,
  • "call_delay": 0,
  • "number_of_retries": 0,
  • "payload": { }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

roles

Retrieve list of all Role IDs (strings)

Retrieve list of all Role IDs (strings)

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": [
    ]
}

Grant new Role(s) to a user

Grant new Role(s) to a user

path Parameters
user_id
required
integer
Request Body schema: application/json
roleIds
required
Array of strings

Array of Role IDs (strings) to be granted to user

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete user role

Delete user role

-
path Parameters
user_id
required
integer
role_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

source_scans

Note that a source has been labelled.

Note that a source has been labelled.

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete user role

Delete user role

+
path Parameters
user_id
required
integer
role_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

source_scans

Note that a source has been labelled.

Note that a source has been labelled.

path Parameters
obj_id
required
string

ID of object to indicate source labelling for

Request Body schema: application/json
groupIds
required
Array of integers

List of IDs of groups to indicate labelling for

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

notifications

Send out a new source notification

Send out a new source notification

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

notifications

Send out a new source notification

Send out a new source notification

Request Body schema: application/json
additionalNotes
string

Notes to append to the message sent out

groupIds
required
Array of integers

List of IDs of groups whose members should get the notification (if they've opted in)

sourceId
required
string

The ID of the Source's Obj the notification is being sent about

level
required
string

Either 'soft' or 'hard', determines whether to send an email or email+SMS notification

-

Responses

Request samples

Content type
application/json
{
  • "additionalNotes": "string",
  • "groupIds": [
    ],
  • "sourceId": "string",
  • "level": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

spatial_catalogs

Retrieve a SpatialCatalog

Retrieve a SpatialCatalog

+

Responses

Request samples

Content type
application/json
{
  • "additionalNotes": "string",
  • "groupIds": [
    ],
  • "sourceId": "string",
  • "level": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

spatial_catalogs

Retrieve a SpatialCatalog

Retrieve a SpatialCatalog

path Parameters
catalog_id
required
integer

Retrieve all SpatialCatalogs

Retrieve all SpatialCatalogs

survey_efficiency_for_observation_plans

Retrieve an observation plan efficiency analysis

Retrieve an observation plan efficiency analysis

-
path Parameters
survey_efficiency_analysis_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

config

Retrieve parts of the config file that are exposed

Retrieve parts of the config file that are exposed to the user/browser

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

taxonomies

Retrieve a taxonomy

Retrieve a taxonomy

-
path Parameters
taxonomy_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update taxonomy

Update taxonomy

+
path Parameters
survey_efficiency_analysis_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

config

Retrieve parts of the config file that are exposed

Retrieve parts of the config file that are exposed to the user/browser

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

taxonomies

Retrieve a taxonomy

Retrieve a taxonomy

+
path Parameters
taxonomy_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update taxonomy

Update taxonomy

path Parameters
taxonomy_id
required
integer
Request Body schema: application/json
groups
Array of any
classifications
Array of any
name
required
string

Short string to make this taxonomy memorable to end users.

hierarchy
required
any

Nested JSON describing the taxonomy which should be validated against a schema before entry.

provenance
string or null

Identifier (e.g., URL or git hash) that uniquely ties this taxonomy back to an origin or place of record.

version
required
string

Semantic version of this taxonomy

isLatest
boolean

Consider this the latest version of the taxonomy with this name? Defaults to True.

-

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "classifications": [
    ],
  • "name": "string",
  • "hierarchy": null,
  • "provenance": "string",
  • "version": "string",
  • "isLatest": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a taxonomy

Delete a taxonomy

-
path Parameters
taxonomy_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Get all the taxonomies

Get all the taxonomies

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Post new taxonomy

Post new taxonomy

+

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "classifications": [
    ],
  • "name": "string",
  • "hierarchy": null,
  • "provenance": "string",
  • "version": "string",
  • "isLatest": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a taxonomy

Delete a taxonomy

+
path Parameters
taxonomy_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Get all the taxonomies

Get all the taxonomies

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Post new taxonomy

Post new taxonomy

Request Body schema: application/json
name
required
string

Short string to make this taxonomy memorable to end users.

hierarchy
required
object

Nested JSON describing the taxonomy @@ -3355,8 +3355,8 @@

Pagination

to an origin or place of record

isLatest
boolean

Consider this version of the taxonomy with this name the latest? Defaults to True.

-

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "hierarchy": { },
  • "group_ids": [
    ],
  • "version": "string",
  • "provenance": "string",
  • "isLatest": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

telescopes

Retrieve a telescope

Retrieve a telescope

-
path Parameters
telescope_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update telescope

Update telescope

+

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "hierarchy": { },
  • "group_ids": [
    ],
  • "version": "string",
  • "provenance": "string",
  • "isLatest": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

telescopes

Retrieve a telescope

Retrieve a telescope

+
path Parameters
telescope_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update telescope

Update telescope

path Parameters
telescope_id
required
integer
Request Body schema: application/json
instruments
Array of any
name
required
string

Unabbreviated facility name (e.g., Palomar 200-inch Hale Telescope).

nickname
required
string

Abbreviated facility name (e.g., P200).

lat
number or null

Latitude in deg.

@@ -3367,14 +3367,14 @@

Pagination

weather_link
string or null

Link to the preferred weather site

robotic
boolean

Is this telescope robotic?

fixed_location
boolean

Does this telescope have a fixed location (lon, lat, elev)?

-

Responses

Request samples

Content type
application/json
{
  • "instruments": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "diameter": 0,
  • "skycam_link": "string",
  • "weather_link": "string",
  • "robotic": true,
  • "fixed_location": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a telescope

Delete a telescope

-
path Parameters
telescope_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all telescopes

Retrieve all telescopes

+

Responses

Request samples

Content type
application/json
{
  • "instruments": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "diameter": 0,
  • "skycam_link": "string",
  • "weather_link": "string",
  • "robotic": true,
  • "fixed_location": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a telescope

Delete a telescope

+
path Parameters
telescope_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all telescopes

Retrieve all telescopes

query Parameters
name
string

Filter by name (exact match)

latitudeMin
number

Filter by latitude >= latitudeMin

latitudeMax
number

Filter by latitude <= latitudeMax

longitudeMin
number

Filter by longitude >= longitudeMin

longitudeMax
number

Filter by longitude <= longitudeMax

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Create telescopes

Create telescopes

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Create telescopes

Create telescopes

Request Body schema: application/json
instruments
Array of any
name
required
string

Unabbreviated facility name (e.g., Palomar 200-inch Hale Telescope).

nickname
required
string

Abbreviated facility name (e.g., P200).

lat
number or null

Latitude in deg.

@@ -3385,9 +3385,9 @@

Pagination

weather_link
string or null

Link to the preferred weather site

robotic
boolean

Is this telescope robotic?

fixed_location
boolean

Does this telescope have a fixed location (lon, lat, elev)?

-

Responses

Request samples

Content type
application/json
{
  • "instruments": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "diameter": 0,
  • "skycam_link": "string",
  • "weather_link": "string",
  • "robotic": true,
  • "fixed_location": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Retrieve weather info at the telescope site saved

Retrieve weather info at the telescope site saved by user or telescope specified by telescope_id parameter

-
query Parameters
telescope_id
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

thumbnails

Retrieve a thumbnail

Retrieve a thumbnail

-
path Parameters
thumbnail_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Update thumbnail

Update thumbnail

+

Responses

Request samples

Content type
application/json
{
  • "instruments": [
    ],
  • "name": "string",
  • "nickname": "string",
  • "lat": 0,
  • "lon": 0,
  • "elevation": 0,
  • "diameter": 0,
  • "skycam_link": "string",
  • "weather_link": "string",
  • "robotic": true,
  • "fixed_location": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Retrieve weather info at the telescope site saved

Retrieve weather info at the telescope site saved by user or telescope specified by telescope_id parameter

+
query Parameters
telescope_id
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

thumbnails

Retrieve a thumbnail

Retrieve a thumbnail

+
path Parameters
thumbnail_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Update thumbnail

Update thumbnail

path Parameters
thumbnail_id
required
integer
Request Body schema: application/json
obj
any or null

The Thumbnail's Obj.

type
string or null <= 6 characters
Enum: "new" "ref" "sub" "sdss" "dr8" "ls" "ps1" "new_gz" "ref_gz" "sub_gz"

Thumbnail type (e.g., ref, new, sub, ls, ps1, ...)

file_uri
string or null

Path of the Thumbnail on the machine running SkyPortal.

@@ -3395,12 +3395,12 @@

Pagination

origin
string or null

Origin of the Thumbnail.

obj_id
required
string

ID of the thumbnail's obj.

is_grayscale
boolean

Boolean indicating whether the thumbnail is (mostly) grayscale or not.

-

Responses

Request samples

Content type
application/json
{
  • "obj": null,
  • "type": "new",
  • "file_uri": "string",
  • "public_url": "string",
  • "origin": "string",
  • "obj_id": "string",
  • "is_grayscale": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Delete a thumbnail

Delete a thumbnail

-
path Parameters
thumbnail_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Upload thumbnails

Upload thumbnails

+

Responses

Request samples

Content type
application/json
{
  • "obj": null,
  • "type": "new",
  • "file_uri": "string",
  • "public_url": "string",
  • "origin": "string",
  • "obj_id": "string",
  • "is_grayscale": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Delete a thumbnail

Delete a thumbnail

+
path Parameters
thumbnail_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Upload thumbnails

Upload thumbnails

Request Body schema: application/json
obj_id
string

ID of object associated with thumbnails.

data
required
string <byte>

base64-encoded PNG image file contents. Image size must be between 16px and 500px on a side.

ttype
required
string

Thumbnail type. Must be one of 'new', 'ref', 'sub', 'sdss', 'dr8', 'new_gz', 'ref_gz', 'sub_gz'

-

Responses

Request samples

Content type
application/json
{
  • "obj_id": "string",
  • "data": "string",
  • "ttype": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Get information on thumbnails that are +

Responses

Request samples

Content type
application/json
{
  • "obj_id": "string",
  • "data": "string",
  • "ttype": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Get information on thumbnails that are or are not

Get information on thumbnails that are or are not in the correct folder/path.

query Parameters
types
Array of strings

types of thumbnails to check @@ -3414,11 +3414,11 @@

Pagination

hash of the source name. If requiredDepth is 0, then thumbnails are expected to be all in one folder under /skyportal/static/thumbnails.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

Delete all empty subfolders under "thumbnails". +

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

Delete all empty subfolders under "thumbnails". Th

Delete all empty subfolders under "thumbnails". These can be left over if moving thumbnails to a different folder structure.

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Update the file path and file_uri of the database

Update the file path and file_uri of the database rows +

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Update the file path and file_uri of the database

Update the file path and file_uri of the database rows of thumbnails that are not in the correct folder/path.

query Parameters
types
Array of strings

types of thumbnails to check The default is ['new', 'ref', 'sub'] which @@ -3433,27 +3433,27 @@

Pagination

to be all in one folder under /skyportal/static/thumbnails.

numPerPage
integer

Number of sources to check for updates. Defaults to 100. Max 500.

pageNumber
integer

Page number for iterating through all sources. Defaults to 1

-

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

tnsrobots

Retrieve a TNS robot

Retrieve a TNS robot

-
path Parameters
tnsrobot_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "message": "string"
}

Delete TNS robot.

Delete TNS robot.

-
path Parameters
tnsrobot_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Retrieve all TNS robots

Retrieve all TNS robots

-

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "message": "string"
}

Post new TNS robot

Post new TNS robot

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

tnsrobots

Retrieve a TNS robot

Retrieve a TNS robot

+
path Parameters
tnsrobot_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "status": "success"
}

Delete TNS robot.

Delete TNS robot.

+
path Parameters
tnsrobot_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Retrieve all TNS robots

Retrieve all TNS robots

+

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": [
    ],
  • "status": "success"
}

Post new TNS robot

Post new TNS robot

Request Body schema: application/json
group
any or null

The Group the TNS robot is associated with.

group_id
required
integer

The ID of the Group the allocation is associated with.

bot_name
required
string

Name of the TNS bot.

bot_id
required
integer

ID of the TNS bot.

source_group_id
required
integer

Source group ID of the TNS bot.

-
_altdata
string or null

Responses

Request samples

Content type
application/json
{
  • "group": null,
  • "group_id": 0,
  • "bot_name": "string",
  • "bot_id": 0,
  • "source_group_id": 0,
  • "_altdata": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

acls

Grant new ACL(s) to a user

Grant new ACL(s) to a user

+
_altdata
string or null

Responses

Request samples

Content type
application/json
{
  • "group": null,
  • "group_id": 0,
  • "bot_name": "string",
  • "bot_id": 0,
  • "source_group_id": 0,
  • "_altdata": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

acls

Grant new ACL(s) to a user

Grant new ACL(s) to a user

path Parameters
user_id
required
integer
Request Body schema: application/json
aclIds
required
Array of strings

Array of ACL IDs (strings) to be granted to user

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

Remove ACL from user permissions

Remove ACL from user permissions

-
path Parameters
user_id
required
integer
acl_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}

weather

Retrieve weather info at the telescope site saved

Retrieve weather info at the telescope site saved by user or telescope specified by telescope_id parameter

-
query Parameters
telescope_id
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string",
  • "data": {
    }
}

webhook

Return the results of an analysis

Return the results of an analysis

+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

Remove ACL from user permissions

Remove ACL from user permissions

+
path Parameters
user_id
required
integer
acl_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}

weather

Retrieve weather info at the telescope site saved

Retrieve weather info at the telescope site saved by user or telescope specified by telescope_id parameter

+
query Parameters
telescope_id
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success",
  • "data": {
    }
}

webhook

Return the results of an analysis

Return the results of an analysis

path Parameters
analysis_resource_type
required
string

What underlying data the analysis was performed on: must be "obj" (more to be added in the future)

token
required
string

The unique token for this analysis.

Request Body schema: application/json
results
object

Results data of this analysis

-

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "string"
}
+

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "success"
}