v3

latestOpenAPI 3.1.02026-08-08155201291.7 KB

Screening

Submit Screening

Submit a screening for processing. Submitting a screening is an idempotent operation. Once a screening has been submitted and entered the PENDING state, submitting it again will have no further effect. <br/> If the screening as configured at submission fails validation, the server will return HTTP status 422 (Unprocessable Entity) and the screening will not enter the PENDING state until the configuration is updated and the screening is submitted again.

put/screenings/{id}/submit

Path parameters

idstring uuid required

Response

Successful Response

idstring uuid required

group_idstring uuid nullable

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 required

secondary_sources_countinteger required

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