BLbluestaq
Sensor

GET /udl/sensormaintenance

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

Query parameters

endTimestring date-time

(One or more of fields 'endTime, startTime' are required.) The planned outage end time in ISO8601 UTC format. (YYYY-MM-DDTHH:MM:SS.ssssssZ)

startTimestring date-time

(One or more of fields 'endTime, startTime' are required.) The planned outage start time in ISO8601 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.

siteCodestring required

The site to which this item applies. NOTE - this site code is COLT specific and may not identically correspond to other UDL site IDs.

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

UUID of the sensor.

startTimestring date-time required

The planned outage start time in ISO8601 UTC format.

endTimestring date-time required

The planned outage end time in ISO8601 UTC format.

recallstring

The minimum time required to recall this activity, expressed as ddd:hh:mm.

durationstring

The duration of the planned outage, expressed as ddd:hh:mm.

mwOpsCapstring

The Missile Warning operational capability of this maintenance item. Typical values are G, Y, R, and - for non-applicable sites.

ssOpsCapstring

The Space Surveillance operational capability of this maintenance item. Typical values are G, Y, R, and - for non-applicable sites.

mdOpsCapstring

The Missile Defense operational capability of this maintenance item. Typical values are G, Y, R, and - for non-applicable sites.

impactedFacesstring

The sensor face(s) to which this COLT maintenance item applies, if applicable.

equipStatusstring

The mission capability status of the equipment (e.g. FMC, NMC, PMC, UNK, etc.).

activitystring

Description of the activity taking place during this outage.

remarkstring

Remarks concerning this outage.

requestorstring

The name of the requestor.

changerstring

The name of the changer, if applicable.

approverstring

The name of the approver.

eowIdstring

COLT EOWID.

revstring

The revision number for this maintenance item.

prioritystring

The priority of this maintenance item.

relstring

Release.

lineNumberstring

The internal COLT line number assigned to this item.

resourcestring

The name of the resource(s) affected by this maintenance item.

inactiveDatestring date-time

The date that this item became inactive in ISO8601 UTC format.

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": "SENSORMAINTENANCE-ID",
    "classificationMarking": "U",
    "siteCode": "site01",
    "externalId": "EXTERNAL-ID",
    "idSensor": "idSensor",
    "startTime": "2018-01-01T16:00:00.123456Z",
    "endTime": "2018-01-01T16:00:00.123456Z",
    "recall": "128:16:52",
    "duration": "128:16:52",
    "mwOpsCap": "G",
    "ssOpsCap": "Y",
    "mdOpsCap": "R",
    "impactedFaces": "impactedFaces",
    "equipStatus": "FMC",
    "activity": "Activity Description",
    "remark": "Remarks",
    "requestor": "requestor",
    "changer": "changer",
    "approver": "approver",
    "eowId": "eowId",
    "rev": "rev",
    "priority": "low",
    "rel": "rel",
    "lineNumber": "lineNumber",
    "resource": "resource",
    "inactiveDate": "2018-01-01T16:00:00.123Z",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "origNetwork": "OPS1"
  }
]

Changes

  • 7b321e16ea56Revision changes
    • info

      added the optional property / to the response with the status

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

Some revisions have not been checked yet.