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">
Download OpenAPI specification:Download
SkyPortal provides an API to access most of its underlying + " fill="currentColor">
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 @@
Produce a report on allocations for an instrument
instrument_id required | integer |
output_format | string Output format for analysis. Can be png or pdf - |
{- "status": "success",
- "message": "string"
}
Retrieve an allocation
-allocation_id required | integer |
{- "data": {
- "requests": [
- null
], - "default_requests": [
- null
], - "default_observation_plans": [
- null
], - "catalog_queries": [
- null
], - "observation_plans": [
- null
], - "group": null,
- "instrument": null,
- "allocation_users": [
- null
], - "gcn_triggers": [
- null
], - "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",
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve an allocation
+allocation_id required | integer |
{- "message": "string",
- "data": {
- "requests": [
- null
], - "default_requests": [
- null
], - "default_observation_plans": [
- null
], - "catalog_queries": [
- null
], - "observation_plans": [
- null
], - "group": null,
- "instrument": null,
- "allocation_users": [
- null
], - "gcn_triggers": [
- null
], - "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",
- "id": 0
}, - "status": "success"
}
Update an allocation on a robotic instrument
allocation_id required | integer |
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 |
{- "requests": [
- null
], - "default_requests": [
- null
], - "default_observation_plans": [
- null
], - "catalog_queries": [
- null
], - "observation_plans": [
- null
], - "group": null,
- "instrument": null,
- "allocation_users": [
- null
], - "gcn_triggers": [
- null
], - "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"
}
{- "status": "success",
- "message": "string"
}
{- "requests": [
- null
], - "default_requests": [
- null
], - "default_observation_plans": [
- null
], - "catalog_queries": [
- null
], - "observation_plans": [
- null
], - "group": null,
- "instrument": null,
- "allocation_users": [
- null
], - "gcn_triggers": [
- null
], - "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"
}
{- "message": "string",
- "status": "success"
}
Retrieve all allocations
instrument_id | number Instrument ID to retrieve allocations for - |
{- "data": [
- {
- "requests": [
- null
], - "default_requests": [
- null
], - "default_observation_plans": [
- null
], - "catalog_queries": [
- null
], - "observation_plans": [
- null
], - "group": null,
- "instrument": null,
- "allocation_users": [
- null
], - "gcn_triggers": [
- null
], - "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",
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "requests": [
- null
], - "default_requests": [
- null
], - "default_observation_plans": [
- null
], - "catalog_queries": [
- null
], - "observation_plans": [
- null
], - "group": null,
- "instrument": null,
- "allocation_users": [
- null
], - "gcn_triggers": [
- null
], - "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",
- "id": 0
}
], - "status": "success"
}
Post new allocation on a robotic instrument
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 |
{- "requests": [
- null
], - "default_requests": [
- null
], - "default_observation_plans": [
- null
], - "catalog_queries": [
- null
], - "observation_plans": [
- null
], - "group": null,
- "instrument": null,
- "allocation_users": [
- null
], - "gcn_triggers": [
- null
], - "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"
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
{- "requests": [
- null
], - "default_requests": [
- null
], - "default_observation_plans": [
- null
], - "catalog_queries": [
- null
], - "observation_plans": [
- null
], - "group": null,
- "instrument": null,
- "allocation_users": [
- null
], - "gcn_triggers": [
- null
], - "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"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve all observation analyses
gcnevent_id | number GcnEvent ID to retrieve observation efficiency analyses for - |
{- "data": [
- {
- "gcnevent": null,
- "localization": null,
- "instrument": null,
- "requester": null,
- "groups": [
- null
], - "gcnevent_id": 0,
- "localization_id": 0,
- "instrument_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "gcnevent": null,
- "localization": null,
- "instrument": null,
- "requester": null,
- "groups": [
- null
], - "gcnevent_id": 0,
- "localization_id": 0,
- "instrument_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}
], - "status": "success"
}
Retrieve all observation plan efficiency analyses
observation_plan_id | number EventObservationPlan ID to retrieve observation plan efficiency analyses for - |
{- "data": [
- {
- "observation_plan": null,
- "requester": null,
- "groups": [
- null
], - "observation_plan_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "observation_plan": null,
- "requester": null,
- "groups": [
- null
], - "observation_plan_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}
], - "status": "success"
}
Retrieve a default analysis
analysis_service_id required | any Analysis service ID |
default_analysis_id required | any Default analysis ID - |
{- "data": {
- "analysis_service": null,
- "groups": [
- null
], - "author": null,
- "analysis_service_id": 0,
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "default_analysis_parameters": "string",
- "source_filter": null,
- "stats": null,
- "author_id": 0,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "analysis_service": null,
- "groups": [
- null
], - "author": null,
- "analysis_service_id": 0,
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "default_analysis_parameters": "string",
- "source_filter": null,
- "stats": null,
- "author_id": 0,
- "id": 0
}, - "status": "success"
}
{- "message": "string",
- "status": "success"
}
Retrieve all default analyses
analysis_service_id required | any Analysis service ID, if not provided, return all default analyses for all analysis services - |
{- "data": [
- {
- "analysis_service": null,
- "groups": [
- null
], - "author": null,
- "analysis_service_id": 0,
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "default_analysis_parameters": "string",
- "source_filter": null,
- "stats": null,
- "author_id": 0,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "analysis_service": null,
- "groups": [
- null
], - "author": null,
- "analysis_service_id": 0,
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "default_analysis_parameters": "string",
- "source_filter": null,
- "stats": null,
- "author_id": 0,
- "id": 0
}
], - "status": "success"
}
Get Swift LSXPS objects and post them as sources. Repeated posting will skip the existing source.
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. - |
{- "telescope_name": 0
}
{- "status": "success",
- "message": "string"
}
Get Gaia Photometric Alert objects and post them as sources. +
{- "telescope_name": 0
}
{- "message": "string",
- "status": "success"
}
Get Gaia Photometric Alert objects and post them as sources. Repeated posting will skip the existing source.
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. - |
{- "telescope_name": "string",
- "startDate": null,
- "endDate": null
}
{- "status": "success",
- "message": "string"
}
{- "data": [
- {
- "sent_by": null,
- "notices": [
- null
], - "predictions": [
- null
], - "measurements": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "sent_by_id": 0,
- "event_id": "string",
- "event_uri": "string",
- "status": "string",
- "id": 0
}
], - "status": "success",
- "message": "string"
}
get Gaia parallax and magnitudes and post them as an annotation, +
{- "telescope_name": "string",
- "startDate": null,
- "endDate": null
}
{- "message": "string",
- "status": "success"
}
{- "message": "string",
- "data": [
- {
- "sent_by": null,
- "notices": [
- null
], - "predictions": [
- null
], - "measurements": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "sent_by_id": 0,
- "event_id": "string",
- "event_uri": "string",
- "status": "string",
- "id": 0
}
], - "status": "success"
}
get Gaia parallax and magnitudes and post them as an annotation, based on cross-match to the Gaia DR3.
obj_id required | string ID of the object to retrieve Gaia colors for |
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. - |
{- "catalog": "string",
- "crossmatchRadius": 0,
- "crossmatchLimmag": 0,
- "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
{- "catalog": "string",
- "crossmatchRadius": 0,
- "crossmatchLimmag": 0,
- "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
get WISE colors and post them as an annotation based on cross-matches to some catalog (default is allwise_p3as_psd).
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. - |
{- "catalog": "string",
- "crossmatchRadius": 0,
- "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
get cross-match with Vizier and post them as an annotation +
{- "catalog": "string",
- "crossmatchRadius": 0,
- "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
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).
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. - |
{- "catalog": "string",
- "crossmatchRadius": 0,
- "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
Generate a PDF/PNG finding chart for a position or Gaia ID
+{- "catalog": "string",
- "crossmatchRadius": 0,
- "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Generate a PDF/PNG finding chart for a position or Gaia ID
location_type required | string Enum: "gaia_dr3" "gaia_dr2" "pos" What is the type of the search? From gaia or by position? If 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) |
{- "data": { },
- "status": "error",
- "message": "string"
}
Retrieve an Analysis Service by id
-analysis_service_id required | integer |
{- "data": {
- "groups": [
- null
], - "obj_analyses": [
- null
], - "default_analyses": [
- null
], - "name": "string",
- "display_name": "string",
- "description": "string",
- "version": "string",
- "contact_name": "string",
- "contact_email": "string",
- "url": "string",
- "optional_analysis_parameters": "string",
- "authentication_type": "none",
- "_authinfo": "string",
- "enabled": true,
- "analysis_type": "lightcurve_fitting",
- "input_data_types": [
- null
], - "timeout": 0,
- "upload_only": true,
- "display_on_resource_dropdown": true,
- "is_summary": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "data": [
- {
- "groups": [
- null
], - "obj_analyses": [
- null
], - "default_analyses": [
- null
], - "name": "string",
- "display_name": "string",
- "description": "string",
- "version": "string",
- "contact_name": "string",
- "contact_email": "string",
- "url": "string",
- "optional_analysis_parameters": "string",
- "authentication_type": "none",
- "_authinfo": "string",
- "enabled": true,
- "analysis_type": "lightcurve_fitting",
- "input_data_types": [
- null
], - "timeout": 0,
- "upload_only": true,
- "display_on_resource_dropdown": true,
- "is_summary": true,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
Retrieve an Analysis Service by id
+analysis_service_id required | integer |
{- "message": "string",
- "data": {
- "groups": [
- null
], - "obj_analyses": [
- null
], - "default_analyses": [
- null
], - "name": "string",
- "display_name": "string",
- "description": "string",
- "version": "string",
- "contact_name": "string",
- "contact_email": "string",
- "url": "string",
- "optional_analysis_parameters": "string",
- "authentication_type": "none",
- "_authinfo": "string",
- "enabled": true,
- "analysis_type": "lightcurve_fitting",
- "input_data_types": [
- null
], - "timeout": 0,
- "upload_only": true,
- "display_on_resource_dropdown": true,
- "is_summary": true,
- "id": 0
}, - "status": "success"
}
{- "message": "string",
- "data": [
- {
- "groups": [
- null
], - "obj_analyses": [
- null
], - "default_analyses": [
- null
], - "name": "string",
- "display_name": "string",
- "description": "string",
- "version": "string",
- "contact_name": "string",
- "contact_email": "string",
- "url": "string",
- "optional_analysis_parameters": "string",
- "authentication_type": "none",
- "_authinfo": "string",
- "enabled": true,
- "analysis_type": "lightcurve_fitting",
- "input_data_types": [
- null
], - "timeout": 0,
- "upload_only": true,
- "display_on_resource_dropdown": true,
- "is_summary": true,
- "id": 0
}
], - "status": "success"
}
Upload an upload_only analysis result
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. - |
{- "results": { },
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string",
- "data": {
- "analysis_id": 0
}
}
{- "results": { },
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success",
- "data": {
- "analysis_id": 0
}
}
Retrieve an Analysis by id
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 @@PaginationDefaults to false. |
includeFilename | boolean Boolean indicating whether to include the filename of the data associated with the analysis in the response. Defaults to false. - |
{- "data": {
- "obj": null,
- "author": null,
- "analysis_service": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "_unique_id": "string",
- "hash": "string",
- "_full_name": "string",
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": "string",
- "author_id": 0,
- "analysis_service_id": 0,
- "invalid_after": "2019-08-24T14:15:22Z",
- "token": "string",
- "handled_by_url": "string",
- "status": "queued",
- "duration": 0,
- "last_activity": "2019-08-24T14:15:22Z",
- "status_message": "string"
}, - "status": "success",
- "message": "string"
}
{- "data": [
- {
- "obj": null,
- "author": null,
- "analysis_service": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "_unique_id": "string",
- "hash": "string",
- "_full_name": "string",
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": "string",
- "author_id": 0,
- "analysis_service_id": 0,
- "invalid_after": "2019-08-24T14:15:22Z",
- "token": "string",
- "handled_by_url": "string",
- "status": "queued",
- "duration": 0,
- "last_activity": "2019-08-24T14:15:22Z",
- "status_message": "string"
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "obj": null,
- "author": null,
- "analysis_service": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "_unique_id": "string",
- "hash": "string",
- "_full_name": "string",
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": "string",
- "author_id": 0,
- "analysis_service_id": 0,
- "invalid_after": "2019-08-24T14:15:22Z",
- "token": "string",
- "handled_by_url": "string",
- "status": "queued",
- "duration": 0,
- "last_activity": "2019-08-24T14:15:22Z",
- "status_message": "string"
}, - "status": "success"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "author": null,
- "analysis_service": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "_unique_id": "string",
- "hash": "string",
- "_full_name": "string",
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": "string",
- "author_id": 0,
- "analysis_service_id": 0,
- "invalid_after": "2019-08-24T14:15:22Z",
- "token": "string",
- "handled_by_url": "string",
- "status": "queued",
- "duration": 0,
- "last_activity": "2019-08-24T14:15:22Z",
- "status_message": "string"
}
], - "status": "success"
}
Begin an analysis run
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. - |
{- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": {
- "property1": "string",
- "property2": "string"
}, - "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string",
- "data": {
- "analysis_id": 0
}
}
{- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": {
- "property1": "string",
- "property2": "string"
}, - "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success",
- "data": {
- "analysis_id": 0
}
}
Retrieve an Analysis by id
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 @@PaginationDefaults to false. |
includeFilename | boolean Boolean indicating whether to include the filename of the data associated with the analysis in the response. Defaults to false. - |
{- "data": {
- "obj": null,
- "author": null,
- "analysis_service": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "_unique_id": "string",
- "hash": "string",
- "_full_name": "string",
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": "string",
- "author_id": 0,
- "analysis_service_id": 0,
- "invalid_after": "2019-08-24T14:15:22Z",
- "token": "string",
- "handled_by_url": "string",
- "status": "queued",
- "duration": 0,
- "last_activity": "2019-08-24T14:15:22Z",
- "status_message": "string"
}, - "status": "success",
- "message": "string"
}
{- "data": [
- {
- "obj": null,
- "author": null,
- "analysis_service": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "_unique_id": "string",
- "hash": "string",
- "_full_name": "string",
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": "string",
- "author_id": 0,
- "analysis_service_id": 0,
- "invalid_after": "2019-08-24T14:15:22Z",
- "token": "string",
- "handled_by_url": "string",
- "status": "queued",
- "duration": 0,
- "last_activity": "2019-08-24T14:15:22Z",
- "status_message": "string"
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "obj": null,
- "author": null,
- "analysis_service": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "_unique_id": "string",
- "hash": "string",
- "_full_name": "string",
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": "string",
- "author_id": 0,
- "analysis_service_id": 0,
- "invalid_after": "2019-08-24T14:15:22Z",
- "token": "string",
- "handled_by_url": "string",
- "status": "queued",
- "duration": 0,
- "last_activity": "2019-08-24T14:15:22Z",
- "status_message": "string"
}, - "status": "success"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "author": null,
- "analysis_service": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "_unique_id": "string",
- "hash": "string",
- "_full_name": "string",
- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": "string",
- "author_id": 0,
- "analysis_service_id": 0,
- "invalid_after": "2019-08-24T14:15:22Z",
- "token": "string",
- "handled_by_url": "string",
- "status": "queued",
- "duration": 0,
- "last_activity": "2019-08-24T14:15:22Z",
- "status_message": "string"
}
], - "status": "success"
}
Begin an analysis run
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. - |
{- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": {
- "property1": "string",
- "property2": "string"
}, - "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string",
- "data": {
- "analysis_id": 0
}
}
Retrieve primary data associated with an Analysis.
+{- "show_parameters": true,
- "show_plots": true,
- "show_corner": true,
- "analysis_parameters": {
- "property1": "string",
- "property2": "string"
}, - "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success",
- "data": {
- "analysis_id": 0
}
}
Retrieve primary data associated with an Analysis.
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 @@ Paginationif new plots are to be generated (e.g. with corner plots) |
{- "download": null,
- "plot_kwargs": {
- "property1": { },
- "property2": { }
}
}
{ }
Retrieve an observing run assignment
-assignment_id required | integer |
{- "data": {
- "requester": null,
- "last_modified_by": null,
- "obj": null,
- "spectra": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "run": null,
- "requester_id": 0,
- "last_modified_by_id": 0,
- "obj_id": "string",
- "comment": "string",
- "status": "string",
- "priority": "1",
- "run_id": 0,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "requester": null,
- "last_modified_by": null,
- "obj": null,
- "spectra": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "run": null,
- "requester_id": 0,
- "last_modified_by_id": 0,
- "obj_id": "string",
- "comment": "string",
- "status": "string",
- "priority": "1",
- "run_id": 0,
- "id": 0
}, - "status": "success"
}
Update an assignment
assignment_id required | integer |
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. - |
{- "requester": null,
- "last_modified_by": null,
- "obj": null,
- "spectra": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "run": null,
- "requester_id": 0,
- "obj_id": "string",
- "comment": "string",
- "status": "string",
- "priority": "1",
- "run_id": 0
}
{- "status": "success",
- "message": "string"
}
{- "data": [
- {
- "requester": null,
- "last_modified_by": null,
- "obj": null,
- "spectra": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "run": null,
- "requester_id": 0,
- "last_modified_by_id": 0,
- "obj_id": "string",
- "comment": "string",
- "status": "string",
- "priority": "1",
- "run_id": 0,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
Post new target assignment to observing run
-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. - |
{- "run_id": 0,
- "obj_id": "string",
- "priority": "1",
- "status": "string",
- "comment": "string"
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
{- "requester": null,
- "last_modified_by": null,
- "obj": null,
- "spectra": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "run": null,
- "requester_id": 0,
- "obj_id": "string",
- "comment": "string",
- "status": "string",
- "priority": "1",
- "run_id": 0
}
{- "message": "string",
- "status": "success"
}
{- "message": "string",
- "data": [
- {
- "requester": null,
- "last_modified_by": null,
- "obj": null,
- "spectra": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "run": null,
- "requester_id": 0,
- "last_modified_by_id": 0,
- "obj_id": "string",
- "comment": "string",
- "status": "string",
- "priority": "1",
- "run_id": 0,
- "id": 0
}
], - "status": "success"
}
Post new target assignment to observing run
+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). + |
{- "status": "string",
- "run_id": 0,
- "obj_id": "string",
- "comment": "string",
- "priority": "1"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve a candidate
obj_id required | string |
includeComments | boolean Boolean indicating whether to include associated comments. Defaults to false. |
includeAlerts | boolean Boolean indicating whether to include associated alerts. Defaults to false. - |
{- "data": {
- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "id": "string",
- "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": [
- null
], - "sources": [
- null
], - "users": [
- null
]
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "id": "string",
- "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": [
- null
], - "sources": [
- null
], - "users": [
- null
]
}, - "status": "success"
}
Retrieve all candidates
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 - |
{- "status": "success",
- "message": "string",
- "data": {
- "candidates": [
- {
- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "id": "string",
- "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": [
- null
], - "sources": [
- null
], - "users": [
- null
], - "is_source": true
}
], - "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "candidates": [
- {
- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "id": "string",
- "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": [
- null
], - "sources": [
- null
], - "users": [
- null
], - "is_source": true
}
], - "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
Create new candidate(s) (one per filter).
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. - |
{- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "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": [
- null
], - "sources": [
- null
], - "users": [
- null
], - "filter_ids": [
- 0
], - "passing_alert_id": 0,
- "passed_at": "string"
}
{- "status": "success",
- "message": "string",
- "data": {
- "ids": [
- 0
]
}
}
{- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "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": [
- null
], - "sources": [
- null
], - "users": [
- null
], - "filter_ids": [
- 0
], - "passing_alert_id": 0,
- "passed_at": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "ids": [
- 0
]
}
}
Create new candidate(s) (one per filter).
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. - |
{- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "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": [
- null
], - "sources": [
- null
], - "users": [
- null
], - "filter_ids": [
- 0
], - "passing_alert_id": 0,
- "passed_at": "string"
}
{- "status": "success",
- "message": "string",
- "data": {
- "ids": [
- 0
]
}
}
Submit catalog queries
-allocation_id required | integer Catalog query request allocation ID. + |
{- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "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": [
- null
], - "sources": [
- null
], - "users": [
- null
], - "filter_ids": [
- 0
], - "passing_alert_id": 0,
- "passed_at": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "ids": [
- 0
]
}
}
Submit catalog queries
+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. - |
{- "allocation_id": 0,
- "status": "pending submission",
- "target_group_ids": [
- 0
], - "payload": null
}
{- "status": "success",
- "message": "string"
}
Catalog query request allocation ID.
+{- "target_group_ids": [
- 0
], - "payload": null,
- "status": "pending submission",
- "allocation_id": 0
}
{- "message": "string",
- "status": "success"
}
Vote for a classification.
classification_id required | string ID of classification to indicate the vote for |
vote required | integer Upvote or downvote a classification - |
{- "vote": 0
}
{- "status": "success",
- "message": "string"
}
{- "vote": 0
}
{- "message": "string",
- "status": "success"
}
Retrieve a classification
classification_id required | integer |
includeTaxonomy | boolean Return associated taxonomy. - |
{- "data": {
- "taxonomy": null,
- "author": null,
- "obj": null,
- "groups": [
- null
], - "votes": [
- null
], - "classification": "string",
- "taxonomy_id": 0,
- "probability": 0,
- "author_id": 0,
- "author_name": "string",
- "obj_id": "string",
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "taxonomy": null,
- "author": null,
- "obj": null,
- "groups": [
- null
], - "votes": [
- null
], - "classification": "string",
- "taxonomy_id": 0,
- "probability": 0,
- "author_id": 0,
- "author_name": "string",
- "obj_id": "string",
- "id": 0
}, - "status": "success"
}
Update a classification
classification required | integer |
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. - |
{- "taxonomy": null,
- "author": null,
- "obj": null,
- "groups": [
- null
], - "votes": [
- null
], - "classification": "string",
- "taxonomy_id": 0,
- "probability": 0,
- "author_id": 0,
- "author_name": "string",
- "obj_id": "string",
- "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
{- "taxonomy": null,
- "author": null,
- "obj": null,
- "groups": [
- null
], - "votes": [
- null
], - "classification": "string",
- "taxonomy_id": 0,
- "probability": 0,
- "author_id": 0,
- "author_name": "string",
- "obj_id": "string",
- "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Delete a classification
classification_id required | integer |
label | boolean or null Add label associated with classification. - |
{- "label": true
}
{- "status": "success",
- "message": "string"
}
{- "label": true
}
{- "message": "string",
- "status": "success"
}
Retrieve all classifications
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 - |
{- "status": "success",
- "message": "string",
- "data": {
- "sources": [
- {
- "taxonomy": null,
- "author": null,
- "obj": null,
- "groups": [
- null
], - "votes": [
- null
], - "classification": "string",
- "taxonomy_id": 0,
- "probability": 0,
- "author_id": 0,
- "author_name": "string",
- "obj_id": "string",
- "id": 0
}
], - "totalMatches": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "sources": [
- {
- "taxonomy": null,
- "author": null,
- "obj": null,
- "groups": [
- null
], - "votes": [
- null
], - "classification": "string",
- "taxonomy_id": 0,
- "probability": 0,
- "author_id": 0,
- "author_name": "string",
- "obj_id": "string",
- "id": 0
}
], - "totalMatches": 0
}
}
Post a classification
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 @@ Paginationrequesting user's groups. |
vote | boolean or null Add vote associated with classification. |
label | boolean or null Add label associated with classification. - |
{- "obj_id": "string",
- "classification": "string",
- "taxonomy_id": 0,
- "probability": null,
- "group_ids": [
- 0
], - "vote": true,
- "label": true
}
{- "status": "success",
- "message": "string",
- "data": {
- "classification_id": 0
}
}
Retrieve an object's classifications
-obj_id required | string |
{- "data": [
- {
- "taxonomy": null,
- "author": null,
- "obj": null,
- "groups": [
- null
], - "votes": [
- null
], - "classification": "string",
- "taxonomy_id": 0,
- "probability": 0,
- "author_id": 0,
- "author_name": "string",
- "obj_id": "string",
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "obj_id": "string",
- "classification": "string",
- "taxonomy_id": 0,
- "probability": null,
- "group_ids": [
- 0
], - "vote": true,
- "label": true
}
{- "message": "string",
- "status": "success",
- "data": {
- "classification_id": 0
}
}
Retrieve an object's classifications
+obj_id required | string |
{- "message": "string",
- "data": [
- {
- "taxonomy": null,
- "author": null,
- "obj": null,
- "groups": [
- null
], - "votes": [
- null
], - "classification": "string",
- "taxonomy_id": 0,
- "probability": 0,
- "author_id": 0,
- "author_name": "string",
- "obj_id": "string",
- "id": 0
}
], - "status": "success"
}
Delete all of an object's classifications
classification_id required | integer |
label | boolean or null Add label associated with classification. - |
{- "label": true
}
{- "status": "success",
- "message": "string"
}
{- "label": true
}
{- "message": "string",
- "status": "success"
}
Vote for a classification.
classification_id required | string ID of classification to indicate the vote for |
vote required | integer Upvote or downvote a classification - |
{- "vote": 0
}
{- "status": "success",
- "message": "string"
}
{- "vote": 0
}
{- "message": "string",
- "status": "success"
}
find the sources with classifications
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 - |
{- "status": "success",
- "message": "string",
- "data": [
- 0
]
}
{- "status": "success",
- "message": "string",
- "data": {
- "ALLOWED_SPECTRUM_TYPES": [ ],
- "ALLOWED_MAGSYSTEMS": [ ],
- "ALLOWED_BANDPASSES": [ ],
- "THUMBNAIL_TYPES": [ ],
- "FOLLOWUP_PRIORITIES": [ ],
- "ALLOWED_API_CLASSNAMES": [ ],
- "ANALYSIS_TYPES": [ ],
- "ANALYSIS_INPUT_TYPES": [ ],
- "AUTHENTICATION_TYPES": [ ]
}
}
{- "status": "success",
- "message": "string",
- "data": {
- "Number of candidates": 0,
- "Number of objs": 0,
- "Number of sources": 0,
- "Number of photometry": 0,
- "Number of spectra": 0,
- "Number of groups": 0,
- "Number of users": 0,
- "Number of tokens": 0,
- "Oldest candidate creation datetime": "string",
- "Newest candidate creation datetime": "string"
}
}
Retrieve a single default follow-up request
-default_followup_request_id required | integer |
{- "data": {
- "requester": null,
- "allocation": null,
- "target_groups": [
- null
], - "requester_id": 0,
- "payload": null,
- "allocation_id": 0,
- "default_followup_name": "string",
- "source_filter": null,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "data": [
- {
- "requester": null,
- "allocation": null,
- "target_groups": [
- null
], - "requester_id": 0,
- "payload": null,
- "allocation_id": 0,
- "default_followup_name": "string",
- "source_filter": null,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "data": [
- {
- "requester": null,
- "allocation": null,
- "target_groups": [
- null
], - "default_survey_efficiencies": [
- null
], - "requester_id": 0,
- "payload": null,
- "filters": null,
- "allocation_id": 0,
- "default_plan_name": "string",
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "data": [
- {
- "default_observationplan_request": null,
- "default_observationplan_request_id": 0,
- "payload": null,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success",
- "data": [
- 0
]
}
{- "message": "string",
- "status": "success",
- "data": {
- "ALLOWED_SPECTRUM_TYPES": [ ],
- "ALLOWED_MAGSYSTEMS": [ ],
- "ALLOWED_BANDPASSES": [ ],
- "THUMBNAIL_TYPES": [ ],
- "FOLLOWUP_PRIORITIES": [ ],
- "ALLOWED_API_CLASSNAMES": [ ],
- "ANALYSIS_TYPES": [ ],
- "ANALYSIS_INPUT_TYPES": [ ],
- "AUTHENTICATION_TYPES": [ ]
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "Number of candidates": 0,
- "Number of objs": 0,
- "Number of sources": 0,
- "Number of photometry": 0,
- "Number of spectra": 0,
- "Number of groups": 0,
- "Number of users": 0,
- "Number of tokens": 0,
- "Oldest candidate creation datetime": "string",
- "Newest candidate creation datetime": "string"
}
}
Retrieve a single default follow-up request
+default_followup_request_id required | integer |
{- "message": "string",
- "data": {
- "requester": null,
- "allocation": null,
- "target_groups": [
- null
], - "requester_id": 0,
- "payload": null,
- "allocation_id": 0,
- "default_followup_name": "string",
- "source_filter": null,
- "id": 0
}, - "status": "success"
}
{- "message": "string",
- "data": [
- {
- "requester": null,
- "allocation": null,
- "target_groups": [
- null
], - "requester_id": 0,
- "payload": null,
- "allocation_id": 0,
- "default_followup_name": "string",
- "source_filter": null,
- "id": 0
}
], - "status": "success"
}
{- "message": "string",
- "data": [
- {
- "requester": null,
- "allocation": null,
- "target_groups": [
- null
], - "default_survey_efficiencies": [
- null
], - "requester_id": 0,
- "payload": null,
- "filters": null,
- "allocation_id": 0,
- "default_plan_name": "string",
- "id": 0
}
], - "status": "success"
}
{- "message": "string",
- "data": [
- {
- "default_observationplan_request": null,
- "default_observationplan_request_id": 0,
- "payload": null,
- "id": 0
}
], - "status": "success"
}
Update filter name
filter_id required | integer |
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. - |
{- "stream": null,
- "group": null,
- "candidates": [
- null
], - "name": "string",
- "stream_id": 0,
- "group_id": 0
}
{- "status": "success",
- "message": "string"
}
{- "stream": null,
- "group": null,
- "candidates": [
- null
], - "name": "string",
- "stream_id": 0,
- "group_id": 0
}
{- "message": "string",
- "status": "success"
}
POST a new filter.
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. - |
{- "stream": null,
- "group": null,
- "candidates": [
- null
], - "name": "string",
- "stream_id": 0,
- "group_id": 0
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Create default follow-up request.
-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. - |
{- "allocation_id": 0,
- "target_group_ids": [
- 0
], - "payload": null
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Retrieve a single default observation plan
-default_observation_plan_id required | integer |
{- "data": {
- "requester": null,
- "allocation": null,
- "target_groups": [
- null
], - "default_survey_efficiencies": [
- null
], - "requester_id": 0,
- "payload": null,
- "filters": null,
- "allocation_id": 0,
- "default_plan_name": "string",
- "id": 0
}, - "status": "success",
- "message": "string"
}
Create default observation plan requests.
-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. - |
{- "allocation_id": 0,
- "target_group_ids": [
- 0
], - "payload": null
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Retrieve a single default survey efficiency
-default_survey_efficiency_id required | integer |
{- "data": {
- "default_observationplan_request": null,
- "default_observationplan_request_id": 0,
- "payload": null,
- "id": 0
}, - "status": "success",
- "message": "string"
}
Create default survey efficiency requests.
-default_observationplan_request_id required | integer Default observation plan request ID. - |
payload | any Content of the default survey efficiency analysis. - |
{- "default_observationplan_request_id": 0,
- "payload": null
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Post a message from a remote facility
-new_status required | string |
followup_request_id required | integer |
{- "new_status": "string",
- "followup_request_id": 0
}
{- "status": "success",
- "message": "string"
}
{- "stream": null,
- "group": null,
- "candidates": [
- null
], - "name": "string",
- "stream_id": 0,
- "group_id": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Create default follow-up request.
+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. + |
{- "target_group_ids": [
- 0
], - "payload": null,
- "allocation_id": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve a single default observation plan
+default_observation_plan_id required | integer |
{- "message": "string",
- "data": {
- "requester": null,
- "allocation": null,
- "target_groups": [
- null
], - "default_survey_efficiencies": [
- null
], - "requester_id": 0,
- "payload": null,
- "filters": null,
- "allocation_id": 0,
- "default_plan_name": "string",
- "id": 0
}, - "status": "success"
}
Create default observation plan requests.
+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. + |
{- "target_group_ids": [
- 0
], - "payload": null,
- "allocation_id": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve a single default survey efficiency
+default_survey_efficiency_id required | integer |
{- "message": "string",
- "data": {
- "default_observationplan_request": null,
- "default_observationplan_request_id": 0,
- "payload": null,
- "id": 0
}, - "status": "success"
}
Create default survey efficiency requests.
+payload | any Content of the default survey efficiency analysis. + |
default_observationplan_request_id required | integer Default observation plan request ID. + |
{- "payload": null,
- "default_observationplan_request_id": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Post a message from a remote facility
+new_status required | string |
followup_request_id required | integer |
{- "new_status": "string",
- "followup_request_id": 0
}
{- "message": "string",
- "status": "success"
}
Retrieve followup requests schedule
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 |
{- "data": { },
- "status": "error",
- "message": "string"
}
Update a follow-up request
-request_id required | string |
{- "payload": null,
- "allocation_id": 0,
- "target_group_ids": [
- 0
], - "status": "pending submission",
- "obj_id": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
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.
file_name | string Name of the file containing the galaxies (in the data directory) |
file_url | string URL of the file containing the galaxies - |
{- "file_name": "string",
- "file_url": "string"
}
{- "status": "success",
- "message": "string"
}
{- "file_name": "string",
- "file_url": "string"
}
{- "message": "string",
- "status": "success"
}
Upload galaxies from ASCII file
catalogData | any Catalog data Ascii string |
catalogName | string Galaxy catalog name. - |
{- "catalogData": null,
- "catalogName": "string"
}
{- "data": [
- {
- "objects": [
- null
], - "catalog_name": "string",
- "name": "string",
- "alt_name": "string",
- "distmpc": 0,
- "distmpc_unc": 0,
- "redshift": 0,
- "redshift_error": 0,
- "sfr_fuv": 0,
- "sfr_w4": 0,
- "mstar": 0,
- "magb": 0,
- "magk": 0,
- "mag_fuv": 0,
- "mag_nuv": 0,
- "a": 0,
- "b2a": 0,
- "pa": 0,
- "btc": 0,
- "id": 0,
- "ra": 0,
- "dec": 0
}
], - "status": "success",
- "message": "string"
}
{- "catalogData": null,
- "catalogName": "string"
}
{- "message": "string",
- "data": [
- {
- "objects": [
- null
], - "catalog_name": "string",
- "name": "string",
- "alt_name": "string",
- "distmpc": 0,
- "distmpc_unc": 0,
- "redshift": 0,
- "redshift_error": 0,
- "sfr_fuv": 0,
- "sfr_w4": 0,
- "mstar": 0,
- "magb": 0,
- "magk": 0,
- "mag_fuv": 0,
- "mag_nuv": 0,
- "a": 0,
- "b2a": 0,
- "pa": 0,
- "btc": 0,
- "id": 0,
- "ra": 0,
- "dec": 0
}
], - "status": "success"
}
Set an object's host galaxy
obj_id required | string |
galaxyName required | string Name of the galaxy to associate with the object - |
{- "galaxyName": "string"
}
{- "status": "success",
- "message": "string"
}
{- "galaxyName": "string"
}
{- "message": "string",
- "status": "success"
}
Upload spatial catalog from ASCII file
catalogData | any Catalog data Ascii string |
catalogName | string Spatial catalog name. - |
{- "catalogData": null,
- "catalogName": "string"
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
{- "catalogData": null,
- "catalogName": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve all galaxies
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. - |
{- "data": [
- {
- "objects": [
- null
], - "catalog_name": "string",
- "name": "string",
- "alt_name": "string",
- "distmpc": 0,
- "distmpc_unc": 0,
- "redshift": 0,
- "redshift_error": 0,
- "sfr_fuv": 0,
- "sfr_w4": 0,
- "mstar": 0,
- "magb": 0,
- "magk": 0,
- "mag_fuv": 0,
- "mag_nuv": 0,
- "a": 0,
- "b2a": 0,
- "pa": 0,
- "btc": 0,
- "id": 0,
- "ra": 0,
- "dec": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "objects": [
- null
], - "catalog_name": "string",
- "name": "string",
- "alt_name": "string",
- "distmpc": 0,
- "distmpc_unc": 0,
- "redshift": 0,
- "redshift_error": 0,
- "sfr_fuv": 0,
- "sfr_w4": 0,
- "mstar": 0,
- "magb": 0,
- "magk": 0,
- "mag_fuv": 0,
- "mag_nuv": 0,
- "a": 0,
- "b2a": 0,
- "pa": 0,
- "btc": 0,
- "id": 0,
- "ra": 0,
- "dec": 0
}
], - "status": "success"
}
Ingest a Galaxy catalog
catalog_name | string Galaxy catalog name. |
catalog_data | Array of any Galaxy catalog data - |
{- "catalog_name": "string",
- "catalog_data": [
- null
]
}
{- "status": "success",
- "message": "string"
}
{- "catalog_name": "string",
- "catalog_data": [
- null
]
}
{- "message": "string",
- "status": "success"
}
Ingest a Spatial Catalog
catalog_name | string Spatial catalog name. |
catalog_data | Array of any Spatial catalog data - |
{- "catalog_name": "string",
- "catalog_data": [
- null
]
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Compute instrument field probabilities for a skymap
+{- "catalog_name": "string",
- "catalog_data": [
- null
]
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Compute instrument field probabilities for a skymap
dateobs required | string |
Instrument ID required | integer |
localization_name required | string Localization map name |
integrated_probability | float Cumulative integrated probability threshold - |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve an instrument
instrument_id required | integer |
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 @@ Paginationtable. |
localizationCumprob | number Cumulative probability up to which to include fields. Defaults to 0.95. - |
{- "data": {
- "telescope": null,
- "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "allocations": [
- null
], - "observing_runs": [
- null
], - "observations": [
- null
], - "queued_observations": [
- null
], - "fields": [
- null
], - "tiles": [
- null
], - "plans": [
- null
], - "name": "string",
- "type": "imager",
- "band": "string",
- "telescope_id": 0,
- "filters": [
- null
], - "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,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "telescope": null,
- "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "allocations": [
- null
], - "observing_runs": [
- null
], - "observations": [
- null
], - "queued_observations": [
- null
], - "fields": [
- null
], - "tiles": [
- null
], - "plans": [
- null
], - "name": "string",
- "type": "imager",
- "band": "string",
- "telescope_id": 0,
- "filters": [
- null
], - "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,
- "id": 0
}, - "status": "success"
}
Update instrument
instrument_id required | integer |
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. - |
{- "telescope": null,
- "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "allocations": [
- null
], - "observing_runs": [
- null
], - "observations": [
- null
], - "queued_observations": [
- null
], - "fields": [
- null
], - "tiles": [
- null
], - "plans": [
- null
], - "name": "string",
- "type": "imager",
- "band": "string",
- "telescope_id": 0,
- "filters": [
- null
], - "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
}
{- "status": "success",
- "message": "string"
}
{- "telescope": null,
- "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "allocations": [
- null
], - "observing_runs": [
- null
], - "observations": [
- null
], - "queued_observations": [
- null
], - "fields": [
- null
], - "tiles": [
- null
], - "plans": [
- null
], - "name": "string",
- "type": "imager",
- "band": "string",
- "telescope_id": 0,
- "filters": [
- null
], - "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
}
{- "message": "string",
- "status": "success"
}
Delete an instrument
instrument_id required | integer |
fieldsOnly | boolean Boolean indicating whether to just delete the associated fields. Defaults to false. - |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve all instruments
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 ( |
{- "data": [
- {
- "telescope": null,
- "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "allocations": [
- null
], - "observing_runs": [
- null
], - "observations": [
- null
], - "queued_observations": [
- null
], - "fields": [
- null
], - "tiles": [
- null
], - "plans": [
- null
], - "name": "string",
- "type": "imager",
- "band": "string",
- "telescope_id": 0,
- "filters": [
- null
], - "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,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "telescope": null,
- "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "allocations": [
- null
], - "observing_runs": [
- null
], - "observations": [
- null
], - "queued_observations": [
- null
], - "fields": [
- null
], - "tiles": [
- null
], - "plans": [
- null
], - "name": "string",
- "type": "imager",
- "band": "string",
- "telescope_id": 0,
- "filters": [
- null
], - "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,
- "id": 0
}
], - "status": "success"
}
Add a new instrument
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 @@PaginationSingle float radius in degrees in case of circle or list of two floats (height and width) in case of a rectangle. - |
{- "telescope": null,
- "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "allocations": [
- null
], - "observing_runs": [
- null
], - "observations": [
- null
], - "queued_observations": [
- null
], - "fields": [
- null
], - "tiles": [
- null
], - "plans": [
- null
], - "name": "string",
- "type": "imager",
- "band": "string",
- "telescope_id": 0,
- "filters": [
- null
], - "sensitivity_data": {
- "filter_name": "bessellux"
}, - "configuration_data": {
- "filter_name": {
- "filt_change_time": null,
- "readout": null,
- "overhead_per_exposure": null,
- "slew_rate": 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,
- "field_data": null,
- "field_region": null,
- "references": null,
- "field_fov_type": null,
- "field_fov_attributes": null
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Retrieve a ground velocity measurement for the earthquake.
-earthquake_id required | string |
mma_detector_id required | string |
{- "data": {
- "event_id": 0,
- "detector_id": 0,
- "rfamp": 0,
- "lockloss": 0,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "telescope": null,
- "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "allocations": [
- null
], - "observing_runs": [
- null
], - "observations": [
- null
], - "queued_observations": [
- null
], - "fields": [
- null
], - "tiles": [
- null
], - "plans": [
- null
], - "name": "string",
- "type": "imager",
- "band": "string",
- "telescope_id": 0,
- "filters": [
- null
], - "sensitivity_data": {
- "filter_name": "bessellux"
}, - "configuration_data": {
- "filter_name": {
- "filt_change_time": null,
- "readout": null,
- "overhead_per_exposure": null,
- "slew_rate": 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,
- "field_data": null,
- "field_region": null,
- "references": null,
- "field_fov_type": null,
- "field_fov_attributes": null
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve a ground velocity measurement for the earthquake.
+earthquake_id required | string |
mma_detector_id required | string |
{- "message": "string",
- "data": {
- "event_id": 0,
- "detector_id": 0,
- "rfamp": 0,
- "lockloss": 0,
- "id": 0
}, - "status": "success"
}
Retrieve multiple Earthquake events
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 @@ PaginationRequest Body schema: application/json
ResponsesRequest samples
Content type application/json { Response samples
Content type application/json { |
{- "sent_by": null,
- "notices": [
- null
], - "predictions": [
- null
], - "measurements": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "sent_by_id": 0,
- "event_id": "string",
- "event_uri": "string",
- "status": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve all comments associated with specified resource
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. - |
{- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success"
}
Update a comment
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. - |
{- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0,
- "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
{- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0,
- "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Post a comment
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 |
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 |
{- "text": "string",
- "group_ids": [
- 0
], - "attachment": {
- "body": "string",
- "name": "string"
}
}
{- "status": "success",
- "message": "string",
- "data": {
- "comment_id": 0
}
}
{- "text": "string",
- "group_ids": [
- 0
], - "attachment": {
- "body": "string",
- "name": "string"
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "comment_id": 0
}
}
Delete a comment
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 |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve a comment
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 |
{- "data": {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}, - "status": "success"
}
Update a comment
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. - |
{- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0,
- "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
{- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0,
- "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Delete a comment
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 |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Download comment attachment
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 |
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. |
create attachments for a batch of comments with attachment_bytes
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 - |
{- "status": "success",
- "message": "string",
- "data": {
- "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
Retrieve all comments associated with specified resource
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. - |
{- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success"
}
Retrieve all annotations associated with specified resource
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. - |
{- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success"
}
Retrieve a comment
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 |
{- "data": {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}, - "status": "success"
}
Retrieve a reminder
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 |
{- "data": {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}, - "status": "success",
- "message": "string"
}
Retrieve all reminders associated with specified resource
+{- "message": "string",
- "data": {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}, - "status": "success"
}
Retrieve all reminders associated with specified resource
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. - |
{- "data": [
- {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}
], - "status": "success"
}
Retrieve all spectra associated with an Object
obj_id required | string ID of the object to retrieve spectra for |
normalization | string what normalization is needed for the spectra (e.g., "median"). If omitted, returns the original spectrum. @@ -1313,41 +1313,41 @@ Pagination
|
{- "status": "success",
- "message": "string",
- "data": {
- "obj_id": "string",
- "spectra": [
- {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}
]
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "obj_id": "string",
- "spectra": [
- {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}
]
}
}
Retrieve all annotations associated with specified resource
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. - |
{- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success"
}
Retrieve an annotation
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 |
{- "data": {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}, - "status": "success",
- "message": "string"
}
{- "data": {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}, - "status": "success",
- "message": "string"
}
Update spectrum
-spectrum_id required | integer |
type | string Enum: "source" "host" "host_center" Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'. + |
annotation_id required | integer |
{- "message": "string",
- "data": {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}, - "status": "success"
}
{- "message": "string",
- "data": {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}, - "status": "success"
}
Update spectrum
+spectrum_id required | integer |
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 |
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 |
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. - |
{- "type": "source",
- "external_observer": null,
- "obj_id": "string",
- "errors": [
- 0
], - "origin": "string",
- "altdata": null,
- "observed_by": [ ],
- "units": "string",
- "assignment_id": 0,
- "reduced_by": [ ],
- "instrument_id": 0,
- "wavelengths": [
- 0
], - "followup_request_id": 0,
- "fluxes": [
- 0
], - "external_reducer": null,
- "group_ids": [ ],
- "label": "string",
- "observed_at": "2019-08-24T14:15:22Z"
}
{- "status": "success",
- "message": "string"
}
ID of this Spectrum's Obj.
+{- "external_reducer": null,
- "observed_by": [ ],
- "wavelengths": [
- 0
], - "observed_at": "2019-08-24T14:15:22Z",
- "label": "string",
- "group_ids": [ ],
- "fluxes": [
- 0
], - "assignment_id": 0,
- "external_observer": null,
- "origin": "string",
- "followup_request_id": 0,
- "type": "source",
- "units": "string",
- "reduced_by": [ ],
- "errors": [
- 0
], - "altdata": null,
- "instrument_id": 0,
- "obj_id": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve multiple spectra with given criteria
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
-type | string Enum: "source" "host" "host_center" Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'. +Request Body schema: application/json
ResponsesRequest samples
Content type application/json { Response samples
Content type application/json { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
obj_id required | string ID of this Spectrum's Obj. + |
{- "external_reducer": null,
- "observed_by": [ ],
- "wavelengths": [
- 0
], - "observed_at": "2019-08-24T14:15:22Z",
- "label": "string",
- "group_ids": [ ],
- "fluxes": [
- 0
], - "assignment_id": 0,
- "external_observer": null,
- "origin": "string",
- "followup_request_id": 0,
- "type": "source",
- "units": "string",
- "reduced_by": [ ],
- "errors": [
- 0
], - "altdata": null,
- "instrument_id": 0,
- "obj_id": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Parse spectrum from ASCII file
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). |
{- "ascii": "string",
- "wave_column": 0,
- "fluxerr_column": null,
- "flux_column": 1
}
{- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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
-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
ResponsesRequest samples
Content type application/json { Response samples
Content type application/json { | ||||||||||||||||||
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. + |
{- "ascii": "string",
- "external_reducer": null,
- "observed_by": [ ],
- "label": "string",
- "observed_at": "2019-08-24T14:15:22Z",
- "group_ids": [
- 0
], - "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"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Create synthetic photometry from a spectrum
spectrum_id required | integer |
filters required | list List of filters - |
{- "data": {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}, - "status": "success"
}
Retrieve spectra for given instrument within date range
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. - |
{- "status": "success",
- "message": "string",
- "data": {
- "obj_id": "string",
- "spectra": [
- {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}
]
}
}
{- "data": {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}, - "status": "success",
- "message": "string"
}
Update spectrum
-spectrum_id required | integer |
type | string Enum: "source" "host" "host_center" Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'. + |
{- "message": "string",
- "status": "success",
- "data": {
- "obj_id": "string",
- "spectra": [
- {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}
]
}
}
{- "message": "string",
- "data": {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}, - "status": "success"
}
Update spectrum
+spectrum_id required | integer |
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 |
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 |
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. - |
{- "type": "source",
- "external_observer": null,
- "obj_id": "string",
- "errors": [
- 0
], - "origin": "string",
- "altdata": null,
- "observed_by": [ ],
- "units": "string",
- "assignment_id": 0,
- "reduced_by": [ ],
- "instrument_id": 0,
- "wavelengths": [
- 0
], - "followup_request_id": 0,
- "fluxes": [
- 0
], - "external_reducer": null,
- "group_ids": [ ],
- "label": "string",
- "observed_at": "2019-08-24T14:15:22Z"
}
{- "status": "success",
- "message": "string"
}
ID of this Spectrum's Obj.
+{- "external_reducer": null,
- "observed_by": [ ],
- "wavelengths": [
- 0
], - "observed_at": "2019-08-24T14:15:22Z",
- "label": "string",
- "group_ids": [ ],
- "fluxes": [
- 0
], - "assignment_id": 0,
- "external_observer": null,
- "origin": "string",
- "followup_request_id": 0,
- "type": "source",
- "units": "string",
- "reduced_by": [ ],
- "errors": [
- 0
], - "altdata": null,
- "instrument_id": 0,
- "obj_id": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve multiple spectra with given criteria
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
-type | string Enum: "source" "host" "host_center" Type of spectrum. One of: 'source''host''host_center'. - Defaults to 'fsource'. +Request Body schema: application/json
ResponsesRequest samples
Content type application/json { Response samples
Content type application/json { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
obj_id required | string ID of this Spectrum's Obj. + |
{- "external_reducer": null,
- "observed_by": [ ],
- "wavelengths": [
- 0
], - "observed_at": "2019-08-24T14:15:22Z",
- "label": "string",
- "group_ids": [ ],
- "fluxes": [
- 0
], - "assignment_id": 0,
- "external_observer": null,
- "origin": "string",
- "followup_request_id": 0,
- "type": "source",
- "units": "string",
- "reduced_by": [ ],
- "errors": [
- 0
], - "altdata": null,
- "instrument_id": 0,
- "obj_id": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Parse spectrum from ASCII file
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). |
{- "ascii": "string",
- "wave_column": 0,
- "fluxerr_column": null,
- "flux_column": 1
}
{- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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
-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
ResponsesRequest samples
Content type application/json { Response samples
Content type application/json { | ||||||||||||||||||
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. + |
{- "ascii": "string",
- "external_reducer": null,
- "observed_by": [ ],
- "label": "string",
- "observed_at": "2019-08-24T14:15:22Z",
- "group_ids": [
- 0
], - "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"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve spectra for given instrument within date range
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. - |
{- "status": "success",
- "message": "string",
- "data": {
- "obj_id": "string",
- "spectra": [
- {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}
]
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "obj_id": "string",
- "spectra": [
- {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}
]
}
}
Submit a (classification) spectrum to TNS
spectrum_id required | integer |
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. - |
{- "data": {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "obj": null,
- "instrument": null,
- "groups": [
- null
], - "reducers": [
- null
], - "observers": [
- null
], - "followup_request": null,
- "assignment": null,
- "owner": null,
- "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "wavelengths": [
- 0
], - "fluxes": [
- 0
], - "errors": [
- 0
], - "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",
- "owner_id": 0,
- "id": 0
}, - "status": "success"
}
Retrieve all comments associated with specified resource
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. - |
{- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success"
}
Retrieve all annotations associated with specified resource
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. - |
{- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success"
}
Retrieve a comment
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 |
{- "data": {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}, - "status": "success"
}
Retrieve a reminder
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 |
{- "data": {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}, - "status": "success",
- "message": "string"
}
Retrieve all reminders associated with specified resource
+{- "message": "string",
- "data": {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}, - "status": "success"
}
Retrieve all reminders associated with specified resource
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. - |
{- "data": [
- {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}
], - "status": "success"
}
calculate healpix values for a batch of sources without a Healpix value
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 - |
{- "status": "success",
- "message": "string",
- "data": {
- "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
Get a summary of all the activity of shift users on skyportal for a given period
shift_id required | integer |
startDate | string Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by shift.start_date >= startDate - |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Copy all photometry points from one source to another
target_id required | string The obj_id of the target Source (to which the photometry is being copied to) |
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 - |
{- "group_ids": [
- 0
], - "origin_id": "string"
}
{- "status": "success",
- "message": "string"
}
{- "group_ids": [
- 0
], - "origin_id": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve offset stars to aid in spectroscopy
obj_id required | string |
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 - |
{- "status": "success",
- "message": "string",
- "data": {
- "facility": "Keck",
- "starlist_str": "string",
- "starlist_info": [
- {
- "str": "string",
- "ra": 0,
- "dec": 0,
- "name": "string",
- "dras": "string",
- "ddecs": "string",
- "mag": 0
}
], - "ra": 0,
- "dec": 0,
- "queries_issued": 0,
- "noffsets": 0,
- "query": "string"
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "facility": "Keck",
- "starlist_str": "string",
- "starlist_info": [
- {
- "str": "string",
- "ra": 0,
- "dec": 0,
- "name": "string",
- "dras": "string",
- "ddecs": "string",
- "mag": 0
}
], - "ra": 0,
- "dec": 0,
- "queries_issued": 0,
- "noffsets": 0,
- "query": "string"
}
}
Generate a PDF/PNG finding chart to aid in spectroscopy
obj_id required | string |
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) |
{- "data": { },
- "status": "error",
- "message": "string"
}
Retrieve an object's classifications
-obj_id required | string |
{- "data": [
- {
- "taxonomy": null,
- "author": null,
- "obj": null,
- "groups": [
- null
], - "votes": [
- null
], - "classification": "string",
- "taxonomy_id": 0,
- "probability": 0,
- "author_id": 0,
- "author_name": "string",
- "obj_id": "string",
- "id": 0
}
], - "status": "success",
- "message": "string"
}
Retrieve an object's classifications
+obj_id required | string |
{- "message": "string",
- "data": [
- {
- "taxonomy": null,
- "author": null,
- "obj": null,
- "groups": [
- null
], - "votes": [
- null
], - "classification": "string",
- "taxonomy_id": 0,
- "probability": 0,
- "author_id": 0,
- "author_name": "string",
- "obj_id": "string",
- "id": 0
}
], - "status": "success"
}
Delete all of an object's classifications
classification_id required | integer |
label | boolean or null Add label associated with classification. - |
{- "label": true
}
{- "status": "success",
- "message": "string"
}
Retrieve basic info on Groups that an Obj is saved to
-obj_id required | integer |
{- "data": [
- {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "label": true
}
{- "message": "string",
- "status": "success"
}
Retrieve basic info on Groups that an Obj is saved to
+obj_id required | integer |
{- "message": "string",
- "data": [
- {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
], - "status": "success"
}
Note that a source has been labelled.
obj_id required | string ID of object to indicate source labelling for |
groupIds required | Array of integers List of IDs of groups to indicate labelling for - |
{- "groupIds": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
{- "groupIds": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Delete source labels
obj_id required | string |
groupIds required | Array of integers List of IDs of groups to indicate scanning for - |
{- "groupIds": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
Retrieve all annotations associated with specified resource
+{- "groupIds": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Retrieve all annotations associated with specified resource
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. - |
{- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success"
}
Retrieve an annotation
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 |
{- "data": {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}, - "status": "success"
}
Retrieve a source
obj_id required | string |
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. - |
{- "data": {
- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "id": "string",
- "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": [
- null
], - "sources": [
- null
], - "users": [
- null
]
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "id": "string",
- "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": [
- null
], - "sources": [
- null
], - "users": [
- null
]
}, - "status": "success"
}
Update a source
obj_id required | string |
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: |
ra | number or null |
dec | number or null |
candidates | Array of any |
sources | Array of any |
users | Array of any |
{- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "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": [
- null
], - "sources": [
- null
], - "users": [
- null
]
}
{- "status": "success",
- "message": "string"
}
{- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "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": [
- null
], - "sources": [
- null
], - "users": [
- null
]
}
{- "message": "string",
- "status": "success"
}
Retrieve all sources
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. - |
{- "status": "success",
- "message": "string",
- "data": {
- "sources": [
- {
- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "id": "string",
- "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": [
- null
], - "sources": [
- null
], - "users": [
- null
]
}
], - "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "sources": [
- {
- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "id": "string",
- "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": [
- null
], - "sources": [
- null
], - "users": [
- null
]
}
], - "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
Add a new source
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. - |
{- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "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": [
- null
], - "sources": [
- null
], - "users": [
- null
], - "group_ids": [
- 0
], - "refresh_source": null
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": "string"
}
}
{- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "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": [
- null
], - "sources": [
- null
], - "users": [
- null
], - "group_ids": [
- 0
], - "refresh_source": null
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": "string"
}
}
Retrieve all sources
ra | number RA for spatial filtering (in decimal degrees) | ||||||||||||||
dec | number Declination for spatial filtering (in decimal degrees) @@ -2182,45 +2182,45 @@PaginationRequest Body schema: application/json
ResponsesRequest samples
Content type application/json { Response samples
Content type application/json { Update a Source table rowUpdate a Source table row -path Parameters
Request Body schema: application/json
ResponsesRequest samples
Content type application/json { Response samples
Content type application/json { |
{- "objId": "string",
- "inviteGroupIds": [
- 0
], - "unsaveGroupIds": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Update a Source table row
+obj_id required | integer |
groupID required | integer |
active required | boolean |
requested required | boolean |
{- "groupID": 0,
- "active": true,
- "requested": true
}
{- "message": "string",
- "status": "success"
}
Retrieve all comments associated with specified resource
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. - |
{- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success"
}
Retrieve all comments associated with specified resource
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. - |
{- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success"
}
Retrieve a comment
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 |
{- "data": {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}, - "status": "success",
- "message": "string"
}
Retrieve all comments associated with specified resource
+{- "message": "string",
- "data": {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}, - "status": "success"
}
Retrieve all comments associated with specified resource
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. - |
{- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}
], - "status": "success"
}
Retrieve a comment
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 |
{- "data": {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}, - "status": "success",
- "message": "string"
}
Get a summary of all the activity of shift users on skyportal for a given period
+{- "message": "string",
- "data": {
- "obj": null,
- "author": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "attachment_name": "string",
- "_attachment_path": "string",
- "origin": "string",
- "bot": true,
- "attachment_bytes": "string",
- "author_id": 0
}, - "status": "success"
}
Get a summary of all the activity of shift users on skyportal for a given period
shift_id required | integer |
startDate | string Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by shift.start_date >= startDate - |
{- "status": "success",
- "message": "string"
}
Retrieve shifts
-shift_id required | integer |
group_id | integer |
{- "data": [
- {
- "group": null,
- "users": [
- null
], - "shift_users": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "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,
- "id": 0,
- "shift_users_ids": null
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve shifts
+shift_id required | integer |
group_id | integer |
{- "message": "string",
- "data": [
- {
- "group": null,
- "users": [
- null
], - "shift_users": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "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,
- "id": 0,
- "shift_users_ids": null
}
], - "status": "success"
}
Update a shift
shift_id required | integer |
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 - |
{- "group": null,
- "users": [
- null
], - "shift_users": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "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
}
{- "status": "success",
- "message": "string"
}
{- "group": null,
- "users": [
- null
], - "shift_users": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "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
}
{- "message": "string",
- "status": "success"
}
Add a new shift
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. - |
{- "group": null,
- "users": [
- null
], - "shift_users": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "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": [
- 0
]
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0,
- "name": "string",
- "start_date": "string",
- "end_date": "string",
- "shift_admins": [ ],
- "description": "string",
- "required_users_number": 0
}
}
Add a shift user
-shift_id required | integer |
userID required | integer |
admin required | boolean |
{- "userID": 0,
- "admin": true
}
{- "status": "success",
- "message": "string",
- "data": {
- "shift_id": 0,
- "user_id": 0,
- "admin": true,
- "needs_replacement": true
}
}
Update a shift user's admin status, or needs_replacement status
+{- "group": null,
- "users": [
- null
], - "shift_users": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "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": [
- 0
]
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0,
- "name": "string",
- "start_date": "string",
- "end_date": "string",
- "shift_admins": [ ],
- "description": "string",
- "required_users_number": 0
}
}
Add a shift user
+shift_id required | integer |
userID required | integer |
admin required | boolean |
{- "userID": 0,
- "admin": true
}
{- "message": "string",
- "status": "success",
- "data": {
- "shift_id": 0,
- "user_id": 0,
- "admin": true,
- "needs_replacement": true
}
}
Update a shift user's admin status, or needs_replacement status
shift_id required | integer |
userID required | integer |
admin | boolean Boolean indicating whether user is shift admin. |
needs_replacement | boolean Boolean indicating whether user needs replacement or not - |
{- "userID": 0,
- "admin": true,
- "needs_replacement": true
}
{- "status": "success",
- "message": "string"
}
Retrieve all annotations associated with specified resource
+{- "userID": 0,
- "admin": true,
- "needs_replacement": true
}
{- "message": "string",
- "status": "success"
}
Retrieve all annotations associated with specified resource
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. - |
{- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success"
}
Retrieve all annotations associated with specified resource
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. - |
{- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success"
}
Update an annotation
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. - |
{- "author": null,
- "obj": null,
- "groups": [
- null
], - "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string",
- "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
{- "author": null,
- "obj": null,
- "groups": [
- null
], - "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string",
- "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Post an annotation
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. - |
{- "origin": "string",
- "data": { },
- "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string",
- "data": {
- "annotation_id": 0
}
}
Delete an annotation
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 |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve an annotation
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 |
{- "data": {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}, - "status": "success"
}
Update an annotation
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. - |
{- "author": null,
- "obj": null,
- "groups": [
- null
], - "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string",
- "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
{- "author": null,
- "obj": null,
- "groups": [
- null
], - "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string",
- "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Delete an annotation
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 |
{- "status": "success",
- "message": "string"
}
Retrieve all annotations associated with specified resource
+{- "message": "string",
- "status": "success"
}
Retrieve all annotations associated with specified resource
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. - |
{- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success"
}
retrieve the PhotStat associated with the obj_id.
obj_id required | string object ID to get statistics on |
{- "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
}
{- "message": "string",
- "status": "success"
}
{- "message": "string",
- "status": "success"
}
{- "message": "string",
- "status": "success"
}
find the number of sources with and without a PhotStat object
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. - |
{- "status": "success",
- "message": "string",
- "data": {
- "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
calculate photometric stats for a batch of sources without a PhotStat
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. - |
{- "status": "success",
- "message": "string",
- "data": {
- "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
manually recalculate the photometric stats for a batch of sources
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. - |
{- "status": "success",
- "message": "string",
- "data": {
- "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
Retrieve photometry
photometry_id required | integer |
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) - |
{- "data": {
- "dec": null,
- "fluxerr": 0,
- "filter": "bessellux",
- "mjd": 0,
- "flux": null,
- "origin": null,
- "ref_zp": null,
- "ra": null,
- "obj_id": "string",
- "magsys": "jla1",
- "ref_fluxerr": null,
- "alert_id": null,
- "dec_unc": null,
- "altdata": null,
- "ra_unc": null,
- "assignment_id": null,
- "ref_flux": null,
- "instrument_id": 0,
- "zp": 0
}, - "status": "success",
- "message": "string"
}
Update photometry
-photometry_id required | integer |
dec_unc | number or null Default: null Uncertainty on dec [arcsec]. + |
{- "message": "string",
- "data": {
- "ref_zp": null,
- "alert_id": null,
- "ra_unc": null,
- "fluxerr": 0,
- "mjd": 0,
- "dec_unc": null,
- "altdata": null,
- "instrument_id": 0,
- "magsys": "jla1",
- "zp": 0,
- "flux": null,
- "origin": null,
- "filter": "bessellux",
- "ref_flux": null,
- "ra": null,
- "ref_fluxerr": null,
- "dec": null,
- "assignment_id": null,
- "obj_id": "string"
}, - "status": "success"
}
Update photometry
+photometry_id required | integer |
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 |
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 |
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. |
dec_unc | number or null Default: null Uncertainty on dec [arcsec]. |
limiting_mag required | number Limiting magnitude of the image in the magnitude system |
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 |
altdata | object or null Default: null Misc. alternative metadata stored in JSON format, e.g. |
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 |
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. + |
{- "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
}
{- "message": "string",
- "status": "success"
}
Update and/or upload photometry, resolving potential duplicates
+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 |
magerr | number or null Default: null Magnitude error of the observation in the magnitude system |
{- "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
}
{- "status": "success",
- "message": "string"
}
Update and/or upload photometry, resolving potential duplicates
-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: |
mag | any or null Default: null Magnitude of the observation in the magnitude system |
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 |
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 |
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: |
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. |
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 |
magref | any or null Default: null Magnitude of the reference image. in the magnitude system |
magerr | any or null Default: null Error on the magnitude in the magnitude system |
{- "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
}
{- "status": "success",
- "message": "string",
- "data": {
- "ids": [
- 0
], - "upload_id": "string"
}
}
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
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 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.
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
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.
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.
+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.
+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.
ID of the classical assignment which generated the photometry
+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.
{- "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
}
{- "message": "string",
- "status": "success",
- "data": {
- "ids": [
- 0
], - "upload_id": "string"
}
}
Retrieve a photometric series
photometric_series_id required | integer |
dataFormat | string Enum: "json" "hdf5" "none" Format of the data to return. If |
{- "data": {
- "obj": null,
- "groups": [
- null
], - "streams": [
- null
], - "instrument": null,
- "followup_request": null,
- "assignment": null,
- "owner": null,
- "obj_id": "string",
- "series_name": "string",
- "series_obj_id": "string",
- "filter": "bessellux",
- "channel": "string",
- "origin": "string",
- "filename": "string",
- "mjd_first": 0,
- "mag_first": 0,
- "mjd_mid": 0,
- "mjd_last": 0,
- "mag_last": 0,
- "mjd_last_detected": 0,
- "mag_last_detected": 0,
- "is_detected": true,
- "exp_time": 0,
- "frame_rate": 0,
- "num_exp": 0,
- "time_stamp_alignment": "start",
- "ra_unc": 0,
- "dec_unc": 0,
- "limiting_mag": 0,
- "ref_flux": 0,
- "ref_fluxerr": 0,
- "altdata": null,
- "instrument_id": 0,
- "followup_request_id": 0,
- "assignment_id": 0,
- "owner_id": 0,
- "mean_mag": 0,
- "rms_mag": 0,
- "robust_mag": 0,
- "robust_rms": 0,
- "median_snr": 0,
- "best_snr": 0,
- "worst_snr": 0,
- "medians": null,
- "maxima": null,
- "minima": null,
- "stds": null,
- "hash": "string",
- "autodelete": true,
- "ra": 0,
- "dec": 0,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "obj": null,
- "groups": [
- null
], - "streams": [
- null
], - "instrument": null,
- "followup_request": null,
- "assignment": null,
- "owner": null,
- "obj_id": "string",
- "series_name": "string",
- "series_obj_id": "string",
- "filter": "bessellux",
- "channel": "string",
- "origin": "string",
- "filename": "string",
- "mjd_first": 0,
- "mag_first": 0,
- "mjd_mid": 0,
- "mjd_last": 0,
- "mag_last": 0,
- "mjd_last_detected": 0,
- "mag_last_detected": 0,
- "is_detected": true,
- "exp_time": 0,
- "frame_rate": 0,
- "num_exp": 0,
- "time_stamp_alignment": "start",
- "ra_unc": 0,
- "dec_unc": 0,
- "limiting_mag": 0,
- "ref_flux": 0,
- "ref_fluxerr": 0,
- "altdata": null,
- "instrument_id": 0,
- "followup_request_id": 0,
- "assignment_id": 0,
- "owner_id": 0,
- "mean_mag": 0,
- "rms_mag": 0,
- "robust_mag": 0,
- "robust_rms": 0,
- "median_snr": 0,
- "best_snr": 0,
- "worst_snr": 0,
- "medians": null,
- "maxima": null,
- "minima": null,
- "stds": null,
- "hash": "string",
- "autodelete": true,
- "ra": 0,
- "dec": 0,
- "id": 0
}, - "status": "success"
}
Retrieve all photometric series, based on various cuts.
dataFormat | string Enum: "json" "hdf5" "none" Format of the data to return. If 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 - |
{- "status": "success",
- "message": "string",
- "data": {
- "series": [
- {
- "obj": null,
- "groups": [
- null
], - "streams": [
- null
], - "instrument": null,
- "followup_request": null,
- "assignment": null,
- "owner": null,
- "obj_id": "string",
- "series_name": "string",
- "series_obj_id": "string",
- "filter": "bessellux",
- "channel": "string",
- "origin": "string",
- "filename": "string",
- "mjd_first": 0,
- "mag_first": 0,
- "mjd_mid": 0,
- "mjd_last": 0,
- "mag_last": 0,
- "mjd_last_detected": 0,
- "mag_last_detected": 0,
- "is_detected": true,
- "exp_time": 0,
- "frame_rate": 0,
- "num_exp": 0,
- "time_stamp_alignment": "start",
- "ra_unc": 0,
- "dec_unc": 0,
- "limiting_mag": 0,
- "ref_flux": 0,
- "ref_fluxerr": 0,
- "altdata": null,
- "instrument_id": 0,
- "followup_request_id": 0,
- "assignment_id": 0,
- "owner_id": 0,
- "mean_mag": 0,
- "rms_mag": 0,
- "robust_mag": 0,
- "robust_rms": 0,
- "median_snr": 0,
- "best_snr": 0,
- "worst_snr": 0,
- "medians": null,
- "maxima": null,
- "minima": null,
- "stds": null,
- "hash": "string",
- "autodelete": true,
- "ra": 0,
- "dec": 0,
- "id": 0
}
], - "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "series": [
- {
- "obj": null,
- "groups": [
- null
], - "streams": [
- null
], - "instrument": null,
- "followup_request": null,
- "assignment": null,
- "owner": null,
- "obj_id": "string",
- "series_name": "string",
- "series_obj_id": "string",
- "filter": "bessellux",
- "channel": "string",
- "origin": "string",
- "filename": "string",
- "mjd_first": 0,
- "mag_first": 0,
- "mjd_mid": 0,
- "mjd_last": 0,
- "mag_last": 0,
- "mjd_last_detected": 0,
- "mag_last_detected": 0,
- "is_detected": true,
- "exp_time": 0,
- "frame_rate": 0,
- "num_exp": 0,
- "time_stamp_alignment": "start",
- "ra_unc": 0,
- "dec_unc": 0,
- "limiting_mag": 0,
- "ref_flux": 0,
- "ref_fluxerr": 0,
- "altdata": null,
- "instrument_id": 0,
- "followup_request_id": 0,
- "assignment_id": 0,
- "owner_id": 0,
- "mean_mag": 0,
- "rms_mag": 0,
- "robust_mag": 0,
- "robust_rms": 0,
- "median_snr": 0,
- "best_snr": 0,
- "worst_snr": 0,
- "medians": null,
- "maxima": null,
- "minima": null,
- "stds": null,
- "hash": "string",
- "autodelete": true,
- "ra": 0,
- "dec": 0,
- "id": 0
}
], - "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
Get photometry taken by specific instruments over a date range
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) - |
min_date | string or null <date-time> Default: null Query for photometry taken after this UT |
max_date | string or null <date-time> Default: null Query for photometry taken before this UT |
instrument_ids | Array of integers or null Default: null IDs of the instruments to query for photometry from. If |
{- "min_date": null,
- "max_date": null,
- "instrument_ids": null
}
{- "data": [
- {
- "dec": null,
- "fluxerr": 0,
- "filter": "bessellux",
- "mjd": 0,
- "flux": null,
- "origin": null,
- "ref_zp": null,
- "ra": null,
- "obj_id": "string",
- "magsys": "jla1",
- "ref_fluxerr": null,
- "alert_id": null,
- "dec_unc": null,
- "altdata": null,
- "ra_unc": null,
- "assignment_id": null,
- "ref_flux": null,
- "instrument_id": 0,
- "zp": 0
}
], - "status": "success",
- "message": "string"
}
max_date | string or null <date-time> Default: null Query for photometry taken before this UT |
instrument_ids | Array of integers or null Default: null IDs of the instruments to query for photometry from. If |
min_date | string or null <date-time> Default: null Query for photometry taken after this UT |
{- "max_date": null,
- "instrument_ids": null,
- "min_date": null
}
{- "message": "string",
- "data": [
- {
- "ref_zp": null,
- "alert_id": null,
- "ra_unc": null,
- "fluxerr": 0,
- "mjd": 0,
- "dec_unc": null,
- "altdata": null,
- "instrument_id": 0,
- "magsys": "jla1",
- "zp": 0,
- "flux": null,
- "origin": null,
- "filter": "bessellux",
- "ref_flux": null,
- "ra": null,
- "ref_fluxerr": null,
- "dec": null,
- "assignment_id": null,
- "obj_id": "string"
}
], - "status": "success"
}
Copy all photometry points from one source to another
target_id required | string The obj_id of the target Source (to which the photometry is being copied to) |
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 - |
{- "group_ids": [
- 0
], - "origin_id": "string"
}
{- "status": "success",
- "message": "string"
}
Retrieve all photometry associated with an Object
+{- "group_ids": [
- 0
], - "origin_id": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve all photometry associated with an Object
obj_id required | string ID of the object to retrieve photometry for |
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. - |
{- "data": [
- {
- "dec": null,
- "fluxerr": 0,
- "filter": "bessellux",
- "mjd": 0,
- "flux": null,
- "origin": null,
- "ref_zp": null,
- "ra": null,
- "obj_id": "string",
- "magsys": "jla1",
- "ref_fluxerr": null,
- "alert_id": null,
- "dec_unc": null,
- "altdata": null,
- "ra_unc": null,
- "assignment_id": null,
- "ref_flux": null,
- "instrument_id": 0,
- "zp": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "ref_zp": null,
- "alert_id": null,
- "ra_unc": null,
- "fluxerr": 0,
- "mjd": 0,
- "dec_unc": null,
- "altdata": null,
- "instrument_id": 0,
- "magsys": "jla1",
- "zp": 0,
- "flux": null,
- "origin": null,
- "filter": "bessellux",
- "ref_flux": null,
- "ra": null,
- "ref_fluxerr": null,
- "dec": null,
- "assignment_id": null,
- "obj_id": "string"
}
], - "status": "success"
}
Retrieve all annotations associated with specified resource
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. - |
{- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}
], - "status": "success"
}
Retrieve an annotation
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 |
{- "data": {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}, - "status": "success",
- "message": "string"
}
Get observation plan requests of the GcnEvent.
-gcnevent_id required | string |
{- "data": [
- {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
Get survey efficiency analyses of the GcnEvent.
-gcnevent_id required | string |
{- "data": [
- {
- "gcnevent": null,
- "localization": null,
- "instrument": null,
- "requester": null,
- "groups": [
- null
], - "gcnevent_id": 0,
- "localization_id": 0,
- "instrument_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}
], - "status": "success",
- "message": "string"
}
Get catalog queries of the GcnEvent.
-gcnevent_id required | string |
{- "data": [
- {
- "requester": null,
- "allocation": null,
- "target_groups": [
- null
], - "requester_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "author": null,
- "obj": null,
- "groups": [
- null
], - "id": 0,
- "data": null,
- "origin": "string",
- "author_id": 0,
- "obj_id": "string"
}, - "status": "success"
}
Get observation plan requests of the GcnEvent.
+gcnevent_id required | string |
{- "message": "string",
- "data": [
- {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}
], - "status": "success"
}
Get survey efficiency analyses of the GcnEvent.
+gcnevent_id required | string |
{- "message": "string",
- "data": [
- {
- "gcnevent": null,
- "localization": null,
- "instrument": null,
- "requester": null,
- "groups": [
- null
], - "gcnevent_id": 0,
- "localization_id": 0,
- "instrument_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}
], - "status": "success"
}
Get catalog queries of the GcnEvent.
+gcnevent_id required | string |
{- "message": "string",
- "data": [
- {
- "requester": null,
- "allocation": null,
- "target_groups": [
- null
], - "requester_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "id": 0
}
], - "status": "success"
}
Post a GCN Event alias
dateobs required | string The dateobs of the event, as an arrow parseable string |
alias required | string Alias to add to the event - |
{- "alias": "string"
}
{- "status": "success",
- "message": "string"
}
{- "alias": "string"
}
{- "message": "string",
- "status": "success"
}
Delete a GCN event alias
dateobs required | dateobs |
alias required | string Alias to remove from the event - |
{- "alias": "string"
}
{- "status": "success",
- "message": "string"
}
{- "alias": "string"
}
{- "message": "string",
- "status": "success"
}
{- "xml": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve a reminder
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 |
{- "data": {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}, - "status": "success"
}
Post a reminder
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 |
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. - |
{- "text": "string",
- "group_ids": [
- 0
]
}
{- "status": "success",
- "message": "string",
- "data": {
- "reminder_id": 0
}
}
{- "text": "string",
- "group_ids": [
- 0
]
}
{- "message": "string",
- "status": "success",
- "data": {
- "reminder_id": 0
}
}
Delete a reminder
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 |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Update a reminder
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. - |
{- "obj": null,
- "user": null,
- "groups": [
- null
], - "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": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
Retrieve all reminders associated with specified resource
+{- "obj": null,
- "user": null,
- "groups": [
- null
], - "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": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Retrieve all reminders associated with specified resource
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. - |
{- "data": [
- {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}
], - "status": "success"
}
Retrieve all reminders associated with specified resource
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. - |
{- "data": [
- {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}
], - "status": "success"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": null
}
}
Scrape aliases of a GCN Event from GCNs notice/circulars
dateobs required | string The dateobs of the event, as an arrow parseable string - |
{- "status": "success",
- "message": "string",
- "data": {
- "id": null
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": null
}
}
Retrieve all reminders associated with specified resource
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. - |
{- "data": [
- {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "obj": null,
- "user": null,
- "groups": [
- null
], - "obj_id": "string",
- "id": 0,
- "text": "string",
- "origin": "string",
- "bot": true,
- "next_reminder": "2019-08-24T14:15:22Z",
- "reminder_delay": 0,
- "number_of_reminders": 0,
- "user_id": 0
}
], - "status": "success"
}
Ingest EarthquakeEvent
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. - |
{- "sent_by": null,
- "notices": [
- null
], - "predictions": [
- null
], - "measurements": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "sent_by_id": 0,
- "event_id": "string",
- "event_uri": "string",
- "status": "string"
}
{- "status": "success",
- "message": "string"
}
Retrieve a GCN summary
-dateobs required | string |
summary_id required | integer |
{- "data": {
- "sent_by": null,
- "group": null,
- "sent_by_id": 0,
- "dateobs": "2019-08-24T14:15:22Z",
- "group_id": 0,
- "title": "string",
- "text": "string",
- "id": 0
}, - "status": "success",
- "message": "string"
}
Get a summary of all the activity of shift users on skyportal for a given period
+{- "sent_by": null,
- "notices": [
- null
], - "predictions": [
- null
], - "measurements": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "sent_by_id": 0,
- "event_id": "string",
- "event_uri": "string",
- "status": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve a GCN summary
+dateobs required | string |
summary_id required | integer |
{- "message": "string",
- "data": {
- "sent_by": null,
- "group": null,
- "sent_by_id": 0,
- "dateobs": "2019-08-24T14:15:22Z",
- "group_id": 0,
- "title": "string",
- "text": "string",
- "id": 0
}, - "status": "success"
}
Get a summary of all the activity of shift users on skyportal for a given period
shift_id required | integer |
startDate | string Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by shift.start_date >= startDate - |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Compute instrument field probabilities for a skymap
dateobs required | string |
Instrument ID required | integer |
localization_name required | string Localization map name |
integrated_probability | float Cumulative integrated probability threshold - |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Create a summary plot for the observability for a given event.
+{- "xml": "string"
}
{- "message": "string",
- "status": "success"
}
Create a summary plot for the observability for a given event.
localization_id required | integer ID of localization to generate observability plot for |
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). - |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Create a summary plot for the observability for a given event.
localization_id required | integer ID of localization to generate map for |
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). - |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve a GCN localization
dateobs required | dateobs |
localization_name required | localization_name |
include2DMap | boolean Boolean indicating whether to include flatted skymap. Defaults to false. - |
{- "contour": null,
- "flat_2d": [
- 0
], - "dateobs": "string",
- "localization_name": "string"
}
A fits file corresponding to the intersection of the input fits files.
-dateobs required | dateobs |
localization_name required | localization_name |
{- "data": { },
- "status": "error",
- "message": "string"
}
Post a skymap-based trigger
-allocation_id required | integer Followup request allocation ID. - |
integrated_probability | number Integrated probability within skymap. - |
localization_id required | integer Localization ID. - |
{- "allocation_id": 0,
- "integrated_probability": 0,
- "localization_id": 0
}
{- "status": "success",
- "message": "string"
}
{- "flat_2d": [
- 0
], - "localization_name": "string",
- "dateobs": "string",
- "contour": null
}
A fits file corresponding to the intersection of the input fits files.
+dateobs required | dateobs |
localization_name required | localization_name |
{- "message": "string",
- "data": { },
- "status": "error"
}
Post a skymap-based trigger
+integrated_probability | number Integrated probability within skymap. + |
localization_id required | integer Localization ID. + |
allocation_id required | integer Followup request allocation ID. + |
{- "integrated_probability": 0,
- "localization_id": 0,
- "allocation_id": 0
}
{- "message": "string",
- "status": "success"
}
Create a summary plot for the observability for a given source.
obj_id required | string ID of object to generate observability plot for |
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). - |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
{- "xml": "string"
}
{- "message": "string",
- "status": "success"
}
Post sources that have been confirmed in a GCN to TNS
+{- "xml": "string"
}
{- "message": "string",
- "status": "success"
}
Post sources that have been confirmed in a GCN to TNS
dateobs required | string The dateobs of the event, as an arrow parseable string |
tnsrobotID required | int TNS Robot ID. |
reporters | string Reporters for the TNS report. @@ -2720,21 +2720,21 @@PaginationIf not provided, all sources confirmed in GCN will be posted. |
confirmed | boolean Only post sources noted as confirmed / highlighted. Defaults to True. - |
{- "tnsrobotID": null,
- "reporters": "string",
- "sourcesIDList": "string",
- "confirmed": true
}
{- "status": "success",
- "message": "string"
}
Retrieve sources that have been confirmed/rejected in a GCN
+{- "tnsrobotID": null,
- "reporters": "string",
- "sourcesIDList": "string",
- "confirmed": true
}
{- "message": "string",
- "status": "success"
}
Retrieve sources that have been confirmed/rejected in a GCN
dateobs required | string The dateobs of the event, as an arrow parseable string |
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. - |
{- "status": "success",
- "message": "string",
- "data": [
- null
]
}
{- "message": "string",
- "status": "success",
- "data": [
- null
]
}
Retrieve a source that has been confirmed or rejected in a GCN
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 - |
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0,
- "obj_id": "string",
- "dateobs": "string",
- "confirmed": true
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0,
- "obj_id": "string",
- "dateobs": "string",
- "confirmed": true
}
}
Deletes the confirmed or rejected status of source in a GCN. Its status can be considered as 'undefined'.
-dateobs required | string |
source_id required | string |
{- "status": "success",
- "message": "string",
- "data": {
- "id": null
}
}
Update the confirmed or rejected status of a source in a GCN
dateobs required | string |
source_id required | string |
confirmed required | boolean Whether the source is confirmed (True) or rejected (False) - |
{- "confirmed": true
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": null
}
}
Retrieve a source that has been confirmed or rejected in a GCN
+{- "confirmed": true
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": null
}
}
Retrieve a source that has been confirmed or rejected in a GCN
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 - |
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0,
- "obj_id": "string",
- "dateobs": "string",
- "confirmed": true
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0,
- "obj_id": "string",
- "dateobs": "string",
- "confirmed": true
}
}
Confirm or reject a source in a gcn
dateobs required | string The dateobs of the event, as an arrow parseable string |
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 - |
{- "localization_name": "string",
- "localization_cumprob": "string",
- "source_id": "string",
- "confirmed": true,
- "start_date": "string",
- "end_date": "string"
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": null
}
}
Deletes the confirmed or rejected status of source in a GCN. +
{- "localization_name": "string",
- "localization_cumprob": "string",
- "source_id": "string",
- "confirmed": true,
- "start_date": "string",
- "end_date": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": null
}
}
Deletes the confirmed or rejected status of source in a GCN. Its status can be considered as 'undefined'.
-dateobs required | string |
source_id required | string |
{- "status": "success",
- "message": "string",
- "data": {
- "id": null
}
}
Update the confirmed or rejected status of a source in a GCN
dateobs required | string |
source_id required | string |
confirmed required | boolean Whether the source is confirmed (True) or rejected (False) - |
{- "confirmed": true
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": null
}
}
Get the GCNs associated with a source (GCNs for which the source has been confirmed)
-source_id required | string |
{- "status": "success",
- "message": "string",
- "data": {
- "gcns": [
- "string"
]
}
}
{- "confirmed": true
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": null
}
}
Get the GCNs associated with a source (GCNs for which the source has been confirmed)
+source_id required | string |
{- "message": "string",
- "status": "success",
- "data": {
- "gcns": [
- "string"
]
}
}
Get an airmass chart for the GcnEvent
localization_id required | integer ID of localization to generate airmass chart for |
telescope_id required | integer ID of telescope to generate airmass chart for - |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Submit the observation plan to treasuremap.space
instrument_id required | string ID for the instrument to submit |
startDate required | string Filter by start date |
endDate required | string Filter by end date @@ -2766,27 +2766,27 @@Paginationtable. |
localizationCumprob | number Cumulative probability up to which to include fields. Defaults to 0.95. - |
{- "status": "success",
- "message": "string"
}
Submit manual observation plan.
-observation_plan_data | any Observation plan data json + |
{- "message": "string",
- "status": "success"
}
Submit manual observation plan.
+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. - |
{- "observation_plan_data": null,
- "allocation_id": 0,
- "status": "pending submission",
- "localization_id": 0,
- "target_group_ids": [
- 0
], - "gcnevent_id": 0
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Submit observation plan request.
-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 + |
{- "gcnevent_id": 0,
- "allocation_id": 0,
- "target_group_ids": [
- 0
], - "localization_id": 0,
- "status": "pending submission",
- "observation_plan_data": null
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Submit observation plan request.
+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. - |
{- "allocation_id": 0,
- "status": "pending submission",
- "payload": null,
- "localization_id": 0,
- "target_group_ids": [
- 0
], - "gcnevent_id": 0
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Get a GCN-izable summary of the observation plan.
-observation_plan_id required | string |
{- "data": {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
Submit an observation plan.
-observation_plan_id required | string |
{- "data": {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
Get a movie summary of the observation plan.
-observation_plan_id required | string |
{- "data": {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
Perform an efficiency analysis of the observation plan.
+Localization ID.
+The status of the request.
+{- "payload": null,
- "gcnevent_id": 0,
- "allocation_id": 0,
- "target_group_ids": [
- 0
], - "localization_id": 0,
- "status": "pending submission"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Get a GCN-izable summary of the observation plan.
+observation_plan_id required | string |
{- "message": "string",
- "data": {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}, - "status": "success"
}
Submit an observation plan.
+observation_plan_id required | string |
{- "message": "string",
- "data": {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}, - "status": "success"
}
Get a movie summary of the observation plan.
+observation_plan_id required | string |
{- "message": "string",
- "data": {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}, - "status": "success"
}
Perform an efficiency analysis of the observation plan.
observation_plan_id required | string |
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. - |
{- "status": "success",
- "message": "string"
}
Get GeoJSON summary of the observation plan.
-observation_plan_id required | string |
{- "data": {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
Get survey efficiency analyses of the observation plan.
-observation_plan_id required | string |
{- "data": [
- {
- "observation_plan": null,
- "requester": null,
- "groups": [
- null
], - "observation_plan_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Get GeoJSON summary of the observation plan.
+observation_plan_id required | string |
{- "message": "string",
- "data": {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}, - "status": "success"
}
Get survey efficiency analyses of the observation plan.
+observation_plan_id required | string |
{- "message": "string",
- "data": [
- {
- "observation_plan": null,
- "requester": null,
- "groups": [
- null
], - "observation_plan_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}
], - "status": "success"
}
Submit the fields in the observation plan to an observing run
observation_plan_id required | integer ID of observation plan request to create observing run for - |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Delete selected fields from the observation plan.
observation_plan_id required | string |
fieldIds | Array of integers List of field IDs to remove from the plan - |
{- "fieldIds": [
- 0
]
}
{- "data": {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "data": {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
Add alert stream access to group
-group_id required | integer |
stream_id required | integer |
{- "stream_id": 0
}
{- "status": "success",
- "message": "string",
- "data": {
- "group_id": 0,
- "stream_id": 0
}
}
{- "fieldIds": [
- 0
]
}
{- "message": "string",
- "data": {
- "requester": null,
- "last_modified_by": null,
- "gcnevent": null,
- "localization": null,
- "allocation": null,
- "observation_plans": [
- null
], - "target_groups": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "requester_id": 0,
- "last_modified_by_id": 0,
- "gcnevent_id": 0,
- "localization_id": 0,
- "payload": null,
- "status": "string",
- "allocation_id": 0,
- "default_plan": true,
- "id": 0
}, - "status": "success"
}
{- "message": "string",
- "data": {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}, - "status": "success"
}
Add alert stream access to group
+group_id required | integer |
stream_id required | integer |
{- "stream_id": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "group_id": 0,
- "stream_id": 0
}
}
Add a group user
group_id required | integer |
userID required | integer |
admin required | boolean |
canSave | boolean Boolean indicating whether user can save sources to group. Defaults to true. - |
{- "userID": 0,
- "admin": true,
- "canSave": true
}
{- "status": "success",
- "message": "string",
- "data": {
- "group_id": 0,
- "user_id": 0,
- "admin": true
}
}
Update a group user's admin or save access status
+{- "userID": 0,
- "admin": true,
- "canSave": true
}
{- "message": "string",
- "status": "success",
- "data": {
- "group_id": 0,
- "user_id": 0,
- "admin": true
}
}
Update a group user's admin or save access status
group_id required | integer |
userID required | integer |
admin | boolean Boolean indicating whether user is group admin. Either this
or |
canSave | boolean Boolean indicating whether user can save sources to group. Either
this or |
{- "userID": 0,
- "admin": true,
- "canSave": true
}
{- "status": "success",
- "message": "string"
}
Add users from other group(s) to specified group
-group_id required | integer |
fromGroupIDs required | boolean |
{- "fromGroupIDs": true
}
{- "status": "success",
- "message": "string"
}
{- "userID": 0,
- "admin": true,
- "canSave": true
}
{- "message": "string",
- "status": "success"
}
Add users from other group(s) to specified group
+group_id required | integer |
fromGroupIDs required | boolean |
{- "fromGroupIDs": true
}
{- "message": "string",
- "status": "success"
}
Retrieve a group
group_id required | integer |
includeGroupUsers | boolean Boolean indicating whether to include group users. Defaults to true. - |
{- "status": "success",
- "message": "string",
- "data": {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- {
- "roles": [
- null
], - "tokens": [
- null
], - "acls": [
- null
], - "username": "string",
- "first_name": "string",
- "last_name": "string",
- "affiliations": null,
- "contact_email": "string",
- "contact_phone": "string",
- "oauth_uid": "string",
- "preferences": null,
- "expiration_date": "2019-08-24T14:15:22Z",
- "id": 0,
- "group_admission_requests": [
- null
], - "streams": [
- null
], - "groups": [
- null
], - "shifts": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "comments_on_gcns": [
- null
], - "reminders_on_gcns": [
- null
], - "comments_on_earthquakes": [
- null
], - "reminders_on_earthquakes": [
- null
], - "default_observationplan_requests": [
- null
], - "catalog_queries": [
- null
], - "comments_on_shifts": [
- null
], - "reminders_on_shifts": [
- null
], - "followup_requests": [
- null
], - "default_followup_requests": [
- null
], - "observationplan_requests": [
- null
], - "survey_efficiency_for_observations": [
- null
], - "survey_efficiency_for_observation_plan": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "assignments": [
- null
], - "recurring_apis": [
- null
], - "gcnevents": [
- null
], - "gcnnotices": [
- null
], - "gcnsummaries": [
- null
], - "gcntags": [
- null
], - "gcnproperties": [
- null
], - "earthquakeevents": [
- null
], - "earthquakenotices": [
- null
], - "listings": [
- null
], - "localizations": [
- null
], - "localizationtags": [
- null
], - "localizationproperties": [
- null
], - "notifications": [
- null
], - "observing_runs": [
- null
], - "sources_in_gcn": [
- null
], - "source_notifications": [
- null
], - "sources": [
- null
], - "social_auth": [
- null
], - "saved_sources": [
- null
]
}
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- {
- "roles": [
- null
], - "tokens": [
- null
], - "acls": [
- null
], - "username": "string",
- "first_name": "string",
- "last_name": "string",
- "affiliations": null,
- "contact_email": "string",
- "contact_phone": "string",
- "oauth_uid": "string",
- "preferences": null,
- "expiration_date": "2019-08-24T14:15:22Z",
- "id": 0,
- "group_admission_requests": [
- null
], - "streams": [
- null
], - "groups": [
- null
], - "shifts": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "comments_on_gcns": [
- null
], - "reminders_on_gcns": [
- null
], - "comments_on_earthquakes": [
- null
], - "reminders_on_earthquakes": [
- null
], - "default_observationplan_requests": [
- null
], - "catalog_queries": [
- null
], - "comments_on_shifts": [
- null
], - "reminders_on_shifts": [
- null
], - "followup_requests": [
- null
], - "default_followup_requests": [
- null
], - "observationplan_requests": [
- null
], - "survey_efficiency_for_observations": [
- null
], - "survey_efficiency_for_observation_plan": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "assignments": [
- null
], - "recurring_apis": [
- null
], - "gcnevents": [
- null
], - "gcnnotices": [
- null
], - "gcnsummaries": [
- null
], - "gcntags": [
- null
], - "gcnproperties": [
- null
], - "earthquakeevents": [
- null
], - "earthquakenotices": [
- null
], - "listings": [
- null
], - "localizations": [
- null
], - "localizationtags": [
- null
], - "localizationproperties": [
- null
], - "notifications": [
- null
], - "observing_runs": [
- null
], - "sources_in_gcn": [
- null
], - "source_notifications": [
- null
], - "sources": [
- null
], - "social_auth": [
- null
], - "saved_sources": [
- null
]
}
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
}
Update a group
group_id required | integer |
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. - |
{- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true
}
{- "status": "success",
- "message": "string"
}
{- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true
}
{- "message": "string",
- "status": "success"
}
Retrieve all groups
name | string Fetch by name (exact match) |
includeSingleUserGroups | boolean Bool indicating whether to include single user groups. Defaults to false. - |
{- "status": "success",
- "message": "string",
- "data": {
- "user_groups": [
- {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
], - "user_accessible_groups": [
- {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
], - "all_groups": [
- {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
]
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "user_groups": [
- {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
], - "user_accessible_groups": [
- {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
], - "all_groups": [
- {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
]
}
}
Create a new group
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. - |
{- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "group_admins": [
- 0
]
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Retrieve a group admission request
-admission_request_id required | integer |
{- "data": {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "group_admins": [
- 0
]
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve a group admission request
+admission_request_id required | integer |
{- "message": "string",
- "data": {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}, - "status": "success"
}
Update a group admission request's status
admission_request_id required | integer |
status required | string One of either 'accepted', 'declined', or 'pending'. - |
{- "status": "string"
}
{- "status": "success",
- "message": "string"
}
{- "status": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve all group admission requests
groupID | integer ID of group for which admission requests are desired - |
{- "data": [
- {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}
], - "status": "success",
- "message": "string"
}
Create a new group admission request
-groupID required | integer |
userID required | integer |
{- "groupID": 0,
- "userID": 0
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Retrieve basic info on Groups that an Obj is saved to
-obj_id required | integer |
{- "data": [
- {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}
], - "status": "success"
}
Create a new group admission request
+groupID required | integer |
userID required | integer |
{- "groupID": 0,
- "userID": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve basic info on Groups that an Obj is saved to
+obj_id required | integer |
{- "message": "string",
- "data": [
- {
- "streams": [
- null
], - "filters": [
- null
], - "shifts": [
- null
], - "users": [
- null
], - "group_users": [
- null
], - "observing_runs": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "allocations": [
- null
], - "source_labels": [
- null
], - "admission_requests": [
- null
], - "tnsrobots": [
- null
], - "gcnsummaries": [
- null
], - "name": "string",
- "nickname": "string",
- "description": "string",
- "private": true,
- "single_user_group": true,
- "id": 0
}
], - "status": "success"
}
Save or request group(s) to save source, and optionally unsave from group(s).
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. - |
{- "objId": "string",
- "inviteGroupIds": [
- 0
], - "unsaveGroupIds": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
Update a Source table row
-obj_id required | integer |
groupID required | integer |
active required | boolean |
requested required | boolean |
{- "groupID": 0,
- "active": true,
- "requested": true
}
{- "status": "success",
- "message": "string"
}
Add alert stream access to group
-group_id required | integer |
stream_id required | integer |
{- "stream_id": 0
}
{- "status": "success",
- "message": "string",
- "data": {
- "group_id": 0,
- "stream_id": 0
}
}
Grant stream access to a user
-stream_id required | integer |
user_id required | integer |
{- "user_id": 0
}
{- "status": "success",
- "message": "string",
- "data": {
- "stream_id": 0,
- "user_id": 0
}
}
{- "data": {
- "groups": [
- null
], - "users": [
- null
], - "filters": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "name": "string",
- "altdata": null,
- "id": 0
}, - "status": "success",
- "message": "string"
}
Update a stream
-stream_id required | integer |
name | string |
altdata | object |
{- "name": "string",
- "altdata": { }
}
{- "status": "success",
- "message": "string"
}
POST a new stream.
-name required | string |
altdata | object |
{- "name": "string",
- "altdata": { }
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
{- "objId": "string",
- "inviteGroupIds": [
- 0
], - "unsaveGroupIds": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Update a Source table row
+obj_id required | integer |
groupID required | integer |
active required | boolean |
requested required | boolean |
{- "groupID": 0,
- "active": true,
- "requested": true
}
{- "message": "string",
- "status": "success"
}
Add alert stream access to group
+group_id required | integer |
stream_id required | integer |
{- "stream_id": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "group_id": 0,
- "stream_id": 0
}
}
Grant stream access to a user
+stream_id required | integer |
user_id required | integer |
{- "user_id": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "stream_id": 0,
- "user_id": 0
}
}
{- "message": "string",
- "data": {
- "groups": [
- null
], - "users": [
- null
], - "filters": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "name": "string",
- "altdata": null,
- "id": 0
}, - "status": "success"
}
Update a stream
+stream_id required | integer |
name | string |
altdata | object |
{- "name": "string",
- "altdata": { }
}
{- "message": "string",
- "status": "success"
}
POST a new stream.
+name required | string |
altdata | object |
{- "name": "string",
- "altdata": { }
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Add a group user
group_id required | integer |
userID required | integer |
admin required | boolean |
canSave | boolean Boolean indicating whether user can save sources to group. Defaults to true. - |
{- "userID": 0,
- "admin": true,
- "canSave": true
}
{- "status": "success",
- "message": "string",
- "data": {
- "group_id": 0,
- "user_id": 0,
- "admin": true
}
}
Update a group user's admin or save access status
+{- "userID": 0,
- "admin": true,
- "canSave": true
}
{- "message": "string",
- "status": "success",
- "data": {
- "group_id": 0,
- "user_id": 0,
- "admin": true
}
}
Update a group user's admin or save access status
group_id required | integer |
userID required | integer |
admin | boolean Boolean indicating whether user is group admin. Either this
or |
canSave | boolean Boolean indicating whether user can save sources to group. Either
this or |
{- "userID": 0,
- "admin": true,
- "canSave": true
}
{- "status": "success",
- "message": "string"
}
Add users from other group(s) to specified group
-group_id required | integer |
fromGroupIDs required | boolean |
{- "fromGroupIDs": true
}
{- "status": "success",
- "message": "string"
}
Retrieve a group admission request
-admission_request_id required | integer |
{- "data": {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "userID": 0,
- "admin": true,
- "canSave": true
}
{- "message": "string",
- "status": "success"
}
Add users from other group(s) to specified group
+group_id required | integer |
fromGroupIDs required | boolean |
{- "fromGroupIDs": true
}
{- "message": "string",
- "status": "success"
}
Retrieve a group admission request
+admission_request_id required | integer |
{- "message": "string",
- "data": {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}, - "status": "success"
}
Update a group admission request's status
admission_request_id required | integer |
status required | string One of either 'accepted', 'declined', or 'pending'. - |
{- "status": "string"
}
{- "status": "success",
- "message": "string"
}
{- "status": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve all group admission requests
groupID | integer ID of group for which admission requests are desired - |
{- "data": [
- {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}
], - "status": "success",
- "message": "string"
}
Create a new group admission request
-groupID required | integer |
userID required | integer |
{- "groupID": 0,
- "userID": 0
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
{- "message": "string",
- "data": [
- {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}
], - "status": "success"
}
Create a new group admission request
+groupID required | integer |
userID required | integer |
{- "groupID": 0,
- "userID": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Get a summary of all the activity of shift users on skyportal for a given period
shift_id required | integer |
startDate | string Arrow-parseable date string (e.g. 2020-01-01). If provided, filter by shift.start_date >= startDate - |
{- "status": "success",
- "message": "string"
}
Add a shift user
-shift_id required | integer |
userID required | integer |
admin required | boolean |
{- "userID": 0,
- "admin": true
}
{- "status": "success",
- "message": "string",
- "data": {
- "shift_id": 0,
- "user_id": 0,
- "admin": true,
- "needs_replacement": true
}
}
{- "message": "string",
- "status": "success"
}
Add a shift user
+shift_id required | integer |
userID required | integer |
admin required | boolean |
{- "userID": 0,
- "admin": true
}
{- "message": "string",
- "status": "success",
- "data": {
- "shift_id": 0,
- "user_id": 0,
- "admin": true,
- "needs_replacement": true
}
}
Update a shift user's admin status, or needs_replacement status
shift_id required | integer |
userID required | integer |
admin | boolean Boolean indicating whether user is shift admin. |
needs_replacement | boolean Boolean indicating whether user needs replacement or not - |
{- "userID": 0,
- "admin": true,
- "needs_replacement": true
}
{- "status": "success",
- "message": "string"
}
Grant stream access to a user
-stream_id required | integer |
user_id required | integer |
{- "user_id": 0
}
{- "status": "success",
- "message": "string",
- "data": {
- "stream_id": 0,
- "user_id": 0
}
}
{- "data": {
- "roles": [
- null
], - "tokens": [
- null
], - "acls": [
- null
], - "username": "string",
- "first_name": "string",
- "last_name": "string",
- "affiliations": null,
- "contact_email": "string",
- "contact_phone": "string",
- "oauth_uid": "string",
- "preferences": null,
- "expiration_date": "2019-08-24T14:15:22Z",
- "id": 0,
- "group_admission_requests": [
- null
], - "streams": [
- null
], - "groups": [
- null
], - "shifts": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "comments_on_gcns": [
- null
], - "reminders_on_gcns": [
- null
], - "comments_on_earthquakes": [
- null
], - "reminders_on_earthquakes": [
- null
], - "default_observationplan_requests": [
- null
], - "catalog_queries": [
- null
], - "comments_on_shifts": [
- null
], - "reminders_on_shifts": [
- null
], - "followup_requests": [
- null
], - "default_followup_requests": [
- null
], - "observationplan_requests": [
- null
], - "survey_efficiency_for_observations": [
- null
], - "survey_efficiency_for_observation_plan": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "assignments": [
- null
], - "recurring_apis": [
- null
], - "gcnevents": [
- null
], - "gcnnotices": [
- null
], - "gcnsummaries": [
- null
], - "gcntags": [
- null
], - "gcnproperties": [
- null
], - "earthquakeevents": [
- null
], - "earthquakenotices": [
- null
], - "listings": [
- null
], - "localizations": [
- null
], - "localizationtags": [
- null
], - "localizationproperties": [
- null
], - "notifications": [
- null
], - "observing_runs": [
- null
], - "sources_in_gcn": [
- null
], - "source_notifications": [
- null
], - "sources": [
- null
], - "social_auth": [
- null
], - "saved_sources": [
- null
]
}, - "status": "success",
- "message": "string"
}
{- "userID": 0,
- "admin": true,
- "needs_replacement": true
}
{- "message": "string",
- "status": "success"
}
Grant stream access to a user
+stream_id required | integer |
user_id required | integer |
{- "user_id": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "stream_id": 0,
- "user_id": 0
}
}
{- "message": "string",
- "data": {
- "roles": [
- null
], - "tokens": [
- null
], - "acls": [
- null
], - "username": "string",
- "first_name": "string",
- "last_name": "string",
- "affiliations": null,
- "contact_email": "string",
- "contact_phone": "string",
- "oauth_uid": "string",
- "preferences": null,
- "expiration_date": "2019-08-24T14:15:22Z",
- "id": 0,
- "group_admission_requests": [
- null
], - "streams": [
- null
], - "groups": [
- null
], - "shifts": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "comments_on_gcns": [
- null
], - "reminders_on_gcns": [
- null
], - "comments_on_earthquakes": [
- null
], - "reminders_on_earthquakes": [
- null
], - "default_observationplan_requests": [
- null
], - "catalog_queries": [
- null
], - "comments_on_shifts": [
- null
], - "reminders_on_shifts": [
- null
], - "followup_requests": [
- null
], - "default_followup_requests": [
- null
], - "observationplan_requests": [
- null
], - "survey_efficiency_for_observations": [
- null
], - "survey_efficiency_for_observation_plan": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "assignments": [
- null
], - "recurring_apis": [
- null
], - "gcnevents": [
- null
], - "gcnnotices": [
- null
], - "gcnsummaries": [
- null
], - "gcntags": [
- null
], - "gcnproperties": [
- null
], - "earthquakeevents": [
- null
], - "earthquakenotices": [
- null
], - "listings": [
- null
], - "localizations": [
- null
], - "localizationtags": [
- null
], - "localizationproperties": [
- null
], - "notifications": [
- null
], - "observing_runs": [
- null
], - "sources_in_gcn": [
- null
], - "source_notifications": [
- null
], - "sources": [
- null
], - "social_auth": [
- null
], - "saved_sources": [
- null
]
}, - "status": "success"
}
Update a User record
user_id required | integer |
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. - |
{- "expirationDate": "string"
}
{- "status": "success",
- "message": "string"
}
{- "expirationDate": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve all users
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. - |
{- "status": "success",
- "message": "string",
- "data": {
- "users": [
- {
- "roles": [
- null
], - "tokens": [
- null
], - "acls": [
- null
], - "username": "string",
- "first_name": "string",
- "last_name": "string",
- "affiliations": null,
- "contact_email": "string",
- "contact_phone": "string",
- "oauth_uid": "string",
- "preferences": null,
- "expiration_date": "2019-08-24T14:15:22Z",
- "id": 0,
- "group_admission_requests": [
- null
], - "streams": [
- null
], - "groups": [
- null
], - "shifts": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "comments_on_gcns": [
- null
], - "reminders_on_gcns": [
- null
], - "comments_on_earthquakes": [
- null
], - "reminders_on_earthquakes": [
- null
], - "default_observationplan_requests": [
- null
], - "catalog_queries": [
- null
], - "comments_on_shifts": [
- null
], - "reminders_on_shifts": [
- null
], - "followup_requests": [
- null
], - "default_followup_requests": [
- null
], - "observationplan_requests": [
- null
], - "survey_efficiency_for_observations": [
- null
], - "survey_efficiency_for_observation_plan": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "assignments": [
- null
], - "recurring_apis": [
- null
], - "gcnevents": [
- null
], - "gcnnotices": [
- null
], - "gcnsummaries": [
- null
], - "gcntags": [
- null
], - "gcnproperties": [
- null
], - "earthquakeevents": [
- null
], - "earthquakenotices": [
- null
], - "listings": [
- null
], - "localizations": [
- null
], - "localizationtags": [
- null
], - "localizationproperties": [
- null
], - "notifications": [
- null
], - "observing_runs": [
- null
], - "sources_in_gcn": [
- null
], - "source_notifications": [
- null
], - "sources": [
- null
], - "social_auth": [
- null
], - "saved_sources": [
- null
]
}
], - "totalMatches": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "users": [
- {
- "roles": [
- null
], - "tokens": [
- null
], - "acls": [
- null
], - "username": "string",
- "first_name": "string",
- "last_name": "string",
- "affiliations": null,
- "contact_email": "string",
- "contact_phone": "string",
- "oauth_uid": "string",
- "preferences": null,
- "expiration_date": "2019-08-24T14:15:22Z",
- "id": 0,
- "group_admission_requests": [
- null
], - "streams": [
- null
], - "groups": [
- null
], - "shifts": [
- null
], - "comments": [
- null
], - "reminders": [
- null
], - "annotations": [
- null
], - "photometry": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "mmadetector_spectra": [
- null
], - "mmadetector_time_intervals": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "comments_on_gcns": [
- null
], - "reminders_on_gcns": [
- null
], - "comments_on_earthquakes": [
- null
], - "reminders_on_earthquakes": [
- null
], - "default_observationplan_requests": [
- null
], - "catalog_queries": [
- null
], - "comments_on_shifts": [
- null
], - "reminders_on_shifts": [
- null
], - "followup_requests": [
- null
], - "default_followup_requests": [
- null
], - "observationplan_requests": [
- null
], - "survey_efficiency_for_observations": [
- null
], - "survey_efficiency_for_observation_plan": [
- null
], - "transactions": [
- null
], - "transaction_requests": [
- null
], - "assignments": [
- null
], - "recurring_apis": [
- null
], - "gcnevents": [
- null
], - "gcnnotices": [
- null
], - "gcnsummaries": [
- null
], - "gcntags": [
- null
], - "gcnproperties": [
- null
], - "earthquakeevents": [
- null
], - "earthquakenotices": [
- null
], - "listings": [
- null
], - "localizations": [
- null
], - "localizationtags": [
- null
], - "localizationproperties": [
- null
], - "notifications": [
- null
], - "observing_runs": [
- null
], - "sources_in_gcn": [
- null
], - "source_notifications": [
- null
], - "sources": [
- null
], - "social_auth": [
- null
], - "saved_sources": [
- null
]
}
], - "totalMatches": 0
}
}
Add a new user
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 |
groupIDsAndAdmin | Array of arrays Array of 2-element arrays |
{- "username": "string",
- "first_name": "string",
- "last_name": "string",
- "affiliations": [
- "string"
], - "contact_email": "string",
- "oauth_uid": "string",
- "contact_phone": "string",
- "roles": [
- "string"
], - "groupIDsAndAdmin": [
- [ ]
]
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Retrieve a Multimessenger Astronomical Detector (MMADetector)
-mmadetector_id required | integer |
{- "data": {
- "events": [
- null
], - "spectra": [
- null
], - "time_intervals": [
- null
], - "name": "string",
- "nickname": "string",
- "type": "gravitational-wave",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "fixed_location": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
Update a Multimessenger Astronomical Detector (MMADetector)
+{- "username": "string",
- "first_name": "string",
- "last_name": "string",
- "affiliations": [
- "string"
], - "contact_email": "string",
- "oauth_uid": "string",
- "contact_phone": "string",
- "roles": [
- "string"
], - "groupIDsAndAdmin": [
- [ ]
]
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve a Multimessenger Astronomical Detector (MMADetector)
+mmadetector_id required | integer |
{- "message": "string",
- "data": {
- "events": [
- null
], - "spectra": [
- null
], - "time_intervals": [
- null
], - "name": "string",
- "nickname": "string",
- "type": "gravitational-wave",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "fixed_location": true,
- "id": 0
}, - "status": "success"
}
Update a Multimessenger Astronomical Detector (MMADetector)
mmadetector_id required | integer |
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)? - |
{- "events": [
- null
], - "spectra": [
- null
], - "time_intervals": [
- null
], - "name": "string",
- "nickname": "string",
- "type": "gravitational-wave",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "fixed_location": true
}
{- "status": "success",
- "message": "string"
}
Retrieve all Multimessenger Astronomical Detectors (MMADetectors)
+{- "events": [
- null
], - "spectra": [
- null
], - "time_intervals": [
- null
], - "name": "string",
- "nickname": "string",
- "type": "gravitational-wave",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "fixed_location": true
}
{- "message": "string",
- "status": "success"
}
Retrieve all Multimessenger Astronomical Detectors (MMADetectors)
name | string Filter by name - |
{- "data": [
- {
- "events": [
- null
], - "spectra": [
- null
], - "time_intervals": [
- null
], - "name": "string",
- "nickname": "string",
- "type": "gravitational-wave",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "fixed_location": true,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "events": [
- null
], - "spectra": [
- null
], - "time_intervals": [
- null
], - "name": "string",
- "nickname": "string",
- "type": "gravitational-wave",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "fixed_location": true,
- "id": 0
}
], - "status": "success"
}
Create a Multimessenger Astronomical Detector (MMADetector)
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)? - |
{- "events": [
- null
], - "spectra": [
- null
], - "time_intervals": [
- null
], - "name": "string",
- "nickname": "string",
- "type": "gravitational-wave",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "fixed_location": true
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Retrieve an mmadetector spectrum
-spectrum_id required | integer |
{- "data": {
- "detector": null,
- "groups": [
- null
], - "owner": null,
- "frequencies": [
- 0
], - "amplitudes": [
- 0
], - "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "detector_id": 0,
- "owner_id": 0,
- "original_file_string": "string",
- "original_file_filename": "string",
- "id": 0
}, - "status": "success",
- "message": "string"
}
Update mmadetector spectrum
-spectrum_id required | integer |
end_time required | string <date-time> The ISO UTC end time the spectrum was taken. + |
{- "events": [
- null
], - "spectra": [
- null
], - "time_intervals": [
- null
], - "name": "string",
- "nickname": "string",
- "type": "gravitational-wave",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "fixed_location": true
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve an mmadetector spectrum
+spectrum_id required | integer |
{- "message": "string",
- "data": {
- "detector": null,
- "groups": [
- null
], - "owner": null,
- "frequencies": [
- 0
], - "amplitudes": [
- 0
], - "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "detector_id": 0,
- "owner_id": 0,
- "original_file_string": "string",
- "original_file_filename": "string",
- "id": 0
}, - "status": "success"
}
Update mmadetector spectrum
+spectrum_id required | integer |
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]. - |
{- "end_time": "2019-08-24T14:15:22Z",
- "group_ids": [ ],
- "amplitudes": [
- 0
], - "start_time": "2019-08-24T14:15:22Z",
- "detector_id": 0,
- "frequencies": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
Frequencies of the spectrum [Hz].
+The ISO UTC end time the spectrum was taken.
+The ISO UTC start time the spectrum was taken.
+{- "amplitudes": [
- 0
], - "group_ids": [ ],
- "detector_id": 0,
- "frequencies": [
- 0
], - "end_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z"
}
{- "message": "string",
- "status": "success"
}
Retrieve multiple spectra with given criteria
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 (MMADetector) spectrum
-end_time required | string <date-time> The ISO UTC end time the spectrum was taken. +Request Body schema: application/json
ResponsesRequest samples
Content type application/json { Response samples
Content type application/json { Retrieve an mmadetector time_intervalRetrieve an mmadetector time_interval -path Parameters
ResponsesResponse samples
Content type application/json { | ||||||||||||||
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. + |
{- "amplitudes": [
- 0
], - "group_ids": [ ],
- "detector_id": 0,
- "frequencies": [
- 0
], - "end_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve an mmadetector time_interval
+time_interval_id required | integer |
{- "message": "string",
- "data": {
- "detector": null,
- "groups": [
- null
], - "owner": null,
- "detector_id": 0,
- "owner_id": 0,
- "id": 0
}, - "status": "success"
}
Update mmadetector time_interval
time_interval_id required | integer |
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. - |
{- "detector": null,
- "groups": [
- null
], - "owner": null,
- "detector_id": 0
}
{- "status": "success",
- "message": "string"
}
Retrieve multiple time_intervals with given criteria
+{- "detector": null,
- "groups": [
- null
], - "owner": null,
- "detector_id": 0
}
{- "message": "string",
- "status": "success"
}
Retrieve multiple time_intervals with given criteria
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 @@ PaginationRequest Body schema: application/json
ResponsesRequest samples
Content type application/json { Response samples
Content type application/json { |
{- "detector": null,
- "groups": [
- null
], - "owner": null,
- "detector_id": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve sources from a user's lists
user_id required | string |
listName | string name of the list to retrieve objects from. If not given will return all objects saved by the user to all lists. - |
{- "data": [
- {
- "user": null,
- "obj": null,
- "user_id": 0,
- "obj_id": "string",
- "list_name": "string",
- "params": null,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "user": null,
- "obj": null,
- "user_id": 0,
- "obj_id": "string",
- "list_name": "string",
- "params": null,
- "id": 0
}
], - "status": "success"
}
Add a listing.
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 @@ Paginationand 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. - |
{- "user_id": 0,
- "obj_id": "string",
- "list_name": "string",
- "params": { }
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
{- "user_id": 0,
- "obj_id": "string",
- "list_name": "string",
- "params": { }
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Remove an existing listing
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. |
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". - |
{- "user_id": 0,
- "obj_id": "string",
- "list_name": "string"
}
{- "status": "success",
- "message": "string"
}
{- "user_id": 0,
- "obj_id": "string",
- "list_name": "string"
}
{- "message": "string",
- "status": "success"
}
Update an existing listing
listing_id required | integer |
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+/) - |
{- "user_id": 0,
- "obj_id": "string",
- "list_name": "string"
}
{- "status": "success",
- "message": "string"
}
Retrieve a group admission request
-admission_request_id required | integer |
{- "data": {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "user_id": 0,
- "obj_id": "string",
- "list_name": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve a group admission request
+admission_request_id required | integer |
{- "message": "string",
- "data": {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}, - "status": "success"
}
Update a group admission request's status
admission_request_id required | integer |
status required | string One of either 'accepted', 'declined', or 'pending'. - |
{- "status": "string"
}
{- "status": "success",
- "message": "string"
}
{- "status": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve all group admission requests
groupID | integer ID of group for which admission requests are desired - |
{- "data": [
- {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}
], - "status": "success",
- "message": "string"
}
Create a new group admission request
-groupID required | integer |
userID required | integer |
{- "groupID": 0,
- "userID": 0
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
{- "message": "string",
- "data": [
- {
- "user": null,
- "group": null,
- "user_id": 0,
- "group_id": 0,
- "status": "pending",
- "id": 0
}
], - "status": "success"
}
Create a new group admission request
+groupID required | integer |
userID required | integer |
{- "groupID": 0,
- "userID": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve invitations
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. - |
{- "status": "success",
- "message": "string",
- "data": {
- "invitations": [
- {
- "role": null,
- "groups": [
- null
], - "streams": [
- null
], - "invited_by": null,
- "token": "string",
- "role_id": "string",
- "admin_for_groups": [
- true
], - "can_save_to_groups": [
- true
], - "user_email": "string",
- "used": true,
- "user_expiration_date": "2019-08-24T14:15:22Z",
- "id": 0
}
], - "totalMatches": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "invitations": [
- {
- "role": null,
- "groups": [
- null
], - "streams": [
- null
], - "invited_by": null,
- "token": "string",
- "role_id": "string",
- "admin_for_groups": [
- true
], - "can_save_to_groups": [
- true
], - "user_email": "string",
- "used": true,
- "user_expiration_date": "2019-08-24T14:15:22Z",
- "id": 0
}
], - "totalMatches": 0
}
}
Invite a new user
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. - |
{- "userEmail": "string",
- "role": "string",
- "streamIDs": [
- 0
], - "groupIDs": [
- 0
], - "groupAdmin": [
- true
], - "canSave": [
- true
], - "userExpirationDate": "string"
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": "string"
}
}
{- "userEmail": "string",
- "role": "string",
- "streamIDs": [
- 0
], - "groupIDs": [
- 0
], - "groupAdmin": [
- true
], - "canSave": [
- true
], - "userExpirationDate": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": "string"
}
}
Update a pending invitation
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. - |
{- "groupIDs": [
- 0
], - "streamIDs": [
- 0
], - "role": "string",
- "userExpirationDate": "string"
}
{- "status": "success",
- "message": "string"
}
{- "groupIDs": [
- 0
], - "streamIDs": [
- 0
], - "role": "string",
- "userExpirationDate": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve all observations
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" - |
{- "data": [
- {
- "instrument": null,
- "field": null,
- "instrument_id": 0,
- "instrument_field_id": 0,
- "observation_id": 0,
- "obstime": "2019-08-24T14:15:22Z",
- "filt": "string",
- "exposure_time": 0,
- "airmass": 0,
- "seeing": 0,
- "limmag": 0,
- "target_name": "string",
- "processed_fraction": 0,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
Ingest a set of ExecutedObservations
-observationData | any Observation data dictionary list - |
instrumentName required | string The instrument name associated with the fields + |
{- "message": "string",
- "data": [
- {
- "instrument": null,
- "field": null,
- "instrument_id": 0,
- "instrument_field_id": 0,
- "observation_id": 0,
- "obstime": "2019-08-24T14:15:22Z",
- "filt": "string",
- "exposure_time": 0,
- "airmass": 0,
- "seeing": 0,
- "limmag": 0,
- "target_name": "string",
- "processed_fraction": 0,
- "id": 0
}
], - "status": "success"
}
Ingest a set of ExecutedObservations
+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 - |
{- "observationData": null,
- "instrumentName": "string",
- "telescopeName": "string"
}
{- "status": "success",
- "message": "string"
}
{- "instrumentName": "string",
- "observationData": null,
- "telescopeName": "string"
}
{- "message": "string",
- "status": "success"
}
Upload observation from ASCII file
observationData | any Observation data Ascii string |
instrumentID required | string The instrument ID associated with the fields - |
{- "observationData": null,
- "instrumentID": "string"
}
{- "data": [
- {
- "instrument": null,
- "field": null,
- "instrument_id": 0,
- "instrument_field_id": 0,
- "observation_id": 0,
- "obstime": "2019-08-24T14:15:22Z",
- "filt": "string",
- "exposure_time": 0,
- "airmass": 0,
- "seeing": 0,
- "limmag": 0,
- "target_name": "string",
- "processed_fraction": 0,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "observationData": null,
- "instrumentID": "string"
}
{- "message": "string",
- "data": [
- {
- "instrument": null,
- "field": null,
- "instrument_id": 0,
- "instrument_field_id": 0,
- "observation_id": 0,
- "obstime": "2019-08-24T14:15:22Z",
- "filt": "string",
- "exposure_time": 0,
- "airmass": 0,
- "seeing": 0,
- "limmag": 0,
- "target_name": "string",
- "processed_fraction": 0,
- "id": 0
}
], - "status": "success"
}
Perform simsurvey efficiency calculation
instrument_id required | string ID for the instrument to submit |
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. - |
{- "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve queued observations from external API
allocation_id required | string ID for the allocation to retrieve |
startDate | string Filter by start date |
endDate | string Filter by end date |
queuesOnly | bool Return queue only (do not commit observations) - |
{- "data": [
- {
- "observation_plan": null,
- "instrument": null,
- "field": null,
- "observation_plan_id": 0,
- "instrument_id": 0,
- "dateobs": "2019-08-24T14:15:22Z",
- "field_id": 0,
- "exposure_time": 0,
- "weight": 0,
- "filt": "string",
- "obstime": "2019-08-24T14:15:22Z",
- "overhead_per_exposure": 0,
- "planned_observation_id": 0,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "observation_plan": null,
- "instrument": null,
- "field": null,
- "observation_plan_id": 0,
- "instrument_id": 0,
- "dateobs": "2019-08-24T14:15:22Z",
- "field_id": 0,
- "exposure_time": 0,
- "weight": 0,
- "filt": "string",
- "obstime": "2019-08-24T14:15:22Z",
- "overhead_per_exposure": 0,
- "planned_observation_id": 0,
- "id": 0
}
], - "status": "success"
}
Retrieve queued observations from external API
allocation_id required | string ID for the allocation to delete queue |
queueName required | string Queue name to remove - |
{- "status": "success",
- "message": "string"
}
Retrieve observations from external API
-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. - |
{- "end_date": null,
- "allocation_id": 0,
- "start_date": null
}
{- "data": [
- {
- "instrument": null,
- "field": null,
- "instrument_id": 0,
- "instrument_field_id": 0,
- "observation_id": 0,
- "obstime": "2019-08-24T14:15:22Z",
- "filt": "string",
- "exposure_time": 0,
- "airmass": 0,
- "seeing": 0,
- "limmag": 0,
- "target_name": "string",
- "processed_fraction": 0,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve observations from external API
+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. + |
{- "start_date": null,
- "end_date": null,
- "allocation_id": 0
}
{- "message": "string",
- "data": [
- {
- "instrument": null,
- "field": null,
- "instrument_id": 0,
- "instrument_field_id": 0,
- "observation_id": 0,
- "obstime": "2019-08-24T14:15:22Z",
- "filt": "string",
- "exposure_time": 0,
- "airmass": 0,
- "seeing": 0,
- "limmag": 0,
- "target_name": "string",
- "processed_fraction": 0,
- "id": 0
}
], - "status": "success"
}
Retrieve skymap-based trigger from external API
allocation_id required | string ID for the allocation to retrieve - |
{- "data": [
- {
- "observation_plan": null,
- "instrument": null,
- "field": null,
- "observation_plan_id": 0,
- "instrument_id": 0,
- "dateobs": "2019-08-24T14:15:22Z",
- "field_id": 0,
- "exposure_time": 0,
- "weight": 0,
- "filt": "string",
- "obstime": "2019-08-24T14:15:22Z",
- "overhead_per_exposure": 0,
- "planned_observation_id": 0,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "observation_plan": null,
- "instrument": null,
- "field": null,
- "observation_plan_id": 0,
- "instrument_id": 0,
- "dateobs": "2019-08-24T14:15:22Z",
- "field_id": 0,
- "exposure_time": 0,
- "weight": 0,
- "filt": "string",
- "obstime": "2019-08-24T14:15:22Z",
- "overhead_per_exposure": 0,
- "planned_observation_id": 0,
- "id": 0
}
], - "status": "success"
}
Delete skymap-based trigger from external API
allocation_id required | string ID for the allocation to delete queue |
queueName required | string Queue name to remove - |
{- "status": "success",
- "message": "string"
}
Retrieve an observation efficiency analysis
-survey_efficiency_analysis_id required | integer |
{- "data": {
- "gcnevent": null,
- "localization": null,
- "instrument": null,
- "requester": null,
- "groups": [
- null
], - "gcnevent_id": 0,
- "localization_id": 0,
- "instrument_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve an observation efficiency analysis
+survey_efficiency_analysis_id required | integer |
{- "message": "string",
- "data": {
- "gcnevent": null,
- "localization": null,
- "instrument": null,
- "requester": null,
- "groups": [
- null
], - "gcnevent_id": 0,
- "localization_id": 0,
- "instrument_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}, - "status": "success"
}
Remove observations from treasuremap.space.
instrument_id required | string ID for the instrument to submit |
localizationDateobs | string Event time in ISO 8601 format ( Paginationidentifier. It can be therefore found as Localization.dateobs, queried from the /api/localization endpoint or dateobs in the GcnEvent page table. - |
{- "status": "success",
- "message": "string"
}
{- "data": {
- "group_id": 0,
- "assignments": [
- null
], - "ephemeris": null,
- "calendar_date": "2019-08-24",
- "instrument_id": 0,
- "observers": "string",
- "pi": "string",
- "instrument": null,
- "id": 0,
- "owner_id": 0
}, - "status": "success",
- "message": "string"
}
Update observing run
-run_id required | integer |
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. + |
{- "message": "string",
- "status": "success"
}
{- "message": "string",
- "data": {
- "assignments": [
- null
], - "calendar_date": "2019-08-24",
- "owner_id": 0,
- "observers": "string",
- "group_id": 0,
- "pi": "string",
- "id": 0,
- "instrument_id": 0,
- "instrument": null,
- "ephemeris": null
}, - "status": "success"
}
Update observing run
+run_id required | integer |
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. - |
{- "group_id": 0,
- "calendar_date": "2019-08-24",
- "instrument_id": 0,
- "observers": "string",
- "pi": "string"
}
{- "status": "success",
- "message": "string"
}
{- "data": [
- {
- "instrument": null,
- "sources": [
- null
], - "group": null,
- "owner": null,
- "assignments": [
- null
], - "instrument_id": 0,
- "pi": "string",
- "observers": "string",
- "group_id": 0,
- "owner_id": 0,
- "calendar_date": "2019-08-24",
- "id": 0
}
], - "status": "success",
- "message": "string"
}
Add a new observing run
-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. + |
{- "calendar_date": "2019-08-24",
- "observers": "string",
- "group_id": 0,
- "pi": "string",
- "instrument_id": 0
}
{- "message": "string",
- "status": "success"
}
{- "message": "string",
- "data": [
- {
- "instrument": null,
- "sources": [
- null
], - "group": null,
- "owner": null,
- "assignments": [
- null
], - "instrument_id": 0,
- "pi": "string",
- "observers": "string",
- "group_id": 0,
- "owner_id": 0,
- "calendar_date": "2019-08-24",
- "id": 0
}
], - "status": "success"
}
Add a new observing run
+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. - |
{- "group_id": 0,
- "calendar_date": "2019-08-24",
- "instrument_id": 0,
- "observers": "string",
- "pi": "string"
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
The ID of the group this run is associated with.
+The PI of the observing run.
+The ID of the instrument to be used in this run.
+{- "calendar_date": "2019-08-24",
- "observers": "string",
- "group_id": 0,
- "pi": "string",
- "instrument_id": 0
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Set an object's host galaxy
obj_id required | string |
galaxyName required | string Name of the galaxy to associate with the object - |
{- "galaxyName": "string"
}
{- "status": "success",
- "message": "string"
}
Retrieve an object's status from Minor Planet Center
+{- "galaxyName": "string"
}
{- "message": "string",
- "status": "success"
}
Retrieve an object's status from Minor Planet Center
obj_id required | string |
obscode | string Minor planet center observatory code. Defaults to 500, corresponds to geocentric. |
date | string Time to check MPC for. @@ -3158,16 +3158,16 @@ PaginationDefaults to 24.0. |
search_radius | float Search radius for MPC [in arcmin]. Defaults to 1 arcminute. - |
{- "obscode": "string",
- "date": "string",
- "limiting_magnitude": null,
- "search_radius": null
}
{- "status": "success",
- "message": "string"
}
{- "obscode": "string",
- "date": "string",
- "limiting_magnitude": null,
- "search_radius": null
}
{- "message": "string",
- "status": "success"
}
Retrieve a photometric series
photometric_series_id required | integer |
dataFormat | string Enum: "json" "hdf5" "none" Format of the data to return. If |
{- "data": {
- "obj": null,
- "groups": [
- null
], - "streams": [
- null
], - "instrument": null,
- "followup_request": null,
- "assignment": null,
- "owner": null,
- "obj_id": "string",
- "series_name": "string",
- "series_obj_id": "string",
- "filter": "bessellux",
- "channel": "string",
- "origin": "string",
- "filename": "string",
- "mjd_first": 0,
- "mag_first": 0,
- "mjd_mid": 0,
- "mjd_last": 0,
- "mag_last": 0,
- "mjd_last_detected": 0,
- "mag_last_detected": 0,
- "is_detected": true,
- "exp_time": 0,
- "frame_rate": 0,
- "num_exp": 0,
- "time_stamp_alignment": "start",
- "ra_unc": 0,
- "dec_unc": 0,
- "limiting_mag": 0,
- "ref_flux": 0,
- "ref_fluxerr": 0,
- "altdata": null,
- "instrument_id": 0,
- "followup_request_id": 0,
- "assignment_id": 0,
- "owner_id": 0,
- "mean_mag": 0,
- "rms_mag": 0,
- "robust_mag": 0,
- "robust_rms": 0,
- "median_snr": 0,
- "best_snr": 0,
- "worst_snr": 0,
- "medians": null,
- "maxima": null,
- "minima": null,
- "stds": null,
- "hash": "string",
- "autodelete": true,
- "ra": 0,
- "dec": 0,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": {
- "obj": null,
- "groups": [
- null
], - "streams": [
- null
], - "instrument": null,
- "followup_request": null,
- "assignment": null,
- "owner": null,
- "obj_id": "string",
- "series_name": "string",
- "series_obj_id": "string",
- "filter": "bessellux",
- "channel": "string",
- "origin": "string",
- "filename": "string",
- "mjd_first": 0,
- "mag_first": 0,
- "mjd_mid": 0,
- "mjd_last": 0,
- "mag_last": 0,
- "mjd_last_detected": 0,
- "mag_last_detected": 0,
- "is_detected": true,
- "exp_time": 0,
- "frame_rate": 0,
- "num_exp": 0,
- "time_stamp_alignment": "start",
- "ra_unc": 0,
- "dec_unc": 0,
- "limiting_mag": 0,
- "ref_flux": 0,
- "ref_fluxerr": 0,
- "altdata": null,
- "instrument_id": 0,
- "followup_request_id": 0,
- "assignment_id": 0,
- "owner_id": 0,
- "mean_mag": 0,
- "rms_mag": 0,
- "robust_mag": 0,
- "robust_rms": 0,
- "median_snr": 0,
- "best_snr": 0,
- "worst_snr": 0,
- "medians": null,
- "maxima": null,
- "minima": null,
- "stds": null,
- "hash": "string",
- "autodelete": true,
- "ra": 0,
- "dec": 0,
- "id": 0
}, - "status": "success"
}
Retrieve all photometric series, based on various cuts.
dataFormat | string Enum: "json" "hdf5" "none" Format of the data to return. If 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 - |
{- "status": "success",
- "message": "string",
- "data": {
- "series": [
- {
- "obj": null,
- "groups": [
- null
], - "streams": [
- null
], - "instrument": null,
- "followup_request": null,
- "assignment": null,
- "owner": null,
- "obj_id": "string",
- "series_name": "string",
- "series_obj_id": "string",
- "filter": "bessellux",
- "channel": "string",
- "origin": "string",
- "filename": "string",
- "mjd_first": 0,
- "mag_first": 0,
- "mjd_mid": 0,
- "mjd_last": 0,
- "mag_last": 0,
- "mjd_last_detected": 0,
- "mag_last_detected": 0,
- "is_detected": true,
- "exp_time": 0,
- "frame_rate": 0,
- "num_exp": 0,
- "time_stamp_alignment": "start",
- "ra_unc": 0,
- "dec_unc": 0,
- "limiting_mag": 0,
- "ref_flux": 0,
- "ref_fluxerr": 0,
- "altdata": null,
- "instrument_id": 0,
- "followup_request_id": 0,
- "assignment_id": 0,
- "owner_id": 0,
- "mean_mag": 0,
- "rms_mag": 0,
- "robust_mag": 0,
- "robust_rms": 0,
- "median_snr": 0,
- "best_snr": 0,
- "worst_snr": 0,
- "medians": null,
- "maxima": null,
- "minima": null,
- "stds": null,
- "hash": "string",
- "autodelete": true,
- "ra": 0,
- "dec": 0,
- "id": 0
}
], - "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "series": [
- {
- "obj": null,
- "groups": [
- null
], - "streams": [
- null
], - "instrument": null,
- "followup_request": null,
- "assignment": null,
- "owner": null,
- "obj_id": "string",
- "series_name": "string",
- "series_obj_id": "string",
- "filter": "bessellux",
- "channel": "string",
- "origin": "string",
- "filename": "string",
- "mjd_first": 0,
- "mag_first": 0,
- "mjd_mid": 0,
- "mjd_last": 0,
- "mag_last": 0,
- "mjd_last_detected": 0,
- "mag_last_detected": 0,
- "is_detected": true,
- "exp_time": 0,
- "frame_rate": 0,
- "num_exp": 0,
- "time_stamp_alignment": "start",
- "ra_unc": 0,
- "dec_unc": 0,
- "limiting_mag": 0,
- "ref_flux": 0,
- "ref_fluxerr": 0,
- "altdata": null,
- "instrument_id": 0,
- "followup_request_id": 0,
- "assignment_id": 0,
- "owner_id": 0,
- "mean_mag": 0,
- "rms_mag": 0,
- "robust_mag": 0,
- "robust_rms": 0,
- "median_snr": 0,
- "best_snr": 0,
- "worst_snr": 0,
- "medians": null,
- "maxima": null,
- "minima": null,
- "stds": null,
- "hash": "string",
- "autodelete": true,
- "ra": 0,
- "dec": 0,
- "id": 0
}
], - "totalMatches": 0,
- "pageNumber": 0,
- "numPerPage": 0
}
}
Get a list of sources with summaries matching the query
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 @@ Paginationthen no upper limit is applied. |
classificationTypes | Array of strings List of classification types to consider. If [] or missing, then all classification types are considered. - |
{- "status": "success",
- "message": "string",
- "data": {
- "sources": [
- {
- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "id": "string",
- "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": [
- null
], - "sources": [
- null
], - "users": [
- null
]
}
]
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "sources": [
- {
- "host": null,
- "comments": [
- null
], - "reminders": [
- null
], - "comments_on_spectra": [
- null
], - "reminders_on_spectra": [
- null
], - "annotations": [
- null
], - "annotations_on_spectra": [
- null
], - "annotations_on_photometry": [
- null
], - "classifications": [
- null
], - "photometry": [
- null
], - "photstats": [
- null
], - "photometric_series": [
- null
], - "spectra": [
- null
], - "thumbnails": [
- null
], - "followup_requests": [
- null
], - "assignments": [
- null
], - "obj_notifications": [
- null
], - "obj_analyses": [
- null
], - "sources_in_gcns": [
- null
], - "id": "string",
- "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": [
- null
], - "sources": [
- null
], - "users": [
- null
]
}
]
}
}
Share data with additional groups/users
photometryIDs | Array of integers IDs of the photometry data to be shared. If |
spectrumIDs | Array of integers IDs of the spectra to be shared. If |
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. - |
{- "photometryIDs": [
- 0
], - "spectrumIDs": [
- 0
], - "groupIDs": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
Retrieve an Recurring API by id
-recurring_api_id required | integer |
{- "data": {
- "owner": null,
- "owner_id": 0,
- "endpoint": "string",
- "payload": null,
- "method": "string",
- "next_call": "2019-08-24T14:15:22Z",
- "call_delay": 0,
- "number_of_retries": 0,
- "active": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "data": [
- {
- "owner": null,
- "owner_id": 0,
- "endpoint": "string",
- "payload": null,
- "method": "string",
- "next_call": "2019-08-24T14:15:22Z",
- "call_delay": 0,
- "number_of_retries": 0,
- "active": true,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "photometryIDs": [
- 0
], - "spectrumIDs": [
- 0
], - "groupIDs": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Retrieve an Recurring API by id
+recurring_api_id required | integer |
{- "message": "string",
- "data": {
- "owner": null,
- "owner_id": 0,
- "endpoint": "string",
- "payload": null,
- "method": "string",
- "next_call": "2019-08-24T14:15:22Z",
- "call_delay": 0,
- "number_of_retries": 0,
- "active": true,
- "id": 0
}, - "status": "success"
}
{- "message": "string",
- "data": [
- {
- "owner": null,
- "owner_id": 0,
- "endpoint": "string",
- "payload": null,
- "method": "string",
- "next_call": "2019-08-24T14:15:22Z",
- "call_delay": 0,
- "number_of_retries": 0,
- "active": true,
- "id": 0
}
], - "status": "success"
}
POST a new Recurring APIs.
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. - |
{- "endpoint": "string",
- "method": "string",
- "next_call": null,
- "call_delay": 0,
- "number_of_retries": 0,
- "payload": { }
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
{- "endpoint": "string",
- "method": "string",
- "next_call": null,
- "call_delay": 0,
- "number_of_retries": 0,
- "payload": { }
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Grant new Role(s) to a user
user_id required | integer |
roleIds required | Array of strings Array of Role IDs (strings) to be granted to user - |
{- "roleIds": [
- "string"
]
}
{- "status": "success",
- "message": "string"
}
{- "roleIds": [
- "string"
]
}
{- "message": "string",
- "status": "success"
}
Note that a source has been labelled.
obj_id required | string ID of object to indicate source labelling for |
groupIds required | Array of integers List of IDs of groups to indicate labelling for - |
{- "groupIds": [
- 0
]
}
{- "status": "success",
- "message": "string"
}
{- "groupIds": [
- 0
]
}
{- "message": "string",
- "status": "success"
}
Send out a new source notification
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 - |
{- "additionalNotes": "string",
- "groupIds": [
- 0
], - "sourceId": "string",
- "level": "string"
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": "string"
}
}
{- "additionalNotes": "string",
- "groupIds": [
- 0
], - "sourceId": "string",
- "level": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": "string"
}
}
Retrieve an observation plan efficiency analysis
-survey_efficiency_analysis_id required | integer |
{- "data": {
- "observation_plan": null,
- "requester": null,
- "groups": [
- null
], - "observation_plan_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}, - "status": "success",
- "message": "string"
}
Retrieve parts of the config file that are exposed to the user/browser
-{- "status": "success",
- "message": "string",
- "data": {
- "invitationsEnabled": true,
- "slackPreamble": "string",
- "cosmology": "string",
- "cosmoref": "string",
- "allowedSpectrumTypes": [ ],
- "defaultSpectrumType": "string",
- "classificationsClasses": { }
}
}
{- "data": {
- "groups": [
- null
], - "classifications": [
- null
], - "name": "string",
- "hierarchy": null,
- "provenance": "string",
- "version": "string",
- "isLatest": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
Update taxonomy
+survey_efficiency_analysis_id required | integer |
{- "message": "string",
- "data": {
- "observation_plan": null,
- "requester": null,
- "groups": [
- null
], - "observation_plan_id": 0,
- "id": 0,
- "payload": null,
- "status": "string",
- "lightcurves": null,
- "requester_id": 0
}, - "status": "success"
}
Retrieve parts of the config file that are exposed to the user/browser
+{- "message": "string",
- "status": "success",
- "data": {
- "invitationsEnabled": true,
- "slackPreamble": "string",
- "cosmology": "string",
- "cosmoref": "string",
- "allowedSpectrumTypes": [ ],
- "defaultSpectrumType": "string",
- "classificationsClasses": { }
}
}
{- "message": "string",
- "data": {
- "groups": [
- null
], - "classifications": [
- null
], - "name": "string",
- "hierarchy": null,
- "provenance": "string",
- "version": "string",
- "isLatest": true,
- "id": 0
}, - "status": "success"
}
Update taxonomy
taxonomy_id required | integer |
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. - |
{- "groups": [
- null
], - "classifications": [
- null
], - "name": "string",
- "hierarchy": null,
- "provenance": "string",
- "version": "string",
- "isLatest": true
}
{- "status": "success",
- "message": "string"
}
{- "data": [
- {
- "groups": [
- null
], - "classifications": [
- null
], - "name": "string",
- "hierarchy": null,
- "provenance": "string",
- "version": "string",
- "isLatest": true,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "groups": [
- null
], - "classifications": [
- null
], - "name": "string",
- "hierarchy": null,
- "provenance": "string",
- "version": "string",
- "isLatest": true
}
{- "message": "string",
- "status": "success"
}
{- "message": "string",
- "data": [
- {
- "groups": [
- null
], - "classifications": [
- null
], - "name": "string",
- "hierarchy": null,
- "provenance": "string",
- "version": "string",
- "isLatest": true,
- "id": 0
}
], - "status": "success"
}
Post new taxonomy
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 @@ Paginationto an origin or place of record |
isLatest | boolean Consider this version of the taxonomy with this name the latest? Defaults to True. - |
{- "name": "string",
- "hierarchy": { },
- "group_ids": [
- 0
], - "version": "string",
- "provenance": "string",
- "isLatest": true
}
{- "status": "success",
- "message": "string",
- "data": {
- "taxonomy_id": 0
}
}
{- "data": {
- "instruments": [
- null
], - "name": "string",
- "nickname": "string",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "diameter": 0,
- "skycam_link": "string",
- "weather_link": "string",
- "robotic": true,
- "fixed_location": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "name": "string",
- "hierarchy": { },
- "group_ids": [
- 0
], - "version": "string",
- "provenance": "string",
- "isLatest": true
}
{- "message": "string",
- "status": "success",
- "data": {
- "taxonomy_id": 0
}
}
{- "message": "string",
- "data": {
- "instruments": [
- null
], - "name": "string",
- "nickname": "string",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "diameter": 0,
- "skycam_link": "string",
- "weather_link": "string",
- "robotic": true,
- "fixed_location": true,
- "id": 0
}, - "status": "success"
}
Update telescope
telescope_id required | integer |
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)? - |
{- "instruments": [
- null
], - "name": "string",
- "nickname": "string",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "diameter": 0,
- "skycam_link": "string",
- "weather_link": "string",
- "robotic": true,
- "fixed_location": true
}
{- "status": "success",
- "message": "string"
}
{- "instruments": [
- null
], - "name": "string",
- "nickname": "string",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "diameter": 0,
- "skycam_link": "string",
- "weather_link": "string",
- "robotic": true,
- "fixed_location": true
}
{- "message": "string",
- "status": "success"
}
Retrieve all telescopes
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 - |
{- "data": [
- {
- "instruments": [
- null
], - "name": "string",
- "nickname": "string",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "diameter": 0,
- "skycam_link": "string",
- "weather_link": "string",
- "robotic": true,
- "fixed_location": true,
- "id": 0
}
], - "status": "success",
- "message": "string"
}
{- "message": "string",
- "data": [
- {
- "instruments": [
- null
], - "name": "string",
- "nickname": "string",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "diameter": 0,
- "skycam_link": "string",
- "weather_link": "string",
- "robotic": true,
- "fixed_location": true,
- "id": 0
}
], - "status": "success"
}
Create telescopes
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)? - |
{- "instruments": [
- null
], - "name": "string",
- "nickname": "string",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "diameter": 0,
- "skycam_link": "string",
- "weather_link": "string",
- "robotic": true,
- "fixed_location": true
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
Retrieve weather info at the telescope site saved by user or telescope specified by telescope_id
parameter
telescope_id | integer |
{- "status": "success",
- "message": "string",
- "data": {
- "weather": { },
- "weather_retrieved_at": "string",
- "weather_link": "string",
- "telescope_name": "string",
- "telescope_nickname": "string",
- "telescope_id": 0,
- "message": "string"
}
}
{- "data": {
- "obj": null,
- "type": "new",
- "file_uri": "string",
- "public_url": "string",
- "origin": "string",
- "obj_id": "string",
- "is_grayscale": true,
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "instruments": [
- null
], - "name": "string",
- "nickname": "string",
- "lat": 0,
- "lon": 0,
- "elevation": 0,
- "diameter": 0,
- "skycam_link": "string",
- "weather_link": "string",
- "robotic": true,
- "fixed_location": true
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Retrieve weather info at the telescope site saved by user or telescope specified by telescope_id
parameter
telescope_id | integer |
{- "message": "string",
- "status": "success",
- "data": {
- "weather": { },
- "weather_retrieved_at": "string",
- "weather_link": "string",
- "telescope_name": "string",
- "telescope_nickname": "string",
- "telescope_id": 0,
- "message": "string"
}
}
{- "message": "string",
- "data": {
- "obj": null,
- "type": "new",
- "file_uri": "string",
- "public_url": "string",
- "origin": "string",
- "obj_id": "string",
- "is_grayscale": true,
- "id": 0
}, - "status": "success"
}
Update thumbnail
thumbnail_id required | integer |
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. - |
{- "obj": null,
- "type": "new",
- "file_uri": "string",
- "public_url": "string",
- "origin": "string",
- "obj_id": "string",
- "is_grayscale": true
}
{- "status": "success",
- "message": "string"
}
{- "obj": null,
- "type": "new",
- "file_uri": "string",
- "public_url": "string",
- "origin": "string",
- "obj_id": "string",
- "is_grayscale": true
}
{- "message": "string",
- "status": "success"
}
Upload thumbnails
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' - |
{- "obj_id": "string",
- "data": "string",
- "ttype": "string"
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
{- "obj_id": "string",
- "data": "string",
- "ttype": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Get information on thumbnails that are or are not in the correct folder/path.
types | Array of strings types of thumbnails to check @@ -3414,11 +3414,11 @@ Paginationhash of the source name. If requiredDepth is 0, then thumbnails are expected to be all in one folder under /skyportal/static/thumbnails. - |
{- "status": "success",
- "message": "string",
- "data": {
- "totalMatches": 0,
- "inCorrectFolder": 0,
- "inWrongFolder": 0
}
}
{- "message": "string",
- "status": "success",
- "data": {
- "totalMatches": 0,
- "inCorrectFolder": 0,
- "inWrongFolder": 0
}
}
Update the file path and file_uri of the database rows of thumbnails that are not in the correct folder/path.
types | Array of strings types of thumbnails to check The default is ['new', 'ref', 'sub'] which @@ -3433,27 +3433,27 @@ Paginationto 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 - |
{- "status": "success",
- "message": "string",
- "data": {
- "totalMatches": 0,
- "inCorrectFolder": 0,
- "inWrongFolder": 0
}
}
{- "data": {
- "group": null,
- "group_id": 0,
- "bot_name": "string",
- "bot_id": 0,
- "source_group_id": 0,
- "_altdata": "string",
- "id": 0
}, - "status": "success",
- "message": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "totalMatches": 0,
- "inCorrectFolder": 0,
- "inWrongFolder": 0
}
}
{- "message": "string",
- "data": {
- "group": null,
- "group_id": 0,
- "bot_name": "string",
- "bot_id": 0,
- "source_group_id": 0,
- "_altdata": "string",
- "id": 0
}, - "status": "success"
}
Post new TNS robot
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 |
{- "group": null,
- "group_id": 0,
- "bot_name": "string",
- "bot_id": 0,
- "source_group_id": 0,
- "_altdata": "string"
}
{- "status": "success",
- "message": "string",
- "data": {
- "id": 0
}
}
{- "group": null,
- "group_id": 0,
- "bot_name": "string",
- "bot_id": 0,
- "source_group_id": 0,
- "_altdata": "string"
}
{- "message": "string",
- "status": "success",
- "data": {
- "id": 0
}
}
Grant new ACL(s) to a user
user_id required | integer |
aclIds required | Array of strings Array of ACL IDs (strings) to be granted to user - |
{- "aclIds": [
- "string"
]
}
{- "status": "success",
- "message": "string"
}
Retrieve weather info at the telescope site saved by user or telescope specified by telescope_id
parameter
telescope_id | integer |
{- "status": "success",
- "message": "string",
- "data": {
- "weather": { },
- "weather_retrieved_at": "string",
- "weather_link": "string",
- "telescope_name": "string",
- "telescope_nickname": "string",
- "telescope_id": 0,
- "message": "string"
}
}
{- "aclIds": [
- "string"
]
}
{- "message": "string",
- "status": "success"
}
Retrieve weather info at the telescope site saved by user or telescope specified by telescope_id
parameter
telescope_id | integer |
{- "message": "string",
- "status": "success",
- "data": {
- "weather": { },
- "weather_retrieved_at": "string",
- "weather_link": "string",
- "telescope_name": "string",
- "telescope_nickname": "string",
- "telescope_id": 0,
- "message": "string"
}
}
Return the results of an analysis
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. |
results | object Results data of this analysis - |
{- "results": { }
}
{- "status": "success",
- "message": "string"
}
{- "results": { }
}
{- "message": "string",
- "status": "success"
}