Screening

Submit Screening

Changed on

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

Request

  • Base URL: https://api.satcat.com/api/satcat
  • URL: https://api.satcat.com/api/satcat/screenings/{id}/submit
  • Auth: OAuth 2 (client credentials, token URL oauth/token; password, token URL login)

Path parameters

idstring uuid required

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
engine'automatic' | 'classic' | 'caskd' required
engine_used'automatic' | 'classic' | 'caskd'
hard_body_shape'SQUARE' | 'CIRCLE' required
strict_coverageboolean required
publish_cdmsboolean required
allow_synthetic_covarianceboolean 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

Changes

  • 9a3b0a312528Revision changes
    • info

      added the required property to the response with the status

  • fba1aea33824Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status