Proposal Handling Tool (PHT) REST API

A SwaggerUI for the latest main branch of the API is available at

https://k8s.stfc.skao.int/integration-ska-oso-services/oso/api/v2/ui/

The API provides proposal preparation and management resources that support proposal creation, submission, review, and decision processes. Outlined below are the endpoints grouped by different functionality of the PHT.

• Proposal Preparation:

GET /ska-oso-services/oso/api/v5/pht/prsls/osd/{cycle}

Retrieve OSD data for a given cycle

This queries the OSD data by cycle id.

This data is made available for the PHT UI.

Returns: OsdDataModel: The OSD data validated against the defined schema.

Parameters:

• cycle (integer, required)

Response JSON Object:

• observatory_policy (object, required)

• observatory_policy.cycle_number (integer, required)

• observatory_policy.cycle_description (string, required)

• observatory_policy.cycle_information (object, required)

• observatory_policy.cycle_information.cycle_id (string, required)

• observatory_policy.cycle_information.proposal_open (string, required)

• observatory_policy.cycle_information.proposal_close (string, required)

• observatory_policy.cycle_policies (object, required)

• observatory_policy.cycle_policies.normal_max_hours (integer, required)

• observatory_policy.telescope_capabilities (object, required)

• observatory_policy.telescope_capabilities.Mid (string, required)

• observatory_policy.telescope_capabilities.Low (string, required)

• capabilities (object, required)

• capabilities.mid (object, required)

• capabilities.mid.basic_capabilities (object, required)

• capabilities.mid.basic_capabilities.dish_elevation_limit_deg (integer, required)

• capabilities.mid.basic_capabilities.receiver_information[] (object)

• capabilities.mid.basic_capabilities.receiver_information[].rx_id (string, required)

• capabilities.mid.basic_capabilities.receiver_information[].min_frequency_hz (integer, required)

• capabilities.mid.basic_capabilities.receiver_information[].max_frequency_hz (integer, required)

• capabilities.mid.AA2 (object, required)

• capabilities.mid.AA2.available_receivers[] (string)

• capabilities.mid.AA2.number_ska_dishes (integer, required)

• capabilities.mid.AA2.number_meerkat_dishes (integer, required)

• capabilities.mid.AA2.number_meerkatplus_dishes (integer, required)

• capabilities.mid.AA2.max_baseline_km (integer, required)

• capabilities.mid.AA2.available_bandwidth_hz (integer, required)

• capabilities.mid.AA2.number_channels (integer, required)

• capabilities.mid.AA2.cbf_modes[] (string)

• capabilities.mid.AA2.number_zoom_windows (integer, required)

• capabilities.mid.AA2.number_zoom_channels (integer, required)

• capabilities.mid.AA2.number_pss_beams (integer, required)

• capabilities.mid.AA2.number_pst_beams (integer, required)

• capabilities.mid.AA2.ps_beam_bandwidth_hz (integer, required)

• capabilities.mid.AA2.number_fsps (integer, required)

• capabilities.low (object, required)

• capabilities.low.basic_capabilities (object, required)

• capabilities.low.basic_capabilities.min_frequency_hz (integer, required)

• capabilities.low.basic_capabilities.max_frequency_hz (integer, required)

• capabilities.low.AA2 (object, required)

• capabilities.low.AA2.number_stations (integer, required)

• capabilities.low.AA2.number_substations (integer, required)

• capabilities.low.AA2.number_beams (integer, required)

• capabilities.low.AA2.max_baseline_km (integer, required)

• capabilities.low.AA2.available_bandwidth_hz (integer, required)

• capabilities.low.AA2.channel_width_hz (integer, required)

• capabilities.low.AA2.cbf_modes[] (string)

• capabilities.low.AA2.number_zoom_windows (integer, required)

• capabilities.low.AA2.number_zoom_channels (integer, required)

• capabilities.low.AA2.number_pss_beams (integer, required)

• capabilities.low.AA2.number_pst_beams (integer, required)

• capabilities.low.AA2.number_vlbi_beams (integer, required)

• capabilities.low.AA2.ps_beam_bandwidth_hz (integer, required)

• capabilities.low.AA2.number_fsps (integer, required)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

POST /ska-oso-services/oso/api/v5/pht/prsls/create

Create a new proposal

Creates a new proposal in the ODA.

Request Headers:

• X-Request-ID

Request JSON Object:

• prsl_id (string, required)

• status (string, required)

• cycle (string, required)

• info (object, required)

• info.title (string, required)

• info.proposal_type (object, required)

• info.proposal_type.main_type (string, required) – e.g. ‘standard_proposal’

• info.proposal_type.attributes[] (string)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /ska-oso-services/oso/api/v5/pht/prsls/reviewable

Get a list of proposals by status

Function that requests to GET /prsls/reviewable are mapped to.

Retrieves the Proposals from the underlying data store, if available Return proposals, preferring UNDER_REVIEW over SUBMITTED. One latest proposal per prsl_id.

Returns: list[Proposal]

Request Headers:

• X-Request-ID

Response JSON Array of Objects:

• prsl_id (string)

• status (string:enum)

• submitted_on (string:date-time) – The date and time the proposal was submitted.

• submitted_by (string) – User id of the user that submitted the proposal

• investigator_refs[] (string)

• metadata (object) – Represents metadata about other entities.

• metadata.version (integer)

• metadata.created_by (string)

• metadata.created_on (string:date-time)

• metadata.last_modified_by (string)

• metadata.last_modified_on (string:date-time)

• metadata.pdm_version (string) – The version of the PDM used to generate the entity

• cycle (string, required) – The cycle to which validation standards are applied

• info (object, required)

• info.title (string, required) – Title of the proposal

• info.proposal_type (object, required) – Represents the categories of a proposal.

• info.proposal_type.main_type (string, required) – Type of the proposal

• info.proposal_type.attributes[] (string)

• info.abstract (string) – Abstract of the proposal

• info.science_category (string) – Science category of the proposal

• info.targets[] (object) –

  Target represents the receptor pointing for an SKA observation, consisting of a reference position and a pointing pattern to be used when observing the target.

  Default pointing patterns and equatorial coordinates will be set if not provided.

• info.targets[].target_id (string)

• info.targets[].name (string)

• info.targets[].pointing_pattern (object) –

  PointingPattern holds the user-configured pointing patterns and current active pattern for receptor pointing patterns associated with a target.

  One of each pointing pattern type can be held in the parameters list. Only the active pattern will be used for observing; the remainder provide an easy way to recover previously edited observing parameters for the target.

• info.targets[].pointing_pattern.active (string:enum)

• info.targets[].pointing_pattern.parameters[] (object) – FivePointParameters defines the properties of an observing pattern that uses a five-point observing pattern centred on a reference position.

• info.targets[].pointing_pattern.parameters[].kind (string)

• info.targets[].pointing_pattern.parameters[].offset_arcsec (number)

• info.targets[].reference_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].reference_coordinate.kind (string)

• info.targets[].reference_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].radial_velocity (object) –

  Radial velocity measures the line-of-sight velocity of an astronomical source.

  In principle, the radial velocity can be converted to and from the target redshift. However, these values are persisted separately to give the user the option of inputting either value.

  A velocity must also define the reference frame and definition that are applicable to the velocity. By default, these have values of:

  • definition = RADIO

  • reference_frame = LSRK

  • redshift = 0.0

• info.targets[].radial_velocity.quantity (object)

• info.targets[].radial_velocity.quantity.value (number, required)

• info.targets[].radial_velocity.quantity.unit (string:enum)

• info.targets[].radial_velocity.definition (string:enum) –

  Enumeration of reference definitions supported by a RadialVelocity.

  The sky frequency (ν) at which we must observe a spectral line is derived from the rest frequency of the spectral line (ν₀), the line-of-sight velocity of the source (V), and the speed of light (c). The relativistic velocity, or true line-of-sight velocity, is related to the observed and rest frequencies by

  V= c * (ν₀²− ν²) / (v₀² + v²)
  

  This equation is a bit cumbersome to use; in astronomy two different approximations are typically used:

  Optical Velocity:

  Voptical = c * (λ − λ₀) / λ₀ = cz
  

  (z is the redshift of the source; λ and λ₀ are the corresponding observed and rest wavelengths, respectively)

  Radio Velocity:

  Vradio = c * (ν₀ − ν) / v₀ = c * (λ−λ₀) / λ
  

  The radio and optical velocities are not identical. Particularly, Voptical and Vradio diverge for large velocities. Optical velocities are commonly used for (Helio/Barycentric) extragalactic observations; (LSRK) radio velocities are typical for Galactic observations.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.reference_frame (string:enum) –

  Reference frame in which the radial velocity is defined.

  The Earth rotates, revolves around the Sun, rotates around the Galaxy, moves within the Local Group, and shows motion against the Cosmic Microwave Background. As for the convention above, any source velocity must therefore also always be specified relative to a reference frame.

  Various velocity rest frames are used in the literature. The following table lists their name, the motion that is corrected for, and the maximum amplitude of the velocity correction. Each rest frame correction is incremental to the preceding row:

  Velocity Rest Frame Correct for + max correction (km/s) =========================== ====================================== ====================================== Topocentric Telescope Nothing (0) Geocentric Earth Center Earth rotation (0.5) Earth-Moon Barycentric Earth+Moon center of mass Motion around Earth+Moon center of mass (0.013) Heliocentric Center of the Sun Earth orbital motion (30) Barycentric Earth+Sun center of mass Earth+Sun center of mass (0.012) Local Standard of Rest Center of Mass of local stars Solar motion relative to nearby stars (20) Galactocentric Center of Milky Way Milky Way Rotation (230) Local Group Barycentric Local Group center of mass Milky Way Motion (100) Virgocentric Center of the Local Virgo supercluster Local Group motion (300) Cosmic Microwave Background CMB Local Supercluster Motion (600)

  The velocity frame should be chosen based on the science. For most observations, however, one of the following three reference frames is commonly used:

  • Topocentric is the reference frame of the observatory (defining the sky frequency of the observations). Visibilities in a measurement set are typically stored in this frame.

  • Local Standard of Rest is the native output of images in CASA. Note that there are two varieties of LSR: the kinematic LSR (LSRK) and the dynamic (LSRD) definitions for the kinematic and dynamic centers, respectively. In almost all cases LSRK is being used and the less precise name LSR is usually used synonymously with the more modern LSRK definition.

  • Barycentric is a commonly used frame that has virtually replaced the older Heliocentric standard. Given the small difference between the Barycentric and Heliocentric frames, they are frequently used interchangeably.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.redshift (number)

• info.targets[].tied_array_beams (object) – Tied Array Beam argument lists.

