Sensor Tasking

POST /udl/collectrequest/createBulk

Changed on

Service operation intended for initial integration only, to take a list of CollectRequest as a POST body and ingest into the database. This operation is not intended to be used for automated feeds into UDL. Data providers should contact the UDL team for specific role assignments and for instructions on setting up a permanent feed through an alternate mechanism.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/collectrequest/createBulk
  • Auth
    none declared

Request body

idstring

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

classificationMarkingstring required

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

idParentReqstring

The unique ID of the collect request record from which this request originated. This may be used for cases of sensor-to-sensor tasking, such as tip/cue operations.

msgTypestring

The type of external message from which this request originated.

msgCreateDatestring date-time

The timestamp of the external message from which this request originated, if applicable, in ISO8601 UTC format with millisecond precision.

typestring required

The type of this collect or contact request (DIRECTED SEARCH, DWELL, OBJECT, POL, RATE TRACK, SEARCH, SOI, STARE, TTC, VOLUME SEARCH, etc.).

idPlanstring

Unique identifier of the parent plan or schedule associated with this request. If null, this request is assumed not associated with a plan or schedule.

planIndexinteger

Index number (integer) for records within a collection plan or schedule.

taskIdstring

Task ID associated with this request. A task ID may be associated with a single collect request or may be used to tie together the sub-requests of a full collect, for example a DWELL consisting of many dwell points.

dwellIdstring

The dwell ID associated with this request. A dwell ID is dwell point specific and a DWELL request consist of many dwell point requests.

externalIdstring

Optional ID from external systems. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID.

idSensorstring

Unique identifier of the requested/scheduled/planned sensor associated with this request. If both idSensor and origSensorId are null then the request is assumed to be a general request for observations or contact on an object, if specified, or an area/volume. In this case, the requester may specify a desired obType.

origSensorIdstring

Optional identifier provided by the source to indicate the sensor identifier requested/scheduled/planned for this request. This may be an internal identifier and not necessarily a valid sensor ID. If both idSensor and origSensorId are null then the request is assumed to be a general request for observations or contact on an object, if specified, or an area/volume. In this case, the requester may specify a desired obType.

obTypestring

Optional type of observation (EO, IR, RADAR, RF-ACTIVE, RF-PASSIVE, OTHER) requested. This field may correspond to a request of a specific sensor, or to a general non sensor specific request.

prioritystring

The priority of the collect request (EMERGENCY, FLASH, IMMEDIATE, PRIORITY, ROUTINE).

taskCategoryinteger

The (SSN) tasking category (1-5) associated with this request. The tasking category defines the priority of gathering and transmitting the requested observational data. Note that category definitions are sensor type specific.

suffixstring

The (SSN) tasking suffix (A-Z) associated with this request. The suffix defines the amount of observational data and the frequency of collection. Note that suffix definitions are sensor type specific.

uctFollowUpboolean

Boolean indicating that this collect request is UCT follow-up.

startTimestring date-time required

The start time or earliest time of the collect or contact request window, in ISO 8601 UTC format.

endTimestring date-time

The end time of the collect or contact request window, in ISO 8601 UTC format. If no endTime or duration is provided it is assumed the request is either ongoing or that the request is for a specified number of tracks (numTracks). If both duration and endTime are provided, the endTime is assumed to take precedence.

idOnOrbitstring

Unique identifier of the target on-orbit object for this request.

satNointeger

Satellite/catalog number of the target on-orbit object for this request.

origObjectIdstring

Optional identifier provided by the data source to indicate the target object of this request. This may be an internal identifier and not necessarily map to a valid satellite number.

taskGroupstring

The tasking group to which the target object is assigned.

ironinteger

Inter-Range Operations Number. Four-digit identifier used to schedule and identify AFSCN contact support for booster, launch, and on-orbit operations.

orbitRegimestring

The orbit regime of the target (GEO, HEO, LAUNCH, LEO, MEO, OTHER).

targetSizenumber double

