Observation

Add an Observation

POST /obs

Submits an observation.

Headers

Name	Value
Authentication-Token	<token>

Body

Name	Type	Description
name	string	Name of the observation
mode	int	0 = Continue on same 1 = Continue on different 2 = Run in parallel
minEl	float	Minimum allowed target elevation
maxSun	float	Maximum allowed Sun elevation. The maximum allowed value is -6.
raHours	float	Right Ascension of the target. Must be between 0 and 24.
decDegs	float	Declination of the target. Must be between -90 and 90.
telescopes	list[string | int]	List of telescope names or integer IDs to add to the observation
minMoonSepDegs	float	Minimum allowed separation from the moon
targetTracking	string	Allowed valued include track_target or lock_field
fieldLockUtc	string	Locks the field at the given UTC yyyy-mm-ddThh:mm:ss.s
objectName	string	Name of the object
objectType	string	Type of the object. Allowed values include sidereal, planet, asteroid, comet, and nonsidereal.
objectDist	float	Distance to the solar system object measured in AU
exps	list[dict]	List of exposures
cancelAfterUtc	string	Cancel the observation after this date yyyy-mm-ddThh:mm:ss.s
nextExpStartAfterUtc	string	Delay the start of the observation until this time. yyyy-mm-ddThh:mm:ss.s
efficiency	float	Assumes exposure length
priority	int	Priority of the observation
isToo	int	Target-Of-Opportunity
tooJustification	string	Justification for using TOO
pointAheadEnabled	bool
pointAheadSecs	float
constantRaOffsetArcmin	float
constantDecOffsetArcmin	float
triggerRepointEnabled	bool
triggerRepointArcmins	float
rbiFractionAvgBkgLimit	float
ditherEnabled	bool
ditherXSize	float
ditherYSize	float
ditherSpacingArcsecs	float
trigger	dict	Dictionary containing Campaign Trigger parameters. See below.

Trigger

The trigger object can be added to the observation request instead of exposures. This will trigger the Campaign Manager.

I wrote the CM API back when I was a wee lad and had no idea what I was doing. Much like myself, it works just fine, but its quite ugly. As a result, some of the parameter names are non-descriptive or flat out wrong. This can make things confusing.

For example, refSNR is not a reference SNR. It is a user desired SNR.

Name	Type	Description
campaignId	int	ID of the hardware template
refMag	float	Magnitude of the target in the reference image
refTime	float	Time since the event in seconds that the reference image was taken
refFilter	int | string	Filter that the reference image was taken with
delay	float	Delay in seconds between filter sequences
refSNR	float	Desired signal-to-noise ratio of the target
expFunction	string	power law or exponential
tempIndex	float	Temporal evolution (negative indicates fading)
specIndex	float	Spectral evolution (negative indicated reddening)
eventTime	string yyyy-mm-ddThh:mm:ss.s	Time of the event trigger
ebv	float	E(B - V) strength

Example

Python Standard Obs

import json
import requests

token = '1234'

payload = {'name': 'api-test',
           'mode': 1,
           'timeAccountId': 123,
           'targetTracking': 'track_target',
           'raHours': 12.,
           'decDegs': 40.,
           'minEl': 20,
           'maxSun': -18,
           'minMoonSepDegs': 0,
           'exps': json.dumps([dict(expLength=5,
                                    filterRequested='R',
                                    telescopeRequested='Morehead')
                              ])}
  
 response = requests.request(method='POST', url=f"https://api.skynet.unc.edu/2.0/obs/",
                                **{'data': payload, 'headers': {'Authentication-Token': token}})

if response.status_code != 200:
    raise RuntimeError(response.text)
    
data = response.json()

Python Campaign Manager Obs

---

Update an Observation

PUT /obs

Update an observation. In addition to any field defined in Add an Observation, the user can update the state to cancel the observation.

Headers

Name	Value
Authentication-Token	<token>

Body

Name	Type	Description
state	string	canceled

---

Get Observations

GET /obs

Get an observation. Providing an observation ID will return a single observation (if found). If the observation ID is not provided, the server will return a list of observation IDs matching the search criteria.

Headers

Name	Value
Authentication-Token	<token>

Body

Name	Type	Description
id	int | string	Observation ID
user	int | string | list	Request user observations.
group	int | string | list	Request group observations.
collab	int | string | list	Request collaboration observations.
scope	int | string | list/-	Return observations submitted to specific telescope(s)
after	string yyyy-mm-ddThh:mm:ss.s	Request observations submitted after the given date/time
before	string yyyy-mm-ddThh:mm:ss.s	Request observations submitted beforethe given date/time
sort_by	string	Comma-separated list of Observation or Exposure column names with "-" before the column name indicating reversed order
offset	int	Return items starting from the given index
limit	int	Return the given number of items
other	-	Return observations with the corresponding Observation or Exposure field equal to the given value

---