• info.targets[].tied_array_beams.pst_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pst_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pst_beams[].beam_name (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pst_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.pss_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pss_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pss_beams[].beam_name (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pss_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.vlbi_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.vlbi_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.vlbi_beams[].beam_name (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.vlbi_beams[].stn_weights[] (number)

• info.documents[] (object)

• info.documents[].document_id (string, required) – Unique identifier for the Documents class generated by appending the name of the proposal to the class of uploaded document i.e science or technical.

• info.documents[].uploaded_pdf (boolean) – indicates if pdf is uploaded

• info.investigators[] (object)

• info.investigators[].user_id (string)

• info.investigators[].given_name (string)

• info.investigators[].family_name (string)

• info.investigators[].email (string:email)

• info.investigators[].organization (string)

• info.investigators[].for_phd (boolean) – Is this to count towards a qualification

• info.investigators[].status (string, required) – Status of the invitation sent to co-investigators

• info.investigators[].principal_investigator (boolean) – Is this a principle investigator for the proposal

• info.observation_sets[] (object)

• info.observation_sets[].observation_set_id (string, required) – Unique identifier for Observation Sets

• info.observation_sets[].group_id (string) – Grouping identifier

• info.observation_sets[].observing_band (string, required) – Observing Band

• info.observation_sets[].elevation (integer) – Elevation from the horizon to be used

• info.observation_sets[].array_details (object) – Array details specific to the telescope selected

• info.observation_sets[].array_details.array (string)

• info.observation_sets[].array_details.subarray (string, required) – Mid Sub Array

• info.observation_sets[].array_details.weather (integer) – Amount of accepted rainfall in mm

• info.observation_sets[].array_details.number_15_antennas (integer) – Number of 15mm antennas to use in the observation

• info.observation_sets[].array_details.number_13_antennas (integer) – Number of 13.5mm antennas to use in the observation

• info.observation_sets[].array_details.number_sub_bands (integer) – Number of Sub bands

• info.observation_sets[].array_details.tapering (string) – tapering

• info.observation_sets[].observation_type_details (object, required)

• info.observation_sets[].observation_type_details.observation_type (string, required) – Observation type

• info.observation_sets[].observation_type_details.bandwidth (object, required)

• info.observation_sets[].observation_type_details.bandwidth.value (number, required)

• info.observation_sets[].observation_type_details.bandwidth.unit (string)

• info.observation_sets[].observation_type_details.central_frequency (object, required)

• info.observation_sets[].observation_type_details.central_frequency.value (number, required)

• info.observation_sets[].observation_type_details.central_frequency.unit (string)

• info.observation_sets[].observation_type_details.supplied (object) – Integration Time or sensitivity object

• info.observation_sets[].observation_type_details.supplied.supplied_type (string:enum, required)

• info.observation_sets[].observation_type_details.supplied.quantity (object, required)

• info.observation_sets[].observation_type_details.supplied.quantity.value (number, required)

• info.observation_sets[].observation_type_details.supplied.quantity.unit (string)

• info.observation_sets[].observation_type_details.spectral_resolution (string) – Spectral Resolution

• info.observation_sets[].observation_type_details.effective_resolution (string) – Effective resolution

• info.observation_sets[].observation_type_details.image_weighting (string) – Image Weighting

• info.observation_sets[].observation_type_details.robust (string) – a Briggs image weighting parameter to balance sensitivity and resolution

• info.observation_sets[].observation_type_details.spectral_averaging (string) – Spectral Averaging

• info.data_product_sdps[] (object)

• info.data_product_sdps[].data_products_sdp_id (string, required) – Unique identifier for the Data Products SDP class

• info.data_product_sdps[].options[] (string)

• info.data_product_sdps[].observation_set_refs[] (string)

• info.data_product_sdps[].image_size (object, required)

• info.data_product_sdps[].image_size.value (number, required)

• info.data_product_sdps[].image_size.unit (string)

• info.data_product_sdps[].pixel_size (object, required)

• info.data_product_sdps[].pixel_size.value (number, required)

• info.data_product_sdps[].pixel_size.unit (string)

• info.data_product_sdps[].weighting (string, required) – Weighting

• info.data_product_src_nets[] (object)

• info.data_product_src_nets[].data_products_src_id (string, required) – Unique identifier for the Data Products SRC-Net class

• info.result_details[] (object)

• info.result_details[].observation_set_ref (string, required) – Observation set related to the results

• info.result_details[].target_ref (string, required) – Target related to the results

• info.result_details[].result (object) – results specific to the observation/target combination

• info.result_details[].result.supplied_type (string)

• info.result_details[].result.weighted_continuum_sensitivity (object) – weighted continuum sensitivity

• info.result_details[].result.weighted_continuum_sensitivity.value (number, required)

• info.result_details[].result.weighted_continuum_sensitivity.unit (string)

• info.result_details[].result.weighted_spectral_sensitivity (object) – weighted spectral sensitivity

• info.result_details[].result.weighted_spectral_sensitivity.value (number, required)

• info.result_details[].result.weighted_spectral_sensitivity.unit (string)

• info.result_details[].result.total_continuum_sensitivity (object) – Total continuum sensitivity

• info.result_details[].result.total_continuum_sensitivity.value (number, required)

• info.result_details[].result.total_continuum_sensitivity.unit (string)

• info.result_details[].result.total_spectral_sensitivity (object) – Total spectral sensitivity

• info.result_details[].result.total_spectral_sensitivity.value (number, required)

• info.result_details[].result.total_spectral_sensitivity.unit (string)

• info.result_details[].result.surface_brightness_sensitivity (object, required)

• info.result_details[].result.surface_brightness_sensitivity.continuum (number)

• info.result_details[].result.surface_brightness_sensitivity.spectral (number)

• info.result_details[].result.surface_brightness_sensitivity.unit (string)

• info.result_details[].continuum_confusion_noise (object, required)

• info.result_details[].continuum_confusion_noise.value (number, required)

• info.result_details[].continuum_confusion_noise.unit (string)

• info.result_details[].synthesized_beam_size (object, required)

• info.result_details[].synthesized_beam_size.continuum (string)

• info.result_details[].synthesized_beam_size.spectral (string)

• info.result_details[].synthesized_beam_size.unit (string)

• info.result_details[].spectral_confusion_noise (object, required)

• info.result_details[].spectral_confusion_noise.value (number, required)

• info.result_details[].spectral_confusion_noise.unit (string)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /ska-oso-services/oso/api/v5/pht/prsls/mine

Get a list of proposals the user can access

List all proposals accessible to the authenticated user.

Request Headers:

• X-Request-ID

Response JSON Array of Objects:

• prsl_id (string)

• status (string:enum)

• submitted_on (string:date-time) – The date and time the proposal was submitted.

• submitted_by (string) – User id of the user that submitted the proposal

• investigator_refs[] (string)

• metadata (object) – Represents metadata about other entities.

• metadata.version (integer)

• metadata.created_by (string)

• metadata.created_on (string:date-time)

• metadata.last_modified_by (string)

• metadata.last_modified_on (string:date-time)

• metadata.pdm_version (string) – The version of the PDM used to generate the entity

• cycle (string, required) – The cycle to which validation standards are applied

• info (object, required)

• info.title (string, required) – Title of the proposal

• info.proposal_type (object, required) – Represents the categories of a proposal.

• info.proposal_type.main_type (string, required) – Type of the proposal

• info.proposal_type.attributes[] (string)

• info.abstract (string) – Abstract of the proposal

• info.science_category (string) – Science category of the proposal

• info.targets[] (object) –

  Target represents the receptor pointing for an SKA observation, consisting of a reference position and a pointing pattern to be used when observing the target.

  Default pointing patterns and equatorial coordinates will be set if not provided.

• info.targets[].target_id (string)

• info.targets[].name (string)

• info.targets[].pointing_pattern (object) –

  PointingPattern holds the user-configured pointing patterns and current active pattern for receptor pointing patterns associated with a target.

  One of each pointing pattern type can be held in the parameters list. Only the active pattern will be used for observing; the remainder provide an easy way to recover previously edited observing parameters for the target.

• info.targets[].pointing_pattern.active (string:enum)

• info.targets[].pointing_pattern.parameters[] (object) – FivePointParameters defines the properties of an observing pattern that uses a five-point observing pattern centred on a reference position.

• info.targets[].pointing_pattern.parameters[].kind (string)

• info.targets[].pointing_pattern.parameters[].offset_arcsec (number)

• info.targets[].reference_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].reference_coordinate.kind (string)

• info.targets[].reference_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].radial_velocity (object) –

  Radial velocity measures the line-of-sight velocity of an astronomical source.

  In principle, the radial velocity can be converted to and from the target redshift. However, these values are persisted separately to give the user the option of inputting either value.

  A velocity must also define the reference frame and definition that are applicable to the velocity. By default, these have values of:

  • definition = RADIO

  • reference_frame = LSRK

  • redshift = 0.0

• info.targets[].radial_velocity.quantity (object)

• info.targets[].radial_velocity.quantity.value (number, required)

• info.targets[].radial_velocity.quantity.unit (string:enum)

• info.targets[].radial_velocity.definition (string:enum) –

  Enumeration of reference definitions supported by a RadialVelocity.

  The sky frequency (ν) at which we must observe a spectral line is derived from the rest frequency of the spectral line (ν₀), the line-of-sight velocity of the source (V), and the speed of light (c). The relativistic velocity, or true line-of-sight velocity, is related to the observed and rest frequencies by

  V= c * (ν₀²− ν²) / (v₀² + v²)
  

  This equation is a bit cumbersome to use; in astronomy two different approximations are typically used:

  Optical Velocity:

  Voptical = c * (λ − λ₀) / λ₀ = cz
  

  (z is the redshift of the source; λ and λ₀ are the corresponding observed and rest wavelengths, respectively)

  Radio Velocity:

  Vradio = c * (ν₀ − ν) / v₀ = c * (λ−λ₀) / λ
  

  The radio and optical velocities are not identical. Particularly, Voptical and Vradio diverge for large velocities. Optical velocities are commonly used for (Helio/Barycentric) extragalactic observations; (LSRK) radio velocities are typical for Galactic observations.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.reference_frame (string:enum) –

  Reference frame in which the radial velocity is defined.

  The Earth rotates, revolves around the Sun, rotates around the Galaxy, moves within the Local Group, and shows motion against the Cosmic Microwave Background. As for the convention above, any source velocity must therefore also always be specified relative to a reference frame.

  Various velocity rest frames are used in the literature. The following table lists their name, the motion that is corrected for, and the maximum amplitude of the velocity correction. Each rest frame correction is incremental to the preceding row:

  Velocity Rest Frame Correct for + max correction (km/s) =========================== ====================================== ====================================== Topocentric Telescope Nothing (0) Geocentric Earth Center Earth rotation (0.5) Earth-Moon Barycentric Earth+Moon center of mass Motion around Earth+Moon center of mass (0.013) Heliocentric Center of the Sun Earth orbital motion (30) Barycentric Earth+Sun center of mass Earth+Sun center of mass (0.012) Local Standard of Rest Center of Mass of local stars Solar motion relative to nearby stars (20) Galactocentric Center of Milky Way Milky Way Rotation (230) Local Group Barycentric Local Group center of mass Milky Way Motion (100) Virgocentric Center of the Local Virgo supercluster Local Group motion (300) Cosmic Microwave Background CMB Local Supercluster Motion (600)

  The velocity frame should be chosen based on the science. For most observations, however, one of the following three reference frames is commonly used:

  • Topocentric is the reference frame of the observatory (defining the sky frequency of the observations). Visibilities in a measurement set are typically stored in this frame.

  • Local Standard of Rest is the native output of images in CASA. Note that there are two varieties of LSR: the kinematic LSR (LSRK) and the dynamic (LSRD) definitions for the kinematic and dynamic centers, respectively. In almost all cases LSRK is being used and the less precise name LSR is usually used synonymously with the more modern LSRK definition.

  • Barycentric is a commonly used frame that has virtually replaced the older Heliocentric standard. Given the small difference between the Barycentric and Heliocentric frames, they are frequently used interchangeably.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.redshift (number)

• info.targets[].tied_array_beams (object) – Tied Array Beam argument lists.

• info.targets[].tied_array_beams.pst_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pst_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pst_beams[].beam_name (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pst_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.pss_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pss_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pss_beams[].beam_name (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pss_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.vlbi_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.vlbi_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.vlbi_beams[].beam_name (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.vlbi_beams[].stn_weights[] (number)

• info.documents[] (object)

• info.documents[].document_id (string, required) – Unique identifier for the Documents class generated by appending the name of the proposal to the class of uploaded document i.e science or technical.

• info.documents[].uploaded_pdf (boolean) – indicates if pdf is uploaded

• info.investigators[] (object)

• info.investigators[].user_id (string)

• info.investigators[].given_name (string)

• info.investigators[].family_name (string)

• info.investigators[].email (string:email)

• info.investigators[].organization (string)

• info.investigators[].for_phd (boolean) – Is this to count towards a qualification

• info.investigators[].status (string, required) – Status of the invitation sent to co-investigators

• info.investigators[].principal_investigator (boolean) – Is this a principle investigator for the proposal

• info.observation_sets[] (object)

• info.observation_sets[].observation_set_id (string, required) – Unique identifier for Observation Sets

• info.observation_sets[].group_id (string) – Grouping identifier

• info.observation_sets[].observing_band (string, required) – Observing Band

• info.observation_sets[].elevation (integer) – Elevation from the horizon to be used

• info.observation_sets[].array_details (object) – Array details specific to the telescope selected

• info.observation_sets[].array_details.array (string)

• info.observation_sets[].array_details.subarray (string, required) – Mid Sub Array

• info.observation_sets[].array_details.weather (integer) – Amount of accepted rainfall in mm

• info.observation_sets[].array_details.number_15_antennas (integer) – Number of 15mm antennas to use in the observation

• info.observation_sets[].array_details.number_13_antennas (integer) – Number of 13.5mm antennas to use in the observation

• info.observation_sets[].array_details.number_sub_bands (integer) – Number of Sub bands

• info.observation_sets[].array_details.tapering (string) – tapering

• info.observation_sets[].observation_type_details (object, required)

• info.observation_sets[].observation_type_details.observation_type (string, required) – Observation type

• info.observation_sets[].observation_type_details.bandwidth (object, required)

• info.observation_sets[].observation_type_details.bandwidth.value (number, required)

• info.observation_sets[].observation_type_details.bandwidth.unit (string)

• info.observation_sets[].observation_type_details.central_frequency (object, required)

• info.observation_sets[].observation_type_details.central_frequency.value (number, required)

• info.observation_sets[].observation_type_details.central_frequency.unit (string)

• info.observation_sets[].observation_type_details.supplied (object) – Integration Time or sensitivity object

• info.observation_sets[].observation_type_details.supplied.supplied_type (string:enum, required)

• info.observation_sets[].observation_type_details.supplied.quantity (object, required)

• info.observation_sets[].observation_type_details.supplied.quantity.value (number, required)

• info.observation_sets[].observation_type_details.supplied.quantity.unit (string)

• info.observation_sets[].observation_type_details.spectral_resolution (string) – Spectral Resolution

• info.observation_sets[].observation_type_details.effective_resolution (string) – Effective resolution

• info.observation_sets[].observation_type_details.image_weighting (string) – Image Weighting

• info.observation_sets[].observation_type_details.robust (string) – a Briggs image weighting parameter to balance sensitivity and resolution

• info.observation_sets[].observation_type_details.spectral_averaging (string) – Spectral Averaging

• info.data_product_sdps[] (object)

• info.data_product_sdps[].data_products_sdp_id (string, required) – Unique identifier for the Data Products SDP class

• info.data_product_sdps[].options[] (string)

• info.data_product_sdps[].observation_set_refs[] (string)

• info.data_product_sdps[].image_size (object, required)

• info.data_product_sdps[].image_size.value (number, required)

• info.data_product_sdps[].image_size.unit (string)

• info.data_product_sdps[].pixel_size (object, required)

• info.data_product_sdps[].pixel_size.value (number, required)

• info.data_product_sdps[].pixel_size.unit (string)

• info.data_product_sdps[].weighting (string, required) – Weighting

• info.data_product_src_nets[] (object)

• info.data_product_src_nets[].data_products_src_id (string, required) – Unique identifier for the Data Products SRC-Net class

• info.result_details[] (object)

• info.result_details[].observation_set_ref (string, required) – Observation set related to the results

• info.result_details[].target_ref (string, required) – Target related to the results

• info.result_details[].result (object) – results specific to the observation/target combination

• info.result_details[].result.supplied_type (string)

• info.result_details[].result.weighted_continuum_sensitivity (object) – weighted continuum sensitivity

• info.result_details[].result.weighted_continuum_sensitivity.value (number, required)

• info.result_details[].result.weighted_continuum_sensitivity.unit (string)

• info.result_details[].result.weighted_spectral_sensitivity (object) – weighted spectral sensitivity

• info.result_details[].result.weighted_spectral_sensitivity.value (number, required)

• info.result_details[].result.weighted_spectral_sensitivity.unit (string)

• info.result_details[].result.total_continuum_sensitivity (object) – Total continuum sensitivity

• info.result_details[].result.total_continuum_sensitivity.value (number, required)

• info.result_details[].result.total_continuum_sensitivity.unit (string)

• info.result_details[].result.total_spectral_sensitivity (object) – Total spectral sensitivity

• info.result_details[].result.total_spectral_sensitivity.value (number, required)

• info.result_details[].result.total_spectral_sensitivity.unit (string)

• info.result_details[].result.surface_brightness_sensitivity (object, required)

• info.result_details[].result.surface_brightness_sensitivity.continuum (number)

• info.result_details[].result.surface_brightness_sensitivity.spectral (number)

• info.result_details[].result.surface_brightness_sensitivity.unit (string)

• info.result_details[].continuum_confusion_noise (object, required)

• info.result_details[].continuum_confusion_noise.value (number, required)

• info.result_details[].continuum_confusion_noise.unit (string)

• info.result_details[].synthesized_beam_size (object, required)

• info.result_details[].synthesized_beam_size.continuum (string)

• info.result_details[].synthesized_beam_size.spectral (string)

• info.result_details[].synthesized_beam_size.unit (string)

• info.result_details[].spectral_confusion_noise (object, required)

• info.result_details[].spectral_confusion_noise.value (number, required)

• info.result_details[].spectral_confusion_noise.unit (string)

Status Codes:

• 200 OK – Successful Response

GET /ska-oso-services/oso/api/v5/pht/prsls/{prsl_id}

Retrieve an existing proposal

Retrieves the latest proposal by prsl_id. 1.) Check that the authenticated user has the permission to access the proposal.

Returns: Proposal: Returns the latest version of the proposal for the supplied prsl_id, including the metadata.

Request Headers:

• X-Request-ID

Parameters:

• prsl_id (string, required)

Response JSON Object:

• prsl_id (string)

• status (string:enum)

• submitted_on (string:date-time) – The date and time the proposal was submitted.

• submitted_by (string) – User id of the user that submitted the proposal

• investigator_refs[] (string)

• metadata (object) – Represents metadata about other entities.

• metadata.version (integer)

• metadata.created_by (string)

• metadata.created_on (string:date-time)

• metadata.last_modified_by (string)

• metadata.last_modified_on (string:date-time)

• metadata.pdm_version (string) – The version of the PDM used to generate the entity

• cycle (string, required) – The cycle to which validation standards are applied

• info (object, required)

• info.title (string, required) – Title of the proposal

• info.proposal_type (object, required) – Represents the categories of a proposal.

• info.proposal_type.main_type (string, required) – Type of the proposal

• info.proposal_type.attributes[] (string)

• info.abstract (string) – Abstract of the proposal

• info.science_category (string) – Science category of the proposal

• info.targets[] (object) –

  Target represents the receptor pointing for an SKA observation, consisting of a reference position and a pointing pattern to be used when observing the target.

  Default pointing patterns and equatorial coordinates will be set if not provided.

• info.targets[].target_id (string)

• info.targets[].name (string)

• info.targets[].pointing_pattern (object) –

  PointingPattern holds the user-configured pointing patterns and current active pattern for receptor pointing patterns associated with a target.

  One of each pointing pattern type can be held in the parameters list. Only the active pattern will be used for observing; the remainder provide an easy way to recover previously edited observing parameters for the target.

• info.targets[].pointing_pattern.active (string:enum)

• info.targets[].pointing_pattern.parameters[] (object) – FivePointParameters defines the properties of an observing pattern that uses a five-point observing pattern centred on a reference position.

• info.targets[].pointing_pattern.parameters[].kind (string)

• info.targets[].pointing_pattern.parameters[].offset_arcsec (number)

• info.targets[].reference_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].reference_coordinate.kind (string)

• info.targets[].reference_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].radial_velocity (object) –

  Radial velocity measures the line-of-sight velocity of an astronomical source.

  In principle, the radial velocity can be converted to and from the target redshift. However, these values are persisted separately to give the user the option of inputting either value.

  A velocity must also define the reference frame and definition that are applicable to the velocity. By default, these have values of:

  • definition = RADIO

  • reference_frame = LSRK

  • redshift = 0.0

• info.targets[].radial_velocity.quantity (object)

• info.targets[].radial_velocity.quantity.value (number, required)

• info.targets[].radial_velocity.quantity.unit (string:enum)

• info.targets[].radial_velocity.definition (string:enum) –

  Enumeration of reference definitions supported by a RadialVelocity.

  The sky frequency (ν) at which we must observe a spectral line is derived from the rest frequency of the spectral line (ν₀), the line-of-sight velocity of the source (V), and the speed of light (c). The relativistic velocity, or true line-of-sight velocity, is related to the observed and rest frequencies by

  V= c * (ν₀²− ν²) / (v₀² + v²)
  

  This equation is a bit cumbersome to use; in astronomy two different approximations are typically used:

  Optical Velocity:

  Voptical = c * (λ − λ₀) / λ₀ = cz
  

  (z is the redshift of the source; λ and λ₀ are the corresponding observed and rest wavelengths, respectively)

  Radio Velocity:

  Vradio = c * (ν₀ − ν) / v₀ = c * (λ−λ₀) / λ
  

  The radio and optical velocities are not identical. Particularly, Voptical and Vradio diverge for large velocities. Optical velocities are commonly used for (Helio/Barycentric) extragalactic observations; (LSRK) radio velocities are typical for Galactic observations.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.reference_frame (string:enum) –

  Reference frame in which the radial velocity is defined.

  The Earth rotates, revolves around the Sun, rotates around the Galaxy, moves within the Local Group, and shows motion against the Cosmic Microwave Background. As for the convention above, any source velocity must therefore also always be specified relative to a reference frame.

  Various velocity rest frames are used in the literature. The following table lists their name, the motion that is corrected for, and the maximum amplitude of the velocity correction. Each rest frame correction is incremental to the preceding row:

  Velocity Rest Frame Correct for + max correction (km/s) =========================== ====================================== ====================================== Topocentric Telescope Nothing (0) Geocentric Earth Center Earth rotation (0.5) Earth-Moon Barycentric Earth+Moon center of mass Motion around Earth+Moon center of mass (0.013) Heliocentric Center of the Sun Earth orbital motion (30) Barycentric Earth+Sun center of mass Earth+Sun center of mass (0.012) Local Standard of Rest Center of Mass of local stars Solar motion relative to nearby stars (20) Galactocentric Center of Milky Way Milky Way Rotation (230) Local Group Barycentric Local Group center of mass Milky Way Motion (100) Virgocentric Center of the Local Virgo supercluster Local Group motion (300) Cosmic Microwave Background CMB Local Supercluster Motion (600)

  The velocity frame should be chosen based on the science. For most observations, however, one of the following three reference frames is commonly used:

  • Topocentric is the reference frame of the observatory (defining the sky frequency of the observations). Visibilities in a measurement set are typically stored in this frame.

  • Local Standard of Rest is the native output of images in CASA. Note that there are two varieties of LSR: the kinematic LSR (LSRK) and the dynamic (LSRD) definitions for the kinematic and dynamic centers, respectively. In almost all cases LSRK is being used and the less precise name LSR is usually used synonymously with the more modern LSRK definition.

  • Barycentric is a commonly used frame that has virtually replaced the older Heliocentric standard. Given the small difference between the Barycentric and Heliocentric frames, they are frequently used interchangeably.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.redshift (number)

• info.targets[].tied_array_beams (object) – Tied Array Beam argument lists.

• info.targets[].tied_array_beams.pst_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pst_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pst_beams[].beam_name (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pst_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.pss_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pss_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pss_beams[].beam_name (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pss_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.vlbi_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.vlbi_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.vlbi_beams[].beam_name (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.vlbi_beams[].stn_weights[] (number)

• info.documents[] (object)

• info.documents[].document_id (string, required) – Unique identifier for the Documents class generated by appending the name of the proposal to the class of uploaded document i.e science or technical.

• info.documents[].uploaded_pdf (boolean) – indicates if pdf is uploaded

• info.investigators[] (object)

• info.investigators[].user_id (string)

• info.investigators[].given_name (string)

• info.investigators[].family_name (string)

• info.investigators[].email (string:email)

• info.investigators[].organization (string)

• info.investigators[].for_phd (boolean) – Is this to count towards a qualification

• info.investigators[].status (string, required) – Status of the invitation sent to co-investigators

• info.investigators[].principal_investigator (boolean) – Is this a principle investigator for the proposal

• info.observation_sets[] (object)

• info.observation_sets[].observation_set_id (string, required) – Unique identifier for Observation Sets

• info.observation_sets[].group_id (string) – Grouping identifier

• info.observation_sets[].observing_band (string, required) – Observing Band

• info.observation_sets[].elevation (integer) – Elevation from the horizon to be used

• info.observation_sets[].array_details (object) – Array details specific to the telescope selected

• info.observation_sets[].array_details.array (string)

• info.observation_sets[].array_details.subarray (string, required) – Mid Sub Array

• info.observation_sets[].array_details.weather (integer) – Amount of accepted rainfall in mm

• info.observation_sets[].array_details.number_15_antennas (integer) – Number of 15mm antennas to use in the observation

• info.observation_sets[].array_details.number_13_antennas (integer) – Number of 13.5mm antennas to use in the observation

• info.observation_sets[].array_details.number_sub_bands (integer) – Number of Sub bands

• info.observation_sets[].array_details.tapering (string) – tapering

• info.observation_sets[].observation_type_details (object, required)

• info.observation_sets[].observation_type_details.observation_type (string, required) – Observation type

• info.observation_sets[].observation_type_details.bandwidth (object, required)

• info.observation_sets[].observation_type_details.bandwidth.value (number, required)

• info.observation_sets[].observation_type_details.bandwidth.unit (string)

• info.observation_sets[].observation_type_details.central_frequency (object, required)

• info.observation_sets[].observation_type_details.central_frequency.value (number, required)

• info.observation_sets[].observation_type_details.central_frequency.unit (string)

• info.observation_sets[].observation_type_details.supplied (object) – Integration Time or sensitivity object

• info.observation_sets[].observation_type_details.supplied.supplied_type (string:enum, required)

• info.observation_sets[].observation_type_details.supplied.quantity (object, required)

• info.observation_sets[].observation_type_details.supplied.quantity.value (number, required)

• info.observation_sets[].observation_type_details.supplied.quantity.unit (string)

• info.observation_sets[].observation_type_details.spectral_resolution (string) – Spectral Resolution

• info.observation_sets[].observation_type_details.effective_resolution (string) – Effective resolution

• info.observation_sets[].observation_type_details.image_weighting (string) – Image Weighting

• info.observation_sets[].observation_type_details.robust (string) – a Briggs image weighting parameter to balance sensitivity and resolution

• info.observation_sets[].observation_type_details.spectral_averaging (string) – Spectral Averaging

• info.data_product_sdps[] (object)

• info.data_product_sdps[].data_products_sdp_id (string, required) – Unique identifier for the Data Products SDP class

• info.data_product_sdps[].options[] (string)

• info.data_product_sdps[].observation_set_refs[] (string)

• info.data_product_sdps[].image_size (object, required)

• info.data_product_sdps[].image_size.value (number, required)

• info.data_product_sdps[].image_size.unit (string)

• info.data_product_sdps[].pixel_size (object, required)

• info.data_product_sdps[].pixel_size.value (number, required)

• info.data_product_sdps[].pixel_size.unit (string)

• info.data_product_sdps[].weighting (string, required) – Weighting

• info.data_product_src_nets[] (object)

• info.data_product_src_nets[].data_products_src_id (string, required) – Unique identifier for the Data Products SRC-Net class

• info.result_details[] (object)

• info.result_details[].observation_set_ref (string, required) – Observation set related to the results

• info.result_details[].target_ref (string, required) – Target related to the results

• info.result_details[].result (object) – results specific to the observation/target combination

• info.result_details[].result.supplied_type (string)

• info.result_details[].result.weighted_continuum_sensitivity (object) – weighted continuum sensitivity

• info.result_details[].result.weighted_continuum_sensitivity.value (number, required)

• info.result_details[].result.weighted_continuum_sensitivity.unit (string)

• info.result_details[].result.weighted_spectral_sensitivity (object) – weighted spectral sensitivity

• info.result_details[].result.weighted_spectral_sensitivity.value (number, required)

• info.result_details[].result.weighted_spectral_sensitivity.unit (string)

• info.result_details[].result.total_continuum_sensitivity (object) – Total continuum sensitivity

• info.result_details[].result.total_continuum_sensitivity.value (number, required)

• info.result_details[].result.total_continuum_sensitivity.unit (string)

• info.result_details[].result.total_spectral_sensitivity (object) – Total spectral sensitivity

• info.result_details[].result.total_spectral_sensitivity.value (number, required)

• info.result_details[].result.total_spectral_sensitivity.unit (string)

• info.result_details[].result.surface_brightness_sensitivity (object, required)

• info.result_details[].result.surface_brightness_sensitivity.continuum (number)

• info.result_details[].result.surface_brightness_sensitivity.spectral (number)

• info.result_details[].result.surface_brightness_sensitivity.unit (string)

• info.result_details[].continuum_confusion_noise (object, required)

• info.result_details[].continuum_confusion_noise.value (number, required)

• info.result_details[].continuum_confusion_noise.unit (string)

• info.result_details[].synthesized_beam_size (object, required)

• info.result_details[].synthesized_beam_size.continuum (string)

• info.result_details[].synthesized_beam_size.spectral (string)

• info.result_details[].synthesized_beam_size.unit (string)

• info.result_details[].spectral_confusion_noise (object, required)

• info.result_details[].spectral_confusion_noise.value (number, required)

• info.result_details[].spectral_confusion_noise.unit (string)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

PUT /ska-oso-services/oso/api/v5/pht/prsls/{prsl_id}

Update an existing proposal

Updates a proposal in the underlying data store.

Request Headers:

• X-Request-ID

Parameters:

• prsl_id (string, required)

Request JSON Object:

• prsl_id (string)

• status (string:enum)

• submitted_on (string:date-time) – The date and time the proposal was submitted.

• submitted_by (string) – User id of the user that submitted the proposal

• investigator_refs[] (string)

• metadata (object) – Represents metadata about other entities.

• metadata.version (integer)

• metadata.created_by (string)

• metadata.created_on (string:date-time)

• metadata.last_modified_by (string)

• metadata.last_modified_on (string:date-time)

• metadata.pdm_version (string) – The version of the PDM used to generate the entity

• cycle (string, required) – The cycle to which validation standards are applied

• info (object, required)

• info.title (string, required) – Title of the proposal

• info.proposal_type (object, required) – Represents the categories of a proposal.

• info.proposal_type.main_type (string, required) – Type of the proposal

• info.proposal_type.attributes[] (string)

• info.abstract (string) – Abstract of the proposal

• info.science_category (string) – Science category of the proposal

• info.targets[] (object) –

  Target represents the receptor pointing for an SKA observation, consisting of a reference position and a pointing pattern to be used when observing the target.

  Default pointing patterns and equatorial coordinates will be set if not provided.

• info.targets[].target_id (string)

• info.targets[].name (string)

• info.targets[].pointing_pattern (object) –

  PointingPattern holds the user-configured pointing patterns and current active pattern for receptor pointing patterns associated with a target.

  One of each pointing pattern type can be held in the parameters list. Only the active pattern will be used for observing; the remainder provide an easy way to recover previously edited observing parameters for the target.

• info.targets[].pointing_pattern.active (string:enum)

• info.targets[].pointing_pattern.parameters[] (object) – FivePointParameters defines the properties of an observing pattern that uses a five-point observing pattern centred on a reference position.

• info.targets[].pointing_pattern.parameters[].kind (string)

• info.targets[].pointing_pattern.parameters[].offset_arcsec (number)

• info.targets[].reference_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].reference_coordinate.kind (string)

• info.targets[].reference_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].radial_velocity (object) –

  Radial velocity measures the line-of-sight velocity of an astronomical source.

  In principle, the radial velocity can be converted to and from the target redshift. However, these values are persisted separately to give the user the option of inputting either value.

  A velocity must also define the reference frame and definition that are applicable to the velocity. By default, these have values of:

  • definition = RADIO

  • reference_frame = LSRK

  • redshift = 0.0

• info.targets[].radial_velocity.quantity (object)

• info.targets[].radial_velocity.quantity.value (number, required)

• info.targets[].radial_velocity.quantity.unit (string:enum)

• info.targets[].radial_velocity.definition (string:enum) –

  Enumeration of reference definitions supported by a RadialVelocity.

  The sky frequency (ν) at which we must observe a spectral line is derived from the rest frequency of the spectral line (ν₀), the line-of-sight velocity of the source (V), and the speed of light (c). The relativistic velocity, or true line-of-sight velocity, is related to the observed and rest frequencies by

  V= c * (ν₀²− ν²) / (v₀² + v²)
  

  This equation is a bit cumbersome to use; in astronomy two different approximations are typically used:

  Optical Velocity:

  Voptical = c * (λ − λ₀) / λ₀ = cz
  

  (z is the redshift of the source; λ and λ₀ are the corresponding observed and rest wavelengths, respectively)

  Radio Velocity:

  Vradio = c * (ν₀ − ν) / v₀ = c * (λ−λ₀) / λ
  

  The radio and optical velocities are not identical. Particularly, Voptical and Vradio diverge for large velocities. Optical velocities are commonly used for (Helio/Barycentric) extragalactic observations; (LSRK) radio velocities are typical for Galactic observations.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.reference_frame (string:enum) –

  Reference frame in which the radial velocity is defined.

  The Earth rotates, revolves around the Sun, rotates around the Galaxy, moves within the Local Group, and shows motion against the Cosmic Microwave Background. As for the convention above, any source velocity must therefore also always be specified relative to a reference frame.

  Various velocity rest frames are used in the literature. The following table lists their name, the motion that is corrected for, and the maximum amplitude of the velocity correction. Each rest frame correction is incremental to the preceding row:

  Velocity Rest Frame Correct for + max correction (km/s) =========================== ====================================== ====================================== Topocentric Telescope Nothing (0) Geocentric Earth Center Earth rotation (0.5) Earth-Moon Barycentric Earth+Moon center of mass Motion around Earth+Moon center of mass (0.013) Heliocentric Center of the Sun Earth orbital motion (30) Barycentric Earth+Sun center of mass Earth+Sun center of mass (0.012) Local Standard of Rest Center of Mass of local stars Solar motion relative to nearby stars (20) Galactocentric Center of Milky Way Milky Way Rotation (230) Local Group Barycentric Local Group center of mass Milky Way Motion (100) Virgocentric Center of the Local Virgo supercluster Local Group motion (300) Cosmic Microwave Background CMB Local Supercluster Motion (600)

  The velocity frame should be chosen based on the science. For most observations, however, one of the following three reference frames is commonly used:

  • Topocentric is the reference frame of the observatory (defining the sky frequency of the observations). Visibilities in a measurement set are typically stored in this frame.

  • Local Standard of Rest is the native output of images in CASA. Note that there are two varieties of LSR: the kinematic LSR (LSRK) and the dynamic (LSRD) definitions for the kinematic and dynamic centers, respectively. In almost all cases LSRK is being used and the less precise name LSR is usually used synonymously with the more modern LSRK definition.

  • Barycentric is a commonly used frame that has virtually replaced the older Heliocentric standard. Given the small difference between the Barycentric and Heliocentric frames, they are frequently used interchangeably.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.redshift (number)

• info.targets[].tied_array_beams (object) – Tied Array Beam argument lists.

• info.targets[].tied_array_beams.pst_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pst_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pst_beams[].beam_name (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pst_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.pss_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pss_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pss_beams[].beam_name (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pss_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.vlbi_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.vlbi_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.vlbi_beams[].beam_name (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.vlbi_beams[].stn_weights[] (number)

• info.documents[] (object)

• info.documents[].document_id (string, required) – Unique identifier for the Documents class generated by appending the name of the proposal to the class of uploaded document i.e science or technical.

• info.documents[].uploaded_pdf (boolean) – indicates if pdf is uploaded

• info.investigators[] (object)

• info.investigators[].user_id (string)

• info.investigators[].given_name (string)

• info.investigators[].family_name (string)

• info.investigators[].email (string:email)

• info.investigators[].organization (string)

• info.investigators[].for_phd (boolean) – Is this to count towards a qualification

• info.investigators[].status (string, required) – Status of the invitation sent to co-investigators

• info.investigators[].principal_investigator (boolean) – Is this a principle investigator for the proposal

• info.observation_sets[] (object)

• info.observation_sets[].observation_set_id (string, required) – Unique identifier for Observation Sets

• info.observation_sets[].group_id (string) – Grouping identifier

• info.observation_sets[].observing_band (string, required) – Observing Band

• info.observation_sets[].elevation (integer) – Elevation from the horizon to be used

• info.observation_sets[].array_details (object) – Array details specific to the telescope selected

• info.observation_sets[].array_details.array (string)

• info.observation_sets[].array_details.subarray (string, required) – Mid Sub Array

• info.observation_sets[].array_details.weather (integer) – Amount of accepted rainfall in mm

• info.observation_sets[].array_details.number_15_antennas (integer) – Number of 15mm antennas to use in the observation

• info.observation_sets[].array_details.number_13_antennas (integer) – Number of 13.5mm antennas to use in the observation

• info.observation_sets[].array_details.number_sub_bands (integer) – Number of Sub bands

• info.observation_sets[].array_details.tapering (string) – tapering

• info.observation_sets[].observation_type_details (object, required)

• info.observation_sets[].observation_type_details.observation_type (string, required) – Observation type

• info.observation_sets[].observation_type_details.bandwidth (object, required)

• info.observation_sets[].observation_type_details.bandwidth.value (number, required)

• info.observation_sets[].observation_type_details.bandwidth.unit (string)

• info.observation_sets[].observation_type_details.central_frequency (object, required)

• info.observation_sets[].observation_type_details.central_frequency.value (number, required)

• info.observation_sets[].observation_type_details.central_frequency.unit (string)

• info.observation_sets[].observation_type_details.supplied (object) – Integration Time or sensitivity object

• info.observation_sets[].observation_type_details.supplied.supplied_type (string:enum, required)

• info.observation_sets[].observation_type_details.supplied.quantity (object, required)

• info.observation_sets[].observation_type_details.supplied.quantity.value (number, required)

• info.observation_sets[].observation_type_details.supplied.quantity.unit (string)

• info.observation_sets[].observation_type_details.spectral_resolution (string) – Spectral Resolution

• info.observation_sets[].observation_type_details.effective_resolution (string) – Effective resolution

• info.observation_sets[].observation_type_details.image_weighting (string) – Image Weighting

• info.observation_sets[].observation_type_details.robust (string) – a Briggs image weighting parameter to balance sensitivity and resolution

• info.observation_sets[].observation_type_details.spectral_averaging (string) – Spectral Averaging

• info.data_product_sdps[] (object)

• info.data_product_sdps[].data_products_sdp_id (string, required) – Unique identifier for the Data Products SDP class

• info.data_product_sdps[].options[] (string)

• info.data_product_sdps[].observation_set_refs[] (string)

• info.data_product_sdps[].image_size (object, required)

• info.data_product_sdps[].image_size.value (number, required)

• info.data_product_sdps[].image_size.unit (string)

• info.data_product_sdps[].pixel_size (object, required)

• info.data_product_sdps[].pixel_size.value (number, required)

• info.data_product_sdps[].pixel_size.unit (string)

• info.data_product_sdps[].weighting (string, required) – Weighting

• info.data_product_src_nets[] (object)

• info.data_product_src_nets[].data_products_src_id (string, required) – Unique identifier for the Data Products SRC-Net class

• info.result_details[] (object)

• info.result_details[].observation_set_ref (string, required) – Observation set related to the results

• info.result_details[].target_ref (string, required) – Target related to the results

• info.result_details[].result (object) – results specific to the observation/target combination

• info.result_details[].result.supplied_type (string)

• info.result_details[].result.weighted_continuum_sensitivity (object) – weighted continuum sensitivity

• info.result_details[].result.weighted_continuum_sensitivity.value (number, required)

• info.result_details[].result.weighted_continuum_sensitivity.unit (string)

• info.result_details[].result.weighted_spectral_sensitivity (object) – weighted spectral sensitivity

• info.result_details[].result.weighted_spectral_sensitivity.value (number, required)

• info.result_details[].result.weighted_spectral_sensitivity.unit (string)

• info.result_details[].result.total_continuum_sensitivity (object) – Total continuum sensitivity

• info.result_details[].result.total_continuum_sensitivity.value (number, required)

• info.result_details[].result.total_continuum_sensitivity.unit (string)

• info.result_details[].result.total_spectral_sensitivity (object) – Total spectral sensitivity

• info.result_details[].result.total_spectral_sensitivity.value (number, required)

• info.result_details[].result.total_spectral_sensitivity.unit (string)

• info.result_details[].result.surface_brightness_sensitivity (object, required)

• info.result_details[].result.surface_brightness_sensitivity.continuum (number)

• info.result_details[].result.surface_brightness_sensitivity.spectral (number)

• info.result_details[].result.surface_brightness_sensitivity.unit (string)

• info.result_details[].continuum_confusion_noise (object, required)

• info.result_details[].continuum_confusion_noise.value (number, required)

• info.result_details[].continuum_confusion_noise.unit (string)

• info.result_details[].synthesized_beam_size (object, required)

• info.result_details[].synthesized_beam_size.continuum (string)

• info.result_details[].synthesized_beam_size.spectral (string)

• info.result_details[].synthesized_beam_size.unit (string)

• info.result_details[].spectral_confusion_noise (object, required)

• info.result_details[].spectral_confusion_noise.value (number, required)

• info.result_details[].spectral_confusion_noise.unit (string)

Response JSON Object:

• prsl_id (string)

• status (string:enum)

• submitted_on (string:date-time) – The date and time the proposal was submitted.

• submitted_by (string) – User id of the user that submitted the proposal

• investigator_refs[] (string)

• metadata (object) – Represents metadata about other entities.

• metadata.version (integer)

• metadata.created_by (string)

• metadata.created_on (string:date-time)

• metadata.last_modified_by (string)

• metadata.last_modified_on (string:date-time)

• metadata.pdm_version (string) – The version of the PDM used to generate the entity

• cycle (string, required) – The cycle to which validation standards are applied

• info (object, required)

• info.title (string, required) – Title of the proposal

• info.proposal_type (object, required) – Represents the categories of a proposal.

• info.proposal_type.main_type (string, required) – Type of the proposal

• info.proposal_type.attributes[] (string)

• info.abstract (string) – Abstract of the proposal

• info.science_category (string) – Science category of the proposal

• info.targets[] (object) –

  Target represents the receptor pointing for an SKA observation, consisting of a reference position and a pointing pattern to be used when observing the target.

  Default pointing patterns and equatorial coordinates will be set if not provided.

• info.targets[].target_id (string)

• info.targets[].name (string)

• info.targets[].pointing_pattern (object) –

  PointingPattern holds the user-configured pointing patterns and current active pattern for receptor pointing patterns associated with a target.

  One of each pointing pattern type can be held in the parameters list. Only the active pattern will be used for observing; the remainder provide an easy way to recover previously edited observing parameters for the target.

• info.targets[].pointing_pattern.active (string:enum)

• info.targets[].pointing_pattern.parameters[] (object) – FivePointParameters defines the properties of an observing pattern that uses a five-point observing pattern centred on a reference position.

• info.targets[].pointing_pattern.parameters[].kind (string)

• info.targets[].pointing_pattern.parameters[].offset_arcsec (number)

• info.targets[].reference_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].reference_coordinate.kind (string)

• info.targets[].reference_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].radial_velocity (object) –

  Radial velocity measures the line-of-sight velocity of an astronomical source.

  In principle, the radial velocity can be converted to and from the target redshift. However, these values are persisted separately to give the user the option of inputting either value.

  A velocity must also define the reference frame and definition that are applicable to the velocity. By default, these have values of:

  • definition = RADIO

  • reference_frame = LSRK

  • redshift = 0.0

• info.targets[].radial_velocity.quantity (object)

• info.targets[].radial_velocity.quantity.value (number, required)

• info.targets[].radial_velocity.quantity.unit (string:enum)

• info.targets[].radial_velocity.definition (string:enum) –

  Enumeration of reference definitions supported by a RadialVelocity.

  The sky frequency (ν) at which we must observe a spectral line is derived from the rest frequency of the spectral line (ν₀), the line-of-sight velocity of the source (V), and the speed of light (c). The relativistic velocity, or true line-of-sight velocity, is related to the observed and rest frequencies by

  V= c * (ν₀²− ν²) / (v₀² + v²)
  

  This equation is a bit cumbersome to use; in astronomy two different approximations are typically used:

  Optical Velocity:

  Voptical = c * (λ − λ₀) / λ₀ = cz
  

  (z is the redshift of the source; λ and λ₀ are the corresponding observed and rest wavelengths, respectively)

  Radio Velocity:

  Vradio = c * (ν₀ − ν) / v₀ = c * (λ−λ₀) / λ
  

  The radio and optical velocities are not identical. Particularly, Voptical and Vradio diverge for large velocities. Optical velocities are commonly used for (Helio/Barycentric) extragalactic observations; (LSRK) radio velocities are typical for Galactic observations.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.reference_frame (string:enum) –

  Reference frame in which the radial velocity is defined.

  The Earth rotates, revolves around the Sun, rotates around the Galaxy, moves within the Local Group, and shows motion against the Cosmic Microwave Background. As for the convention above, any source velocity must therefore also always be specified relative to a reference frame.

  Various velocity rest frames are used in the literature. The following table lists their name, the motion that is corrected for, and the maximum amplitude of the velocity correction. Each rest frame correction is incremental to the preceding row:

  Velocity Rest Frame Correct for + max correction (km/s) =========================== ====================================== ====================================== Topocentric Telescope Nothing (0) Geocentric Earth Center Earth rotation (0.5) Earth-Moon Barycentric Earth+Moon center of mass Motion around Earth+Moon center of mass (0.013) Heliocentric Center of the Sun Earth orbital motion (30) Barycentric Earth+Sun center of mass Earth+Sun center of mass (0.012) Local Standard of Rest Center of Mass of local stars Solar motion relative to nearby stars (20) Galactocentric Center of Milky Way Milky Way Rotation (230) Local Group Barycentric Local Group center of mass Milky Way Motion (100) Virgocentric Center of the Local Virgo supercluster Local Group motion (300) Cosmic Microwave Background CMB Local Supercluster Motion (600)

  The velocity frame should be chosen based on the science. For most observations, however, one of the following three reference frames is commonly used:

  • Topocentric is the reference frame of the observatory (defining the sky frequency of the observations). Visibilities in a measurement set are typically stored in this frame.

  • Local Standard of Rest is the native output of images in CASA. Note that there are two varieties of LSR: the kinematic LSR (LSRK) and the dynamic (LSRD) definitions for the kinematic and dynamic centers, respectively. In almost all cases LSRK is being used and the less precise name LSR is usually used synonymously with the more modern LSRK definition.

  • Barycentric is a commonly used frame that has virtually replaced the older Heliocentric standard. Given the small difference between the Barycentric and Heliocentric frames, they are frequently used interchangeably.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.redshift (number)

• info.targets[].tied_array_beams (object) – Tied Array Beam argument lists.

• info.targets[].tied_array_beams.pst_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pst_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pst_beams[].beam_name (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pst_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.pss_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pss_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pss_beams[].beam_name (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pss_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.vlbi_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.vlbi_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.vlbi_beams[].beam_name (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.vlbi_beams[].stn_weights[] (number)

• info.documents[] (object)

• info.documents[].document_id (string, required) – Unique identifier for the Documents class generated by appending the name of the proposal to the class of uploaded document i.e science or technical.

• info.documents[].uploaded_pdf (boolean) – indicates if pdf is uploaded

• info.investigators[] (object)

• info.investigators[].user_id (string)

• info.investigators[].given_name (string)

• info.investigators[].family_name (string)

• info.investigators[].email (string:email)

• info.investigators[].organization (string)

• info.investigators[].for_phd (boolean) – Is this to count towards a qualification

• info.investigators[].status (string, required) – Status of the invitation sent to co-investigators

• info.investigators[].principal_investigator (boolean) – Is this a principle investigator for the proposal

• info.observation_sets[] (object)

• info.observation_sets[].observation_set_id (string, required) – Unique identifier for Observation Sets

• info.observation_sets[].group_id (string) – Grouping identifier

• info.observation_sets[].observing_band (string, required) – Observing Band

• info.observation_sets[].elevation (integer) – Elevation from the horizon to be used

• info.observation_sets[].array_details (object) – Array details specific to the telescope selected

• info.observation_sets[].array_details.array (string)

• info.observation_sets[].array_details.subarray (string, required) – Mid Sub Array

• info.observation_sets[].array_details.weather (integer) – Amount of accepted rainfall in mm

• info.observation_sets[].array_details.number_15_antennas (integer) – Number of 15mm antennas to use in the observation

• info.observation_sets[].array_details.number_13_antennas (integer) – Number of 13.5mm antennas to use in the observation

• info.observation_sets[].array_details.number_sub_bands (integer) – Number of Sub bands

• info.observation_sets[].array_details.tapering (string) – tapering

• info.observation_sets[].observation_type_details (object, required)

• info.observation_sets[].observation_type_details.observation_type (string, required) – Observation type

• info.observation_sets[].observation_type_details.bandwidth (object, required)

• info.observation_sets[].observation_type_details.bandwidth.value (number, required)

• info.observation_sets[].observation_type_details.bandwidth.unit (string)

• info.observation_sets[].observation_type_details.central_frequency (object, required)

• info.observation_sets[].observation_type_details.central_frequency.value (number, required)

• info.observation_sets[].observation_type_details.central_frequency.unit (string)

• info.observation_sets[].observation_type_details.supplied (object) – Integration Time or sensitivity object

• info.observation_sets[].observation_type_details.supplied.supplied_type (string:enum, required)

• info.observation_sets[].observation_type_details.supplied.quantity (object, required)

• info.observation_sets[].observation_type_details.supplied.quantity.value (number, required)

• info.observation_sets[].observation_type_details.supplied.quantity.unit (string)

• info.observation_sets[].observation_type_details.spectral_resolution (string) – Spectral Resolution

• info.observation_sets[].observation_type_details.effective_resolution (string) – Effective resolution

• info.observation_sets[].observation_type_details.image_weighting (string) – Image Weighting

• info.observation_sets[].observation_type_details.robust (string) – a Briggs image weighting parameter to balance sensitivity and resolution

• info.observation_sets[].observation_type_details.spectral_averaging (string) – Spectral Averaging

• info.data_product_sdps[] (object)

• info.data_product_sdps[].data_products_sdp_id (string, required) – Unique identifier for the Data Products SDP class

• info.data_product_sdps[].options[] (string)

• info.data_product_sdps[].observation_set_refs[] (string)

• info.data_product_sdps[].image_size (object, required)

• info.data_product_sdps[].image_size.value (number, required)

• info.data_product_sdps[].image_size.unit (string)

• info.data_product_sdps[].pixel_size (object, required)

• info.data_product_sdps[].pixel_size.value (number, required)

• info.data_product_sdps[].pixel_size.unit (string)

• info.data_product_sdps[].weighting (string, required) – Weighting

• info.data_product_src_nets[] (object)

• info.data_product_src_nets[].data_products_src_id (string, required) – Unique identifier for the Data Products SRC-Net class

• info.result_details[] (object)

• info.result_details[].observation_set_ref (string, required) – Observation set related to the results

• info.result_details[].target_ref (string, required) – Target related to the results

• info.result_details[].result (object) – results specific to the observation/target combination

• info.result_details[].result.supplied_type (string)

• info.result_details[].result.weighted_continuum_sensitivity (object) – weighted continuum sensitivity

• info.result_details[].result.weighted_continuum_sensitivity.value (number, required)

• info.result_details[].result.weighted_continuum_sensitivity.unit (string)

• info.result_details[].result.weighted_spectral_sensitivity (object) – weighted spectral sensitivity

• info.result_details[].result.weighted_spectral_sensitivity.value (number, required)

• info.result_details[].result.weighted_spectral_sensitivity.unit (string)

• info.result_details[].result.total_continuum_sensitivity (object) – Total continuum sensitivity

• info.result_details[].result.total_continuum_sensitivity.value (number, required)

• info.result_details[].result.total_continuum_sensitivity.unit (string)

• info.result_details[].result.total_spectral_sensitivity (object) – Total spectral sensitivity

• info.result_details[].result.total_spectral_sensitivity.value (number, required)

• info.result_details[].result.total_spectral_sensitivity.unit (string)

• info.result_details[].result.surface_brightness_sensitivity (object, required)

• info.result_details[].result.surface_brightness_sensitivity.continuum (number)

• info.result_details[].result.surface_brightness_sensitivity.spectral (number)

• info.result_details[].result.surface_brightness_sensitivity.unit (string)

• info.result_details[].continuum_confusion_noise (object, required)

• info.result_details[].continuum_confusion_noise.value (number, required)

• info.result_details[].continuum_confusion_noise.unit (string)

• info.result_details[].synthesized_beam_size (object, required)

• info.result_details[].synthesized_beam_size.continuum (string)

• info.result_details[].synthesized_beam_size.spectral (string)

• info.result_details[].synthesized_beam_size.unit (string)

• info.result_details[].spectral_confusion_noise (object, required)

• info.result_details[].spectral_confusion_noise.value (number, required)

• info.result_details[].spectral_confusion_noise.unit (string)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

POST /ska-oso-services/oso/api/v5/pht/prsls/batch

Retrieve multiple proposals in batch

Batch retrieves proposals by accepting a list of proposal ids and returning the proposals for those ids.

Request Headers:

• X-Request-ID

Request JSON Object:

• prsl_ids[] (string)

Response JSON Array of Objects:

• prsl_id (string)

• status (string:enum)

• submitted_on (string:date-time) – The date and time the proposal was submitted.

• submitted_by (string) – User id of the user that submitted the proposal

• investigator_refs[] (string)

• metadata (object) – Represents metadata about other entities.

• metadata.version (integer)

• metadata.created_by (string)

• metadata.created_on (string:date-time)

• metadata.last_modified_by (string)

• metadata.last_modified_on (string:date-time)

• metadata.pdm_version (string) – The version of the PDM used to generate the entity

• cycle (string, required) – The cycle to which validation standards are applied

• info (object, required)

• info.title (string, required) – Title of the proposal

• info.proposal_type (object, required) – Represents the categories of a proposal.

• info.proposal_type.main_type (string, required) – Type of the proposal

• info.proposal_type.attributes[] (string)

• info.abstract (string) – Abstract of the proposal

• info.science_category (string) – Science category of the proposal

• info.targets[] (object) –

  Target represents the receptor pointing for an SKA observation, consisting of a reference position and a pointing pattern to be used when observing the target.

  Default pointing patterns and equatorial coordinates will be set if not provided.

• info.targets[].target_id (string)

• info.targets[].name (string)

• info.targets[].pointing_pattern (object) –

  PointingPattern holds the user-configured pointing patterns and current active pattern for receptor pointing patterns associated with a target.

  One of each pointing pattern type can be held in the parameters list. Only the active pattern will be used for observing; the remainder provide an easy way to recover previously edited observing parameters for the target.

• info.targets[].pointing_pattern.active (string:enum)

• info.targets[].pointing_pattern.parameters[] (object) – FivePointParameters defines the properties of an observing pattern that uses a five-point observing pattern centred on a reference position.

• info.targets[].pointing_pattern.parameters[].kind (string)

• info.targets[].pointing_pattern.parameters[].offset_arcsec (number)

• info.targets[].reference_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].reference_coordinate.kind (string)

• info.targets[].reference_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].radial_velocity (object) –

  Radial velocity measures the line-of-sight velocity of an astronomical source.

  In principle, the radial velocity can be converted to and from the target redshift. However, these values are persisted separately to give the user the option of inputting either value.

  A velocity must also define the reference frame and definition that are applicable to the velocity. By default, these have values of:

  • definition = RADIO

  • reference_frame = LSRK

  • redshift = 0.0

• info.targets[].radial_velocity.quantity (object)

• info.targets[].radial_velocity.quantity.value (number, required)

• info.targets[].radial_velocity.quantity.unit (string:enum)

• info.targets[].radial_velocity.definition (string:enum) –

  Enumeration of reference definitions supported by a RadialVelocity.

  The sky frequency (ν) at which we must observe a spectral line is derived from the rest frequency of the spectral line (ν₀), the line-of-sight velocity of the source (V), and the speed of light (c). The relativistic velocity, or true line-of-sight velocity, is related to the observed and rest frequencies by

  V= c * (ν₀²− ν²) / (v₀² + v²)
  

  This equation is a bit cumbersome to use; in astronomy two different approximations are typically used:

  Optical Velocity:

  Voptical = c * (λ − λ₀) / λ₀ = cz
  

  (z is the redshift of the source; λ and λ₀ are the corresponding observed and rest wavelengths, respectively)

  Radio Velocity:

  Vradio = c * (ν₀ − ν) / v₀ = c * (λ−λ₀) / λ
  

  The radio and optical velocities are not identical. Particularly, Voptical and Vradio diverge for large velocities. Optical velocities are commonly used for (Helio/Barycentric) extragalactic observations; (LSRK) radio velocities are typical for Galactic observations.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.reference_frame (string:enum) –

  Reference frame in which the radial velocity is defined.

  The Earth rotates, revolves around the Sun, rotates around the Galaxy, moves within the Local Group, and shows motion against the Cosmic Microwave Background. As for the convention above, any source velocity must therefore also always be specified relative to a reference frame.

  Various velocity rest frames are used in the literature. The following table lists their name, the motion that is corrected for, and the maximum amplitude of the velocity correction. Each rest frame correction is incremental to the preceding row:

  Velocity Rest Frame Correct for + max correction (km/s) =========================== ====================================== ====================================== Topocentric Telescope Nothing (0) Geocentric Earth Center Earth rotation (0.5) Earth-Moon Barycentric Earth+Moon center of mass Motion around Earth+Moon center of mass (0.013) Heliocentric Center of the Sun Earth orbital motion (30) Barycentric Earth+Sun center of mass Earth+Sun center of mass (0.012) Local Standard of Rest Center of Mass of local stars Solar motion relative to nearby stars (20) Galactocentric Center of Milky Way Milky Way Rotation (230) Local Group Barycentric Local Group center of mass Milky Way Motion (100) Virgocentric Center of the Local Virgo supercluster Local Group motion (300) Cosmic Microwave Background CMB Local Supercluster Motion (600)

  The velocity frame should be chosen based on the science. For most observations, however, one of the following three reference frames is commonly used:

  • Topocentric is the reference frame of the observatory (defining the sky frequency of the observations). Visibilities in a measurement set are typically stored in this frame.

  • Local Standard of Rest is the native output of images in CASA. Note that there are two varieties of LSR: the kinematic LSR (LSRK) and the dynamic (LSRD) definitions for the kinematic and dynamic centers, respectively. In almost all cases LSRK is being used and the less precise name LSR is usually used synonymously with the more modern LSRK definition.

  • Barycentric is a commonly used frame that has virtually replaced the older Heliocentric standard. Given the small difference between the Barycentric and Heliocentric frames, they are frequently used interchangeably.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.redshift (number)

• info.targets[].tied_array_beams (object) – Tied Array Beam argument lists.

• info.targets[].tied_array_beams.pst_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pst_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pst_beams[].beam_name (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pst_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.pss_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pss_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pss_beams[].beam_name (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pss_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.vlbi_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.vlbi_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.vlbi_beams[].beam_name (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.vlbi_beams[].stn_weights[] (number)

• info.documents[] (object)

• info.documents[].document_id (string, required) – Unique identifier for the Documents class generated by appending the name of the proposal to the class of uploaded document i.e science or technical.

• info.documents[].uploaded_pdf (boolean) – indicates if pdf is uploaded

• info.investigators[] (object)

• info.investigators[].user_id (string)

• info.investigators[].given_name (string)

• info.investigators[].family_name (string)

• info.investigators[].email (string:email)

• info.investigators[].organization (string)

• info.investigators[].for_phd (boolean) – Is this to count towards a qualification

• info.investigators[].status (string, required) – Status of the invitation sent to co-investigators

• info.investigators[].principal_investigator (boolean) – Is this a principle investigator for the proposal

• info.observation_sets[] (object)

• info.observation_sets[].observation_set_id (string, required) – Unique identifier for Observation Sets

• info.observation_sets[].group_id (string) – Grouping identifier

• info.observation_sets[].observing_band (string, required) – Observing Band

• info.observation_sets[].elevation (integer) – Elevation from the horizon to be used

• info.observation_sets[].array_details (object) – Array details specific to the telescope selected

• info.observation_sets[].array_details.array (string)

• info.observation_sets[].array_details.subarray (string, required) – Mid Sub Array

• info.observation_sets[].array_details.weather (integer) – Amount of accepted rainfall in mm

• info.observation_sets[].array_details.number_15_antennas (integer) – Number of 15mm antennas to use in the observation

• info.observation_sets[].array_details.number_13_antennas (integer) – Number of 13.5mm antennas to use in the observation

• info.observation_sets[].array_details.number_sub_bands (integer) – Number of Sub bands

• info.observation_sets[].array_details.tapering (string) – tapering

• info.observation_sets[].observation_type_details (object, required)

• info.observation_sets[].observation_type_details.observation_type (string, required) – Observation type

• info.observation_sets[].observation_type_details.bandwidth (object, required)

• info.observation_sets[].observation_type_details.bandwidth.value (number, required)

• info.observation_sets[].observation_type_details.bandwidth.unit (string)

• info.observation_sets[].observation_type_details.central_frequency (object, required)

• info.observation_sets[].observation_type_details.central_frequency.value (number, required)

• info.observation_sets[].observation_type_details.central_frequency.unit (string)

• info.observation_sets[].observation_type_details.supplied (object) – Integration Time or sensitivity object

• info.observation_sets[].observation_type_details.supplied.supplied_type (string:enum, required)

• info.observation_sets[].observation_type_details.supplied.quantity (object, required)

• info.observation_sets[].observation_type_details.supplied.quantity.value (number, required)

• info.observation_sets[].observation_type_details.supplied.quantity.unit (string)

• info.observation_sets[].observation_type_details.spectral_resolution (string) – Spectral Resolution

• info.observation_sets[].observation_type_details.effective_resolution (string) – Effective resolution

• info.observation_sets[].observation_type_details.image_weighting (string) – Image Weighting

• info.observation_sets[].observation_type_details.robust (string) – a Briggs image weighting parameter to balance sensitivity and resolution

• info.observation_sets[].observation_type_details.spectral_averaging (string) – Spectral Averaging

• info.data_product_sdps[] (object)

• info.data_product_sdps[].data_products_sdp_id (string, required) – Unique identifier for the Data Products SDP class

• info.data_product_sdps[].options[] (string)

• info.data_product_sdps[].observation_set_refs[] (string)

• info.data_product_sdps[].image_size (object, required)

• info.data_product_sdps[].image_size.value (number, required)

• info.data_product_sdps[].image_size.unit (string)

• info.data_product_sdps[].pixel_size (object, required)

• info.data_product_sdps[].pixel_size.value (number, required)

• info.data_product_sdps[].pixel_size.unit (string)

• info.data_product_sdps[].weighting (string, required) – Weighting

• info.data_product_src_nets[] (object)

• info.data_product_src_nets[].data_products_src_id (string, required) – Unique identifier for the Data Products SRC-Net class

• info.result_details[] (object)

• info.result_details[].observation_set_ref (string, required) – Observation set related to the results

• info.result_details[].target_ref (string, required) – Target related to the results

• info.result_details[].result (object) – results specific to the observation/target combination

• info.result_details[].result.supplied_type (string)

• info.result_details[].result.weighted_continuum_sensitivity (object) – weighted continuum sensitivity

• info.result_details[].result.weighted_continuum_sensitivity.value (number, required)

• info.result_details[].result.weighted_continuum_sensitivity.unit (string)

• info.result_details[].result.weighted_spectral_sensitivity (object) – weighted spectral sensitivity

• info.result_details[].result.weighted_spectral_sensitivity.value (number, required)

• info.result_details[].result.weighted_spectral_sensitivity.unit (string)

• info.result_details[].result.total_continuum_sensitivity (object) – Total continuum sensitivity

• info.result_details[].result.total_continuum_sensitivity.value (number, required)

• info.result_details[].result.total_continuum_sensitivity.unit (string)

• info.result_details[].result.total_spectral_sensitivity (object) – Total spectral sensitivity

• info.result_details[].result.total_spectral_sensitivity.value (number, required)

• info.result_details[].result.total_spectral_sensitivity.unit (string)

• info.result_details[].result.surface_brightness_sensitivity (object, required)

• info.result_details[].result.surface_brightness_sensitivity.continuum (number)

• info.result_details[].result.surface_brightness_sensitivity.spectral (number)

• info.result_details[].result.surface_brightness_sensitivity.unit (string)

• info.result_details[].continuum_confusion_noise (object, required)

• info.result_details[].continuum_confusion_noise.value (number, required)

• info.result_details[].continuum_confusion_noise.unit (string)

• info.result_details[].synthesized_beam_size (object, required)

• info.result_details[].synthesized_beam_size.continuum (string)

• info.result_details[].synthesized_beam_size.spectral (string)

• info.result_details[].synthesized_beam_size.unit (string)

• info.result_details[].spectral_confusion_noise (object, required)

• info.result_details[].spectral_confusion_noise.value (number, required)

• info.result_details[].spectral_confusion_noise.unit (string)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /ska-oso-services/oso/api/v5/pht/prsls/reviews/{prsl_id}

Get all reviews for a particular proposal

Function that requests to GET /reviews/{prsl_id} are mapped to.

Get reviews for a given proposal ID from the underlying data store, if available.

Returns: list[PanelReview]

Request Headers:

• X-Request-ID

Parameters:

• prsl_id (string, required)

Response JSON Array of Objects:

• metadata (object) – Represents metadata about other entities.

• metadata.version (integer)

• metadata.created_by (string)

• metadata.created_on (string:date-time)

• metadata.last_modified_by (string)

• metadata.last_modified_on (string:date-time)

• metadata.pdm_version (string) – The version of the PDM used to generate the entity

• panel_id (string)

• review_id (string, required)

• cycle (string)

• reviewer_id (string, required)

• prsl_id (string, required)

• comments (string)

• src_net (string)

• submitted_on (string:date-time)

• submitted_by (string)

• status (string:enum)

• review_type (object)

• review_type.kind (string)

• review_type.rank (integer)

• review_type.conflict (object, required)

• review_type.conflict.has_conflict (boolean)

• review_type.conflict.reason (string)

• review_type.excluded_from_decision (boolean)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

POST /ska-oso-services/oso/api/v5/pht/prsls/validate

Validate a proposal

Validates a submitted proposal via POST.

Returns: dict: { “result”: bool, “validation_errors”: list[str]}.

Request Headers:

• X-Request-ID

Request JSON Object:

• prsl_id (string)

• status (string:enum)

• submitted_on (string:date-time) – The date and time the proposal was submitted.

• submitted_by (string) – User id of the user that submitted the proposal

• investigator_refs[] (string)

• metadata (object) – Represents metadata about other entities.

• metadata.version (integer)

• metadata.created_by (string)

• metadata.created_on (string:date-time)

• metadata.last_modified_by (string)

• metadata.last_modified_on (string:date-time)

• metadata.pdm_version (string) – The version of the PDM used to generate the entity

• cycle (string, required) – The cycle to which validation standards are applied

• info (object, required)

• info.title (string, required) – Title of the proposal

• info.proposal_type (object, required) – Represents the categories of a proposal.

• info.proposal_type.main_type (string, required) – Type of the proposal

• info.proposal_type.attributes[] (string)

• info.abstract (string) – Abstract of the proposal

• info.science_category (string) – Science category of the proposal

• info.targets[] (object) –

  Target represents the receptor pointing for an SKA observation, consisting of a reference position and a pointing pattern to be used when observing the target.

  Default pointing patterns and equatorial coordinates will be set if not provided.

• info.targets[].target_id (string)

• info.targets[].name (string)

• info.targets[].pointing_pattern (object) –

  PointingPattern holds the user-configured pointing patterns and current active pattern for receptor pointing patterns associated with a target.

  One of each pointing pattern type can be held in the parameters list. Only the active pattern will be used for observing; the remainder provide an easy way to recover previously edited observing parameters for the target.

• info.targets[].pointing_pattern.active (string:enum)

• info.targets[].pointing_pattern.parameters[] (object) – FivePointParameters defines the properties of an observing pattern that uses a five-point observing pattern centred on a reference position.

• info.targets[].pointing_pattern.parameters[].kind (string)

• info.targets[].pointing_pattern.parameters[].offset_arcsec (number)

• info.targets[].reference_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].reference_coordinate.kind (string)

• info.targets[].reference_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].radial_velocity (object) –

  Radial velocity measures the line-of-sight velocity of an astronomical source.

  In principle, the radial velocity can be converted to and from the target redshift. However, these values are persisted separately to give the user the option of inputting either value.

  A velocity must also define the reference frame and definition that are applicable to the velocity. By default, these have values of:

  • definition = RADIO

  • reference_frame = LSRK

  • redshift = 0.0

• info.targets[].radial_velocity.quantity (object)

• info.targets[].radial_velocity.quantity.value (number, required)

• info.targets[].radial_velocity.quantity.unit (string:enum)

• info.targets[].radial_velocity.definition (string:enum) –

  Enumeration of reference definitions supported by a RadialVelocity.

  The sky frequency (ν) at which we must observe a spectral line is derived from the rest frequency of the spectral line (ν₀), the line-of-sight velocity of the source (V), and the speed of light (c). The relativistic velocity, or true line-of-sight velocity, is related to the observed and rest frequencies by

  V= c * (ν₀²− ν²) / (v₀² + v²)
  

  This equation is a bit cumbersome to use; in astronomy two different approximations are typically used:

  Optical Velocity:

  Voptical = c * (λ − λ₀) / λ₀ = cz
  

  (z is the redshift of the source; λ and λ₀ are the corresponding observed and rest wavelengths, respectively)

  Radio Velocity:

  Vradio = c * (ν₀ − ν) / v₀ = c * (λ−λ₀) / λ
  

  The radio and optical velocities are not identical. Particularly, Voptical and Vradio diverge for large velocities. Optical velocities are commonly used for (Helio/Barycentric) extragalactic observations; (LSRK) radio velocities are typical for Galactic observations.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.reference_frame (string:enum) –

  Reference frame in which the radial velocity is defined.

  The Earth rotates, revolves around the Sun, rotates around the Galaxy, moves within the Local Group, and shows motion against the Cosmic Microwave Background. As for the convention above, any source velocity must therefore also always be specified relative to a reference frame.

  Various velocity rest frames are used in the literature. The following table lists their name, the motion that is corrected for, and the maximum amplitude of the velocity correction. Each rest frame correction is incremental to the preceding row:

  Velocity Rest Frame Correct for + max correction (km/s) =========================== ====================================== ====================================== Topocentric Telescope Nothing (0) Geocentric Earth Center Earth rotation (0.5) Earth-Moon Barycentric Earth+Moon center of mass Motion around Earth+Moon center of mass (0.013) Heliocentric Center of the Sun Earth orbital motion (30) Barycentric Earth+Sun center of mass Earth+Sun center of mass (0.012) Local Standard of Rest Center of Mass of local stars Solar motion relative to nearby stars (20) Galactocentric Center of Milky Way Milky Way Rotation (230) Local Group Barycentric Local Group center of mass Milky Way Motion (100) Virgocentric Center of the Local Virgo supercluster Local Group motion (300) Cosmic Microwave Background CMB Local Supercluster Motion (600)

  The velocity frame should be chosen based on the science. For most observations, however, one of the following three reference frames is commonly used:

  • Topocentric is the reference frame of the observatory (defining the sky frequency of the observations). Visibilities in a measurement set are typically stored in this frame.

  • Local Standard of Rest is the native output of images in CASA. Note that there are two varieties of LSR: the kinematic LSR (LSRK) and the dynamic (LSRD) definitions for the kinematic and dynamic centers, respectively. In almost all cases LSRK is being used and the less precise name LSR is usually used synonymously with the more modern LSRK definition.

  • Barycentric is a commonly used frame that has virtually replaced the older Heliocentric standard. Given the small difference between the Barycentric and Heliocentric frames, they are frequently used interchangeably.

  Taken from https://science.nrao.edu/facilities/vla/docs/manuals/obsguide/modes/line

• info.targets[].radial_velocity.redshift (number)

• info.targets[].tied_array_beams (object) – Tied Array Beam argument lists.

• info.targets[].tied_array_beams.pst_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pst_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pst_beams[].beam_name (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pst_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pst_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.pss_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.pss_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.pss_beams[].beam_name (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.pss_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.pss_beams[].stn_weights[] (number)

• info.targets[].tied_array_beams.vlbi_beams[] (object) –

  Tied Array Beam arguments.

  Args: beam_id (int): integer identifying this tied-array beam. It should be unique within each tied-array-beam class beam_name (str): string beam_coordinate (EquatorialCoordinatesPST): position on sky at which beam will be formed. It should lie within the HPBW of the station beam stn_weights (List(float)): array of weights, one for each station.

• info.targets[].tied_array_beams.vlbi_beams[].beam_id (integer, required)

• info.targets[].tied_array_beams.vlbi_beams[].beam_name (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate (object) – Planet represents the argument for SKA scheduling block.

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.kind (string)

• info.targets[].tied_array_beams.vlbi_beams[].beam_coordinate.name (string:enum, required) – SolarSystemObjectName represents name of the solar system object.

• info.targets[].tied_array_beams.vlbi_beams[].stn_weights[] (number)

• info.documents[] (object)

• info.documents[].document_id (string, required) – Unique identifier for the Documents class generated by appending the name of the proposal to the class of uploaded document i.e science or technical.

• info.documents[].uploaded_pdf (boolean) – indicates if pdf is uploaded

• info.investigators[] (object)

• info.investigators[].user_id (string)

• info.investigators[].given_name (string)

• info.investigators[].family_name (string)

• info.investigators[].email (string:email)

• info.investigators[].organization (string)

• info.investigators[].for_phd (boolean) – Is this to count towards a qualification

• info.investigators[].status (string, required) – Status of the invitation sent to co-investigators

• info.investigators[].principal_investigator (boolean) – Is this a principle investigator for the proposal

• info.observation_sets[] (object)

• info.observation_sets[].observation_set_id (string, required) – Unique identifier for Observation Sets

• info.observation_sets[].group_id (string) – Grouping identifier

• info.observation_sets[].observing_band (string, required) – Observing Band

• info.observation_sets[].elevation (integer) – Elevation from the horizon to be used

• info.observation_sets[].array_details (object) – Array details specific to the telescope selected

• info.observation_sets[].array_details.array (string)

• info.observation_sets[].array_details.subarray (string, required) – Mid Sub Array

• info.observation_sets[].array_details.weather (integer) – Amount of accepted rainfall in mm

• info.observation_sets[].array_details.number_15_antennas (integer) – Number of 15mm antennas to use in the observation

• info.observation_sets[].array_details.number_13_antennas (integer) – Number of 13.5mm antennas to use in the observation

• info.observation_sets[].array_details.number_sub_bands (integer) – Number of Sub bands

• info.observation_sets[].array_details.tapering (string) – tapering

• info.observation_sets[].observation_type_details (object, required)

• info.observation_sets[].observation_type_details.observation_type (string, required) – Observation type

• info.observation_sets[].observation_type_details.bandwidth (object, required)

• info.observation_sets[].observation_type_details.bandwidth.value (number, required)

• info.observation_sets[].observation_type_details.bandwidth.unit (string)

• info.observation_sets[].observation_type_details.central_frequency (object, required)

• info.observation_sets[].observation_type_details.central_frequency.value (number, required)

• info.observation_sets[].observation_type_details.central_frequency.unit (string)

• info.observation_sets[].observation_type_details.supplied (object) – Integration Time or sensitivity object

• info.observation_sets[].observation_type_details.supplied.supplied_type (string:enum, required)

• info.observation_sets[].observation_type_details.supplied.quantity (object, required)

• info.observation_sets[].observation_type_details.supplied.quantity.value (number, required)

• info.observation_sets[].observation_type_details.supplied.quantity.unit (string)

• info.observation_sets[].observation_type_details.spectral_resolution (string) – Spectral Resolution

• info.observation_sets[].observation_type_details.effective_resolution (string) – Effective resolution

• info.observation_sets[].observation_type_details.image_weighting (string) – Image Weighting

• info.observation_sets[].observation_type_details.robust (string) – a Briggs image weighting parameter to balance sensitivity and resolution

• info.observation_sets[].observation_type_details.spectral_averaging (string) – Spectral Averaging

• info.data_product_sdps[] (object)

• info.data_product_sdps[].data_products_sdp_id (string, required) – Unique identifier for the Data Products SDP class

• info.data_product_sdps[].options[] (string)

• info.data_product_sdps[].observation_set_refs[] (string)

• info.data_product_sdps[].image_size (object, required)

• info.data_product_sdps[].image_size.value (number, required)

• info.data_product_sdps[].image_size.unit (string)

• info.data_product_sdps[].pixel_size (object, required)

• info.data_product_sdps[].pixel_size.value (number, required)

• info.data_product_sdps[].pixel_size.unit (string)

• info.data_product_sdps[].weighting (string, required) – Weighting

• info.data_product_src_nets[] (object)

• info.data_product_src_nets[].data_products_src_id (string, required) – Unique identifier for the Data Products SRC-Net class

• info.result_details[] (object)

• info.result_details[].observation_set_ref (string, required) – Observation set related to the results

• info.result_details[].target_ref (string, required) – Target related to the results

• info.result_details[].result (object) – results specific to the observation/target combination

• info.result_details[].result.supplied_type (string)

• info.result_details[].result.weighted_continuum_sensitivity (object) – weighted continuum sensitivity

• info.result_details[].result.weighted_continuum_sensitivity.value (number, required)

• info.result_details[].result.weighted_continuum_sensitivity.unit (string)

• info.result_details[].result.weighted_spectral_sensitivity (object) – weighted spectral sensitivity

• info.result_details[].result.weighted_spectral_sensitivity.value (number, required)

• info.result_details[].result.weighted_spectral_sensitivity.unit (string)

• info.result_details[].result.total_continuum_sensitivity (object) – Total continuum sensitivity

• info.result_details[].result.total_continuum_sensitivity.value (number, required)

• info.result_details[].result.total_continuum_sensitivity.unit (string)

• info.result_details[].result.total_spectral_sensitivity (object) – Total spectral sensitivity

• info.result_details[].result.total_spectral_sensitivity.value (number, required)

• info.result_details[].result.total_spectral_sensitivity.unit (string)

• info.result_details[].result.surface_brightness_sensitivity (object, required)

• info.result_details[].result.surface_brightness_sensitivity.continuum (number)

• info.result_details[].result.surface_brightness_sensitivity.spectral (number)

• info.result_details[].result.surface_brightness_sensitivity.unit (string)

• info.result_details[].continuum_confusion_noise (object, required)

• info.result_details[].continuum_confusion_noise.value (number, required)

• info.result_details[].continuum_confusion_noise.unit (string)

• info.result_details[].synthesized_beam_size (object, required)

• info.result_details[].synthesized_beam_size.continuum (string)

• info.result_details[].synthesized_beam_size.spectral (string)

• info.result_details[].synthesized_beam_size.unit (string)

• info.result_details[].spectral_confusion_noise (object, required)

• info.result_details[].spectral_confusion_noise.value (number, required)

• info.result_details[].spectral_confusion_noise.unit (string)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

POST /ska-oso-services/oso/api/v5/pht/prsls/send-email/

Send an async email

Endpoint to send SKAO email asynchronously via SMTP.

Request Headers:

• X-Request-ID

Request JSON Object:

• email (string:email, required)

• prsl_id (string, required)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

POST /ska-oso-services/oso/api/v5/pht/prsls/signed-url/upload/{filename}

Create upload PDF URL

Generate a presigned S3 upload URL for the given filename.

Request Headers:

• X-Request-ID

Parameters:

• filename (string, required)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

POST /ska-oso-services/oso/api/v5/pht/prsls/signed-url/download/{filename}

Create download PDF URL

Generate a presigned S3 download URL for the given filename.

Request Headers:

• X-Request-ID

Parameters:

• filename (string, required)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

POST /ska-oso-services/oso/api/v5/pht/prsls/signed-url/delete/{filename}

Create delete PDF URL

Generate a presigned S3 delete URL for the given filename.

Request Headers:

• X-Request-ID

Parameters:

• filename (string, required)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /ska-oso-services/oso/api/v5/pht/prsls/member/{email}

Retrieve user by email

Returns an MS Entra user by email from MS Graph.

Returns: dict

Request Headers:

• X-Request-ID

Parameters:

• email (string, required)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error