BLbluestaq
Onorbit

GET /udl/onorbitlist/tuple

Changed on

Service operation to dynamically query data and only return specified columns/fields. Requested columns are specified by the 'columns' query parameter and should be a comma separated list of valid fields for the specified data type. classificationMarking is always returned. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information. An example URI: /udl/elset/tuple?columns=satNo,period&epoch=>now-5 hours would return the satNo and period of elsets with an epoch greater than 5 hours ago.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/onorbitlist/tuple
  • Auth
    none declared

Query parameters

columnsstring required

Comma-separated list of valid field names for this data type to be returned in the response. Only the fields specified will be returned as well as the classification marking of the data, if applicable. See the ‘queryhelp’ operation for a complete list of possible fields.

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

namestring required

Unique name of the list.

descriptionstring

Description of the list.

listPrioritynumber 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.

defaultRevisitRateMinsnumber double

Default revisit rate in minutes for all objects in this list.

namespacestring

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).

tagsstring[]

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.

transactionIdstring

Optional identifier to track a commercial or marketplace transaction executed to produce this data.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

updatedAtstring date-time

Time the row was last updated in the database, auto-populated by the system.

updatedBystring

Application user who updated the row in the database, auto-populated by the system.

sourceDLstring

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.

sourcestring required

Source of the data.

originstring

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.

Example response

[
  {
    "id": "ONORBITLIST-ID",
    "classificationMarking": "U",
    "name": "HRR-SATELLITES",
    "description": "DESCRIPTION_OF_LIST",
    "listPriority": 1.1,
    "defaultRevisitRateMins": 15.3,
    "namespace": "18SDS",
    "tags": [
      "TAG1",
      "TAG2"
    ],
    "transactionId": "TRANSACTION-ID",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "updatedAt": "2018-01-01T16:00:00.123Z",
    "updatedBy": "some.user",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "onOrbitListItems": [
      {
        "objectId": "5",
        "origObjectId": "ORIGOBJECT-ID",
        "commonName": "VANGUARD 1",
        "countryCode": "USA",
        "orbitRegime": "LEO",
        "rank": 3,
        "urgency": 5.1,
        "payloadPriority": 2.5,
        "monitoringType": "REVISIT_RATE",
        "freqMins": 300.25,
        "clearingRadius": 1.25,
        "clearingBoxInTrack": 1.25,
        "clearingBoxCrossTrack": 1.25,
        "expiredOn": "2024-07-12T00:00:00.000Z"
      }
    ]
  }
]

Changes

  • 173e4aff893fRevision changes
    • breaking

      the / response property's minItems was decreased from 1 to 0 for the response status

  • 09bd422d5ac1Revision changes
    • breaking

      the / response property's maxLength was increased from 512 to 1024 for the response status

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

Some revisions have not been checked yet.