The minimum object (diameter) size, in meters, to be reported.

rcsMinnumber double

The minimum Radar Cross-Section of the target, in m^2. If only minimum RCS is provided it is assumed to be minimum reportable RCS.

rcsnumber double

The Radar Cross-Section of the target, in m^2.

rcsMaxnumber double

The maximum Radar Cross-Section of the target, in m^2.

freqMinnumber double

The minimum frequency of interest, in MHz. If only minimum frequency is provided it is assumed to be minimum reportable frequency.

freqnumber double

The estimated or expected emission frequency of the target, in MHz.

freqMaxnumber double

The maximum frequency of interest, in MHz.

polarizationstring

The RF polarization (H, LHC, RHC, V).

visMagMinnumber double

The minimum estimated or expected visual magnitude of the target, in Magnitudes (M). If only minimum vismag is provided it is assumed to be minimum reportable vismag.

visMagnumber double

The estimated or expected visual magnitude of the target, in Magnitudes (M).

visMagMaxnumber double

The maximum estimated or expected visual magnitude of the target, in Magnitudes (M).

spectralModelstring

The spectral model used for the irradiance calculation.

reflectancenumber double

The fraction of solar energy reflected from target.

irradiancenumber double

The target object irradiance value.

numFramesinteger

For optical sensors, the requested number of frames to capture at each sensor step.

frameRatenumber double

For optical sensors, the frame rate of the camera, in Hz.

integrationTimenumber double

For optical sensors, the integration time per camera frame, in milliseconds.

numTracksinteger

The number of requested tracks on the target. If numTracks is not provided it is assumed to indicate all possible observations every pass over the request duration or within the request start/end window.

numObsinteger

The number of requested observations on the target.

durationinteger

The duration of the collect request, in seconds. If both duration and endTime are provided, the endTime is assumed to take precedence.

srchPatternstring

The search pattern to be executed for this request (e.g. PICKET-FENCE, SCAN, etc.).

scenariostring

Pre-coordinated code, direction, or configuration to be executed by the sensor or site for this collect or contact.

idElsetstring

ID of the UDL Elset of the object associated with this request.

idManifoldstring

ID of the UDL Manifold Elset of the object associated with this request. A Manifold Elset provides theoretical Keplerian orbital elements belonging to an object of interest's manifold describing a possible/theoretical orbit for an object of interest for tasking purposes.

idStateVectorstring

ID of the UDL State Vector of the object or central vector associated with this request.

esIdstring

ID of the UDL Ephemeris Set of the object associated with this request.

epochstring date-time

Epoch time, in ISO 8601 UTC format, of the orbital elements.

semiMajorAxisnumber double

The average of the periapsis and apoapsis distances, in kilometers. For circular orbits, the semimajor axis is the distance between the centers of the bodies.

eccentricitynumber double

The orbital eccentricity of an astronomical object is a parameter that determines the amount by which its orbit around another body deviates from a perfect circle.

inclinationnumber double

The angle, in degrees, between the equator and the orbit plane when looking from the center of the Earth. Inclination ranges from 0-180 degrees, with 0-90 representing posigrade orbits and 90-180 representing retrograde orbits.

raannumber double

Right ascension of the ascending node, or RAAN is the angle as measured in degrees eastwards (or, as seen from the north, counterclockwise) from the First Point of Aries to the ascending node.

argOfPerigeenumber double

The argument of perigee is the angle, in degrees, formed between the perigee and the ascending node.

trueAnomolynumber double

The true anomaly defines the angular position, in degrees, of the object on it's orbital path as measured from the orbit focal point at epoch. The true anomaly is referenced from perigee.

ranumber double

The expected or directed right ascension angle, in degrees, for search or target acquisition.

decnumber double

The expected or directed declination angle, in degrees, for search or target acquisition.

aznumber double

The expected or directed azimuth angle, in degrees, for search or target acquisition.

elnumber double

The expected or directed elevation angle, in degrees, for search or target acquisition.

rangenumber double

