BLbluestaq
Sensor

PUT /udl/sensor/{id}

Changed on

Service operation to update a single Sensor. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

Request

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

Path parameters

idstring required

The ID of the Sensor to update.

Request body

idSensorstring

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

sensorNamestring required

Unique name of this sensor.

classificationMarkingstring required

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

sensorNumberinteger

Number assigned to this sensor. Since there is no authoritative numbering scheme, these numbers sometimes collide across sensors (especially commercial sensors). It is therefore not a unique identifier.

shortNamestring

Optional short name for the sensor.

dataControlstring

Optional dissemination control required for accessing data (e.g observations) produced by this sensor. This is typically a proprietary data owner control for commercial sensors.

afIdstring

Optional US Air Force identifier for the sensor/ASR site, typically for air surveillance radar (ASR) sensors.

asrTypestring

The sensor type at the site. Optional field, intended primarily for ASRs.

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.

activeboolean

Optional flag indicating if the sensor is active.

idEntitystring

Unique identifier of the parent entity. idEntity is required for Put.

Example request

{
  "idSensor": "SENSOR-ID",
  "sensorName": "SENSOR_NAME",
  "classificationMarking": "U",
  "sensorNumber": 1234,
  "shortName": "SNR-1",
  "dataControl": "observations",
  "afId": "AF-ID",
  "asrType": "SENSOR_TYPE",
  "source": "some.user",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST",
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "active": true,
  "sensorcharacteristics": [
    {
      "id": "SENSORCHARACTERISTICS-ID",
      "idSensor": "SENSOR-ID",
      "classificationMarking": "U",
      "origNetwork": "OPS1",
      "equipmentType": "PS",
      "siteCode": "07",
      "testNumber": "02022",
      "description": "PROFILER DATA - PROFILE/SOUNDER DATA FROM PRIMARY WINDS SOURCE",
      "location": "KENNEDY SPACE CENTER, FL",
      "beamQty": 2,
      "beamOrder": [
        "vb1",
        "ob1"
      ],
      "azimuthRate": 10.23,
      "azAngs": [
        135.1,
        45.2
      ],
      "elevationRateGeolm": 10.23,
      "elAngs": [
        75.3,
        75.4
      ],
      "minRangeLimit": 20.23,
      "maxRangeLimit": 20.23,
      "leftClockAngle": 20.23,
      "rightClockAngle": 20.23,
      "boresight": 20.23,
      "boresightOffAngle": 20.23,
      "settleTime": 4.4,
      "negativeRangeRateLimit": 20.23,
      "positiveRangeRateLimit": 20.23,
      "magnitudeLimit": 20.23,
      "trackAngle": 1.23,
      "minSignalNoiseRatio": 20.23,
      "detectSNR": 2.1,
      "trackSNR": 15.1,
      "fanBeamWidth": 3.1,
      "taskableRange": 20.23,
      "maxObservableRange": 20.23,
      "maxNumTracks": 6,
      "obsPerTrack": 100,
      "obsSpacing": 1.1,
      "radioFrequency": 20000.1,
      "radarFrequency": 45300000000.1,
      "transmitPower": 20.23,
      "loopGain": 150.1,
      "dutyCycle": 0.5,
      "taskingChannels": [
        "AD-HOC",
        "DAILY",
        "CTL"
      ],
      "peakPower": 5000000.1,
      "transmitGain": 32.1,
      "transmitLoss": 7.1,
      "maxDataTransmissionRate": 10.23,
      "receiveGain": 10.2,
      "receiveLoss": 1.23,
      "numSearchPatterns": 2,
      "searchPatternPoints": [
        0,
        40.1,
        60.1
      ],
      "patternScanLoss": 1.23,
      "patternAbsorptionLoss": 1.23,
      "radomeLoss": 1.23,
      "collapsingLoss": 1.23,
      "signalProcessingLoss": 1.23,
      "atmosTransmissionLoss": 0.5,
      "atmosReceiverLoss": 0.5,
      "filterMismatchFactor": 10.23,
      "numWaveforms": 2,
      "waveformPulseWidths": [
        100.1,
        200.1
      ],
      "waveformBandwidths": [
        0.25,
        0.25
      ],
      "waveformMinRanges": [
        150.1,
        150.1
      ],
      "waveformMaxRanges": [
        2000.1,
        2000.1
      ],
      "waveformLoopGains": [
        150.1,
        155.1
      ],
      "hFOV": 20.23,
      "vFOV": 20.23,
      "hResPixels": 1000,
      "vResPixels": 1000,
      "band": "BAND",
      "bandwidth": 100.23,
      "maxDeviationAngle": 20.23,
      "solarExclAngle": 50.5,
      "lunarExclAngle": 45.2,
      "earthLimbExclHgt": 20.23,
      "twilightAngle": 7.5,
      "aperture": 2.23,
      "leftGeoBeltLimit": 20.23,
      "rightGeoBeltLimit": 20.23,
      "asrScanRate": 20.23,
      "k": 1.4,
      "focalPoint": 20.23,
      "towerHeight": 20.23,
      "trueNorthCorrector": 10,
      "magDec": 45.23,
      "z1MinRange": 20.23,
      "z2MinRange": 20.23,
      "z1MaxRange": 50.23,
      "z2MaxRange": 50.23,
      "radarMUR": 20.23,
      "probFalseAlarm": 0.5,
      "prf": 20.23,
      "radarPulseWidths": [
        20.23,
        20.33
      ],
      "pulseRepPeriods": [
        153.8,
        153.9
      ],
      "numIntegratedPulses": 10,
      "nonCoherentIntegratedPulses": 2,
      "delayGates": [
        690.2,
        690.3
      ],
      "rangeGates": [
        51,
        52
      ],
      "rangeSpacings": [
        690.2,
        690.3
      ],
      "vertGateSpacings": [
        149.1,
        149.2
      ],
      "vertGateWidths": [
        149.1,
        149.2
      ],
      "transmitHorizBeamWidth": 135.1,
      "transmitVertBeamWidth": 45.2,
      "receiveHorizBeamWidth": 75.3,
      "receiveVertBeamWidth": 75.4,
      "trueTilt": 20.23,
      "radarMessageFormat": "DATA_FORMAT",
      "dataFormats": [
        "AA007",
        "EOSSA"
      ],
      "acceptableSatIdFormats": [
        "5-DIGIT",
        "ALPHA-5"
      ],
      "systemNoiseTemperature": 3.5,
      "refTemp": 3.5,
      "noiseFigure": 10.23,
      "probDetectSNR": 0.5,
      "specAvgSpectraNums": [
        3,
        4
      ],
      "tempMedFiltCodes": [
        3,
        4
      ],
      "fft": 4096,
      "runMeanCodes": [
        0,
        5
      ],
      "critShear": 47.1,
      "fgpCrit": 5,
      "totRecNums": [
        5,
        2
      ],
      "reqRecords": [
        0,
        1
      ],
      "acceptSampleRanges": [
        3.01,
        3.02
      ],
      "minWavelength": 1.23,
      "centerWavelength": 4.56,
      "maxWavelength": 7.89,
      "fNum": 1.23,
      "opticalTransmission": 0.5,
      "pixelInstantaneousFOV": 10.23,
      "quantumEff": 0.5,
      "readNoise": 12,
      "darkCurrent": 12.3,
      "minIntegrationTime": 0.3,
      "maxIntegrationTime": 1.1,
      "numIntegrationFrames": 2,
      "numOpticalIntegrationModes": 2,
      "opticalIntegrationTimes": [
        0.3,
        1
      ],
      "opticalIntegrationAngularRates": [
        15.1,
        0.1
      ],
      "opticalIntegrationFrames": [
        2.1,
        3.1
      ],
      "opticalIntegrationPixelBinnings": [
        2.1,
        1.1
      ],
      "opticalIntegrationSNRs": [
        6.1,
        6.1
      ],
      "pixelWellDepth": 12,
      "analogToDigitalBitSize": 2,
      "backgroundSkyVisMag": 10.23,
      "backgroundSkyRadiance": 10.23,
      "avgAtmosSeeingConditions": 10.23,
      "source": "Bluestaq",
      "dataMode": "TEST",
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user"
    }
  ],
  "sensorStats": [
    {
      "id": "SENSORSTATS-ID",
      "idSensor": "idSensor",
      "classificationMarking": "U",
      "lastObTime": "2021-01-01T01:01:01.123456Z",
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "updatedAt": "2018-01-01T16:00:00.123Z",
      "updatedBy": "some.user",
      "source": "Bluestaq",
      "dataMode": "TEST"
    }
  ],
  "sensorlimitsCollection": [
    {
      "idSensorLimits": "SENSORLIMITS-ID",
      "classificationMarking": "U",
      "origNetwork": "OPS1",
      "upperLeftAzimuthLimit": 1.23,
      "upperRightAzimuthLimit": 1.23,
      "lowerRightAzimuthLimit": 1.23,
      "lowerLeftAzimuthLimit": 1.23,
      "lowerLeftElevationLimit": 1.23,
      "upperLeftElevationLimit": 1.23,
      "lowerRightElevationLimit": 1.23,
      "upperRightElevationLimit": 1.23,
      "source": "Bluestaq",
      "dataMode": "TEST",
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "idSensor": "SENSOR-ID"
    }
  ],
  "entity": {
    "idEntity": "ENTITY-ID",
    "name": "Example name",
    "classificationMarking": "U",
    "terrestrialId": "TERRESTRIAL-ID",
    "type": "ONORBIT",
    "idLocation": "LOCATION-ID",
    "countryCode": "US",
    "ownerType": "Commercial",
    "urls": [
      "URL1",
      "URL2"
    ],
    "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"
  },
  "idEntity": "ENTITY-ID",
  "sensorObservationType": {
    "id": "3",
    "type": "5",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "origNetwork": "OPS1"
  },
  "sensorType": {
    "id": 12344411,
    "type": "Space Borne",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "origNetwork": "OPS1"
  }
}

Response

Success

Changes

  • bd17bc53681eRevision changes
    • warning

      the /// request property's maxLength was set to 16

    • warning

      the // request property's max was set to 3.14

    • warning

      the // request property's max was set to 99.99

    • warning

      the // request property's min was set to 0.00

    • warning

      the // request property's min was set to 0.00

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request optional property became read-only

  • 7b321e16ea56Revision changes
    • breaking

      the request property // became required

    • breaking

      the // request property's minLength was increased from 0 to 1

Some revisions have not been checked yet.