BLbluestaq
Sensor Tasking

GET /udl/collectresponse

Changed on

Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information.

Request

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

Query parameters

createdAtstring date required

Time the row was created in the database, auto-populated by the system. (YYYY-MM-DDTHH:MM:SS.sssZ)

firstResultinteger
maxResultsinteger

Response

OK

idstring

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

classificationMarkingstring required

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

idRequeststring required

Unique identifier of the request associated with this response.

idOnOrbitstring

Unique identifier of the target on-orbit object associated with this response.

origObjectIdstring

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

satNointeger

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

taskIdstring

Optional task ID associated with the request/response.

idPlanstring

Unique identifier of the parent plan or schedule associated with the request/response.

externalIdstring

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

statusstring

The status of the request (ACCEPTED, CANCELLED, COLLECTED, COMPLETED, DELIVERED, FAILED, PARTIAL, PROPOSED, REJECTED, SCHEDULED):

ACCEPTED: The collect or contact request has been received and accepted.

CANCELLED: A previously scheduled collect or contact whose execution was cancelled.

COLLECTED: The collect has been accomplished. A collected state implies that additional activity is required for delivery/completion.

COMPLETED: The collect or contact has been completed. For many systems completed and delivered constitute an equivalent successful end state.

DELIVERED: The collected observation(s) have been delivered to the requestor. For many systems completed and delivered constitute an equivalent successful end state. A DELIVERED state is typically used for systems that exhibit a delay between collect and delivery, such as with space-based systems which require ground contact to deliver observations.

FAILED: The collect or contact was attempted and failed, or the delivery of the collected observation(s) failed. A FAILED status may be accompanied by an error code (errCode), if available.

PARTIAL: A PARTIAL state indicates that a part of a multi-track request has been accomplished, but the full request is incomplete. A PARTIAL status should ultimately be resolved to an end state.

PROPOSED: Indicates that the request was received and alternate collect or contact time(s) (altStartTime, altEndTime) have been proposed. If an alternate is accepted by the requestor the current request should be cancelled and a new request created.

REJECTED: The request has been received and rejected by the provider. A REJECTED status may be accompanied by an explanation (notes) of the reason that the request was rejected.

SCHEDULED: The request was received and has been scheduled for execution.

actualStartTimestring date-time

The actual start time of the collect or contact, in ISO 8601 UTC format.

actualEndTimestring date-time

The actual end time of the collect or contact, in ISO 8601 UTC format.

altStartTimestring date-time

Proposed alternative start time, in ISO 8601 UTC format.

altEndTimestring date-time

Proposed alternative end time, in ISO 8601 UTC format.

errCodestring

Error code associated with this request/response.

srcTypsstring[]

Array of UDL record type(s) (DOA, ELSET, EO, RADAR, RF, SV) collected or produced in response to the associated request. See the associated 'srcIds' array for the record UUIDs, positionally corresponding to the record types in this array. The 'srcTyps' and 'srcIds' arrays must match in size. The appropriate API operation can be used to retrieve the specified object(s) (e.g. /udl/rfobservation/{uuid}).

srcIdsstring[]

Array of UUIDs of the UDL data record(s) collected in response to the associated request. See the associated 'srcTyps' array for the specific types of data, positionally corresponding to the UUIDs in this array. The 'srcTyps' and 'srcIds' arrays must match in size. The appropriate API operation can be used to retrieve the specified object(s) (e.g. /udl/rfobservation/{uuid}).

notesstring

Notes or comments associated with this response.

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.

idSensorstring

Unique identifier of the reporting sensor.

origSensorIdstring

Optional identifier provided by the collection source to indicate the sensor identifier responding to this collect or contact. This may be an internal identifier and not necessarily a valid sensor ID.

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.

Example response

[
  {
    "id": "COLLECTRESPONSE-ID",
    "classificationMarking": "U",
    "idRequest": "REF-REQUEST-ID",
    "idOnOrbit": "REF-ONORBIT-ID",
    "origObjectId": "ORIGOBJECT-ID",
    "satNo": 101,
    "taskId": "TASK-ID",
    "idPlan": "REF-PLAN-ID",
    "externalId": "EXTERNAL-ID",
    "status": "ACCEPTED",
    "actualStartTime": "2018-01-01T16:00:00.123456Z",
    "actualEndTime": "2018-01-01T18:00:00.123456Z",
    "altStartTime": "2018-01-01T16:00:00.123456Z",
    "altEndTime": "2018-01-01T18:00:00.123456Z",
    "errCode": "ERROR CODE",
    "srcTyps": [
      "DOA",
      "DWELL"
    ],
    "srcIds": [
      "DOA_ID",
      "DWELL_ID"
    ],
    "notes": "Example notes",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "idSensor": "REF-SENSOR-ID",
    "origSensorId": "ORIGSENSOR-ID",
    "dataMode": "TEST"
  }
]

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

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.