The expected acquisition range or defined center range, in km.

extentAznumber double

The extent of the azimuth angle, in degrees, from center azimuth to define a spatial volume.

extentElnumber double

The extent of the elevation angle, in degrees, from center elevation to define a spatial volume.

extentRangenumber double

The extent of the range, in km, from center range to define a spatial volume.

latnumber double

WGS-84 latitude, in degrees. -90 to 90 degrees (negative values south of equator). If an accompanying stopLat is provided, then the lat value can be assumed to be the starting latitude of a volume definition.

lonnumber double

WGS-84 longitude, in degrees. -180 to 180 degrees (negative values west of Prime Meridian). If an accompanying stopLon is provided, then lon value can be assumed to be the starting longitude of a volume definition.

altnumber double

Height above WGS-84 ellipsoid (HAE), in kilometers. If an accompanying stopAlt is provided, then alt value can be assumed to be the starting altitude of a volume definition.

stopLatnumber double

The stopping WGS-84 latitude of a volume definition, in degrees. -90 to 90 degrees (negative values south of equator). The stopLat value is only meaningful if a (starting) lat value is provided.

stopLonnumber double

The stopping WGS-84 longitude of a volume definition, in degrees. -180 to 180 degrees (negative values west of Prime Meridian). The stopLon value is only meaningful if a (starting) lon value is provided.

stopAltnumber double

The stopping HAE WGS-84 height above ellipsoid (HAE), of a volume definition, in kilometers. The stopAlt value is only meaningful if a (starting) alt value is provided.

srchIncnumber double

The maximum inclination, in degrees, to be used in search operations.

xAnglenumber double

The angular distance, in degrees, in the sensor-x direction from scan center defined by the central vector. The specification of xAngle and yAngle defines a rectangle of width 2xAngle and height 2yAngle centered about the central vector.

yAnglenumber double

The angular distance, in degrees, in the sensor-y direction from scan center defined by the central vector. The specification of xAngle and yAngle defines a rectangle of width 2xAngle and height 2yAngle centered about the central vector.

orientAnglenumber double

The magnitude of rotation, in degrees, between the xAngle direction and locally defined equinoctial plane. A positive value indicates clockwise rotation about the sensor boresight vector.

customerstring

The customer for this request.

transactionIdstring

Optional identifier to track a commercial or marketplace transaction executed to produce this data.

notesstring

Notes or comments associated with this request.

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.

tagsstring[]

Optional array of provider/source specific tags for this data, where each element is no longer than 32 characters, used for implementing data owner conditional access controls to restrict access to the data. Should be left null by data providers unless conditional access controls are coordinated with the UDL team.

Example request

