--- title: "GET /udl/effectresponse" method: GET path: "/udl/effectresponse" tags: ["Mission Ops"] --- # GET /udl/effectresponse `GET /udl/effectresponse` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/effectresponse` - Auth: none declared Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (`/udl//queryhelp`) for more details on valid/required query parameter information. ## Query parameters - `createdAt` string, date, required - `firstResult` integer - `maxResults` integer ## Response `200` OK - EffectResponseAbridged[] - `id` string: Unique identifier of the record, auto-generated by the system. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `idEffectRequest` string: Unique identifier of the EffectRequest associated with this response. - `externalRequestId` string: The external system identifier of the associated effect request. A human readable unique id. - `type` string, required: The type of response in this record (e.g. COA, SCORECARD, etc.). - `actorSrcType` string: The source type of the asset/actor identifier (AIRCRAFT, LANDCRAFT, SEACRAFT, TRACK). - `actorSrcId` string: The record ID, depending on the type identified in actorSrcType, of the requested asset. - `munitionType` string: The type of munition being fired. - `munitionId` string: Unique identifier of the munition. - `shotsRequired` integer: The number of shots required to destroy target. - `probabilityOfKill` number, double: The probability of kill (0-1) of the target being destroyed. - `collateralDamageEst` number, double: The collateral damage estimate (CDE) of the munition being fired. - `actionsList` EffectResponseActionsListAbridged[]: List of actions associated with this effect response. - `summary` string: A summary string describing different aspects of the action. - `actionId` string: Identifier of this action. - `actionStartTime` string, date-time: The desired start time of this task, in ISO8601 UTC format. - `actionEndTime` string, date-time: The desired end time of this task, in ISO8601 UTC format. - `totStartTime` string, date-time: The start time of the asset TOT (time over target), in ISO8601 UTC format. - `totEndTime` string, date-time: The end time of the asset TOT (time over target), in ISO8601 UTC format. - `actionActorSrcType` string: The source type of the asset/actor identifier (AIRCRAFT, LANDCRAFT, SEACRAFT, TRACK). - `actionActorSrcId` string: The record ID, depending on the type identified in actorSrcType, of the requested asset/actor. - `effector` string: The type of munition or sensor used by this asset/actor. - `targetSrcType` string: The source type of the targetId identifier (POI, TRACK). - `targetSrcId` string: The POI or TRACK 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. - `actorInterceptLat` number, double: The WGS-84 latitude of the asset/actor location at weapon launch, in degrees. -90 to 90 degrees (negative values south of equator). - `actorInterceptLon` number, double: The WGS-84 longitude of the asset/actor location at weapon launch, in degrees. -180 to 180 degrees (negative values west of Prime Meridian). - `actorInterceptAlt` number, double: The WGS-84 altitude of the asset/actor location at weapon launch, in meters. - `weaponInterceptLat` number, double: The WGS-84 latitude of the weapon destination location, in degrees. -90 to 90 degrees (negative values south of equator). - `weaponInterceptLon` number, double: The WGS-84 longitude of the weapon destination location, in degrees. -180 to 180 degrees (negative values west of Prime Meridian). - `weaponInterceptAlt` number, double: The WGS-84 altitude of the weapon destination location, in meters. - `actionMetrics` EffectResponseMetricsAbridged[]: List of metrics associated with this action. - `metricType` string: The type of the metric (e.g. CollateralDamage, GoalAchievement, OpportunityCost, Timeliness, Unavailable, etc.). - `domainValue` number, double: The metric score specific to its domain. - `relativeValue` number, double: The metric score adjusted to be relative and comparable to other domains. - `provenance` string: The metric that was used to score this task. - `externalActions` string[]: List of external actions to be executed as part of this task. - `coaMetrics` EffectResponseMetricsAbridged[]: List of COA metrics associated with this effect response. - `metricType` string: The type of the metric (e.g. CollateralDamage, GoalAchievement, OpportunityCost, Timeliness, Unavailable, etc.). - `domainValue` number, double: The metric score specific to its domain. - `relativeValue` number, double: The metric score adjusted to be relative and comparable to other domains. - `provenance` string: The metric that was used to score this task. - `redTimeToOverhead` string, date-time: The time to overhead for the red force to be over their target, in ISO8601 UTC format. - `decisionDeadline` string, date-time: The deadline time to accept this COA before it's no longer valid, in ISO8601 UTC format. - `redTargetSrcType` string: The source type of the targetId identifier (POI, SITE, TRACK). - `redTargetSrcId` string: 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. - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system. - `createdBy` string: Application user who created the row in the database, auto-populated by the system. - `source` string, required: Source of the data. - `origin` string: 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. - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system. ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `405`: Method Not Allowed - `406`: MediaType Not Accepted by Request Headers - `429`: Rate of Requests Exceeds Allowed Limit - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2025-05-29** `4e1cbc17e814`: 2 info - added the new optional `query` request parameter `firstResult` - added the new optional `query` request parameter `maxResults` - **2025-04-16** `75f764c843a9`: 1 breaking, 2 info - the `items/externalActions/items/` response property's maxLength was unset from `64` for the response status `200` - api operation id `findAll_33` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/effectresponse/get.md) --- [API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)