BLbluestaq
Link Status

GET /udl/linkstatus/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/linkstatus/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.

createdAtstring date

(One or more of fields 'createdAt, linkStartTime, linkStopTime' are required.) Time the row was created in the database, auto-populated by the system. (YYYY-MM-DDTHH:MM:SS.sssZ)

linkStartTimestring date-time

(One or more of fields 'createdAt, linkStartTime, linkStopTime' are required.) The link establishment time, or the time that the link becomes available for use, in ISO8601 UTC format. (YYYY-MM-DDTHH:MM:SS.ssssssZ)

linkStopTimestring date-time

(One or more of fields 'createdAt, linkStartTime, linkStopTime' are required.) The link termination time, or the time that the link becomes unavailable for use, in ISO8601 UTC format. (YYYY-MM-DDTHH:MM:SS.ssssssZ)

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.

idOnOrbit1string

Unique ID of the on-orbit satellite (Sat-1) forming the link. A null value for idOnOrbit1 indicates that the link is formed over a LEO/MEO constellation.

idOnOrbit2string

Unique ID of the on-orbit satellite (Sat-2) forming the link. A null value for idOnOrbit2 indicates either a link employing only Sat-1 or a link formed over a LEO/MEO constellation.

linkStartTimestring date-time required

The link establishment time, or the time that the link becomes available for use, in ISO8601 UTC format.

linkStopTimestring date-time required

The link termination time, or the time that the link becomes unavailable for use, in ISO8601 UTC format.

constellationstring

The constellation name if the link is established over a LEO/MEO constellation. In this case, idOnOrbit1 and idOnOrbit2 will be null.

linkNamestring required

The name or description of the link.

linkTypestring

The type of the link.

bandstring

The RF band employed by the link (e.g. MIL-KA, COM-KA, X-BAND, C-BAND, etc.).

idBeam1string

The ID of beam-1 forming the link. In the case of two sat link, beam-1 corresponds to Sat-1.

endPoint1Namestring required

The name or description of link endpoint-1, corresponding to beam-1.

endPoint1Latnumber double required

Latitude of link endpoint-1, WGS-84 in degrees. -90 to 90 degrees (negative values south of equator).

endPoint1Lonnumber double required

Longitude of link endpoint-1, WGS-84 longitude in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

idBeam2string

The ID of beam-2 forming the link. In the case of two sat link, beam-2 corresponds to Sat-2.

endPoint2Namestring required

The name or description of link endpoint-2, corresponding to beam-2.

endPoint2Latnumber double required

Latitude of link endpoint-2, WGS-84 in degrees. -90 to 90 degrees (negative values south of equator).

endPoint2Lonnumber double required

Longitude of link endpoint-2, WGS-84 longitude in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

dataRate1To2number double

The endpoint-1 to endpoint-2 data rate, in kbps.

dataRate2To1number double

The endpoint-2 to endpoint-1 data rate, in kbps.

linkStatestring

The state of the link (e.g. OK, DEGRADED-WEATHER, DEGRADED-EMI, etc.).

sysCapstring

The SYSCAP mission status of the system(s) forming the link.

opsCapstring

The OPSCAP mission status of the system(s) forming the link.

snrnumber double

Signal to noise ratio, in dB.

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.

origNetworkstring

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

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.

satNo1integer

Satellite/catalog number of the target on-orbit primary object.

satNo2integer

Satellite/catalog number of the target on-orbit secondary object.

Example response

[
  {
    "id": "LINKSTATUS-ID",
    "classificationMarking": "U",
    "idOnOrbit1": "REF-ONORBIT1-ID",
    "idOnOrbit2": "REF-ONORBIT2-ID",
    "linkStartTime": "2021-01-01T01:01:01.123456Z",
    "linkStopTime": "2021-01-01T01:01:01.123456Z",
    "constellation": "Fornax",
    "linkName": "Example description",
    "linkType": "Example link",
    "band": "MIL-KA",
    "idBeam1": "REF-BEAM1-ID",
    "endPoint1Name": "Example endpoint",
    "endPoint1Lat": 45.23,
    "endPoint1Lon": 80.23,
    "idBeam2": "REF-BEAM2-ID",
    "endPoint2Name": "Example description",
    "endPoint2Lat": 45.23,
    "endPoint2Lon": 80.23,
    "dataRate1To2": 10.23,
    "dataRate2To1": 10.23,
    "linkState": "DEGRADED-WEATHER",
    "sysCap": "Example status",
    "opsCap": "Example status",
    "snr": 10.1,
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST",
    "satNo1": 1,
    "satNo2": 2
  }
]

Changes

  • 45631f9bb3f0Revision changes
    • info

      added the optional property / to the response with the status

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

Some revisions have not been checked yet.