BLbluestaq
Supporting Data

GET /udl/entity

Changed on

Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information.

Request

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

Query parameters

firstResultinteger
maxResultsinteger

Response

OK

idEntitystring

Unique identifier of the record.

namestring required

Unique entity name.

classificationMarkingstring required

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

type'AIRCRAFT' | 'BUS' | 'COMM' | 'IR' | 'LASEREMITTER' | 'NAVIGATION' | 'ONORBIT' | 'RFEMITTER' | 'SCIENTIFIC' | 'SENSOR' | 'SITE' | 'VESSEL' required

The type of entity represented by this record (AIRCRAFT, BUS, COMM, IR, LASEREMITTER, NAVIGATION, ONORBIT, RFEMITTER, SCIENTIFIC, SENSOR, SITE, VESSEL).

idLocationstring

Unique identifier of the entity location, if terrestrial/fixed.

countryCodestring

The country code. This value is typically the ISO 3166 Alpha-2 two-character country code, however it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code.

ownerType'Commercial' | 'Government' | 'Academic' | 'Consortium' | 'Other'

Type of organization which owns this entity (e.g. Commercial, Government, Academic, Consortium, etc).

taskableboolean

Boolean indicating if this entity is taskable.

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.

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.

idOnOrbitstring

Onorbit identifier if this entity is part of an on-orbit object. For the public catalog, the idOnOrbit is typically the satellite number as a string, but may be a UUID for analyst or other unknown or untracked satellites.

idOperatingUnitstring

Unique identifier of the associated operating unit object.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

Example response

[
  {
    "idEntity": "ENTITY-ID",
    "name": "Example name",
    "classificationMarking": "U",
    "type": "ONORBIT",
    "idLocation": "LOCATION-ID",
    "countryCode": "US",
    "ownerType": "Commercial",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "location": {
      "idLocation": "LOCATION-ID",
      "classificationMarking": "U",
      "name": "Example location",
      "countryCode": "US",
      "lat": 45.23,
      "lon": 179.1,
      "altitude": 10.23,
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "source": "Bluestaq",
      "origin": "THIRD_PARTY_DATASOURCE",
      "dataMode": "TEST",
      "origNetwork": "OPS1"
    },
    "onOrbit": {
      "idOnOrbit": "ONORBIT-ID",
      "classificationMarking": "U",
      "satNo": 1,
      "commonName": "Example common name",
      "constellation": "Big Dipper",
      "intlDes": "2021123ABC",
      "launchDate": "2018-01-01",
      "decayDate": "2018-01-01T16:00:00.123Z",
      "objectType": "PAYLOAD",
      "origin": "THIRD_PARTY_DATASOURCE",
      "missionNumber": "Expedition 1",
      "category": "Lunar",
      "lifetimeYears": 10,
      "altName": "Alternate Name",
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "source": "Bluestaq",
      "dataMode": "TEST",
      "launchSiteId": "LAUNCHSITE-ID",
      "countryCode": "US",
      "origNetwork": "OPS1"
    },
    "idOnOrbit": "ONORBIT-ID",
    "idOperatingUnit": "OPERATINGUNIT-ID",
    "origNetwork": "OPS1"
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • warning

      added the new LASEREMITTER enum value to the / response property for the response status

    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • info

      api operation id findAll_36 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.