BLbluestaq
Comm

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

idCommstring required

ID of the parent Comm object for this transponder.

namestring

Optional name of the transponder.

classificationMarkingstring required

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

nidstring

Optional external network id as provided data source.

tidstring

Optional external transponder id as provided data source.

ttfnumber double

Transponder Translation Factor. This is the frequency difference between the uplink received by a satellite, and the downlink transmitted back. It varies satellite to satellite dependent on the mission.

symbolRatenumber double

Symbol rate is the number of symbol changes, waveform changes, or signaling events, across the transmission medium per time unit using a digitally modulated signal or a line code. Also measured in Hz.

fecinteger

Forward error correction, e.g. 0=Auto, 1 = 1/2, 2 = 2/3, 3 = 3/4, 4 = 5/6, 5 = 7/8, 6 = 8/9, 7 = 3/5, 8 = 4/5, 9 = 9/10, 15 = None.

modulationstring

Transponder modulation, e.g. Auto, QPSK, 8PSK.

formatstring

Format.

systemstring

Transponder system, e.g. DVB-S, DVB-S2.

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.

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.

Example response

[
  {
    "id": "TRANSPONDER-ID",
    "idComm": "REF-COMM-ID",
    "name": "AA10",
    "classificationMarking": "U",
    "nid": "N-ID",
    "tid": "T-ID",
    "ttf": 1.53261520047876,
    "symbolRate": 4,
    "modulation": "Auto",
    "format": "format",
    "system": "DVB-S",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "updatedAt": "2018-01-01T16:00:00.123Z",
    "updatedBy": "some.user",
    "channels": [
      {
        "id": "CHANNEL-ID",
        "idTransponder": "REF-TRANSPONDER-ID",
        "name": "Example name",
        "classificationMarking": "U",
        "type": "Example type",
        "idBeam": "REF-BEAM-ID",
        "beamName": "B8VD",
        "idRFBand": "REF-RFBAND-ID",
        "encryption": "Example encryption",
        "pkg": "Example pkg",
        "res": "Example res",
        "compression": "Example compression",
        "vpid": "VP-ID",
        "apid": "AP-ID",
        "sid": "S-ID",
        "owner": "example_owner",
        "source": "system.source",
        "origin": "example_origin",
        "origNetwork": "OPS1",
        "dataMode": "TEST",
        "createdAt": "2018-01-01T16:00:00.123Z",
        "createdBy": "some.user",
        "updatedAt": "2018-01-01T16:00:00.123Z",
        "updatedBy": "some.user"
      }
    ]
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • info

      api operation id findAllTuples_139 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.