GRgridstatus
Constraints

List Contingencies For Constraint

Changed on

Contingencies binding for a constraint in a dataset/time window.

get/constraints/{constraint_id}/contingencies

Request

Path parameters

constraint_idstring required

Constraint GS entity ID to filter by (constraint_gs_entity_id)

Query parameters

dataset_idstring required
include_binding_statsboolean

When true, include binding_intervals and absolute_cost and apply start_time/end_time/time filters. Default returns id and name only.

start_timestring nullable

Start time (ISO timestamp) for filtering (inclusive). Requires time index column. Only used when include_binding_stats is true.

end_timestring nullable

End time (ISO timestamp) for filtering (exclusive). Requires time index column. Only used when include_binding_stats is true.

timestring nullable

Optional specific timestamp to filter results. Cannot be used with start_time or end_time. Only used when include_binding_stats is true.

api_keystring nullable

API key for authentication (query)

Headers

x-api-keystring nullable

API key for authentication (header)

Response

Successful Response

idstring nullable required
namestring required
binding_intervalsinteger nullable
absolute_costnumber nullable

Changes

  • de58449b43e2Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status