BLbluestaq
Mission Ops

GET /udl/effectrequest/{id}

Changed on

Service operation to get a single EffectRequest by its unique ID passed as a path parameter.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/effectrequest/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the EffectRequest to retrieve.

Query parameters

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.

externalRequestIdstring

The extenal system identifier of this request. A human readable unique id.

effectListstring[] required

List of effects to be achieved on the target (e.g. COVER, DECEIVE, DEGRADE, DENY, DESTROY, DISRUPT, DIVERSION, DIVERT, FIX, INSPECT, INTERCEPT, ISOLATE, MANIPULATE, NEUTRALIZE, SHADOW, SUPPRESS, etc.). The effects included in this list are connected by implied AND.

statestring

State of this effect request (e.g. CREATED, UPDATED, DELETED, etc.).

contextstring

Specific descriptive instantiation of the effect, e.g., playbook to be used.

startTimestring date-time

The time the effect should start, in ISO8601 UTC format.

endTimestring date-time

The time the effect should end, in ISO8601 UTC format.

deadlineTypestring

The indicator of deadline of the bid request (e.g. BETWEEN, IMMEDIATE, NOEARLIERTHAN, NOLATERTHAN, etc.):

BETWEEN: Produce effect any time between the given start and end times, equal penalty for being early or late.

IMMEDIATE: Start as soon as possible, earlier is always better.

NOEARLIERTHAN: Produce effect at this time or later. Large penalty for being earlier, no reward for being later.

NOLATERTHAN: Produce effect no later than the given startTime. Large penalty for being later, no reward for being even earlier as long as the effect starts by the given time.

targetSrcTypestring

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

targetSrcIdstring

The record ID, depending on the type identified in targetSrcType, of the requested target. This identifier corresponds to either poi.poiid or track.trkId from their respective schemas.

prioritystring

The priority (LOW, MEDIUM, HIGH) of this request.

modelClassstring

The type or class of the preference model used to evaluate this offer.

metricTypesstring[]

Array of the the metric classes to be evaluated (e.g. Cost, GoalAchievement, OpportunityCost, Risk, Timeliness, Unavailable, etc.). See the associated 'metricWeights' array for the weighting values, positionally corresponding to these types. The 'metricTypes' and 'metricWeights' arrays must match in size.

metricWeightsnumber[]

Array of the weights for the metric in the final evaluation score. Normalized (0 to 1). See the associated 'metricTypes' array for the metric classes, positionally corresponding to these values. The 'metricTypes' and 'metricWeights' arrays must match in size.

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": "EFFECTREQUEST-ID",
  "classificationMarking": "U",
  "externalRequestId": "EXTERNALREQUEST-ID",
  "effectList": [
    "COVER",
    "DECEIVE"
  ],
  "state": "CREATED",
  "context": "Example Notes",
  "startTime": "2018-01-01T16:00:00.123456Z",
  "endTime": "2018-01-01T16:00:00.123456Z",
  "deadlineType": "NoLaterThan",
  "targetSrcType": "POI",
  "targetSrcId": "TARGETSRC-ID",
  "priority": "LOW",
  "modelClass": "Preference model",
  "metricTypes": [
    "COST",
    "RISK"
  ],
  "metricWeights": [
    0.5,
    0.6
  ],
  "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 find_37 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.