BLbluestaq
Comm

GET /udl/seradatacommdetails/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/seradatacommdetails/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

UUID of the parent Comm record.

classificationMarkingstring required

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

spacecraftIdstring

Seradata ID of the spacecraft (SeradataSpacecraftDetails ID).

bandstring

Name of the band of this RF range (e.g. X,K,Ku,Ka,L,S,C,UHF,VHF,EHF,SHF,UNK,VLF,HF,E,Q,V,W). See RFBandType for more details and descriptions of each band name.

solidStatePowerAmpnumber double

Solid state power amplifier, in Watts.

travelingWaveTubeAmplifiernumber double

Comm travelingWaveTubeAmplifier in Watts.

gatewayUplinkFromnumber double

Comm gatewayUplinkFrom in Ghz.

gatewayUplinkTonumber double

Comm gatewayUplinkTo in Ghz.

gatewayDownlinkFromnumber double

Comm gatewayDownlinkFrom in Ghz.

gatewayDownlinkTonumber double

Comm gatewayDownlinkTo in Ghz.

polarizationstring

Comm polarization.

eirpnumber double

Effective isotropic radiated power in dB.

bandwidthnumber double

Comm bandwidth in Mhz.

numOperationalTranspondersinteger

Comm numOperationalTransponders.

numSpareTranspondersinteger

Comm numSpareTransponders.

hostedForCompanyOrgIdstring

Comm hostedForCompanyOrgId.

manufacturerOrgIdstring

Comm manufacturerOrgId.

tradeLeaseOrgIdstring

Comm tradeLeaseOrgId.

num36MhzEquivalentTranspondersinteger

Comm num36MhzEquivalentTransponders.

htsNumUserSpotBeamsinteger

Comm htsNumUserSpotBeams.

htsUserDownlinkBandwidthPerBeamnumber double

Comm htsUserDownlinkBandwidthPerBeam in Mhz.

htsUserUplinkBandwidthPerBeamnumber double

Comm htsUserUplinkBandwidthPerBeam in Mhz.

estHtsTotalUserDownlinkBandwidthPerBeamnumber double

Comm estimated HtsTotalUserDownlinkBandwidthPerBeam in Mhz.

estHtsTotalUserUplinkBandwidthPerBeamnumber double

Comm estimated HtsTotalUserUplinkBandwidthPerBeam in Mhz.

estHtsTotalCapacitynumber double

Comm estimated HtsTotalCapacity in Gbps.

userDownlinkFromnumber double

Comm userDownlinkFrom in Ghz.

userDownlinkTonumber double

Comm userDownlinkTo in Ghz.

userUplinkFromnumber double

Comm userUplinkFrom in Ghz.

userUplinkTonumber double

Comm userUplinkTo in Ghz.

payloadNotesstring

Payload notes.

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": "SERADATACOMMDETAILS-ID",
    "idComm": "idComm",
    "classificationMarking": "U",
    "spacecraftId": "spacecraftId",
    "band": "X",
    "solidStatePowerAmp": 1.23,
    "travelingWaveTubeAmplifier": 1.23,
    "gatewayUplinkFrom": 1.23,
    "gatewayUplinkTo": 1.23,
    "gatewayDownlinkFrom": 1.23,
    "gatewayDownlinkTo": 1.23,
    "polarization": "polarization",
    "eirp": 1.23,
    "bandwidth": 1.23,
    "numOperationalTransponders": 1,
    "numSpareTransponders": 1,
    "hostedForCompanyOrgId": "hostedForCompanyOrgId",
    "manufacturerOrgId": "manufacturerOrgId",
    "tradeLeaseOrgId": "tradeLeaseOrgId",
    "num36MhzEquivalentTransponders": 1,
    "htsNumUserSpotBeams": 1,
    "htsUserDownlinkBandwidthPerBeam": 1.23,
    "htsUserUplinkBandwidthPerBeam": 1.23,
    "estHtsTotalUserDownlinkBandwidthPerBeam": 1.23,
    "estHtsTotalUserUplinkBandwidthPerBeam": 1.23,
    "estHtsTotalCapacity": 1.23,
    "userDownlinkFrom": 1.23,
    "userDownlinkTo": 1.23,
    "userUplinkFrom": 1.23,
    "userUplinkTo": 1.23,
    "payloadNotes": "Sample Notes",
    "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"
  }
]

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_109 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.