v3
latestOpenAPI 3.1.02026-08-08155201291.7 KBScreening
Update Screening
Update the configuration of a screening. Can only be performed on Screenings that have not yet been submitted.
patch/screenings/{id}
Path parameters
idstring uuid required
Request body
group_idstring uuid nullable
threshold_radius_kmnumber nullable
threshold_radius_manned_kmnumber nullable
threshold_radius_active_kmnumber nullable
threshold_radius_debris_kmnumber nullable
default_secondary_hbr_mnumber nullable
auto_archiveboolean nullable
include_primary_vs_primaryboolean nullable
titlestring nullable
notesstring nullable
screening_type'ON_ORBIT' | 'LAUNCH'
launch_window_startstring date-time nullable
launch_window_endstring date-time nullable
launch_window_cadence_sinteger nullable
hard_body_shape'SQUARE' | 'CIRCLE'
strict_coverageboolean nullable
publish_cdmsboolean nullable
Response
Successful Response
idstring uuid required
group_idstring uuid nullable
status'CREATED' | 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILURE' | 'CANCELED' required
started_atstring date-time nullable
created_atstring date-time nullable
completed_atstring date-time nullable
updated_atstring date-time nullable
threshold_radius_kmnumber required
threshold_radius_manned_kmnumber nullable
threshold_radius_active_kmnumber nullable
threshold_radius_debris_kmnumber nullable
default_secondary_hbr_mnumber required
auto_archiveboolean required
include_primary_vs_primaryboolean required
titlestring nullable
notesstring nullable
screening_type'ON_ORBIT' | 'LAUNCH' required
hard_body_shape'SQUARE' | 'CIRCLE' required
strict_coverageboolean required
publish_cdmsboolean required
screen_count_expectedinteger nullable
screen_count_currentinteger nullable
launch_window_startstring date-time nullable
launch_window_endstring date-time nullable
launch_window_cadence_sinteger nullable
archivedboolean required
percent_completenumber required
primary_sources_countinteger
secondary_sources_countinteger
primaries_countinteger nullable
secondaries_countinteger nullable
lowest_miss_distance_kmnumber nullable
highest_pcnumber nullable
next_tcastring date-time nullable
propagation_start_timestring date-time nullable
propagation_duration_snumber nullable
propagation_timestep_snumber nullable
secondary_any_coverage_endstring date-time nullable
secondary_any_coverage_startstring date-time nullable
secondary_full_coverage_endstring date-time nullable
secondary_full_coverage_startstring date-time nullable
failure_messagestring nullable
conjunctions_countinteger required
high_risk_conjunctions_countinteger required
high_risk_pcnumber required
high_risk_md_kmnumber required
low_risk_pcnumber required
low_risk_md_kmnumber required
ssc_sustainability_threshold_conjunction_countinteger required
ssc_maneuver_planning_threshold_conjunction_countinteger required
primary_rsos_countinteger
secondary_rsos_countinteger
propagations_countinteger
schedule_idstring uuid nullable