--- title: "PUT /udl/onorbitlist/{id}" method: PUT path: "/udl/onorbitlist/{id}" tags: ["Onorbit"] --- # PUT /udl/onorbitlist/{id} `PUT /udl/onorbitlist/{id}` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/onorbitlist/{id}` - Auth: none declared Service operation to update a single OnOrbitList record. A specific role is required to perform this service operation. Please contact the UDL team for assistance. ## Path parameters - `id` string, required ## Request body - OnorbitListIngest: Table for maintaining generic lists of OnOrbit objects (e.g. Favorites, HIO, SHIO, HVA, etc). - `id` string: Unique identifier of the record, auto-generated by the system. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `name` string, required: Unique name of the list. - `description` string: Description of the list. - `listPriority` number, double: Numerical priority of this orbit list relative to other orbit lists; lower values indicate higher priority. Decimal values allowed for fine granularity. Consumers should contact the provider for details on the priority. - `defaultRevisitRateMins` number, double: Default revisit rate in minutes for all objects in this list. - `namespace` string: Defined naming system that ensures each satellite or space object has a unique and unambiguous identifier within the name space (e.g. JCO, 18SDS). If null, it is assumed to be 18th Space Defense Squadron (18SDS). - `tags` string[]: Optional array of provider/source specific tags for this data, where each element is no longer than 32 characters, used for implementing data owner conditional access controls to restrict access to the data. Should be left null by data providers unless conditional access controls are coordinated with the UDL team. - `transactionId` string: Optional identifier to track a commercial or marketplace transaction executed to produce this data. - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system. - `createdBy` string: Application user who created the row in the database, auto-populated by the system. - `updatedAt` string, date-time: Time the row was last updated in the database, auto-populated by the system. - `updatedBy` string: Application user who updated the row in the database, auto-populated by the system. - `sourceDL` string: The source data library from which this record was received. This could be a remote or tactical UDL or another data library. If null, the record should be assumed to have originated from the primary Enterprise UDL. - `source` string, required: Source of the data. - `origin` string: Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin. - `dataMode` 'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE', required: Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data: REAL: Data collected or produced that pertains to real-world objects, events, and analysis. TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics. EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data. SIMULATED: Synthetic data generated by a model to mimic real-world datasets. - `onOrbitListItems` OnorbitListItemIngest[], required: This is a list of onOrbitListItems that will be related one-to-one with an onOrbit entry. - `origObjectId` string: Optional identifier indicates the on-orbit object being referenced. This may be an internal system identifier and not necessarily a valid satellite number. - `objectId` string: Unique identifier of the on-orbit object. This is typically the USSF 18th SDS satellite number (also sometimes referred to as NORAD ID/number) but could be an identifier from another satellite catalog namespace. See the ‘namespace’ field for the appropriate identifier namespace. If namespace is null, 18SDS satellite number is assumed. - `commonName` string: Common name of the onorbit object. - `countryCode` string: This value is typically the ISO 3166 Alpha-3 three-character country code, however it can also represent various consortiums that do not appear in the ISO document. - `orbitRegime` string: Orbit Regime refers to a classification of a satellite's orbit based on its altitude, inclination, and other orbital characteristics. Common orbit regimes include Low Earth Orbit (LEO), Medium Earth Orbit (MEO), Geostationary Orbit (GEO), and Highly Elliptical Orbit (HEO). - `rank` integer: Rank refers to the assigned position or level of priority given to a satellite based on its relative importance, urgency, or operational relevance as determined by the applicable operations unit. - `urgency` number, double: Tasking urgency, typically will be on a 1-10 scale. Urgency as a number. (1=highest priority). - `payloadPriority` number, double: Payload priority based on the type of payload that has been identified or that is suspected. Priority of the payload as a number. (1=highest priority). - `monitoringType` string: Routine tasking that should be applied to this object. REVISIT_RATE allows users to define custom revisit rates for individual satellites, HVA_CLEARING allows users to define custom volumes that are expected to be clear of unknown objects, and POL would be collects on a specified increment in support of collecting data that feeds into Pattern of Life (PoL) assessments. - `freqMins` number, double: Frequency of additional routine, in minutes, tasking identified in and corresponding to the monitoringType array. - `clearingRadius` number, double: Radius, in degrees, of a spherical volume expected to be cleared by sensor providers, if CLEARING is selected. - `clearingBoxInTrack` number, double: Width of a box volume, in degrees, expected to be cleared by sensor providers, if CLEARING is selected. - `clearingBoxCrossTrack` number, double: Height of a box, in degrees, volume expected to be cleared by sensor providers, if CLEARING is selected. - `expiredOn` string, date-time: Datetime expiration of a satellite on this list, allowing for the maintenance of a history of when satellites entered and when they exited the list in ISO 8601 UTC datetime format with millisecond precision. ## Response `204` Success ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `404`: Item Not Found - `405`: Method Not Allowed - `415`: MediaType Unsupported - `429`: Rate of Requests Exceeds Allowed Limit - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2025-10-23** `09bd422d5ac1`: 1 breaking, 1 warning, 6 info - added the new required request property `onOrbitListItems` - removed the request property `onorbits` - added the new optional request property `defaultRevisitRateMins` - added the new optional request property `listPriority` - …4 more - **2025-04-16** `75f764c843a9`: 2 info - api operation id `edit_50` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/onorbitlist/:id/put.md) --- [API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)