BLbluestaq
Site

PUT /udl/sitestatus/{id}

Changed on

Service operation to update a single SiteStatus object. 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/sitestatus/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the SiteStatus to update.

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.

idSitestring required

The ID of the site, if this status is associated with a fixed site or platform.

siteTypestring

Optional site type or further detail of type. Intended for, but not limited to, Link-16 site type specifications (e.g. ADOC, GACC, SOC, TACC, etc.).

mobileAltIdstring

Alternate Identifier for a mobile or transportable platform provided by source.

poiidstring

The POI (point of interest) ID related to this platform, if available.

trackIdstring

The track ID related to this platform (if mobile or transportable), if available.

trackRefL16string

Link-16 specific reference track number.

opsCapabilitystring

The operational status of the platform (e.g. Fully Operational, Partially Operational, Not Operational, etc.).

instStatus'FMC' | 'PMC' | 'NMC' | 'UNK'

The status of the installation.

FMC - Fully Mission Capable

PMC - Partially Mission Capable

NMC - Non Mission Capable

UNK - Unknown.

fpcon'NORMAL' | 'ALPHA' | 'BRAVO' | 'CHARLIE' | 'DELTA'

Force Protection Condition (FPCON).

NORMAL - Applies when a general global threat of possible terrorist activity exists and warrants a routine security posture.

ALPHA - Applies when an increased general threat of possible terrorist activity against personnel or facilities. Nature and extent of threat are unpredictable.

BRAVO - Applies when an increased or predictable threat of terrorist activity exists.

CHARLIE - Applies when an incident occurs or intelligence is received indicating some form of terrorist action against personnel and facilities is imminent.

DELTA - Applies in the immediate area where an attack has occurred or when intelligence is received indicating terrorist action against a location is imminent.

hpcon'0' | 'ALPHA' | 'BRAVO' | 'CHARLIE' | 'DELTA'

Health Protection Condition (HPCON).

0 - Routine, no community transmission.

ALPHA - Limited, community transmission beginning.

BRAVO - Moderate, increased community transmission.

CHARLIE - Substantial, sustained community transmission.

DELTA - Severe, widespread community transmission.

cpcon'1' | '2' | '3' | '4' | '5'

Cyberspace Protection Condition (CPCON).

1 - VERY HIGH - Critical functions.

2 - HIGH - Critical and essential functions.

3 - MEDIUM - Critical, essential, and support functions.

4 - LOW - All functions.

5 - VERY LOW - All functions.

reportTimestring date-time

Time of report, in ISO8601 UTC format.

timeFunctionstring

Description of the time function associated with the reportTime (e.g. Activation, Deactivation, Arrival, Departure, etc.), if applicable.

weatherMessagestring

Description of the current weather conditions over a site.

pesboolean

Position Engagement Status flag, Indicating whether this platform is initiating multiple simultaneous engagements. A value of 1/True indicates the platform is initiating multiple simultaneous engagements.

hotInventoryinteger

Estimated number of hot missiles of all types remaining in weapons system inventory.

coldInventoryinteger

Estimated number of cold missiles of all types remaining in weapons system inventory.

samModestring

The state of a SAM unit (e.g. Initialization, Standby, Reorientation, etc.).

radiateModestring

SAM sensor radar surveillance mode (Active, Passive, Off).

opsImpairmentstring

The primary component degrading the operational capability of the platform or system.

commImpairmentstring

The communications component causing the platform or system to be less than fully operational.

cat'COLD' | 'WARM' | 'HOT'

Crisis Action Team (CAT).

COLD - Not in use.

WARM - Facility prepped/possible skeleton crew.

HOT - Fully active.

eoc'COLD' | 'WARM' | 'HOT'

Emergency Operations Center (EOC) status.

COLD - Not in use.

WARM - Facility prepped/possible skeleton crew.

HOT - Fully active.

linkstring[]

Array of Link item(s) for which status is available and reported (ATDL, IJMS, LINK-1, LINK-11, LINK-11B, LINK-16). This array must be the same length as the linkStatus array.

linkStatusstring[]

Array of the status (AVAILABLE, DEGRADED, NOT AVAILABLE, etc.) for each links in the link array. This array must be the same length as the link array, and the status must correspond to the appropriate position index in the link array.

radarSystemstring[]

Array of radar system(s) for which status is available and reported (ACQUISITION, IFFSIF, ILLUMINATING, MODE-4, PRIMARY SURVEILLANCE, SECONDARY SURVEILLANCE, TERTIARY SURVEILLANCE). This array must be the same length as the radarStatus array.

radarStatusstring[]

Array of the status (NON-OPERATIONAL, OPERATIONAL, OFF) for each radar system in the radarSystem array. This array must be the same length as the radarSystem array, and the status must correspond to the appropriate position index in the radarSystem array.

missilestring[]

Array of specific missile types for which an estimated inventory count is available (e.g. GMD TYPE A, HARPOON, TOMAHAWK, etc.). This array must be the same length as the missileInventory array.

missileInventoryinteger[]

Array of the quantity of each of the missile items. This array must be the same length as the missile array, and the values must correspond to appropriate position index in the missile array.

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.

Example request

{
  "id": "SITESTATUS-ID",
  "classificationMarking": "U",
  "idSite": "41e3e554-9790-40b9-bd7b-f30d864dcad8",
  "siteType": "ADOC",
  "mobileAltId": "MOBILEALT-ID",
  "poiid": "d4a91864-6140-4b8d-67cd-45421c75f696",
  "trackId": "PCM4923-1656174732-4-1-257",
  "trackRefL16": "TrkNm",
  "opsCapability": "Fully Operational",
  "instStatus": "PMC",
  "fpcon": "BRAVO",
  "hpcon": "CHARLIE",
  "cpcon": "4",
  "reportTime": "2021-01-01T01:01:01.123Z",
  "timeFunction": "Activation",
  "weatherMessage": "Heavy rain",
  "pes": true,
  "hotInventory": 1,
  "coldInventory": 1,
  "samMode": "Initialization",
  "radiateMode": "Active",
  "opsImpairment": "opsImpairment",
  "commImpairment": "commImpairment",
  "cat": "COLD",
  "eoc": "WARM",
  "link": [
    "ATDL",
    "IJMS",
    "LINK-1"
  ],
  "linkStatus": [
    "AVAILABLE",
    "DEGRADED",
    "NOT AVAILABLE"
  ],
  "radarSystem": [
    "ILLUMINATING",
    "MODE-4",
    "MODE-3"
  ],
  "radarStatus": [
    "OPERATIONAL",
    "OFF",
    "NON-OPERATIONAL"
  ],
  "missile": [
    "GMD",
    "HARPOON",
    "JAVELIN"
  ],
  "missileInventory": [
    5,
    10,
    100
  ],
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST"
}

Response

Success

Changes

  • 75f764c843a9Revision changes
    • info

      api operation id edit_74 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.