BLbluestaq
Mission Ops

GET /udl/effectresponse

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/effectresponse
  • 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.

idEffectRequeststring

Unique identifier of the EffectRequest associated with this response.

externalRequestIdstring

The external system identifier of the associated effect request. A human readable unique id.

typestring required

The type of response in this record (e.g. COA, SCORECARD, etc.).

actorSrcTypestring

The source type of the asset/actor identifier (AIRCRAFT, LANDCRAFT, SEACRAFT, TRACK).

actorSrcIdstring

The record ID, depending on the type identified in actorSrcType, of the requested asset.

munitionTypestring

The type of munition being fired.

munitionIdstring

Unique identifier of the munition.

shotsRequiredinteger

The number of shots required to destroy target.

probabilityOfKillnumber double

The probability of kill (0-1) of the target being destroyed.

collateralDamageEstnumber double

The collateral damage estimate (CDE) of the munition being fired.

externalActionsstring[]

List of external actions to be executed as part of this task.

redTimeToOverheadstring date-time

The time to overhead for the red force to be over their target, in ISO8601 UTC format.

decisionDeadlinestring date-time

The deadline time to accept this COA before it's no longer valid, in ISO8601 UTC format.

redTargetSrcTypestring

The source type of the targetId identifier (POI, SITE, TRACK).

redTargetSrcIdstring

The record ID, depending on the type identified in redTargetSrcType, of the red force target. If the redTargetSrcType is POI or TRACK, then this identifier corresponds to either poi.poiid or track.trkId from their respective schemas.

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": "EFFECTRESPONSE-ID",
    "classificationMarking": "U",
    "idEffectRequest": "EFFECTREQUEST-ID",
    "externalRequestId": "EXTERNALREQUEST-ID",
    "type": "COA",
    "actorSrcType": "AIRCRAFT",
    "actorSrcId": "RC-ID",
    "munitionType": "Dummy",
    "munitionId": "MUNITION-ID",
    "shotsRequired": 10,
    "probabilityOfKill": 0.7,
    "collateralDamageEst": 0.5,
    "actionsList": [
      {
        "summary": "Example summary",
        "actionId": "ACTION-ID",
        "actionStartTime": "2021-01-01T00:00:00.123456Z",
        "actionEndTime": "2021-01-01T00:00:00.123456Z",
        "totStartTime": "2021-01-01T00:00:00.123456Z",
        "totEndTime": "2021-01-01T00:00:00.123456Z",
        "actionActorSrcType": "AIRCRAFT",
        "actionActorSrcId": "ACTIONACTORSRC-ID",
        "effector": "SENSOR1",
        "targetSrcType": "POI",
        "targetSrcId": "TARGETSRC-ID",
        "actorInterceptLat": 45.1,
        "actorInterceptLon": 180.1,
        "actorInterceptAlt": 1.1,
        "weaponInterceptLat": 45.1,
        "weaponInterceptLon": 180.1,
        "weaponInterceptAlt": 1.1,
        "actionMetrics": [
          {
            "metricType": "GoalAchievement",
            "domainValue": 10.1,
            "relativeValue": 10.1,
            "provenance": "Example metric"
          }
        ]
      }
    ],
    "externalActions": [
      "ACTION1",
      "ACTION2"
    ],
    "coaMetrics": [
      {
        "metricType": "GoalAchievement",
        "domainValue": 10.1,
        "relativeValue": 10.1,
        "provenance": "Example metric"
      }
    ],
    "redTimeToOverhead": "2021-01-01T00:00:00.123456Z",
    "decisionDeadline": "2021-01-01T00:00:00.123456Z",
    "redTargetSrcType": "POI",
    "redTargetSrcId": "REDTARGETSRC-ID",
    "createdAt": "2021-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
    • breaking

      the // response property's maxLength was unset from 64 for the response status

    • info

      api operation id findAll_33 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.