[
  {
    "id": "COLLECTREQUEST-ID",
    "classificationMarking": "U",
    "idParentReq": "da98671b-34db-47bf-8c8d-7c668b92c800",
    "msgType": "SU67",
    "msgCreateDate": "2024-04-25T08:17:01.346Z",
    "type": "DWELL",
    "idPlan": "REF-PLAN-ID",
    "planIndex": 8,
    "taskId": "TASK-ID",
    "dwellId": "DWELL-ID",
    "externalId": "EXTERNAL-ID",
    "idSensor": "REF-SENSOR-ID",
    "origSensorId": "ORIGSENSOR-ID",
    "obType": "RADAR",
    "priority": "EMERGENCY",
    "taskCategory": 4,
    "suffix": "T",
    "startTime": "2018-01-01T16:00:00.123456Z",
    "endTime": "2018-01-01T18:00:00.123456Z",
    "idOnOrbit": "REF-ONORBIT-ID",
    "satNo": 101,
    "origObjectId": "ORIGOBJECT-ID",
    "taskGroup": "729",
    "iron": 3,
    "orbitRegime": "GEO",
    "targetSize": 1.1,
    "rcsMin": 1.1,
    "rcs": 1.1,
    "rcsMax": 1.1,
    "freqMin": 1.1,
    "freq": 1.1,
    "freqMax": 1.1,
    "polarization": "H",
    "visMagMin": 1.1,
    "visMag": 1.1,
    "visMagMax": 1.1,
    "spectralModel": "Example Model",
    "reflectance": 1.1,
    "irradiance": 1.1,
    "numFrames": 6,
    "frameRate": 1.1,
    "integrationTime": 1.1,
    "numTracks": 3,
    "numObs": 9,
    "duration": 11,
    "srchPattern": "SCAN",
    "scenario": "Example direction",
    "idElset": "REF-ELSET-ID",
    "idManifold": "REF-MANIFOLD-ID",
    "idStateVector": "STATEVECTOR-ID",
    "esId": "ES-ID",
    "epoch": "2018-01-01T16:00:00.123456Z",
    "semiMajorAxis": 1.1,
    "eccentricity": 1.1,
    "inclination": 1.1,
    "raan": 1.1,
    "argOfPerigee": 1.1,
    "trueAnomoly": 1.1,
    "ra": 1.1,
    "dec": 1.1,
    "az": 1.1,
    "el": 1.1,
    "range": 1.1,
    "extentAz": 1.1,
    "extentEl": 1.1,
    "extentRange": 1.1,
    "lat": 1.1,
    "lon": 1.1,
    "alt": 1.1,
    "stopLat": 1.1,
    "stopLon": 1.1,
    "stopAlt": 1.1,
    "srchInc": 1.1,
    "xAngle": 1.1,
    "yAngle": 1.1,
    "orientAngle": 1.1,
    "customer": "Bluestaq",
    "transactionId": "TRANSACTION-ID",
    "notes": "Example notes",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "Example source",
    "origNetwork": "OPS1",
    "dataMode": "TEST",
    "stateVector": {
      "idStateVector": "STATEVECTOR-ID",
      "classificationMarking": "U",
      "epoch": "2018-01-01T16:00:00.123456Z",
      "pedigree": "CONJUNCTION",
      "idOnOrbit": "ONORBIT-ID",
      "satNo": 12,
      "origObjectId": "ORIGOBJECT-ID",
      "idOrbitDetermination": "026dd511-8ba5-47d3-9909-836149f87686",
      "msgTs": "2018-01-01T16:00:00.123456Z",
      "uct": true,
      "xpos": -1118.577381,
      "ypos": 3026.231084,
      "zpos": 6167.831808,
      "xvel": -4.25242784,
      "yvel": 5.291107434,
      "zvel": -3.356493869,
      "xaccel": -2.12621392,
      "yaccel": 2.645553717,
      "zaccel": -1.06310696,
      "referenceFrame": "J2000",
      "cov": [
        1.1,
        2.4,
        3.8,
        4.2,
        5.5,
        6
      ],
      "covReferenceFrame": "J2000",
      "covMethod": "CALCULATED",
      "eqCov": [
        1.1,
        2.2
      ],
      "xposAlt1": -1145.688502,
      "yposAlt1": 3020.729572,
      "zposAlt1": 6165.55187,
      "xvelAlt1": -4.270832252,
      "yvelAlt1": 5.27074276,
      "zvelAlt1": -3.365155181,
      "alt1ReferenceFrame": "TEME",
      "xposAlt2": -1456.915926,
      "yposAlt2": -2883.540406,
      "zposAlt2": 6165.55187,
      "xvelAlt2": -1.219814294,
      "yvelAlt2": -6.602080212,
      "zvelAlt2": -3.365155181,
      "alt2ReferenceFrame": "EFG/TDR",
      "posUnc": 0.333399744452,
      "velUnc": 0.000004,
      "mass": 164.5,
      "area": 5.065,
      "solarRadPressCoeff": 0.0244394,
      "dragCoeff": 0.0224391269775,
      "dragArea": 4.739,
      "revNo": 7205,
      "geopotentialModel": "EGM-96",
      "dragModel": "JAC70",
      "lunarSolar": true,
      "solarRadPress": true,
      "srpArea": 4.311,
      "solidEarthTides": true,
      "inTrackThrust": true,
      "bDot": 1.23,
      "edr": 1.23,
      "thrustAccel": 1.23,
      "cmOffset": 1.23,
      "lastObStart": "2022-11-09T11:20:21.247192Z",
      "lastObEnd": "2022-11-09T11:20:21.247192Z",
      "obsAvailable": 376,
      "obsUsed": 374,
      "tracksAvail": 163,
      "tracksUsed": 163,
      "recODSpan": 3.5,
      "actualODSpan": 3.5,
      "residualsAcc": 99.5,
      "solarFluxF10": 1.23,
      "solarFluxF10Avg": 1.23,
      "solarFluxAPAvg": 1.23,
      "taiUtc": 1.23,
      "ut1Utc": 1.23,
      "ut1Rate": 1.23,
      "polarMotionX": 1.23,
      "polarMotionY": 1.23,
      "iau1980Terms": 4,
      "leapSecondTime": "2021-01-01T01:01:01.123Z",
      "integratorMode": "integratorMode",
      "partials": "ANALYTIC",
      "stepMode": "AUTO",
      "fixedStep": true,
      "stepSizeSelection": "AUTO",
      "stepSize": 1.23,
      "errorControl": 1.23,
      "sigmaPosUVW": [
        1.23,
        4.56
      ],
      "sigmaVelUVW": [
        1.23,
        4.56
      ],
      "rms": 0.991,
      "rawFileURI": "rawFileURI",
      "source": "Bluestaq",
      "origin": "THIRD_PARTY_DATASOURCE",
      "dataMode": "TEST",
      "tags": [
        "TAG1",
        "TAG2"
      ],
      "algorithm": "SAMPLE_ALGORITHM",
      "sourcedData": [
        "DATA1",
        "DATA2"
      ],
      "sourcedDataTypes": [
        "RADAR"
      ],
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "descriptor": "descriptor",
      "missionCenter": "Mission Center A",
      "transactionId": "transactionId",
      "origNetwork": "OPS1",
      "sourceDL": "AXE"
    },
    "elset": {
      "idElset": "ELSET-ID",
      "classificationMarking": "U",
      "satNo": 12,
      "epoch": "2018-01-01T16:00:00.123456Z",
      "meanMotion": 1.1,
      "idOnOrbit": "ONORBIT-ID",
      "eccentricity": 0.333,
      "inclination": 45.1,
      "raan": 1.1,
      "argOfPerigee": 1.1,
      "meanAnomaly": 179.1,
      "revNo": 111,
      "bStar": 1.1,
      "agom": 0.0126,
      "ballisticCoeff": 0.00815,
      "meanMotionDot": 1.1,
      "meanMotionDDot": 1.1,
      "semiMajorAxis": 1.1,
      "period": 1.1,
      "apogee": 1.1,
      "perigee": 1.1,
      "origObjectId": "ORIGOBJECT-ID",
      "idOrbitDetermination": "026dd511-8ba5-47d3-9909-836149f87686",
      "line1": "Example line1",
      "line2": "Example line2",
      "descriptor": "Example description",
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "rawFileURI": "Example URI",
      "origin": "THIRD_PARTY_DATASOURCE",
      "sourceDL": "AXE",
      "source": "Bluestaq",
      "dataMode": "TEST",
      "tags": [
        "PROVIDER_TAG1",
        "PROVIDER_TAG2"
      ],
      "algorithm": "Example algorithm",
      "sourcedData": [
        "OBSERVATION_UUID1",
        "OBSERVATION_UUID2"
      ],
      "sourcedDataTypes": [
        "RADAR",
        "RF"
      ],
      "transactionId": "TRANSACTION-ID",
      "ephemType": 1,
      "origNetwork": "OPS1"
    },
    "tags": [
      "PROVIDER_TAG1",
      "PROVIDER_TAG2"
    ]
  }
]

Response

Success

Changes

Some revisions have not been checked yet.