BLbluestaq
Comm

GET /udl/channel/{id}

Changed on

Service operation to get a single Channel record by its unique ID passed as a path parameter. A Comm payload may have multiple transponders and a transponder may have many channels.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/channel/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the Channel to find.

Query parameters

firstResultinteger
maxResultsinteger

Response

OK

idstring

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

idTransponderstring required

ID of the parent transponder object for this Channel.

namestring required

Channel name.

classificationMarkingstring required

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

typestring

Channel type.

idBeamstring

Identifier of the particular beam for this channel.

beamNamestring

The antenna beam ID of the particular beam for this channel. beamName is not unique across payloads.

idRFBandstring

ID of the RF Band object for this channel.

encryptionstring

Channel encryption.

pkgstring

Pkg.

resstring

Res.

compressionstring

Channel compression.

vpidstring

Channel vPid.

apidstring

Channel aPid.

sidstring

SID.

ownerstring

Owner.

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": "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 find_23 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.