BLbluestaq
Sensor Tasking

GET /udl/sensorplan

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/sensorplan
  • Auth
    none declared

Query parameters

startTimestring date-time required

The start time of the plan or schedule, in ISO 8601 UTC format. (YYYY-MM-DDTHH:MM:SS.ssssssZ)

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.

typestring required

The type of this sensor plan/schedule (PLAN, REQUEST, SCHEDULE).

recTypestring required

The type of records that comprise this parent set (COLLECT, CONTACT).

startTimestring date-time required

The start time of the plan or schedule, in ISO 8601 UTC format.

endTimestring date-time

The end time of the plan or schedule, in ISO 8601 UTC format.

namestring

Name associated with this plan or schedule.

idSensorstring

Unique identifier of the requested/schedule/planned sensor associated with this request.

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.

purposestring

The purpose/description of this plan or schedule.

senNetworkstring

The sensor or ground network associated with this plan or schedule.

reqTotalinteger

The total number of requests contained in this plan or schedule. Value of this field must match the size of collectRequest list if the list is provided and can be null or any value otherwise.

customerstring

The customer for this plan or schedule.

statusstring

The status of this plan or schedule (ACCEPTED, APPROVED, COMPLETED, PROPOSED, REJECTED, REQUESTED, SCHEDULED).

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.

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.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

Example response

[
  {
    "id": "SENSORPLAN-ID",
    "classificationMarking": "U",
    "type": "PLAN",
    "recType": "COLLECT",
    "startTime": "2018-01-01T16:00:00.123456Z",
    "endTime": "2018-01-01T16:00:00.123456Z",
    "name": "EXAMPLE NAME",
    "idSensor": "REF-SENSOR-ID",
    "origSensorId": "ORIGSENSOR-ID",
    "purpose": "Example purpose",
    "senNetwork": "NETWORK",
    "reqTotal": 2,
    "customer": "CUSTOMER",
    "status": "ACCEPTED",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "origNetwork": "OPS1"
  }
]

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

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.