{"openapi":"3.0.1","info":{"title":"CWMS Data API","description":"CWMS REST API for Data Retrieval","version":"2026.03.16"},"servers":[{"url":"/cwms-data"}],"security":[{"CdaAccessManager":[]}],"paths":{"/":{"get":{"summary":"Get","operationId":"get","responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/auth/keys/{key-name}":{"get":{"tags":["Authorization"],"summary":"Get auth keys with keyName","description":"View specific key","operationId":"getAuthKeysWithKeyName","parameters":[{"name":"key-name","in":"path","description":"Name of the specific key to get more information for. NOTE: Case-sensitive.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Authorization"],"summary":"Delete auth keys with keyName","description":"Delete API key for a user","operationId":"deleteAuthKeysWithKeyName","parameters":[{"name":"key-name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/auth/keys":{"get":{"tags":["Authorization"],"summary":"Get auth keys","description":"View all keys for the current user","operationId":"getAuthKeys","responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Authorization"],"summary":"Post auth keys","description":"Create a new API Key for user. The randomly generated key is returned to the caller. A provided key will be ignored.","operationId":"postAuthKeys","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/location/category/{category-id}":{"get":{"tags":["Location Categories"],"summary":"Get location category with categoryId","description":"Retrieves requested Location Category","operationId":"getLocationCategoryWithCategoryId","parameters":[{"name":"category-id","in":"path","description":"Specifies the Category whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the Location Category whose data is to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCategory"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Location Categories"],"summary":"Delete location category with categoryId","description":"Deletes requested location category","operationId":"deleteLocationCategoryWithCategoryId","parameters":[{"name":"category-id","in":"path","description":"The location category to be deleted","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the location category to be deleted","required":true,"schema":{"type":"string"}},{"name":"cascade-delete","in":"query","description":"Specifies whether to delete any location groups in this location category. Default: false","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/location/category":{"get":{"tags":["Location Categories"],"summary":"Get location category","description":"Returns CWMS Location Category Data","operationId":"getLocationCategory","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the location category(ies) whose data is to be included in the response. If this field is not specified, matching location category information from all offices shall be returned.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocationCategory"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Location Categories"],"summary":"Post location category","description":"Create new LocationCategory","operationId":"postLocationCategory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCategory"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/location/group/{group-id}":{"get":{"tags":["Location Groups"],"summary":"Get location group with groupId","description":"Retrieves requested Location Group. This endpoint supports GEO JSON responses with application/geo+json.For more information about accept header usage, see this page.","operationId":"getLocationGroupWithGroupId","parameters":[{"name":"group-id","in":"path","description":"Specifies the location_group whose data is to be included in the response","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the location group whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"group-office-id","in":"query","description":"Specifies the owning office of the location group whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"category-office-id","in":"query","description":"Specifies the owning office of the category the location group belongs to whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"category-id","in":"query","description":"Specifies the category containing the location group whose data is to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationGroup"}},"text/csv":{"schema":{"$ref":"#/components/schemas/CsvV1LocationGroup"}},"application/geo+json":{"schema":{"$ref":"#/components/schemas/Unit"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Location Groups"],"summary":"Delete location group with groupId","description":"Deletes requested location group","operationId":"deleteLocationGroupWithGroupId","parameters":[{"name":"group-id","in":"path","description":"The location group to be deleted","required":true,"schema":{"type":"string"}},{"name":"category-id","in":"query","description":"Specifies the location category of the location group to be deleted","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the location group to be deleted","required":true,"schema":{"type":"string"}},{"name":"cascade-delete","in":"query","description":"Specifies whether to unassign any location assignments. Default: false","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Location Groups"],"summary":"Patch location group with groupId","description":"Update existing LocationGroup. Allows for renaming group, assigning new locations, and unassigning all locations from the group.","operationId":"patchLocationGroupWithGroupId","parameters":[{"name":"group-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"replace-assigned-locs","in":"query","description":"Specifies whether to unassign all existing locations before assigning new locations specified in the content body Default: false","schema":{"type":"boolean"}},{"name":"office","in":"query","description":"Specifies the office of the user making the request. This is the office that the location, group, and category belong to. If the group and/or category belong to the CWMS office, this only identifies the location.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationGroup"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/location/group":{"get":{"tags":["Location Groups"],"summary":"Get location group","description":"Returns CWMS Location Groups Data","operationId":"getLocationGroup","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the location group whose data is to be included in the response. If this field is not specified, matching location groups information from all offices shall be returned.","schema":{"type":"string"}},{"name":"include-assigned","in":"query","description":"Include the assigned locations in the returned location groups. (default: false)","schema":{"type":"boolean"}},{"name":"location-category-like","in":"query","description":"Posix regular expression matching against the location category id","schema":{"type":"string"}},{"name":"category-office-id","in":"query","description":"Specifies the owning office of the category the location group belongs to whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"location-office-id","in":"query","description":"Specifies the owning office of the location assigned to the location group whose data is to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocationGroup"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CsvV1LocationGroup"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Location Groups"],"summary":"Post location group","description":"Create new LocationGroup","operationId":"postLocationGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationGroup"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/locations/with-kinds":{"get":{"tags":["REGI"],"summary":"Get locations withKinds","description":"Returns CWMS Location Data. The Catalog end-point is also capable of retrieving lists of locations and can filter on additional fields.","operationId":"getLocationsWithKinds","parameters":[{"name":"names","in":"query","description":"Specifies the name(s) of the location(s) whose data is to be included in the response. This parameter is a Posix regular expression matching against the id","schema":{"type":"string"}},{"name":"location-kind-like","in":"query","description":"Specifies the location kind(s) whose data is to be included in the response. This parameter is a Posix regular expression matching against the location kind. If this field is not specified, all location kinds shall be returned.","schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the location level(s) whose data is to be included in the response. If this field is not specified, matching location level information from all offices shall be returned.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CwmsIdLocationKind"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/locations/{location-id}":{"get":{"tags":["Locations"],"summary":"Get locations with locationId","description":"Returns CWMS Location Data","operationId":"getLocationsWithLocationId","parameters":[{"name":"location-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the location level(s) whose data is to be included in the response. If this field is not specified, matching location level information from all offices shall be returned.","required":true,"schema":{"type":"string"}},{"name":"unit","in":"query","description":"Specifies the unit or unit system of the response. Valid values for the unit field are: \n* `EN` Specifies English unit system. Location values will be in the default English units for their parameters. This is the default behavior.\n* `SI` Specifies the SI unit system. Location values will be in the default SI units for their parameters.","schema":{"type":"string"}},{"name":"include-aliases","in":"query","description":"Specifies whether to include location aliases in the response. Default: false","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the location was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Location"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/Location"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Locations"],"summary":"Delete locations with locationId","description":"Delete CWMS Location","operationId":"deleteLocationsWithLocationId","parameters":[{"name":"location-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the location whose data is to be deleted. If this field is not specified, matching location information will be deleted from all offices.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the location was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Location successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Locations"],"summary":"Patch locations with locationId","description":"Update CWMS Location","operationId":"patchLocationsWithLocationId","parameters":[{"name":"location-id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/Location"}},"application/json":{"schema":{"$ref":"#/components/schemas/Location"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the location was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/locations":{"get":{"tags":["Locations"],"summary":"Get locations","description":"Returns CWMS Location Data. The Catalog end-point is also capable of retrieving lists of locations and can filter on additional fields.","operationId":"getLocations","parameters":[{"name":"names","in":"query","description":"Specifies the name(s) of the location(s) whose data is to be included in the response. When the `format` parameter is not provided and `application/json;version=2` is specified in the accept header, this parameter is a Posix regular expression matching against the id","schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the location level(s) whose data is to be included in the response. If this field is not specified, matching location level information from all offices shall be returned.","schema":{"type":"string"}},{"name":"unit","in":"query","description":"Specifies the unit or unit system of the response. Default is SI. Valid values for the unit field are:\n* `EN` Specifies English unit system. Location level values will be in the default English units for their parameters.\n* `SI` Specifies the SI unit system. Location level values will be in the default SI units for their parameters.\n* `Other` Any unit returned in the response to the units URI request that is appropriate for the requested parameters.","schema":{"type":"string"}},{"name":"datum","in":"query","description":"Specifies the elevation datum of the response. This field affects only vertical datum. Valid values for this field are:\n* `NAVD88` The elevation values will in the specified or default units above the NAVD-88 datum.\n* `NGVD29` The elevation values will be in the specified or default units above the NGVD-29 datum.","schema":{"type":"string"}},{"name":"format","in":"query","description":"Specifies the encoding format of the response. Valid values for the format field for this URI are:\n\n* `tab`\n* `csv`\n* `xml`\n* `wml2` (only if name field is specified)\n* `json` (default)\n\n* `geojson`\n\nSee this page for more information about accept header usage.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Location"}}},"application/json":{"schema":{"$ref":"#/components/schemas/Unit"}},"text/tab-separated-values":{"schema":{"type":"string"}},"text/csv":{"schema":{"type":"string"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Unit"}},"application/vnd.opengis.waterml+xml":{"schema":{"$ref":"#/components/schemas/Unit"}},"application/geo+json":{"schema":{"$ref":"#/components/schemas/Unit"}},"":{"schema":{"$ref":"#/components/schemas/Unit"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Locations"],"summary":"Post locations","description":"Create new CWMS Location","operationId":"postLocations","parameters":[{"name":"fail-if-exists","in":"query","description":"Specifies whether to fail if the location already exists. Default: true. If true, an error will be returned if the location already exists. If false, the existing location will be updated with the new values.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Location"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/entity/{entity-id}":{"get":{"tags":["Entity"],"summary":"Get entity with entityId","description":"Returns CWMS Entity data by entity id and office id.","operationId":"getEntityWithEntityId","parameters":[{"name":"entity-id","in":"path","description":"Specifies the Entity ID of the entity to be retrieved. (e.g., NWS).","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the entity to be retrieved. e.g., SPK)","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Entity"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Entity"],"summary":"Delete entity with entityId","description":"Delete CWMS Entity.","operationId":"deleteEntityWithEntityId","parameters":[{"name":"entity-id","in":"path","description":"Specifies the entity ID of the Entity to be deleted (e.g., NWS).","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the entity to be updated. (e.g., SPK)","required":true,"schema":{"type":"string"}},{"name":"cascade-delete","in":"query","description":"If true, also delete all descendant child entities.","required":true,"schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Entity not found for the given parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Entity deleted successfully"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Entity"],"summary":"Patch entity with entityId","description":"Update an existing Entity.","operationId":"patchEntityWithEntityId","parameters":[{"name":"entity-id","in":"path","description":"Specifies the entity ID of the Entity to be updated. (e.g., NWS)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Entity"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Entity updated successfully in CWMS"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/entity":{"get":{"tags":["Entity"],"summary":"Get entity","description":"Returns all CWMS Entity Data filtered by optional masks.","operationId":"getEntity","parameters":[{"name":"office","in":"query","description":"Office ID to filter entities (e.g., SPK). If omitted, returns entities for all offices.","schema":{"type":"string"}},{"name":"entity-id","in":"query","description":"Entity ID to filter by specific entity. If omitted, returns all entities. (e.g., GOV or NWS).","schema":{"type":"string"}},{"name":"parent-entity-id","in":"query","description":"Parent Entity ID to filter entities by parent (e.g., NOAA).","schema":{"type":"string"}},{"name":"category-id","in":"query","description":"Category ID to filter entities by category (e.g., GOV).","schema":{"type":"string"}},{"name":"long-name","in":"query","description":"Entity long name to filter entities (e.g., National Weather Service).","schema":{"type":"string"}},{"name":"match-null-parents","in":"query","description":"If true, include entities with null parent IDs. Default is true.","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Entity"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Entity"],"summary":"Post entity","description":"Create CWMS Entity","operationId":"postEntity","requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Entity"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Entity successfully stored to CWMS"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/states":{"get":{"tags":["States"],"summary":"Get states","operationId":"getStates","responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of states.","content":{"application/json;version=2":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/State"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/counties":{"get":{"tags":["Counties"],"summary":"Get counties","operationId":"getCounties","responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of counties.","content":{"application/json;version=2":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/County"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/offices/{office}":{"get":{"tags":["Offices"],"summary":"Get offices with office","operationId":"getOfficesWithOffice","parameters":[{"name":"office","in":"path","description":"The 3 letter office ID you want more information for","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"(CWMS-Data-Format-Deprecated: 2024-11-01 in favor of Accept header) Specifies the encoding format of the response. Valid value for the format field for this URI are:\r\n* `tab`\r\n* `csv`\r\n* `xml`\r\n* `json` (default)","deprecated":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of offices.","content":{"":{"schema":{"$ref":"#/components/schemas/OfficeFormatV1"}},"application/json":{"schema":{"$ref":"#/components/schemas/Office"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/OfficeFormatV1"}},"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Office"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Office"}},"application/xml;version=1":{"schema":{"$ref":"#/components/schemas/OfficeFormatV1"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/Office"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/offices":{"get":{"tags":["Offices"],"summary":"Get offices","operationId":"getOffices","parameters":[{"name":"format","in":"query","description":"(CWMS-Data-Format-Deprecated: 2024-11-01 in favor of Accept header) Specifies the encoding format of the response. Valid value for the format field for this URI are:\r\n\n* `tab`\r\n\n* `csv`\r\n \n* `xml`\r\n\n* `json` (default)","deprecated":true,"schema":{"type":"string"}},{"name":"has-data","in":"query","description":"A flag ('True'/'False') When set to true this returns offices that have operational data. Default value is False,. Feature #321","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of offices.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Office"}}},"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OfficeFormatV1"}}},"application/json;version=2":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Office"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/units":{"get":{"tags":["Units"],"summary":"Get units","operationId":"getUnits","parameters":[{"name":"format","in":"query","description":"Specifies the encoding format of the response. Valid value for the format field for this URI are:\n* `tab`\n* `csv`\n* `xml`\n* `json` (default)\n\nSee this page for more information about accept header usage.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK"},"501":{"description":"The format requested is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/parameters":{"get":{"tags":["Parameters"],"summary":"Get parameters","operationId":"getParameters","parameters":[{"name":"format","in":"query","description":"Specifies the encoding format of the response. Valid value for the format field for this URI are:\n* `tab`\n* `csv`\n* `xml`\n* `json` (default)\n\nSee this page for more information about accept header usage.","deprecated":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the parameters whose data is to be included in the response. If this field is not specified, the session user's default office will be used.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Parameter"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Parameter"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timezones":{"get":{"tags":["TimeZones"],"summary":"Get timezones","operationId":"getTimezones","parameters":[{"name":"format","in":"query","description":"Specifies the encoding format of the response. Valid value for the format field for this URI are:\n* `tab` \n* `csv` \n* `xml` \n* `json` (default)\n\nSee this page for more information about accept header usage.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TimeZoneIds"}},"application/json":{"schema":{"$ref":"#/components/schemas/TimeZoneIds"}}}},"501":{"description":"The format requested is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/levels/{level-id}":{"get":{"tags":["Levels"],"summary":"Get levels with levelId","description":"Retrieves requested Location Level","operationId":"getLevelsWithLevelId","parameters":[{"name":"level-id","in":"path","description":"Specifies the requested location level.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the office of the Location Level to be returned","required":true,"schema":{"type":"string"}},{"name":"effective-date","in":"query","description":"Specifies the effective date of Location Level to be returned.Expected formats are `YYYY-MM-DDTHH:MM` or `YYYY-MM-DDTHH:MM:SS`","required":true,"schema":{"type":"string"}},{"name":"use-exact-effective-date","in":"query","description":"If true only a level with the exact provided date will be returned. If false The most recent level on or before this time will be returned. The default is false.","schema":{"type":"boolean"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the effective date field (unless otherwise specified), as well as the time zone of any times in the response. If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"unit","in":"query","description":"Specifies the unit or unit system of the response. Valid values for the unit field are:\n* `EN` Specifies English unit system. Location level values will be in the default English units for their parameters.\n* `SI` Specifies the SI unit system. Location level values will be in the default SI units for their parameters.\n* `Other` Any unit returned in the response to the units URI request that is appropriate for the requested parameters. ","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/LocationLevel"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Levels"],"summary":"Delete levels with levelId","description":"Delete CWMS Location Level","operationId":"deleteLevelsWithLevelId","parameters":[{"name":"level-id","in":"path","description":"Specifies the location level id of the Location Level to be deleted","required":true,"schema":{"type":"string"}},{"name":"cascade-delete","in":"query","description":"Specifies whether to cascade the delete. Defaults to false.","schema":{"type":"boolean"}},{"name":"office","in":"query","description":"Specifies the owning office of the location level whose data is to be deleted. If this field is not specified, matching location level information will be deleted from all offices.","schema":{"type":"string"}},{"name":"effective-date","in":"query","description":"Specifies the effective date of the level to be deleted. If not provided will delete all data and reference to the location level.","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the value of the effective date field (unless otherwise specified).If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Levels"],"summary":"Patch levels with levelId","description":"Update CWMS Location Level","operationId":"patchLevelsWithLevelId","parameters":[{"name":"level-id","in":"path","description":"Specifies the location level id of the Location Level to be updated","required":true,"schema":{"type":"string"}},{"name":"effective-date","in":"query","description":"Specifies the effective date of Location Level that will be updated","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationLevel"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/levels":{"get":{"tags":["Levels"],"summary":"Get levels","operationId":"getLevels","parameters":[{"name":"level-id-mask","in":"query","description":"Specifies the name(s) of the location level(s) whose data is to be included in the response. Uses * for all.","schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the location level(s) whose data is to be included in the response. If this field is not specified, matching location level information from all offices shall be returned.","schema":{"type":"string"}},{"name":"unit","in":"query","description":"Specifies the unit or unit system of the response. Valid values for the unit field are:\n* `EN` Specifies English unit system. Location level values will be in the default English units for their parameters.\n* `SI` Specifies the SI unit system. Location level values will be in the default SI units for their parameters. \n\nThe default unit system is SI.","schema":{"type":"string"}},{"name":"datum","in":"query","description":"Specifies the elevation datum of the response. This field affects only elevation location levels. Valid values for this field are:\n* `NAVD88` The elevation values will in the specified or default units above the NAVD-88 datum.\n* `NGVD29` The elevation values will be in the specified or default units above the NGVD-29 datum.","schema":{"type":"string"}},{"name":"begin","in":"query","description":"Specifies the start of the time window for data to be included in the response. If this field is not specified, no beginning time will be used.","schema":{"type":"string"}},{"name":"end","in":"query","description":"Specifies the end of the time window for data to be included in the response. If this field is not specified, no end time will be used.","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified), as well as the time zone of any times in the response. If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"format","in":"query","description":"Specifies the encoding format of the response. Requests specifying an Accept header:application/json;version=2 must not include this field. Valid format field values for this URI are:\n* `tab`\n* `csv`\n* `xml`\n* `wml2` (only if name field is specified)\n* `json` (default)\n\nSee this page for more information about accept header usage.","schema":{"type":"string"}},{"name":"include-aliases","in":"query","description":"Whether to include the aliases for the location levels in the response. The default is false.","schema":{"type":"boolean"}},{"name":"page","in":"query","description":"This identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 100.","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unit"}},"":{"schema":{"$ref":"#/components/schemas/Unit"}},"application/json;version=2":{"schema":{"$ref":"#/components/schemas/LocationLevels"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Levels"],"summary":"Post levels","description":"Create new CWMS Location Level","operationId":"postLevels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationLevel"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/levels/{level-id}/timeseries":{"get":{"tags":["Levels"],"summary":"Get levels with levelId timeseries","description":"Retrieves requested Location Level","operationId":"getLevelsWithLevelIdTimeseries","parameters":[{"name":"level-id","in":"path","description":"Specifies the requested location level.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the office of the Location Level to be returned","required":true,"schema":{"type":"string"}},{"name":"interval","in":"query","description":"Interval time step for the returned time series. Pseudo-regular interval definitions will be treated like local regular. Irregular interval will generate daily time steps. Default: 0","schema":{"type":"string"}},{"name":"begin","in":"query","description":"Specifies the start of the time window for data to be included in the response. If this field is not specified, any required time window begins 24 hours prior to the specified or default end time. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","schema":{"type":"string"}},{"name":"end","in":"query","description":"Specifies the end of the time window for data to be included in the response. If this field is not specified, any required time window ends at the current time. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified), as well as the time zone of any times in the response. If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if begin was specified with offset and timezone.","schema":{"type":"string"}},{"name":"unit","in":"query","description":"Desired unit for the values retrieved.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid parameter combination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a timeseries.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A CWMS Time Series representation of the specified location level.","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"":{"schema":{"$ref":"#/components/schemas/TimeSeries"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/recent":{"get":{"tags":["TimeSeries"],"summary":"Get timeseries recent","description":"Returns CWMS Timeseries Groups Data","operationId":"getTimeseriesRecent","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the timeseries group(s) whose data is to be included in the response. If this field is not specified, matching timeseries groups information from all offices shall be returned.","schema":{"type":"string"}},{"name":"category-id","in":"query","description":"Specifies the category id of the timeseries to be included in the response. Optional.","schema":{"type":"string"}},{"name":"group-id","in":"query","description":"Specifies the group id of the timeseries to be included in the response. Optional.","schema":{"type":"string"}},{"name":"ts-ids","in":"query","description":"Accepts a comma separated list of timeseries ids to be included in the response. Optional. Cannot be used in combination with category_id and group_id.","schema":{"type":"string"}},{"name":"unit-system","in":"query","description":"Unit System desired in response. Can be SI (International Scientific) or EN (Imperial.) If unspecified, defaults to EN.","schema":{"$ref":"#/components/schemas/UnitSystem"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the timeseries group(s) were not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tsv"}}}}},"501":{"description":"request format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/filtered":{"get":{"tags":["TimeSeries"],"summary":"Get timeseries filtered","operationId":"getTimeseriesFiltered","parameters":[{"name":"name","in":"query","description":"Specifies the name of the time series whose data is to be included in the response. A case insensitive comparison is used to match names.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the time series(s) whose data is to be included in the response. Required for:application/json;version=2 and application/xml;version=2. For other formats, if this field is not specified, matching location level information from all offices shall be returned.","schema":{"type":"string"}},{"name":"unit","in":"query","description":"Specifies the unit or unit system of the response. Valid values for the unit field are: \n* `EN` (default) Specifies English unit system. Location level values will be in the default English units for their parameters.\n* `SI` Specifies the SI unit system. Location level values will be in the default SI units for their parameters.\n* `Other` Any unit returned in the response to the units URI request that is appropriate for the requested parameters.","schema":{"type":"string"}},{"name":"version-date","in":"query","description":"Specifies the version date of a time series trace to be selected. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. If field is empty, query will return a max aggregate for the timeseries. Only supported for:application/json;version=2 and application/xml;version=2","schema":{"type":"string"}},{"name":"begin","in":"query","description":"Specifies the start of the time window for data to be included in the response. If this field is not specified, any required time window begins 24 hours prior to the specified or default end time. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","schema":{"type":"string"}},{"name":"end","in":"query","description":"Specifies the end of the time window for data to be included in the response. If this field is not specified, any required time window ends at the current time. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified). For application/json;version=2 and application/xml;version=2 the results are returned in UTC. For other formats this parameter affects the time zone of times in the response. If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if begin was specified with offset and timezone.","schema":{"type":"string"}},{"name":"trim","in":"query","description":"Specifies whether to trim missing values from the beginning and end of the retrieved values. Only supported for:application/json;version=2 and application/xml;version=2. Default is true.","schema":{"type":"boolean"}},{"name":"include-entry-date","in":"query","description":"Specifies whether to include the data entry date of each value in the response. Including the data entry date will increase the size of the array containing each data value from three to four, changing the format of the response. Default is false.","schema":{"type":"boolean"}},{"name":"query","in":"query","description":"Specifies an RSQL-like query string to filter the results. Expressions may reference \"value, date_time, quality, data_entry_date\". Example Queries:\n* `value!=null` Excludes null values\n* `date_time>2020-04-01T00:00:00Z and date_time<2024-04-01T00:00:00Z` Returns values within a date range.\n* `data_entry_date=2025-05-15T00:00:00Z` Returns data entered at a specific data_entry_date\n* `value>=0 and value < 215.0` Returns points when the value is within a specified range.\n* `value<0 or value > 215.0` Returns points when the value is outside a specified range.\n* `(value==null or value<0) and date_time>2019-11-01T00:00:00Z and data_entry_date>2024-03-01T00:00:00Z and data_entry_date<2024-04-01T00:00:00Z` Find null or negative values for times after start of pandemic that were entered in March 2024.\n* `quality=in=(255,256,1023,1024)` Returns points with specific quality codes.","schema":{"type":"string"}},{"name":"page","in":"query","description":"This end point can return large amounts of data as a series of pages. This parameter is used to describes the current location in the response stream. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 500.","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid parameter combination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a timeseries.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of elements of the data set you've selected.","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"":{"schema":{"$ref":"#/components/schemas/TimeSeries"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/standard-text-id/{standard-text-id}":{"get":{"tags":["Standard Text"],"summary":"Get standardTextId with standardTextId","description":"Retrieve a single Standard Text value","operationId":"getStandardTextIdWithStandardTextId","parameters":[{"name":"standard-text-id","in":"path","description":"Specifies the text id of the standard text to retrieve. Default includes all text ids","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of thestandard text. Default includes all offices","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/StandardTextValue"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Standard Text"],"summary":"Delete standardTextId with standardTextId","description":"Delete a single Standard Text value","operationId":"deleteStandardTextIdWithStandardTextId","parameters":[{"name":"standard-text-id","in":"path","description":"Specifies the text id of the standard text to delete","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of thestandard text.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used.","required":true,"schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/standard-text-id":{"get":{"tags":["Standard Text"],"summary":"Get standardTextId","description":"Retrieve a Standard Text catalog","operationId":"getStandardTextId","parameters":[{"name":"office-mask","in":"query","description":"Specifies the office filter of thestandard text.","schema":{"type":"string"}},{"name":"standard-text-id-mask","in":"query","description":"Specifies the text id filter of the standard text","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/StandardTextCatalog"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Standard Text"],"summary":"Post standardTextId","description":"Create new Standard Text","operationId":"postStandardTextId","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/StandardTextValue"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/text":{"get":{"tags":["Text-TimeSeries"],"summary":"Retrieve text time series values for a provided time window and date version.If individual values exceed 64 kilobytes, a URL to a separate download is provided instead of being included in the returned payload from this request.","operationId":"getTimeseriesText","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the Text TimeSeries whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Specifies the ts-id of the text timeseries","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TextTimeSeries"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Text-TimeSeries"],"summary":"Post timeseries text","description":"Create new TextTimeSeries","operationId":"postTimeseriesText","parameters":[{"name":"replace-all","in":"query","description":"Whether to replace any and all existing text with the specified text. Default is false","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TextTimeSeries"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/text/{name}":{"delete":{"tags":["Text-TimeSeries"],"summary":"Delete timeseries text with name","description":"Deletes requested text timeseries id","operationId":"deleteTimeseriesTextWithName","parameters":[{"name":"name","in":"path","description":"The time series identifier to be deleted","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the timeseries identifier to be deleted","required":true,"schema":{"type":"string"}},{"name":"text-mask","in":"query","description":"The standard text pattern to match. Use glob-style wildcard characters instead of sql-style wildcard characters for pattern matching. For StandardTextTimeSeries this should be the Standard_Text_Id (such as 'E' for ESTIMATED)","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window.","required":true,"schema":{"type":"string"}},{"name":"version-date","in":"query","description":"The version date for the time series. If not specified, maximum version date is used.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Text-TimeSeries"],"summary":"Patch timeseries text with name","description":"Updates a text timeseries","operationId":"patchTimeseriesTextWithName","parameters":[{"name":"name","in":"path","description":"The id of the text timeseries to be updated","required":true,"schema":{"type":"string"}},{"name":"replace-all","in":"query","description":"Whether to replace any and all existing text with the specified text. Default is:true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TextTimeSeries"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/text/{name}/value":{"get":{"tags":["Text-TimeSeries"],"summary":"Get timeseries text with name value","operationId":"getTimeseriesTextWithNameValue","parameters":[{"name":"name","in":"path","description":"Specifies the id of the text timeseries","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the Text TimeSeries whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"date","in":"query","description":"The date of the text value to retrieve","required":true,"schema":{"type":"string"}},{"name":"version-date","in":"query","description":"The version date for the value to retrieve.","schema":{"type":"string"}},{"name":"clob-id","in":"query","description":"Will be removed in a schema update. This is a placeholder for integration testing with schema 23.3.16","deprecated":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/binary":{"get":{"tags":["Binary-TimeSeries"],"summary":"Retrieve binary time series values for a provided time window and date version.If individual values exceed 64 kilobytes, a URL to a separate download is provided instead of being included in the returned payload from this request.","operationId":"getTimeseriesBinary","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the Binary TimeSeries whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Specifies the id of the binary timeseries","required":true,"schema":{"type":"string"}},{"name":"binary-type-mask","in":"query","description":"The data type pattern expressed as either an internet media type (e.g. 'image/*') or a file extension (e.g. '.*'). Use glob-style wildcard characters as shown above instead of sql-style wildcard characters for pattern matching. Default is:*","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window","required":true,"schema":{"type":"string"}},{"name":"version-date","in":"query","description":"The version date for the time series.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/BinaryTimeSeries"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Binary-TimeSeries"],"summary":"Post timeseries binary","description":"Create new BinaryTimeSeries","operationId":"postTimeseriesBinary","parameters":[{"name":"replace-all","in":"query","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/BinaryTimeSeries"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/binary/{name}":{"delete":{"tags":["Binary-TimeSeries"],"summary":"Delete timeseries binary with name","description":"Deletes requested binary timeseries id","operationId":"deleteTimeseriesBinaryWithName","parameters":[{"name":"name","in":"path","description":"The time series identifier to be deleted","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the timeseries identifier to be deleted","required":true,"schema":{"type":"string"}},{"name":"binary-type-mask","in":"query","description":"The data type pattern expressed as either an internet media type (e.g. 'image/*') or a file extension (e.g. '.*'). Use glob-style wildcard characters as shown above instead of sql-style wildcard characters for pattern matching. Default:*","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window. ","required":true,"schema":{"type":"string"}},{"name":"version-date","in":"query","description":"The version date for the time series. If not specified, the maximum version date is used.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Binary-TimeSeries"],"summary":"Patch timeseries binary with name","description":"Updates a binary timeseries","operationId":"patchTimeseriesBinaryWithName","parameters":[{"name":"name","in":"path","description":"The id of the binary timeseries to be updated","required":true,"schema":{"type":"string"}},{"name":"replace-all","in":"query","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/BinaryTimeSeries"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/binary/{name}/value":{"get":{"tags":["Binary-TimeSeries"],"summary":"Get timeseries binary with name value","operationId":"getTimeseriesBinaryWithNameValue","parameters":[{"name":"name","in":"path","description":"Specifies the id of the binary timeseries","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the Binary TimeSeries whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"date","in":"query","description":"The date of the binary value to retrieve","required":true,"schema":{"type":"string"}},{"name":"version-date","in":"query","description":"The version date for the value to retrieve.","schema":{"type":"string"}},{"name":"blob-id","in":"query","description":"Will be removed in a schema update. This is a placeholder for integration testing with schema 23.3.16","deprecated":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/profile/{location-id}/{parameter-id}":{"get":{"tags":["TimeSeries"],"summary":"Get a time series profile","operationId":"getTimeseriesProfileWithLocationIdWithParameterId","parameters":[{"name":"location-id","in":"path","description":"The location ID associated with the time series profile","required":true,"schema":{"type":"string"}},{"name":"parameter-id","in":"path","description":"The key parameter ID associated with the time series profile","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"The office ID associated with the time series profile","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A TimeSeriesProfileParser object","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfile"}},"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfile"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["TimeSeries"],"summary":"Delete a time series profile","operationId":"deleteTimeseriesProfileWithLocationIdWithParameterId","parameters":[{"name":"location-id","in":"path","description":"The location ID associated with the time series profile","required":true,"schema":{"type":"string"}},{"name":"parameter-id","in":"path","description":"The key parameter associated with the time series profile","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"The office associated with the time series profile","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Time series profile not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Time series profile deleted"},"501":{"description":"Internal server error"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/profile":{"get":{"tags":["TimeSeries"],"summary":"Get a catalog of time series profiles","operationId":"getTimeseriesProfile","parameters":[{"name":"office-mask","in":"query","description":"The office mask for the time series profile. Default is *","schema":{"type":"string"}},{"name":"location-mask","in":"query","description":"The location mask for the time series profile. Default is *","schema":{"type":"string"}},{"name":"parameter-id-mask","in":"query","description":"The key parameter mask for the time series profile. Default is *","schema":{"type":"string"}},{"name":"page","in":"query","description":"The page cursor. Default is null","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"The page size. Default is 500","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"No data matching input parameters found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A TimeSeriesProfile object","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfileList"}},"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfileList"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["TimeSeries"],"summary":"Create a new time series profile","operationId":"postTimeseriesProfile","parameters":[{"name":"fail-if-exists","in":"query","description":"If true, the parser will fail to save if the TimeSeriesProfile already exists. Default true.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfile"}}}},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/profile-parser/{location-id}/{parameter-id}":{"get":{"tags":["TimeSeries"],"summary":"Get a TimeSeriesProfile Parser by ID","operationId":"getTimeseriesProfileParserWithLocationIdWithParameterId","parameters":[{"name":"location-id","in":"path","description":"The location ID associated with the TimeSeriesProfile","required":true,"schema":{"type":"string"}},{"name":"parameter-id","in":"path","description":"The ID of the TimeSeriesProfileParser","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"The office associated with the TimeSeriesProfile","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a TimeSeriesProfileParser object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A TimeSeriesProfileParser object","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfileParser"}},"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfileParser"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["TimeSeries"],"summary":"Delete a TimeSeriesProfile Parser by ID","operationId":"deleteTimeseriesProfileParserWithLocationIdWithParameterId","parameters":[{"name":"location-id","in":"path","description":"The location ID associated with the TimeSeriesProfile","required":true,"schema":{"type":"string"}},{"name":"parameter-id","in":"path","description":"The parameter ID of the TimeSeriesProfileParser parameter","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"The office associated with the TimeSeriesProfile","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided ID did not find a TimeSeriesProfileParser object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"The TimeSeriesProfileParser was successfully deleted"},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/profile-parser":{"get":{"tags":["TimeSeries"],"summary":"Retrieve a list of TimeSeries Profile Parsers that match the provided mask parameters","operationId":"getTimeseriesProfileParser","parameters":[{"name":"parameter-id-mask","in":"query","description":"The ID mask of the TimeSeriesProfileParser parameter. Default is *","schema":{"type":"string"}},{"name":"office-mask","in":"query","description":"The office mask associated with the TimeSeriesProfile. Default is *","schema":{"type":"string"}},{"name":"location-mask","in":"query","description":"The location ID mask associated with the TimeSeriesProfile. Default is *","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a TimeSeriesProfileParser object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A TimeSeriesProfileParser object","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeSeriesProfileParser"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeSeriesProfileParser"}}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["TimeSeries"],"summary":"Store a TimeSeriesProfile Parser","operationId":"postTimeseriesProfileParser","parameters":[{"name":"fail-if-exists","in":"query","description":"If true, the parser will fail to save if the TimeSeriesProfileParser already exists","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfileParserIndexed"}},"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfileParserColumnar"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/profile-instance/{location-id}/{parameter-id}/{version}":{"get":{"tags":["TimeSeries"],"summary":"Get a time series profile instance that matches the provided parameters.","operationId":"getTimeseriesProfileInstanceWithLocationIdWithParameterIdWithVersion","parameters":[{"name":"location-id","in":"path","description":"The location ID of the time series profile instance.","required":true,"schema":{"type":"string"}},{"name":"parameter-id","in":"path","description":"The key parameter of the time series profile instance.","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"The version of the time series profile instance.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"The office associated with the time series profile instance.","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"version-date","in":"query","description":"The version date of the time series profile instance. Accepts ISO8601 formats. Default is the min or max version date, depending on the maxVersion","schema":{"type":"string","format":"date-time"}},{"name":"unit","in":"query","description":"The units of the time series profile instance. Provided as a list separated by ','","required":true,"schema":{"type":"string"}},{"name":"start-time-inclusive","in":"query","description":"The start inclusive of the time series profile instance. Default is true","schema":{"type":"boolean"}},{"name":"end-time-inclusive","in":"query","description":"The end inclusive of the time series profile instance. Default is true","schema":{"type":"boolean"}},{"name":"previous","in":"query","description":"Whether to include the previous time window of the time series profile instance. Default is false","schema":{"type":"boolean"}},{"name":"next","in":"query","description":"Whether to include the next time window of the time series profile instance. Default is false","schema":{"type":"boolean"}},{"name":"max-version","in":"query","description":"Whether to use the max version date of the time series profile instance. Default is false. If no version date is provided, and maxVersion is false, the min version date will be used.","schema":{"type":"boolean"}},{"name":"start","in":"query","description":"The start of the time series profile instance.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"end","in":"query","description":"The end of the time series profile instance.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"The page of the time series profile instance.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"The page size of the time series profile instance. Default is 500","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A TimeSeriesProfileParser object","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfileInstance"}},"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfileInstance"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["TimeSeries"],"summary":"Delete a time series profile instance","operationId":"deleteTimeseriesProfileInstanceWithLocationIdWithParameterIdWithVersion","parameters":[{"name":"location-id","in":"path","description":"The location ID of the time series profile instance.","required":true,"schema":{"type":"string"}},{"name":"parameter-id","in":"path","description":"The key parameter of the time series profile instance.","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"The version of the time series profile instance.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"The office associated with the time series profile instance.","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields. If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"version-date","in":"query","description":"The version date of the time series profile instance. Accepts ISO8601 format.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"date","in":"query","description":"The first date of the time series profile instance.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"override-protection","in":"query","description":"Override protection for the time series profile instance. Default is true","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/profile-instance":{"get":{"tags":["TimeSeries"],"summary":"Get all time series profile instances that match the provided masks. This endpoint will return a list of time series profile instances without the associated data. Data for an instance can be retrieved using the singular retrieval endpoint.","operationId":"getTimeseriesProfileInstance","parameters":[{"name":"office-mask","in":"query","description":"The office mask of the time series profile instance. Default is *","schema":{"type":"string"}},{"name":"location-mask","in":"query","description":"The location ID mask of the time series profile instance. Default is *","schema":{"type":"string"}},{"name":"parameter-id-mask","in":"query","description":"The parameter ID mask of the time series profile instance. Default is *","schema":{"type":"string"}},{"name":"version-mask","in":"query","description":"The version mask of the time series profile instance. Default is *","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A TimeSeriesProfileInstance object","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfileInstance"}},"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfileInstance"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["TimeSeries"],"summary":"Create a new time series profile instance by parsing provided data","operationId":"postTimeseriesProfileInstance","parameters":[{"name":"method","in":"query","description":"The method of storing the time series profile instance. Default is REPLACE_ALL","schema":{"$ref":"#/components/schemas/StoreRule"}},{"name":"override-protection","in":"query","description":"Override protection for the time series profile instance. Default is false","schema":{"type":"boolean"}},{"name":"version-date","in":"query","description":"The version date of the time series profile instance. Accepts ISO8601 format.","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"profile-data","in":"query","description":"The profile data of the time series profile instance","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"The version of the time series profile instance.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesProfile"}}}},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Time series profile instance created"},"409":{"description":"Time series profile instance already exists"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/category/{category-id}":{"get":{"tags":["TimeSeries Categories"],"summary":"Get timeseries category with categoryId","description":"Retrieves requested timeseries category","operationId":"getTimeseriesCategoryWithCategoryId","parameters":[{"name":"category-id","in":"path","description":"Specifies the Category whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the timeseries category whose data is to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the timeseries category was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesCategory"}}}},"501":{"description":"request format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["TimeSeries Categories"],"summary":"Delete timeseries category with categoryId","description":"Deletes requested time series category","operationId":"deleteTimeseriesCategoryWithCategoryId","parameters":[{"name":"category-id","in":"path","description":"The time series category to be deleted","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the time series category to be deleted","required":true,"schema":{"type":"string"}},{"name":"cascade-delete","in":"query","description":"Specifies whether to delete any time series groups in this time series category. Default: false","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/category":{"get":{"tags":["TimeSeries Categories"],"summary":"Get timeseries category","description":"Returns CWMS timeseries category Data","operationId":"getTimeseriesCategory","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the timeseries category(ies) whose data is to be included in the response. If this field is not specified, matching timeseries category information from all offices shall be returned.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the categories were not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeSeriesCategory"}}}}},"501":{"description":"request format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["TimeSeries Categories"],"summary":"Post timeseries category","description":"Create new TimeSeriesCategory","operationId":"postTimeseriesCategory","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesCategory"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/identifier-descriptor/{timeseries-id}":{"get":{"tags":["TimeSeries Identifier"],"summary":"Get timeseries identifierDescriptor with timeseriesId","description":"Retrieves requested timeseries identifier descriptor","operationId":"getTimeseriesIdentifierDescriptorWithTimeseriesId","parameters":[{"name":"timeseries-id","in":"path","description":"Specifies the identifier of the timeseries to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the timeseries identifier to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the timeseries identifier descriptor was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeriesIdentifierDescriptor"}}}},"501":{"description":"request format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["TimeSeries Identifier"],"summary":"Delete timeseries identifierDescriptor with timeseriesId","description":"Deletes requested timeseries identifier","operationId":"deleteTimeseriesIdentifierDescriptorWithTimeseriesId","parameters":[{"name":"timeseries-id","in":"path","description":"The timeseries-id of the timeseries to be deleted. ","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the timeseries to be deleted.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used.","required":true,"schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["TimeSeries Identifier"],"summary":"Patch timeseries identifierDescriptor with timeseriesId","operationId":"patchTimeseriesIdentifierDescriptorWithTimeseriesId","parameters":[{"name":"timeseries-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The timeseries id","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the timeseries identifier to be updated","required":true,"schema":{"type":"string"}},{"name":"timeseries-id","in":"query","description":"A new timeseries-id. If specified a rename operation will be performed and snap-forward, snap-backward, and active must not be provided","schema":{"type":"string"}},{"name":"interval-offset","in":"query","description":"The offset into the data interval in minutes. If specified and a new timeseries-id is also specified both will be passed to a rename operation. May also be passed to update operation.","schema":{"type":"integer","format":"int64"}},{"name":"snap-forward","in":"query","description":"The new snap forward tolerance in minutes. This specifies how many minutes before the expected data time that data will be considered to be on time.","schema":{"type":"integer","format":"int64"}},{"name":"snap-backward","in":"query","description":"The new snap backward tolerance in minutes. This specifies how many minutes after the expected data time that data will be considered to be on time.","schema":{"type":"integer","format":"int64"}},{"name":"active","in":"query","description":"'True' or 'true' if the time series is active","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/identifier-descriptor":{"get":{"tags":["TimeSeries Identifier"],"summary":"Get timeseries identifierDescriptor","description":"Returns CWMS timeseries identifier descriptorData. Currently includes aliased items in results.","operationId":"getTimeseriesIdentifierDescriptor","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the timeseries identifier(s) whose data is to be included in the response. If this field is not specified, matching timeseries identifier information from all offices shall be returned.","schema":{"type":"string"}},{"name":"timeseries-id-regex","in":"query","description":"A case insensitive RegExp that will be applied to the timeseries-id field. If this field is not specified the results will not be constrained by timeseries-id.","schema":{"type":"string"}},{"name":"include-aliases","in":"query","description":"Specifies whether to include aliased items as content in the results. Default is false.","schema":{"type":"boolean"}},{"name":"page","in":"query","description":"This end point can return a lot of data, this identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 500.","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the time series identifier descriptors were not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeriesIdentifierDescriptors"}}}},"501":{"description":"request format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["TimeSeries Identifier"],"summary":"Post timeseries identifierDescriptor","description":"Create new TimeSeriesIdentifierDescriptor","operationId":"postTimeseriesIdentifierDescriptor","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeriesIdentifierDescriptor"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeriesIdentifierDescriptor"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/group/{group-id}":{"get":{"tags":["Timeseries Groups"],"summary":"Get timeseries group with groupId","description":"Retrieves requested timeseries group","operationId":"getTimeseriesGroupWithGroupId","parameters":[{"name":"group-id","in":"path","description":"Specifies the timeseries group whose data is to be included in the response","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the timeseries assigned to the group whose data is to be included in the response. This will limit the assigned timeseries returned to only those assigned to the specified office.","required":true,"schema":{"type":"string"}},{"name":"category-office-id","in":"query","description":"Specifies the owning office of the timeseries group category","required":true,"schema":{"type":"string"}},{"name":"group-office-id","in":"query","description":"Specifies the owning office of the timeseries group","required":true,"schema":{"type":"string"}},{"name":"category-id","in":"query","description":"Specifies the category containing the timeseries group whose data is to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesGroup"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Timeseries Groups"],"summary":"Delete timeseries group with groupId","description":"Deletes requested time series group","operationId":"deleteTimeseriesGroupWithGroupId","parameters":[{"name":"group-id","in":"path","description":"The time series group to be deleted","required":true,"schema":{"type":"string"}},{"name":"category-id","in":"query","description":"Specifies the time series category of the time series group to be deleted","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the time series group to be deleted","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Timeseries Groups"],"summary":"Patch timeseries group with groupId","description":"Update existing TimeSeriesGroup. Allows for renaming of the group, assigning new time series, and unassigning all time series from the group.","operationId":"patchTimeseriesGroupWithGroupId","parameters":[{"name":"group-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"replace-assigned-ts","in":"query","description":"Specifies whether to unassign all existing time series before assigning new time series specified in the content body Default: false","schema":{"type":"boolean"}},{"name":"office","in":"query","description":"Specifies the office of the user making the request. This is the office that the timeseries, group, and category belong to. If the group and/or category belong to the CWMS office, this only identifies the timeseries.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesGroup"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/group":{"get":{"tags":["Timeseries Groups"],"summary":"Get timeseries group","description":"Returns CWMS Timeseries Groups Data","operationId":"getTimeseriesGroup","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the timeseries assigned to the group(s) whose data is to be included in the response. If this field is not specified, group information for all assigned TS offices shall be returned.","schema":{"type":"string"}},{"name":"include-assigned","in":"query","description":"Include the assigned timeseries in the returned timeseries groups. (default: true)","schema":{"type":"boolean"}},{"name":"timeseries-category-like","in":"query","description":"Posix regular expression matching against the timeseries category id","schema":{"type":"string"}},{"name":"category-office-id","in":"query","description":"Specifies the owning office of the timeseries group category","schema":{"type":"string"}},{"name":"timeseries-group-like","in":"query","description":"Posix regular expression matching against the timeseries group id","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the timeseries group(s) were not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeSeriesGroup"}}}}},"501":{"description":"request format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Timeseries Groups"],"summary":"Post timeseries group","description":"Create new TimeSeriesGroup","operationId":"postTimeseriesGroup","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesGroup"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries":{"get":{"tags":["TimeSeries"],"summary":"Get timeseries","operationId":"getTimeseries","parameters":[{"name":"name","in":"query","description":"Specifies the name of the time series whose data is to be included in the response. A case insensitive comparison is used to match names.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the time series(s) whose data is to be included in the response. Required for:application/json;version=2 and application/xml;version=2. For other formats, if this field is not specified, matching location level information from all offices shall be returned.","schema":{"type":"string"}},{"name":"unit","in":"query","description":"Specifies the unit or unit system of the response. Valid values for the unit field are: \n* `EN` (default) Specifies English unit system. Location level values will be in the default English units for their parameters.\n* `SI` Specifies the SI unit system. Location level values will be in the default SI units for their parameters.\n* `Other` Any unit returned in the response to the units URI request that is appropriate for the requested parameters.","deprecated":true,"schema":{"type":"string"}},{"name":"units","in":"query","description":"Specifies the units or unit system of the response. Valid values for the units field are: \n* `EN` (default) Specifies English unit system. Location level values will be in the default English units for their parameters.\n* `SI` Specifies the SI unit system. Location level values will be in the default SI units for their parameters.\n* `Other` Any units returned in the response to the units URI request that is appropriate for the requested parameters.","schema":{"type":"string"}},{"name":"version-date","in":"query","description":"Specifies the version date of a time series trace to be selected. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.If field is empty, query will return a max aggregate for the timeseries. Only supported for:application/json;version=2 and application/xml;version=2","schema":{"type":"string"}},{"name":"datum","in":"query","description":"Specifies the elevation datum of the response. This field affects only elevation location levels. Valid values for this field are:\n* `NAVD88` The elevation values will in the specified or default units above the NAVD-88 datum.\n* `NGVD29` The elevation values will be in the specified or default units above the NGVD-29 datum. This parameter is not supported for:application/json;version=2 or application/xml;version=2","schema":{"type":"string"}},{"name":"begin","in":"query","description":"Specifies the start of the time window for data to be included in the response. If this field is not specified, any required time window begins 24 hours prior to the specified or default end time. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","schema":{"type":"string"}},{"name":"end","in":"query","description":"Specifies the end of the time window for data to be included in the response. If this field is not specified, any required time window ends at the current time. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified). For application/json;version=2 and application/xml;version=2 the results are returned in UTC. For other formats this parameter affects the time zone of times in the response. If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if begin was specified with offset and timezone.","schema":{"type":"string"}},{"name":"trim","in":"query","description":"Specifies whether to trim missing values from the beginning and end of the retrieved values. Only supported for:application/json;version=2 and application/xml;version=2. Default is true.","schema":{"type":"boolean"}},{"name":"format","in":"query","description":"Specifies the encoding format of the response. Valid values for the format field for this URI are:\n* `tab`\n* `csv`\n* `xml`\n* `wml2` (only if name field is specified)\n* `json` (default)\n\nSee this page for more information about accept header usage.","schema":{"type":"string"}},{"name":"include-entry-date","in":"query","description":"Specifies whether to include the data entry date of each value in the response. Including the data entry date will increase the size of the array containing each data value from three to four, changing the format of the response. Default is false.","schema":{"type":"boolean"}},{"name":"page","in":"query","description":"This end point can return large amounts of data as a series of pages. This parameter is used to describes the current location in the response stream. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 500.","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid parameter combination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a timeseries.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of elements of the data set you've selected.","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"":{"schema":{"$ref":"#/components/schemas/TimeSeries"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["TimeSeries"],"summary":"Post timeseries","description":"Used to create and save time-series data. Data to be stored must have time stamps in UTC represented as epoch milliseconds. If data entry date is included in the request, it will be dropped. ","operationId":"postTimeseries","parameters":[{"name":"timezone","in":"query","description":"Specifies the time zone of the version-date field (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if version-date was specified with offset and timezone.","schema":{"type":"string"}},{"name":"create-as-lrts","in":"query","description":"Flag indicating if timeseries should be created as Local Regular Time Series. 'True' or 'False', default is 'False'","schema":{"type":"boolean"}},{"name":"store-rule","in":"query","description":"The business rule to use when merging the incoming with existing data\n\n\n\n \n \n\n\n \n \n\n\n \n \n\n \n \n\n \n \n\n
Store Rules
Delete InsertAll existing data in the time window will be deleted and then replaced with the new dataset.
Replace All\n
    \n
  • When the new dataset's date/time exactly matches the date/time of an existing data value, the new data value will replace the existing data.
    • \n
  • When the new dataset's data/time does not match an existing data/time (i.e., a new data/time - data value pair) then an insert to the database will occur.
    • \n
  • When there's an existing \"data/time - data value pair\" without a corresponding date/time value pair, no change will happen to the existing date/time value pair.
    • \n
\n
Replace With Non Missing\n
    \n
  • New data is always inserted, i.e., an existing date/time-value pair does not already exist for the record.
    • \n
  • If date/time-value pair does exist, then only non-missing value will replace the existing data value*.
    • \n
\n
Replace Missing Values Only\n
    \n
  • New data is always inserted, i.e., an existing date/time-value pair does not already exist for the record.
    • \n
  • If date/time-value pair does exist, then only replace an existing data/time-value pair whose missing flag was set.
    • \n
\n
Do Not Replace\n Only inserts new data values if an existing date/time-value pair does not already exist.\n Note: an existing date/time-value pair whose missing value quality bit is set will NOT be overwritten.\n
","schema":{"$ref":"#/components/schemas/StoreRule"}},{"name":"override-protection","in":"query","description":"A flag to ignore the protected data quality when storing data. 'True' or 'False', default is true","schema":{"type":"boolean"}},{"name":"datum","in":"query","description":"If the provided time-series includes an explicit vertical-datum-info attribute then it is assumed that the data is in the datum specified by the vertical-datum-info. If the input timeseries does not include vertical-datum-info and this parameter is not provided it is assumed that the data is in the as-stored datum and no conversion is necessary. If the input timeseries does not include vertical-datum-info and this parameter is provided it is assumed that the data is in the Datum named by the argument and should be converted to the as-stored datum before being saved.","schema":{"$ref":"#/components/schemas/VerticalDatum"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeries"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/timeseries/{timeseries}":{"delete":{"tags":["TimeSeries"],"summary":"Delete timeseries with timeseries","operationId":"deleteTimeseriesWithTimeseries","parameters":[{"name":"timeseries","in":"path","description":"The timeseries-id of the timeseries values to be deleted. ","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the office of the timeseries to be deleted.","required":true,"schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window to delete. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window to delete. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"This field specifies a default timezone to be used if the format of the begin, end, or version-date parameters do not include offset or time zone information. Defaults to UTC.","schema":{"type":"string"}},{"name":"version-date","in":"query","description":"The version date/time of the time series in the specified or default time zone. If NULL, the earliest or latest version date will be used depending on p_max_version.","schema":{"type":"string"}},{"name":"start-time-inclusive","in":"query","description":"A flag specifying whether any data at the start time should be deleted ('True') or only data after the start time ('False'). Default value is True","schema":{"type":"boolean"}},{"name":"end-time-inclusive","in":"query","description":"A flag ('True'/'False') specifying whether any data at the end time should be deleted ('True') or only data before the end time ('False'). Default value is False","schema":{"type":"boolean"}},{"name":"max-version","in":"query","description":"A flag ('True'/'False') specifying whether to use the earliest ('False') or latest ('True') version date for each time if p_version_date is NULL. Default is 'True'","schema":{"type":"boolean"}},{"name":"override-protection","in":"query","description":"A flag ('True'/'False') specifying whether to delete protected data. Default is False","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["TimeSeries"],"summary":"Patch timeseries with timeseries","description":"Update a TimeSeries with provided values","operationId":"patchTimeseriesWithTimeseries","parameters":[{"name":"timeseries","in":"path","description":"Full CWMS Timeseries name","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the version-date field (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if version-date was specified with offset and timezone.","schema":{"type":"string"}},{"name":"create-as-lrts","in":"query","description":"","schema":{"type":"boolean"}},{"name":"store-rule","in":"query","description":"The business rule to use when merging the incoming with existing data\n\n\n\n \n \n\n\n \n \n\n\n \n \n\n \n \n\n \n \n\n
Store Rules
Delete InsertAll existing data in the time window will be deleted and then replaced with the new dataset.
Replace All\n
    \n
  • When the new dataset's date/time exactly matches the date/time of an existing data value, the new data value will replace the existing data.
    • \n
  • When the new dataset's data/time does not match an existing data/time (i.e., a new data/time - data value pair) then an insert to the database will occur.
    • \n
  • When there's an existing \"data/time - data value pair\" without a corresponding date/time value pair, no change will happen to the existing date/time value pair.
    • \n
\n
Replace With Non Missing\n
    \n
  • New data is always inserted, i.e., an existing date/time-value pair does not already exist for the record.
    • \n
  • If date/time-value pair does exist, then only non-missing value will replace the existing data value*.
    • \n
\n
Replace Missing Values Only\n
    \n
  • New data is always inserted, i.e., an existing date/time-value pair does not already exist for the record.
    • \n
  • If date/time-value pair does exist, then only replace an existing data/time-value pair whose missing flag was set.
    • \n
\n
Do Not Replace\n Only inserts new data values if an existing date/time-value pair does not already exist.\n Note: an existing date/time-value pair whose missing value quality bit is set will NOT be overwritten.\n
","schema":{"$ref":"#/components/schemas/StoreRule"}},{"name":"override-protection","in":"query","description":"A flag to ignore the protected data quality when storing data. \"'true' or 'false'\"","schema":{"type":"boolean"}},{"name":"datum","in":"query","description":"If the provided time-series includes an explicit vertical-datum-info attribute then it is assumed that the data is in the datum specified by the vertical-datum-info. If the input timeseries does not include vertical-datum-info and this parameter is not provided it is assumed that the data is in the as-stored datum and no conversion is necessary. If the input timeseries does not include vertical-datum-info and this parameter is provided it is assumed that the data is in the Datum named by the argument and should be converted to the as-stored datum before being saved.","schema":{"$ref":"#/components/schemas/VerticalDatum"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeries"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/TimeSeries"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/rate-values/{office}/{rating-id}":{"post":{"tags":["Ratings"],"summary":"Post ratings rateValues with office with ratingId","description":"Rates input values using CWMS ratings. The input format `RatingInputValues` includes a two dimensional array with each dimension corresponding to an independent parameter in the rating curve. The output format `RatedOutputTimeSeries` will contain a singular double array corresponding to the dependent parameter of the rating curve. ","operationId":"postRatingsRateValuesWithOfficeWithRatingId","parameters":[{"name":"office","in":"path","description":"Office owning the rating","required":true,"schema":{"type":"string"}},{"name":"rating-id","in":"path","description":"Rating Specification identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateInputValues"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/RateInputValues"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Client is not authorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The rating curve was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatedOutputValues"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/RatedOutputValues"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/rate-ts/{office}/{rating-id}":{"post":{"tags":["Ratings"],"summary":"Post ratings rateTs with office with ratingId","description":"Rates input values using CWMS ratings. The input format `RateInputTimeSeries` DTO supports an array of CWMS time series ids, each corresponding to an independent parameter in the rating curve.The output format `RatedOutputTimeSeries` will contain a singular double array corresponding to the dependent parameter of the rating curve. ","operationId":"postRatingsRateTsWithOfficeWithRatingId","parameters":[{"name":"office","in":"path","description":"Office owning the rating","required":true,"schema":{"type":"string"}},{"name":"rating-id","in":"path","description":"Rating Specification identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateInputTimeSeries"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/RateInputTimeSeries"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Client is not authorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The rating curve was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatedOutputTimeSeries"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/RatedOutputTimeSeries"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/reverse-rate-values/{office}/{rating-id}":{"post":{"tags":["Ratings"],"summary":"Post ratings reverseRateValues with office with ratingId","description":"Reverse rates input values using CWMS ratings. The input format `RateInputValues` requires a singular array of doubles corresponding to the dependent parameter in the rating curve. The output format `RatedOutputValues` will contain a singular double array corresponding to the independent parameter of the rating curve. Note: This endpoint only works on monotonically increase/decreasing table ratings with a single independent parameter.","operationId":"postRatingsReverseRateValuesWithOfficeWithRatingId","parameters":[{"name":"office","in":"path","description":"Office owning the rating","required":true,"schema":{"type":"string"}},{"name":"rating-id","in":"path","description":"Rating Specification identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateInputValues"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/RateInputValues"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Client is not authorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The rating or input time series were not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatedOutputValues"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/RatedOutputValues"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/reverse-rate-ts/{office}/{rating-id}":{"post":{"tags":["Ratings"],"summary":"Post ratings reverseRateTs with office with ratingId","description":"Reverse rates input values using CWMS ratings. The input format `RateInputTimeSeries` requires a singular time series id corresponding to the dependent parameter in the rating curve. The output format `RatedOutputTimeSeries` will contain a singular double array corresponding to the independent parameter of the rating curve. Note: This endpoint only works on monotonically increase/decreasing table ratings with a single independent parameter.","operationId":"postRatingsReverseRateTsWithOfficeWithRatingId","parameters":[{"name":"office","in":"path","description":"Office owning the rating","required":true,"schema":{"type":"string"}},{"name":"rating-id","in":"path","description":"Rating Specification identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateInputTimeSeries"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/RateInputTimeSeries"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid input parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Client is not authorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The rating or input time series were not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatedOutputTimeSeries"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/RatedOutputTimeSeries"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/template/{template-id}":{"get":{"tags":["Ratings"],"summary":"Get ratings template with templateId","operationId":"getRatingsTemplateWithTemplateId","parameters":[{"name":"template-id","in":"path","description":"Specifies the template whose data is to be included in the response","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the Rating Templates whose data is to be included in the response. If this field is not specified, matching rating information from all offices shall be returned.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RatingTemplate"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Ratings"],"summary":"Delete ratings template with templateId","description":"Deletes requested rating specification","operationId":"deleteRatingsTemplateWithTemplateId","parameters":[{"name":"template-id","in":"path","description":"The rating-template-id of the ratings data to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the ratings to be deleted.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used.","required":true,"schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/template":{"get":{"tags":["Ratings"],"summary":"Get ratings template","operationId":"getRatingsTemplate","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the Rating Templates whose data is to be included in the response. If this field is not specified, matching rating information from all offices shall be returned.","schema":{"type":"string"}},{"name":"template-id-mask","in":"query","description":"RegExp that specifies the rating template IDs to be included in the response. If this field is not specified, all rating templates shall be returned.","schema":{"type":"string"}},{"name":"page","in":"query","description":"This end point can return a lot of data, this identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 100.","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/RatingTemplates"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Ratings"],"summary":"Post ratings template","description":"Create new Rating Template","operationId":"postRatingsTemplate","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/RatingTemplate"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/spec/{rating-id}":{"get":{"tags":["Ratings"],"summary":"Get ratings spec with ratingId","operationId":"getRatingsSpecWithRatingId","parameters":[{"name":"rating-id","in":"path","description":"Specifies the rating-id of the Rating Spec to be included in the response","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the Rating Specs whose data is to be included in the response. If this field is not specified, matching rating information from all offices shall be returned.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/RatingSpec"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Ratings"],"summary":"Delete ratings spec with ratingId","description":"Deletes requested rating specification","operationId":"deleteRatingsSpecWithRatingId","parameters":[{"name":"rating-id","in":"path","description":"The rating-spec-id of the ratings data to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the ratings to be deleted.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used.","required":true,"schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/spec":{"get":{"tags":["Ratings"],"summary":"Get ratings spec","operationId":"getRatingsSpec","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the Rating Specs whose data is to be included in the response. If this field is not specified, matching rating information from all offices shall be returned.","schema":{"type":"string"}},{"name":"rating-id-mask","in":"query","description":"Posix regular expression that specifies the rating IDs to be included in the response. If this field is not specified, all Rating Specs shall be returned.","schema":{"type":"string"}},{"name":"page","in":"query","description":"This end point can return a lot of data, this identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 100.","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/RatingSpecs"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Ratings"],"summary":"Post ratings spec","description":"Create new Rating Specification","operationId":"postRatingsSpec","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/RatingSpec"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/metadata":{"get":{"tags":["Ratings"],"summary":"Get ratings metadata","operationId":"getRatingsMetadata","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the Rating Specs whose data is to be included in the response. If this field is not specified, matching rating information from all offices shall be returned.","schema":{"type":"string"}},{"name":"rating-id-mask","in":"query","description":"RegExp that specifies the rating IDs to be included in the response. If this field is not specified, all Rating Specs shall be returned.","schema":{"type":"string"}},{"name":"start","in":"query","description":"Specifies the start of the time window of the effective dates to be included. If this field is not specified no start time will be used.","schema":{"type":"string"}},{"name":"end","in":"query","description":"Specifies the end of the time window for effective dates to be included. If this field is not specified no end time will be used.","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"page","in":"query","description":"This end point can return a lot of data, this identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 50.","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/RatingMetadataList"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/{rating-id}/latest":{"get":{"tags":["Ratings"],"summary":"Get ratings with ratingId latest","description":"Returns CWMS Rating Data","operationId":"getRatingsWithRatingIdLatest","parameters":[{"name":"rating-id","in":"path","description":"The rating-id of the effective dates to be retrieve. ","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the ratingset to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Unit"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/Unit"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/effective-dates":{"get":{"tags":["Ratings"],"summary":"Get ratings effectiveDates","description":"Returns mapping of office -> spec id -> effective date-times for all matching offices and spec ids.","operationId":"getRatingsEffectiveDates","parameters":[{"name":"office-mask","in":"query","description":"Office Id used to filter the results.","schema":{"type":"string"}},{"name":"rating-id-mask","in":"query","description":"Spec Id used to filter the results. Defaults to '*'","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window","schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/RatingEffectiveDatesMap"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings/{rating-id}":{"get":{"tags":["Ratings"],"summary":"Get ratings with ratingId","description":"Returns CWMS Rating Data. Supports accept header formatting. For more information about accept header usage, see this page.","operationId":"getRatingsWithRatingId","parameters":[{"name":"rating-id","in":"path","description":"The rating-id of the effective dates to be retrieve. ","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the ratingset to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"begin","in":"query","description":"Specifies the start of the time window for data to be included in the response. If this field is not specified no start time will be used.","schema":{"type":"string"}},{"name":"end","in":"query","description":"Specifies the end of the time window for data to be included in the response. If this field is not specified no end time will be used.","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified), as well as the time zone of any times in the response. If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the retrieval method used. If no method is provided EAGER will be used.","schema":{"$ref":"#/components/schemas/DatabaseLoadMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Unit"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/Unit"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Ratings"],"summary":"Delete ratings with ratingId","operationId":"deleteRatingsWithRatingId","parameters":[{"name":"rating-id","in":"path","description":"The rating-id of the effective dates to be deleted. ","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the office of the ratings to be deleted.","required":true,"schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window to delete. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window to delete. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"This field specifies a default timezone to be used if the format of the begin, end, or version-date parameters do not include offset or time zone information. Defaults to UTC.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Ratings"],"summary":"Patch ratings with ratingId","description":"Update a RatingSet","operationId":"patchRatingsWithRatingId","parameters":[{"name":"rating-id","in":"path","description":"Specifies the rating-id of the rating to be updated.","required":true,"schema":{"type":"string"}},{"name":"store-template","in":"query","description":"Also store updates to the rating template. Default: true","schema":{"type":"boolean"}},{"name":"replace-base-curve","in":"query","description":"Replace the base curve of USGS stream flow rating. Default: false","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/Unit"}},"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Unit"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/ratings":{"get":{"tags":["Ratings"],"summary":"Get ratings","operationId":"getRatings","parameters":[{"name":"name","in":"query","description":"Specifies the name(s) of the rating whose data is to be included in the response. A case insensitive comparison is used to match names.","schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the Rating(s) whose data is to be included in the response. If this field is not specified, matching rating information from all offices shall be returned.","schema":{"type":"string"}},{"name":"unit","in":"query","description":"Specifies the unit or unit system of the response. Valid values for the unit field are:\n* `EN` Specifies English unit system. Rating values will be in the default English units for their parameters.\n* `SI` Specifies the SI unit system. Rating values will be in the default SI units for their parameters.\n* `NATIVE` Specifies the NATIVE units. Rating values will be in the native units for their parameters.","schema":{"type":"string"}},{"name":"datum","in":"query","description":"Specifies the elevation datum of the response. This field affects only elevation Ratings. Valid values for this field are:\n* `NAVD88` The elevation values will in the specified or default units above the NAVD-88 datum.\n* `NGVD29` The elevation values will be in the specified or default units above the NGVD-29 datum.","schema":{"type":"string"}},{"name":"at","in":"query","description":"Specifies the start of the time window for data to be included in the response. If this field is not specified, any required time window begins 24 hours prior to the specified or default end time.","schema":{"type":"string"}},{"name":"end","in":"query","description":"Specifies the end of the time window for data to be included in the response. If this field is not specified, any required time window ends at the current time","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"Specifies the time zone of the values of the begin and end fields (unless otherwise specified), as well as the time zone of any times in the response. If this field is not specified, the default time zone of UTC shall be used.","schema":{"type":"string"}},{"name":"format","in":"query","description":"Specifies the encoding format of the response. Valid values for the format field for this URI are:\n* `tab`\n* `csv`\n* `xml`\n* `json` (default)","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a rating table.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unit"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Unit"}},"text/tab-separated-values":{"schema":{"type":"string"}},"text/csv":{"schema":{"type":"string"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Ratings"],"summary":"Post ratings","description":"Create new RatingSet","operationId":"postRatings","parameters":[{"name":"store-template","in":"query","description":"Also store updates to the rating template. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/Unit"}},"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Unit"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Rating Set successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/catalog/{dataset}":{"get":{"tags":["Catalog"],"summary":"Get catalog with dataset","operationId":"getCatalogWithDataset","parameters":[{"name":"dataset","in":"path","description":"A list of what data? E.g. Timeseries, Locations, Ratings, etc","required":true,"schema":{"$ref":"#/components/schemas/CatalogableEndpoint"}},{"name":"page","in":"query","description":"This end point can return a lot of data, this identifies where in the request you are.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 500.","schema":{"type":"integer","format":"int32"}},{"name":"unit-system","in":"query","description":"Unit System desired in response. Can be SI (International Scientific) or EN (Imperial.) If unspecified, defaults to SI.","schema":{"$ref":"#/components/schemas/UnitSystem"}},{"name":"office","in":"query","description":"3-4 letter office name representing the district you want to isolate data to.","schema":{"type":"string"}},{"name":"like","in":"query","description":"Posix regular expression matching against the id","schema":{"type":"string"}},{"name":"timeseries-category-like","in":"query","description":"Posix regular expression matching against the timeseries category id. Note: This parameter is unsupported when dataset is Locations.","schema":{"type":"string"}},{"name":"timeseries-group-like","in":"query","description":"Posix regular expression matching against the timeseries group id. Note: This parameter is unsupported when dataset is Locations.","schema":{"type":"string"}},{"name":"location-category-like","in":"query","description":"Posix regular expression matching against the location category id","schema":{"type":"string"}},{"name":"location-group-like","in":"query","description":"Posix regular expression matching against the location group id","schema":{"type":"string"}},{"name":"bounding-office-like","in":"query","description":"Posix regular expression matching against the location bounding office. When this field is used items with no bounding office set will not be present in results.","schema":{"type":"string"}},{"name":"include-extents","in":"query","description":"Whether the returned catalog entries should include timeseries extents. Only valid for TIMESERIES. Note: This parameter is unsupported when dataset is Locations.Default is true.","schema":{"type":"boolean"}},{"name":"exclude-empty","in":"query","description":"Specifies whether Timeseries that have empty extents should be excluded from the results. For purposes of this parameter 'empty' is defined as VERSION_TIME, EARLIEST_TIME, LATEST_TIME and LAST_UPDATE all being null. This parameter does not control whether the extents are returned to the user, only whether matching timeseries are excluded. Only valid for TIMESERIES. Note: This parameter is unsupported when dataset is Locations.Default is true.","schema":{"type":"boolean"}},{"name":"location-kind-like","in":"query","description":"Posix regular expression matching against the location kind. The location-kind is typically unset or one of the following: {\"SITE\", \"EMBANKMENT\", \"OVERFLOW\", \"TURBINE\", \"STREAM\", \"PROJECT\", \"STREAMGAGE\", \"BASIN\", \"OUTLET\", \"LOCK\", \"GATE\"}. Multiple kinds can be matched by using Regular Expression OR clauses. For example: \"(SITE|STREAM)\"","schema":{"type":"string"}},{"name":"filter-base-locations","in":"query","description":"Specifies whether to filter the locations based on the base location. Default: false. If true, only sublocations locations will be returned. If false, all locations will be returned. Only supported for JSON format.","schema":{"type":"boolean"}},{"name":"negate-location-kind-like","in":"query","description":"Whether to use the location kind regular expression to exclude locations with the specified kinds. Default is false.","schema":{"type":"string"}},{"name":"location-type-like","in":"query","description":"Posix regular expression matching against the location type.","schema":{"type":"string"}},{"name":"include-aliases","in":"query","description":"Whether to add aliases to the catalog entries. Default is false. If true, the aliases will be added to the catalog entries in the response.","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of elements the data set you've selected.","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Catalog"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Catalog"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/basins/{name}":{"get":{"tags":["Basins"],"summary":"Get basins with name","description":"Returns CWMS Basin Data. This endpoint handles multiple accept header types, including named pg json. For more information about accept header usage, see this page.","operationId":"getBasinsWithName","parameters":[{"name":"name","in":"path","description":"Specifies the name of the basin to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the basin whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"unit","in":"query","description":"Specifies the unit or unit system of the response. Valid values for the unit field are: \n* `EN` (default) Specifies English unit system. Basin area values will be in the default English units for their parameters.\n* `SI` Specifies the SI unit system. \n* `Other` Any unit returned in the response to the units URI request that is appropriate for the requested parameters.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a basin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/vnd.named+pg+json":{"schema":{"$ref":"#/components/schemas/Basin"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Basin"}},"application/json":{"schema":{"$ref":"#/components/schemas/Basin"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Basins"],"summary":"Delete basins with name","description":"Deletes CWMS Basin","operationId":"deleteBasinsWithName","parameters":[{"name":"name","in":"path","description":"Specifies the name of the basin to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the basin to be deleted.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used.","required":true,"schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Basins"],"summary":"Patch basins with name","description":"Renames CWMS Basin","operationId":"patchBasinsWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Specifies the new name for the basin.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the basin to be renamed.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a basin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/basins":{"get":{"tags":["Basins"],"summary":"Get basins","description":"Returns CWMS Basin Data. This endpoint handles multiple accept header types, including named pg json. For more information about accept header usage, see this page.","operationId":"getBasins","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the basin whose data is to be included in the response. If this field is not specified, matching basin information from all offices shall be returned.","schema":{"type":"string"}},{"name":"unit","in":"query","description":"Specifies the unit or unit system of the response. Valid values for the unit field are: \n* `EN` Specifies English unit system. Basin values will be in the default English units for their parameters. (This is default if no value is entered)\n* `SI` Specifies the SI unit system. Basin values will be in the default SI units for their parameters.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a basin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/vnd.named+pg+json":{"schema":{"$ref":"#/components/schemas/Basin"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Basin"}},"application/json":{"schema":{"$ref":"#/components/schemas/Basin"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Basins"],"summary":"Post basins","description":"Creates CWMS Basin","operationId":"postBasins","responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Basin successfully stored to CWMS."},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/streams/{name}":{"get":{"tags":["Streams"],"summary":"Get streams with name","description":"Returns CWMS Stream Data","operationId":"getStreamsWithName","parameters":[{"name":"name","in":"path","description":"Specifies the stream-id of the stream to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the stream to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"station-unit","in":"query","description":"Specifies the unit of measure for the station. Defaults to mi.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Stream"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Stream"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Streams"],"summary":"Delete streams with name","description":"Delete CWMS Stream","operationId":"deleteStreamsWithName","parameters":[{"name":"name","in":"path","description":"Specifies the stream-id of the stream to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the stream to be deleted.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used. Defaults to \"DELETE_KEY\"","schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the stream was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Stream successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Streams"],"summary":"Patch streams with name","description":"Rename CWMS Stream","operationId":"patchStreamsWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Specifies the new stream-id. ","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the stream to be renamed.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Stream successfully renamed in CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/streams":{"get":{"tags":["Streams"],"summary":"Get streams","description":"Returns matching CWMS Stream Data for a Reservoir Project.","operationId":"getStreams","parameters":[{"name":"office-mask","in":"query","description":"Office id for the reservoir project location associated with the streams.","schema":{"type":"string"}},{"name":"stream-id-mask","in":"query","description":"Specifies the stream-id of the stream to be retrieved.","schema":{"type":"string"}},{"name":"diverts-from-stream-id-mask","in":"query","description":"Specifies the stream-id of the stream that the returned streams flow from.","schema":{"type":"string"}},{"name":"flows-into-stream-id-mask","in":"query","description":"Specifies the stream-id of the stream that the returned streams flow into.","schema":{"type":"string"}},{"name":"station-unit","in":"query","description":"Specifies the unit of measure for the station. Defaults to mi.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Stream"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Stream"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Streams"],"summary":"Post streams","description":"Create CWMS Stream","operationId":"postStreams","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Stream"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Stream successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/stream-locations/{office}/{name}/downstream-locations":{"get":{"tags":["StreamLocations"],"summary":"Get streamLocations with office with name downstreamLocations","description":"Returns matching downstream stream locations.","operationId":"getStreamLocationsWithOfficeWithNameDownstreamLocations","parameters":[{"name":"office","in":"path","description":"Office id for the stream location associated with the downstream locations.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Specifies the name of the stream location whose downstream locations data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"all-downstream","in":"query","description":"If true, retrieve all downstream locations.","schema":{"type":"boolean"}},{"name":"same-stream-only","in":"query","description":"If true, retrieve only locations on the same stream.","schema":{"type":"boolean"}},{"name":"station-unit","in":"query","description":"Station units.","schema":{"type":"string"}},{"name":"stage-unit","in":"query","description":"Stage units.","schema":{"type":"string"}},{"name":"area-unit","in":"query","description":"Area units.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StreamLocation"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/stream-locations/{office}/{name}/upstream-locations":{"get":{"tags":["StreamLocations"],"summary":"Get streamLocations with office with name upstreamLocations","description":"Returns matching upstream stream locations.","operationId":"getStreamLocationsWithOfficeWithNameUpstreamLocations","parameters":[{"name":"office","in":"path","description":"Office id for the stream location associated with the upstream locations.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Specifies the name of the stream location whose upstream locations data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"all-upstream","in":"query","description":"If true, retrieve all upstream locations.","schema":{"type":"boolean"}},{"name":"same-stream-only","in":"query","description":"If true, retrieve only locations on the same stream.","schema":{"type":"boolean"}},{"name":"station-unit","in":"query","description":"Station units.","schema":{"type":"string"}},{"name":"stage-unit","in":"query","description":"Stage units.","schema":{"type":"string"}},{"name":"area-unit","in":"query","description":"Area units.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StreamLocation"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/stream-locations/{name}":{"get":{"tags":["StreamLocations"],"summary":"Get streamLocations with name","description":"Returns CWMS Stream Location Data","operationId":"getStreamLocationsWithName","parameters":[{"name":"name","in":"path","description":"Specifies the location-id of the stream location to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the stream location to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"stream-id","in":"query","description":"Specifies the stream-id of the stream location to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"station-unit","in":"query","description":"Specifies the unit of measure for the station. Default units are mi.","schema":{"type":"string"}},{"name":"stage-unit","in":"query","description":"Specifies the unit of measure for the stage. Default units are ft.","schema":{"type":"string"}},{"name":"area-unit","in":"query","description":"Specifies the unit of measure for the area. Default units are mi2.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StreamLocation"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StreamLocation"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["StreamLocations"],"summary":"Delete streamLocations with name","description":"Delete CWMS Stream Location","operationId":"deleteStreamLocationsWithName","parameters":[{"name":"name","in":"path","description":"Specifies the location-id of the stream location to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the stream location to be deleted.","required":true,"schema":{"type":"string"}},{"name":"stream-id","in":"query","description":"Specifies the stream-id of the stream location to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Stream Location not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Stream Location successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["StreamLocations"],"summary":"Patch streamLocations with name","description":"Update CWMS Stream Location","operationId":"patchStreamLocationsWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/StreamLocation"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Updated Stream Location"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/stream-locations":{"get":{"tags":["StreamLocations"],"summary":"Get streamLocations","description":"Returns matching CWMS Stream Location Data for a Reservoir Project.","operationId":"getStreamLocations","parameters":[{"name":"office-mask","in":"query","description":"Office id for the reservoir project location associated with the stream locations.","schema":{"type":"string"}},{"name":"stream-id-mask","in":"query","description":"Specifies the stream-id of the stream that the returned stream locations belong to.","schema":{"type":"string"}},{"name":"name-mask","in":"query","description":"Specifies the location-id of the stream location to be retrieved.","schema":{"type":"string"}},{"name":"station-unit","in":"query","description":"Specifies the unit of measure for the station. Default units are mi.","schema":{"type":"string"}},{"name":"stage-unit","in":"query","description":"Specifies the unit of measure for the stage. Default units are ft.","schema":{"type":"string"}},{"name":"area-unit","in":"query","description":"Specifies the unit of measure for the area. Default units are mi2.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StreamLocation"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StreamLocation"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["StreamLocations"],"summary":"Post streamLocations","description":"Create CWMS Stream Location","operationId":"postStreamLocations","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/StreamLocation"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Stream Location successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/stream-reaches/{name}":{"get":{"tags":["StreamReaches"],"summary":"Get streamReaches with name","description":"Returns CWMS Stream Reach Data","operationId":"getStreamReachesWithName","parameters":[{"name":"name","in":"path","description":"Specifies the reach-id of the stream reach to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the stream reach to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"stream-id","in":"query","description":"Specifies the stream-id of the stream reach to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"station-unit","in":"query","description":"Specifies the unit of measure for the station. Defaults to mi.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StreamReach"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StreamReach"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["StreamReaches"],"summary":"Delete streamReaches with name","description":"Delete CWMS Stream Reach","operationId":"deleteStreamReachesWithName","parameters":[{"name":"name","in":"path","description":"Specifies the reach-id of the stream reach to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the stream reach to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Stream Reach successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["StreamReaches"],"summary":"Patch streamReaches with name","description":"Rename CWMS Stream Reach","operationId":"patchStreamReachesWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Specifies the new reach-id. ","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the stream reach to be renamed.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Stream Reach successfully renamed in CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/stream-reaches":{"get":{"tags":["StreamReaches"],"summary":"Get streamReaches","description":"Returns matching CWMS Stream Reach Data for a Reservoir Project.","operationId":"getStreamReaches","parameters":[{"name":"office-mask","in":"query","description":"Office id for the reservoir project location associated with the stream reaches.","schema":{"type":"string"}},{"name":"stream-id-mask","in":"query","description":"Specifies the stream-id mask for the stream reaches.","schema":{"type":"string"}},{"name":"reach-id-mask","in":"query","description":"Specifies the reach-id mask for the stream reaches.","schema":{"type":"string"}},{"name":"configuration-id-mask","in":"query","description":"Specifies the configuration-id mask for the stream reaches.","schema":{"type":"string"}},{"name":"station-unit","in":"query","description":"Specifies the unit of measure for the station. Defaults to mi.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StreamReach"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StreamReach"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["StreamReaches"],"summary":"Post streamReaches","description":"Create CWMS Stream Reach","operationId":"postStreamReaches","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/StreamReach"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Stream Reach successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/measurements/time-extents":{"get":{"tags":["Measurements"],"summary":"Get measurements timeExtents","description":"Returns matching downstream stream locations.","operationId":"getMeasurementsTimeExtents","parameters":[{"name":"office-mask","in":"query","description":"Office Id used to filter the results.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CwmsIdTimeExtentsEntry"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/measurements":{"get":{"tags":["Measurements"],"summary":"Get measurements","description":"Returns matching measurement data.","operationId":"getMeasurements","parameters":[{"name":"office-mask","in":"query","description":"Office id mask for filtering measurements. Use null to retrieve measurements for all offices.","schema":{"type":"string"}},{"name":"id-mask","in":"query","description":"Location id mask for filtering measurements. Use null to retrieve measurements for all locations.","schema":{"type":"string"}},{"name":"min-number","in":"query","description":"Minimum measurement number-id for filtering measurements.","schema":{"type":"string"}},{"name":"max-number","in":"query","description":"Maximum measurement number-id for filtering measurements.","schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window to delete. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. A null value is treated as an unbounded start.","schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window to delete.The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. A null value is treated as an unbounded end.","schema":{"type":"string"}},{"name":"timezone","in":"query","description":"This field specifies a default timezone to be used if the format of the beginand end parameters do not include offset or time zone information. Defaults to UTC.","schema":{"type":"string"}},{"name":"min-height","in":"query","description":"Minimum height for filtering measurements.","schema":{"type":"string"}},{"name":"max-height","in":"query","description":"Maximum height for filtering measurements.","schema":{"type":"string"}},{"name":"min-flow","in":"query","description":"Minimum flow for filtering measurements.","schema":{"type":"string"}},{"name":"max-flow","in":"query","description":"Maximum flow for filtering measurements.","schema":{"type":"string"}},{"name":"agency","in":"query","description":"Agencies for filtering measurements.","schema":{"type":"string"}},{"name":"quality","in":"query","description":"Quality for filtering measurements.","schema":{"type":"string"}},{"name":"unit-system","in":"query","description":"Specifies the unit system of the response. Valid values for the unit field are: \n* `EN` Specifies English unit system. Location values will be in the default English units for their parameters.\n* `SI` Specifies the SI unit system. Location values will be in the default SI units for their parameters. If not specified, EN is used.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Measurement"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Measurement"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Measurements"],"summary":"Post measurements","description":"Create new measurement(s).","operationId":"postMeasurements","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided Measurement(s) already exist. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Measurement"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Measurement"}}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Measurement(s) successfully stored."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/measurements/{location-id}":{"delete":{"tags":["Measurements"],"summary":"Delete measurements with locationId","description":"Delete an existing measurement.","operationId":"deleteMeasurementsWithLocationId","parameters":[{"name":"location-id","in":"path","description":"Specifies the location-id of the measurement(s) to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the office of the measurements to delete","required":true,"schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window to delete. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window to delete.The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"This field specifies a default timezone to be used if the format of the beginand end parameters do not include offset or time zone information. Defaults to UTC.","schema":{"type":"string"}},{"name":"min-number","in":"query","description":"Specifies the min number-id of the measurement to delete.","schema":{"type":"string"}},{"name":"max-number","in":"query","description":"Specifies the max number-id of the measurement to delete.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Measurement not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Measurement successfully deleted."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/blobs/{blob-id}":{"get":{"tags":["Blob"],"summary":"Get blobs with blobId","description":"Returns the binary value of the requested blob as a seekable stream with the appropriate media type.","operationId":"getBlobsWithBlobId","parameters":[{"name":"blob-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office.","schema":{"type":"string"}},{"name":"blob-id","in":"query","description":"If this _query_ parameter is provided the id _path_ parameter is ignored and the value of the query parameter is used. Note: this query parameter is necessary for id's that contain '/' or other special characters. This is due to limitations in path pattern matching. We will likely add support for encoding the ID in the path in the future. For now use the id field for those IDs. Client libraries should detect slashes and choose the appropriate field. \"ignored\" is suggested for the path endpoint.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Returns requested blob.","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Unit"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Blob"],"summary":"Delete blobs with blobId","description":"Deletes requested blob","operationId":"deleteBlobsWithBlobId","parameters":[{"name":"blob-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"blob-id","in":"query","description":"If this _query_ parameter is provided the id _path_ parameter is ignored and the value of the query parameter is used. Note: this query parameter is necessary for id's that contain '/' or other special characters. This is due to limitations in path pattern matching. We will likely add support for encoding the ID in the path in the future. For now use the id field for those IDs. Client libraries should detect slashes and choose the appropriate field. \"ignored\" is suggested for the path endpoint.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the blob to be deleted","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Blob"],"summary":"Patch blobs with blobId","description":"Update an existing Blob","operationId":"patchBlobsWithBlobId","parameters":[{"name":"blob-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"blob-id","in":"query","description":"If this _query_ parameter is provided the id _path_ parameter is ignored and the value of the query parameter is used. Note: this query parameter is necessary for id's that contain '/' or other special characters. This is due to limitations in path pattern matching. We will likely add support for encoding the ID in the path in the future. For now use the id field for those IDs. Client libraries should detect slashes and choose the appropriate field. \"ignored\" is suggested for the path endpoint.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Blob"}},"application/json":{"schema":{"$ref":"#/components/schemas/Blob"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/blobs":{"get":{"tags":["Blob"],"summary":"Get blobs","operationId":"getBlobs","parameters":[{"name":"office","in":"query","description":"Specifies the owning office. If this field is not specified, matching information from all offices shall be returned.","schema":{"type":"string"}},{"name":"page","in":"query","description":"This end point can return a lot of data, this identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 20.","schema":{"type":"integer","format":"int32"}},{"name":"like","in":"query","description":"Posix regular expression describing the blob id's you want","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of blobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Blobs"}},"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Blobs"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Blob"],"summary":"Post blobs","description":"Create new Blob","operationId":"postBlobs","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Blob"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/clobs/{clob-id}":{"get":{"tags":["Clob"],"summary":"Get clobs with clobId","description":"Get a single clob. If the accept header is set to text/plain, the raw value is returned as the response body. Responses to text/plain requests are streamed and support the Range header. When the accept header is set to application/json;version=2 the clob will be returned as a serialized Clob object with fields for office-id, id, description and value. For more information about accept header usage, see this page.","operationId":"getClobsWithClobId","parameters":[{"name":"clob-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office.","schema":{"type":"string"}},{"name":"clob-id","in":"query","description":"If this _query_ parameter is provided the id _path_ parameter is ignored and the value of the query parameter is used. Note: this query parameter is necessary for id's that contain '/' or other special characters. This is due to limitations in path pattern matching. We will likely add support for encoding the ID in the path in the future. For now use the id field for those IDs. Client libraries should detect slashes and choose the appropriate field. \"ignored\" is suggested for the path endpoint.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Returns requested clob.","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Clob"}},"text/plain":{"schema":{"type":"string"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Clob"],"summary":"Delete clobs with clobId","description":"Delete clob","operationId":"deleteClobsWithClobId","parameters":[{"name":"clob-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"clob-id","in":"query","description":"If this _query_ parameter is provided the id _path_ parameter is ignored and the value of the query parameter is used. Note: this query parameter is necessary for id's that contain '/' or other special characters. This is due to limitations in path pattern matching. We will likely add support for encoding the ID in the path in the future. For now use the id field for those IDs. Client libraries should detect slashes and choose the appropriate field. \"ignored\" is suggested for the path endpoint.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the office of the clob.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Clob"],"summary":"Patch clobs with clobId","description":"Update clob","operationId":"patchClobsWithClobId","parameters":[{"name":"clob-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"clob-id","in":"query","description":"If this _query_ parameter is provided the id _path_ parameter is ignored and the value of the query parameter is used. Note: this query parameter is necessary for id's that contain '/' or other special characters. This is due to limitations in path pattern matching. We will likely add support for encoding the ID in the path in the future. For now use the id field for those IDs. Client libraries should detect slashes and choose the appropriate field. \"ignored\" is suggested for the path endpoint.","required":true,"schema":{"type":"string"}},{"name":"ignore-nulls","in":"query","description":"If true, null and empty fields in the provided clob will be ignored and the existing value of those fields left in place. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Clob"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/Clob"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/clobs":{"get":{"tags":["Clob"],"summary":"Get clobs","operationId":"getClobs","parameters":[{"name":"office","in":"query","description":"Specifies the owning office. If this field is not specified, matching information from all offices shall be returned.","schema":{"type":"string"}},{"name":"page","in":"query","description":"This end point can return a lot of data, this identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 20.","schema":{"type":"integer","format":"int32"}},{"name":"include-values","in":"query","description":"Do you want the value associated with this particular clob (default: false)","schema":{"type":"boolean"}},{"name":"like","in":"query","description":"Posix regular expression matching against the id","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of clobs.","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Clobs"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/Clobs"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Clob"],"summary":"Post clobs","description":"Create new Clob","operationId":"postClobs","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Clob"}},"application/xml;version=2":{"schema":{"$ref":"#/components/schemas/Clob"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/pools/{pool-id}":{"get":{"tags":["Pools"],"summary":"Get pools with poolId","description":"Retrieves requested Pool","operationId":"getPoolsWithPoolId","parameters":[{"name":"pool-id","in":"path","description":"Specifies the pool whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the Pool whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"query","description":"Specifies the project-id of the Pool whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"bottom-mask","in":"query","description":"Bottom level mask. Default value:*","schema":{"type":"string"}},{"name":"top-mask","in":"query","description":"Top level mask. Default value:*","schema":{"type":"string"}},{"name":"include-explicit","in":"query","description":"Specifies if the results should include explicit Pools. Default value:false","schema":{"type":"string"}},{"name":"include-implicit","in":"query","description":"Specifies if the results should include implicit Pools. Default value:true","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the Location Category was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Pool"}}}},"501":{"description":"request format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/pools":{"get":{"tags":["Pools"],"summary":"Get pools","description":"Returns Pools Data","operationId":"getPools","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the data in the response. If this field is not specified, matching items from all offices shall be returned.","schema":{"type":"string"}},{"name":"id-mask","in":"query","description":"Project Id mask. Default value:*","schema":{"type":"string"}},{"name":"name-mask","in":"query","description":"Name mask. Default value:*","schema":{"type":"string"}},{"name":"bottom-mask","in":"query","description":"Bottom level mask. Default value:*","schema":{"type":"string"}},{"name":"top-mask","in":"query","description":"Top level mask. Default value:*","schema":{"type":"string"}},{"name":"include-explicit","in":"query","description":"Specifies if the results should include explicit Pools. Default value:false","schema":{"type":"string"}},{"name":"include-implicit","in":"query","description":"Specifies if the results should include implicit Pools. Default value:true","schema":{"type":"string"}},{"name":"page","in":"query","description":"This end point can return a lot of data, this identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 100.","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the pools were not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/Pools"}}}},"501":{"description":"request format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/specified-levels":{"get":{"tags":["Levels"],"summary":"Get specifiedLevels","operationId":"getSpecifiedLevels","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the Specified Levels whose data is to be included in the response. If this field is not specified, matching rating information from all offices shall be returned.","schema":{"type":"string"}},{"name":"template-id-mask","in":"query","description":"Mask that specifies the IDs to be included in the response. If this field is not specified, all specified levels shall be returned.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/SpecifiedLevel"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Levels"],"summary":"Post specifiedLevels","description":"Create new SpecifiedLevel","operationId":"postSpecifiedLevels","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/SpecifiedLevel"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/specified-levels/{specified-level-id}":{"delete":{"tags":["Levels"],"summary":"Delete specifiedLevels with specifiedLevelId","description":"Deletes requested specified level id","operationId":"deleteSpecifiedLevelsWithSpecifiedLevelId","parameters":[{"name":"specified-level-id","in":"path","description":"The specified level id to be deleted","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the timeseries identifier to be deleted","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Levels"],"summary":"Patch specifiedLevels with specifiedLevelId","description":"Renames the requested specified level id","operationId":"patchSpecifiedLevelsWithSpecifiedLevelId","parameters":[{"name":"specified-level-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"specified-level-id","in":"query","description":"The new specified level id.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the specified level to be renamed","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/forecast-instance/{name}":{"get":{"tags":["Forecast"],"summary":"Get forecastInstance with name","description":"Used to get all forecast instances for a given forecast spec","operationId":"getForecastInstanceWithName","parameters":[{"name":"name","in":"path","description":"Specifies the spec id of the forecast spec whose forecast instance data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"forecast-date","in":"query","description":"Specifies the forecast date time of the forecast instance to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"issue-date","in":"query","description":"Specifies the issue date time of the forecast instance to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the forecast spec whose forecast instance is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"designator","in":"query","description":"Specifies the designator of the forecast spec whose forecast instance data to be included in the response.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid parameter combination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a forecast instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of elements of the data set you've selected.","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/ForecastInstance"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Forecast"],"summary":"Delete forecastInstance with name","description":"Used to delete forecast instance data based on unique fields","operationId":"deleteForecastInstanceWithName","parameters":[{"name":"name","in":"path","description":"Specifies the spec id of the forecast spec associated with the forecast instanceto be deleted.","required":true,"schema":{"type":"string"}},{"name":"forecast-date","in":"query","description":"Specifies the forecast date time of the forecast instance to be deleted.","required":true,"schema":{"type":"string"}},{"name":"issue-date","in":"query","description":"Specifies the issue date time of the forecast instance to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the forecast spec associated with the forecast instance to be deleted.","required":true,"schema":{"type":"string"}},{"name":"designator","in":"query","description":"Specifies the designator of the forecast spec associated with the forecast instance to be deleted.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a forecast instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Forecast"],"summary":"Patch forecastInstance with name","description":"Update a forecast instance with new max age, notes, forecast fileand forecast info key/value pairs.","operationId":"patchForecastInstanceWithName","parameters":[{"name":"name","in":"path","description":"Specifies the spec id of the forecast spec to be updated.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/ForecastInstance"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the ForecastInstance was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/forecast-instance":{"get":{"tags":["Forecast"],"summary":"Get forecastInstance","description":"Used to get all forecast instances for a given forecast spec","operationId":"getForecastInstance","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the forecast spec whose forecast instance is to be included in the response. Default will be all offices.","schema":{"type":"string"}},{"name":"name","in":"query","description":"Specifies the spec id of the forecast spec whose forecast instance data is to be included in the response. Default will be all names.","schema":{"type":"string"}},{"name":"designator","in":"query","description":"Specifies the designator of the forecast spec to filter the forecast instance data in the response. This parameter is an exact-match string; if not provided, no filter is applied. Default is no filter.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid parameter combination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of elements of the data set you've selected.","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/ForecastInstance"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Forecast"],"summary":"Post forecastInstance","description":"Used to create and save a forecast instance","operationId":"postForecastInstance","requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/ForecastInstance"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/forecast-spec/{name}":{"get":{"tags":["Forecast"],"summary":"Get forecastSpec with name","description":"Used to query a single forecast spec record","operationId":"getForecastSpecWithName","parameters":[{"name":"name","in":"path","description":"Specifies the spec id of the forecast spec whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the forecast spec whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"designator","in":"query","description":"Specifies the designator of the forecast spec whose data to be included in the response.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid parameter combination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a forecast spec.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Returns the requested forecast spec","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/ForecastSpec"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Forecast"],"summary":"Delete forecastSpec with name","description":"Used to delete forecast spec data based on unique fields","operationId":"deleteForecastSpecWithName","parameters":[{"name":"name","in":"path","description":"Specifies the spec id of the forecast spec whose data is to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the forecast spec whose data is to be deleted.","required":true,"schema":{"type":"string"}},{"name":"designator","in":"query","description":"Specifies the designator of the forecast spec whose data is to be deleted.","schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used. Defaults to \"DELETE_KEY\"","schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a forecast spec.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Forecast"],"summary":"Patch forecastSpec with name","description":"Update a forecast spec with provided values","operationId":"patchForecastSpecWithName","parameters":[{"name":"name","in":"path","description":"Forecast spec id to be updated","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/ForecastSpec"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the forecast spec was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/forecast-spec":{"get":{"tags":["Forecast"],"summary":"Get forecastSpec","description":"Used to query multiple forecast specs","operationId":"getForecastSpec","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the forecast spec whose data is to be included in the response.","schema":{"type":"string"}},{"name":"id-mask","in":"query","description":"Posix regular expression that specifies the spec IDs to be included in the response.","schema":{"type":"string"}},{"name":"designator-mask","in":"query","description":"Posix regular expression that specifies the designator of the forecast spec whose data to be included in the response. Default behavior when this parameter is not provided is to search for forecast specifications with a null designator. ","schema":{"type":"string"}},{"name":"source-entity","in":"query","description":"Specifies the source identity of the forecast spec whose data is to be included in the response.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid parameter combination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"A list of elements of the data set you've selected.","content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/ForecastSpec"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Forecast"],"summary":"Post forecastSpec","description":"Used to create and save forecast spec data","operationId":"postForecastSpec","requestBody":{"content":{"application/json;version=2":{"schema":{"$ref":"#/components/schemas/ForecastSpec"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/forecast-instance/{name}/file-data":{"get":{"tags":["Forecast"],"summary":"Get forecastInstance with name fileData","description":"Used to download forecast file for the given parameters","operationId":"getForecastInstanceWithNameFileData","parameters":[{"name":"name","in":"path","description":"Specifies the spec id of the forecast spec whose forecast instance data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"forecast-date","in":"query","description":"Specifies the forecast date time of the forecast instance to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"issue-date","in":"query","description":"Specifies the issue date time of the forecast instance to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the forecast spec whose forecast instance is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"designator","in":"query","description":"Specifies the designator of the forecast spec whose forecast instance data to be included in the response.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Invalid parameter combination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a forecast instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/status-update/{name}":{"post":{"tags":["Projects"],"summary":"Post projects statusUpdate with name","description":"Publishes a message on the office's STATUS queue that a project has been updated for a specified application","operationId":"postProjectsStatusUpdateWithName","parameters":[{"name":"name","in":"path","description":"The location identifier of the project that has been updated","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"The office generating the message (and owning the project).","required":true,"schema":{"type":"string"}},{"name":"application-id","in":"query","description":"A text string identifying the application for which the update applies.","required":true,"schema":{"type":"string"}},{"name":"source-id","in":"query","description":"An application-defined string of the instance and/or component that generated the message. If NULL or not specified, the generated message will not include this item.","schema":{"type":"string"}},{"name":"timeseries-id","in":"query","description":"A time series identifier of the time series associated with the update. If NULL or not specified, the generated message will not include this item.","schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start time of the updates to the time series. If NULL or not specified, the generated message will not include this item.","schema":{"type":"string"}},{"name":"end","in":"query","description":"The end time of the updates to the time series. If NULL or not specified, the generated message will not include this item.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/{project-id}/water-user/{water-user}":{"get":{"tags":["Water Contracts"],"summary":"Get projects with office with projectId waterUser with waterUser","description":"Gets a specified water user.","operationId":"getProjectsWithOfficeWithProjectIdWaterUserWithWaterUser","parameters":[{"name":"office","in":"path","description":"The office Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"The project Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"water-user","in":"path","description":"The water user the contract is associated with.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/WaterUserContract"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Water Contracts"],"summary":"Delete projects with office with projectId waterUser with waterUser","description":"Deletes a water user from CWMS.","operationId":"deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUser","parameters":[{"name":"office","in":"path","description":"The office Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"The project Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"water-user","in":"path","description":"The water user the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used. Default is DELETE_KEY.","schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Water Contracts"],"summary":"Patch projects with office with projectId waterUser with waterUser","description":"Updates a water user in CWMS.","operationId":"patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUser","parameters":[{"name":"office","in":"path","description":"The office Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"The project Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"water-user","in":"path","description":"The water user the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Specifies the new name of the water user entity.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/WaterUser"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Water user successfully updated in CWMS."},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/{project-id}/water-user":{"get":{"tags":["Water Contracts"],"summary":"Get projects with office with projectId waterUser","description":"Gets all water users.","operationId":"getProjectsWithOfficeWithProjectIdWaterUser","parameters":[{"name":"office","in":"path","description":"The office Id the water user is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"The project Id the water user is associated with.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/WaterUser"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Water Contracts"],"summary":"Post projects with office with projectId waterUser","description":"Stores a water user to CWMS.","operationId":"postProjectsWithOfficeWithProjectIdWaterUser","parameters":[{"name":"office","in":"path","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"fail-if-exists","in":"query","description":"If true, the operation will fail if the water user already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/WaterUser"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Water user successfully stored to CWMS."},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/{project-id}/water-user/{water-user}/contracts/{contract-name}":{"get":{"tags":["Water Contracts"],"summary":"Get projects with office with projectId waterUser with waterUser contracts with contractName","description":"Return a specified water contract","operationId":"getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName","parameters":[{"name":"office","in":"path","description":"The office Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"The project Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"water-user","in":"path","description":"The water user the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"contract-name","in":"path","description":"The name of the contract to retrieve.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find any contracts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/WaterUserContract"}},"application/json":{"schema":{"$ref":"#/components/schemas/WaterUserContract"}}}},"501":{"description":"Requested format is not implemented."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Water Contracts"],"summary":"Delete projects with office with projectId waterUser with waterUser contracts with contractName","description":"Delete a specified water contract","operationId":"deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName","parameters":[{"name":"office","in":"path","description":"The office Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"The project Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"water-user","in":"path","description":"The water user the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"contract-name","in":"path","description":"The name of the contract to be deleted.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used. Defaults to DELETE_KEY.","schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Water Contracts"],"summary":"Patch projects with office with projectId waterUser with waterUser contracts with contractName","description":"Renames a water contract","operationId":"patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName","parameters":[{"name":"office","in":"path","description":"The office Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"The project Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"water-user","in":"path","description":"The water user the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"contract-name","in":"path","required":true,"schema":{"type":"string"}},{"name":"contract-name","in":"query","description":"Specifies the new name of the contract.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/WaterUserContract"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find a contract","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Contract successfully renamed in CWMS."},"501":{"description":"Requested format is not implemented."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/{project-id}/water-user/{water-user}/contracts":{"get":{"tags":["Water Contracts"],"summary":"Get projects with office with projectId waterUser with waterUser contracts","description":"Return all water contracts","operationId":"getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContracts","parameters":[{"name":"office","in":"path","description":"Specifies the office that the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"Specifies the project id of the contract.","required":true,"schema":{"type":"string"}},{"name":"water-user","in":"path","description":"Specifies the water user of the contract.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find any contracts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/WaterUserContract"}},"application/json":{"schema":{"$ref":"#/components/schemas/WaterUserContract"}}}},"501":{"description":"Requested format is not implemented."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Water Contracts"],"summary":"Post projects with office with projectId waterUser with waterUser contracts","description":"Create a new water contract","operationId":"postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContracts","parameters":[{"name":"office","in":"path","description":"The office Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"The project Id the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"water-user","in":"path","description":"The water user the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"fail-if-exists","in":"query","description":"If true, the contract will not be stored if it already exists.","schema":{"type":"boolean"}},{"name":"ignore-nulls","in":"query","description":"If true, null fields will be ignored when storing the contract.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/WaterUserContract"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Water contract successfully stored to CWMS."},"501":{"description":"Requested format is not implemented."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/{project-id}/water-user/{water-user}/contracts/{contract-name}/accounting":{"get":{"tags":["Pump Accounting"],"summary":"Get projects with office with projectId waterUser with waterUser contracts with contractName accounting","description":"Get pump accounting entries associated with a water supply contract.","operationId":"getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameAccounting","parameters":[{"name":"office","in":"path","description":"The office ID of the project the pump accounting is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"The project ID the pump accounting is associated with.","required":true,"schema":{"type":"string"}},{"name":"water-user","in":"path","description":"The water user the pump accounting is associated with.","required":true,"schema":{"type":"string"}},{"name":"contract-name","in":"path","description":"The name of the contract associated with the pump accounting.","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The start time of the time window for pump accounting entries to retrieve. The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end time of the time window for pump accounting entries to retrieve.The format for this field is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'.","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"This field specifies a default timezone to be used if the format of the end or begin parameters do not include offset or time zone information. Defaults to UTC.","schema":{"type":"string"}},{"name":"unit","in":"query","description":"The unit of the flow rate of the accounting entries to retrieve. Defaults to 'cms'.","schema":{"type":"string"}},{"name":"start-time-inclusive","in":"query","description":"Whether or not the start time is inclusive or not. Defaults to TRUE.","schema":{"type":"boolean"}},{"name":"end-time-inclusive","in":"query","description":"Whether or not the end time is inclusive or not. Defaults to TRUE.","schema":{"type":"boolean"}},{"name":"ascending","in":"query","description":"Whether or not the entries should be returned in ascending order. Defaults to TRUE.","schema":{"type":"boolean"}},{"name":"row-limit","in":"query","description":"The maximum number of rows to return. Defaults to 0, which means no limit.","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Pump Accounting not found for provided input parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WaterSupplyAccounting"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WaterSupplyAccounting"}}}}},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Pump Accounting"],"summary":"Post projects with office with projectId waterUser with waterUser contracts with contractName accounting","description":"Create a new pump accounting entry associated with a water supply contract.","operationId":"postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameAccounting","parameters":[{"name":"office","in":"path","description":"The office ID the accounting is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"water-user","in":"path","description":"The water user the accounting is associated with.","required":true,"schema":{"type":"string"}},{"name":"contract-name","in":"path","description":"The name of the contract associated with the accounting.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/WaterSupplyAccounting"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"The pump accounting entry was created."},"501":{"description":"Requested format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/{project-id}/water-user/{water-user}/contracts/{contract-name}/pumps/{name}":{"delete":{"tags":["Water Contracts"],"summary":"Delete projects with office with projectId waterUser with waterUser contracts with contractName pumps with name","description":"Disassociate a pump from a contract","operationId":"deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithName","parameters":[{"name":"office","in":"path","description":"The office the project is associated with.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"The name of the project.","required":true,"schema":{"type":"string"}},{"name":"water-user","in":"path","description":"The name of the water user the contract is associated with.","required":true,"schema":{"type":"string"}},{"name":"contract-name","in":"path","description":"The name of the contract the pump is associated with.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The name of the pump to be disassociated from the specified contract.","required":true,"schema":{"type":"string"}},{"name":"pump-type","in":"query","description":"The type of pump to be disassociated from the contract. Expected values: IN, OUT, OUT BELOW","required":true,"schema":{"$ref":"#/components/schemas/PumpType"}},{"name":"delete-accounting","in":"query","description":"Whether to delete the associated accounting data. Defaults to FALSE.","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/contract-types":{"get":{"tags":["Water Contracts"],"summary":"Get projects with office contractTypes","description":"Get all water contract types","operationId":"getProjectsWithOfficeContractTypes","parameters":[{"name":"office","in":"path","description":"The office Id the contract is associated with.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"The provided combination of parameters did not find any contracts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LookupType"}},"application/json":{"schema":{"$ref":"#/components/schemas/LookupType"}}}},"501":{"description":"Requested format is not implemented."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Water Contracts"],"summary":"Post projects with office contractTypes","description":"Create a new water contract type","operationId":"postProjectsWithOfficeContractTypes","parameters":[{"name":"office","in":"path","required":true,"schema":{"type":"string"}},{"name":"fail-if-exists","in":"query","description":"Create will fail if provideddisplay value already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/LookupType"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Contract type successfully stored to CWMS."},"501":{"description":"Requested format is not implemented."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/contract-types/{display-value}":{"delete":{"tags":["Water Contracts"],"summary":"Delete projects with office contractTypes with displayValue","description":"Delete a water contract type","operationId":"deleteProjectsWithOfficeContractTypesWithDisplayValue","parameters":[{"name":"office","in":"path","description":"The office associated with the contract type to delete","required":true,"schema":{"type":"string"}},{"name":"display-value","in":"path","description":"The location associated with the contract type to delete","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/embankments/{name}":{"get":{"tags":["Embankments"],"summary":"Get projects embankments with name","description":"Returns CWMS Embankment Data","operationId":"getProjectsEmbankmentsWithName","parameters":[{"name":"name","in":"path","description":"Specifies the name of the embankment to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the embankment to be retrieved.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Embankment"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Embankment"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Embankments"],"summary":"Delete projects embankments with name","description":"Delete CWMS Embankment","operationId":"deleteProjectsEmbankmentsWithName","parameters":[{"name":"name","in":"path","description":"Specifies the name of the embankment to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the embankment to be deleted.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used. Defaults to \"DELETE_KEY\"","schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the embankment was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Embankment successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Embankments"],"summary":"Patch projects embankments with name","description":"Rename CWMS Embankment","operationId":"patchProjectsEmbankmentsWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Specifies the new embankment name. ","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the embankment to be renamed.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Embankment successfully renamed in CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/embankments":{"get":{"tags":["Embankments"],"summary":"Get projects embankments","description":"Returns matching CWMS Embankment Data for a Reservoir Project.","operationId":"getProjectsEmbankments","parameters":[{"name":"office","in":"query","description":"Office id for the reservoir project location associated with the embankments.","schema":{"type":"string"}},{"name":"project-id","in":"query","description":"Specifies the project-id of the Embankments whose data is to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Embankment"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Embankment"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Embankments"],"summary":"Post projects embankments","description":"Create CWMS Embankment","operationId":"postProjectsEmbankments","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Embankment"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Embankment successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/turbines/{name}":{"get":{"tags":["Turbines"],"summary":"Get projects turbines with name","description":"Returns CWMS Turbine Data","operationId":"getProjectsTurbinesWithName","parameters":[{"name":"name","in":"path","description":"Specifies the name of the turbine to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the turbine to be retrieved.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Turbine"}},"application/json":{"schema":{"$ref":"#/components/schemas/Turbine"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Turbines"],"summary":"Delete projects turbines with name","description":"Delete CWMS Turbine","operationId":"deleteProjectsTurbinesWithName","parameters":[{"name":"name","in":"path","description":"Specifies the name of the turbine to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the turbine to be deleted.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used. Defaults to \"DELETE_KEY\"","schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the turbine was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Turbine successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Turbines"],"summary":"Patch projects turbines with name","description":"Rename CWMS Turbine","operationId":"patchProjectsTurbinesWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Specifies the new turbine name. ","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the turbine to be renamed.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Turbine successfully renamed in to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/turbines":{"get":{"tags":["Turbines"],"summary":"Get projects turbines","description":"Returns matching CWMS Turbine Data for a Reservoir Project.","operationId":"getProjectsTurbines","parameters":[{"name":"office","in":"query","description":"Office id for the reservoir project location associated with the turbines.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"query","description":"Specifies the project-id of the Turbines whose data is to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Turbine"}}},"application/json":{"schema":{"$ref":"#/components/schemas/Turbine"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Turbines"],"summary":"Post projects turbines","description":"Create CWMS Turbine","operationId":"postProjectsTurbines","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Turbine"}},"application/json":{"schema":{"$ref":"#/components/schemas/Turbine"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Turbine successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/locks/{name}":{"get":{"tags":["Locks"],"summary":"Get projects locks with name","description":"Returns CWMS Lock Data","operationId":"getProjectsLocksWithName","parameters":[{"name":"name","in":"path","description":"Specifies the name of the lock to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the lock to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"unit","in":"query","description":"Specifies the unit system to be used in the response. Valid values are: \n* `SI` - Metric units. \n* `EN` - Imperial units. \nDefaults to SI.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Lock"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Lock"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Locks"],"summary":"Delete projects locks with name","description":"Delete CWMS Lock","operationId":"deleteProjectsLocksWithName","parameters":[{"name":"name","in":"path","description":"Specifies the name of the lock to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the lock to be deleted.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used. Defaults to \"DELETE_KEY\"","schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the lock was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Lock successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Locks"],"summary":"Patch projects locks with name","description":"Rename CWMS Lock","operationId":"patchProjectsLocksWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Specifies the new lock name.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the lock to be renamed.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Lock successfully renamed in CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/locks":{"get":{"tags":["Locks"],"summary":"Get projects locks","description":"Returns matching CWMS Lock Data for a Reservoir Project.","operationId":"getProjectsLocks","parameters":[{"name":"office","in":"query","description":"Office id for the reservoir project location associated with the locks.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"query","description":"Specifies the project ID of the Locks whose data is to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Lock"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Lock"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Locks"],"summary":"Post projects locks","description":"Create CWMS Lock","operationId":"postProjectsLocks","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Lock"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Lock successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/{name}/turbine-changes":{"get":{"tags":["Turbines"],"summary":"Get projects with office with name turbineChanges","description":"Returns matching CWMS Turbine Change Data for a Reservoir Project.","operationId":"getProjectsWithOfficeWithNameTurbineChanges","parameters":[{"name":"office","in":"path","description":"Office id for the reservoir project location associated with the turbine changes.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Specifies the name of project of the Turbine changes whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window.","required":true,"schema":{"type":"string"}},{"name":"start-time-inclusive","in":"query","description":"A flag specifying whether any data at the start time should be retrieved ('True') or only data after the start time ('False'). Default value is True","schema":{"type":"boolean"}},{"name":"end-time-inclusive","in":"query","description":"A flag ('True'/'False') specifying whether any data at the end time should be retrieved ('True') or only data before the end time ('False'). Default value is False","schema":{"type":"boolean"}},{"name":"unit-system","in":"query","description":"Unit System desired in response. Can be SI (International Scientific) or EN (Imperial.) If unspecified, defaults to EN.","schema":{"$ref":"#/components/schemas/UnitSystem"}},{"name":"page-size","in":"query","description":"the maximum number of turbine changes to retrieve, regardless of time window. A positive integer is interpreted as the maximum number of changes from the beginning of the time window. A negative integer is interpreted as the maximum number from the end of the time window. Default 500.A page cursor will not be returned by this DTO. Instead, the next page can be determined by querying the next set of changes using the last returned change date and using start-time-inclusive=false","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TurbineChange"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Turbines"],"summary":"Post projects with office with name turbineChanges","description":"Create CWMS Turbine Changes","operationId":"postProjectsWithOfficeWithNameTurbineChanges","parameters":[{"name":"office","in":"path","description":"Office id for the reservoir project location associated with the turbine changes.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Specifies the name of project of the Turbine changes whose data is to stored.","required":true,"schema":{"type":"string"}},{"name":"override-protection","in":"query","description":"A flag ('True'/'False') specifying whether to delete protected data. Default is False","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/TurbineChange"}},"application/json":{"schema":{"$ref":"#/components/schemas/TurbineChange"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Project Id or Turbine location Ids not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Turbine successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Turbines"],"summary":"Delete projects with office with name turbineChanges","description":"Delete CWMS Turbine Changes","operationId":"deleteProjectsWithOfficeWithNameTurbineChanges","parameters":[{"name":"office","in":"path","description":"Specifies the owning office of the project for changes to be deleted.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Specifies the name of project for the turbine changes to be deleted.","required":true,"schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window.","required":true,"schema":{"type":"string"}},{"name":"override-protection","in":"query","description":"A flag ('True'/'False') specifying whether to delete protected data. Default is False","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the project was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Turbine successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/outlets/{name}":{"get":{"tags":["Outlets"],"summary":"Get projects outlets with name","description":"Returns CWMS Outlet Data","operationId":"getProjectsOutletsWithName","parameters":[{"name":"name","in":"path","description":"Specifies the location-id of the Outlet to be created.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the outlet to be retrieved.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Outlet"}},"application/json":{"schema":{"$ref":"#/components/schemas/Outlet"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Outlets"],"summary":"Delete projects outlets with name","description":"Delete CWMS Outlet","operationId":"deleteProjectsOutletsWithName","parameters":[{"name":"name","in":"path","description":"Specifies the location-id of the outlet to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the outlet to be deleted.","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used. Defaults to \"DELETE_KEY\"","schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the outlet was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Outlet successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Outlets"],"summary":"Patch projects outlets with name","description":"Rename CWMS Outlet","operationId":"patchProjectsOutletsWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Specifies the new outlet location-id.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the outlet to be renamed.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"CWMS Outlet successfully renamed."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/outlets":{"get":{"tags":["Outlets"],"summary":"Get projects outlets","description":"Returns matching CWMS Outlet Data for a Reservoir Project.","operationId":"getProjectsOutlets","parameters":[{"name":"office","in":"query","description":"Office id for the reservoir project location associated with the outlets.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"query","description":"Specifies the project-id of the Outlets whose data is to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Outlet"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Outlet"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Outlets"],"summary":"Post projects outlets","description":"Create CWMS Outlet","operationId":"postProjectsOutlets","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Outlet"}},"application/json":{"schema":{"$ref":"#/components/schemas/Outlet"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Outlet successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/gate-changes":{"post":{"tags":["Outlets"],"summary":"Post projects gateChanges","description":"Create CWMS Gate Changes","operationId":"postProjectsGateChanges","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided Gate Changes already exist. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GateChange"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GateChange"}}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"201":{"description":"Gate Changes successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/{project-id}/gate-changes":{"get":{"tags":["Outlets"],"summary":"Get projects with office with projectId gateChanges","description":"Returns matching CWMS gate change data for a Reservoir Project.","operationId":"getProjectsWithOfficeWithProjectIdGateChanges","parameters":[{"name":"office","in":"path","description":"Office id for the reservoir project location associated with the Gate Changes.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"Specifies the project-id of the Gate Changes whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window.","required":true,"schema":{"type":"string"}},{"name":"start-time-inclusive","in":"query","description":"A flag specifying whether any data at the start time should be retrieved ('True') or only data after the start time ('False'). Default value is True","schema":{"type":"boolean"}},{"name":"end-time-inclusive","in":"query","description":"A flag ('True'/'False') specifying whether any data at the end time should be retrieved ('True') or only data before the end time ('False'). Default value is False","schema":{"type":"boolean"}},{"name":"unit-system","in":"query","description":"Unit System desired in response. Can be SI (International Scientific) or EN (Imperial.) If unspecified, defaults to EN.","schema":{"$ref":"#/components/schemas/UnitSystem"}},{"name":"page-size","in":"query","description":"the maximum number of gate changes to retrieve, regardless of time window. A positive integer is interpreted as the maximum number of changes from the beginning of the time window. A negative integer is interpreted as the maximum number from the end of the time window. Default 500.A page cursor will not be returned by this DTO. Instead, the next page can be determined by querying the next set of changes using the last returned change date and using start-time-inclusive=false","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GateChange"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GateChange"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Outlets"],"summary":"Delete projects with office with projectId gateChanges","description":"Deletes matching CWMS gate change data for a Reservoir Project.","operationId":"deleteProjectsWithOfficeWithProjectIdGateChanges","parameters":[{"name":"office","in":"path","description":"Office id for the reservoir project location associated with the Gate Changes.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"Specifies the project-id of the Gate Changes whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"begin","in":"query","description":"The start of the time window","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end of the time window.","required":true,"schema":{"type":"string"}},{"name":"override-protection","in":"query","description":"A flag ('True'/'False') specifying whether to delete protected data. Default is False","schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the project was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Gate changes successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/{project-id}/virtual-outlets/{name}":{"get":{"tags":["Outlets"],"summary":"Get projects with office with projectId virtualOutlets with name","description":"Returns CWMS Virtual Outlet Data","operationId":"getProjectsWithOfficeWithProjectIdVirtualOutletsWithName","parameters":[{"name":"office","in":"path","description":"Specifies the owning office of the virtual outlet to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"Specifies the project-id of the virtual outlets whose data is to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Specifies the location-id of the virtual outlet to be created.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/VirtualOutlet"}},"application/json":{"schema":{"$ref":"#/components/schemas/VirtualOutlet"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Outlets"],"summary":"Delete projects with office with projectId virtualOutlets with name","description":"Delete CWMS Virtual Outlet","operationId":"deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithName","parameters":[{"name":"office","in":"path","description":"Specifies the owning office of the virtual outlet to be deleted.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"Specifies the project id of the virtual outlet to be deleted.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Specifies the location id of the virtual outlet to be deleted","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used. Defaults to \"DELETE_KEY\"","schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the virtual outlet was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Virtual Outlet successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{office}/{project-id}/virtual-outlets":{"get":{"tags":["Outlets"],"summary":"Get projects with office with projectId virtualOutlets","description":"Returns matching CWMS Virtual Outlet Data for a Reservoir Project.","operationId":"getProjectsWithOfficeWithProjectIdVirtualOutlets","parameters":[{"name":"office","in":"path","description":"Office id for the reservoir project location associated with the virtual outlets. Defaults to the user session id.","required":true,"schema":{"type":"string"}},{"name":"project-id","in":"path","description":"Specifies the project-id of the virtual outlets whose data is to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualOutlet"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirtualOutlet"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/virtual-outlets":{"post":{"tags":["Outlets"],"summary":"Post projects virtualOutlets","description":"Create CWMS Virtual Outlet","operationId":"postProjectsVirtualOutlets","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/VirtualOutlet"}},"application/json":{"schema":{"$ref":"#/components/schemas/VirtualOutlet"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Virtual Outlet successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/locations":{"get":{"tags":["Projects"],"summary":"Get projects locations","description":"Get a list of project child locations","operationId":"getProjectsLocations","parameters":[{"name":"office","in":"query","required":true,"schema":{"type":"string"}},{"name":"project-like","in":"query","description":"Posix regular expression matching against the project_id.","schema":{"type":"string"}},{"name":"location-kind-like","in":"query","description":"Posix regular expression matching against the location kind. The pattern will be matched against the valid location-kinds for Project child locations:{\"EMBANKMENT\", \"TURBINE\", \"OUTLET\", \"LOCK\", \"GATE\"}. Multiple kinds can be matched by using Regular Expression OR clauses. For example: \"(TURBINE|OUTLET)\"","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectChildLocations"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects/{name}":{"get":{"tags":["Projects"],"summary":"Get projects with name","description":"Retrieves requested Project","operationId":"getProjectsWithName","parameters":[{"name":"name","in":"path","description":"Specifies the project to be included in the response.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the Project whose data is to be included in the response.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the Project was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Project"}}}},"501":{"description":"request format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Projects"],"summary":"Delete projects with name","description":"Deletes requested reservoir project","operationId":"deleteProjectsWithName","parameters":[{"name":"name","in":"path","description":"The project identifier to be deleted","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the project to be deleted","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","description":"Specifies the delete method used. Defaults to \"DELETE_KEY\"","schema":{"$ref":"#/components/schemas/DeleteMethod"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Projects"],"summary":"Patch projects with name","description":"Rename a project","operationId":"patchProjectsWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"The new name of the project","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"The office of the project to be renamed","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}},"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Project"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/projects":{"get":{"tags":["Projects"],"summary":"Get projects","description":"Returns Projects Data","operationId":"getProjects","parameters":[{"name":"office","in":"query","description":"Specifies the owning office of the data in the response. If this field is not specified, matching items from all offices shall be returned.","schema":{"type":"string"}},{"name":"id-mask","in":"query","description":"Project Id mask.","schema":{"type":"string"}},{"name":"page","in":"query","description":"This end point can return a lot of data, this identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 100.","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the projects were not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Projects"}}}},"501":{"description":"request format is not implemented"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Projects"],"summary":"Post projects","description":"Create new Project","operationId":"postProjects","parameters":[{"name":"fail-if-exists","in":"query","description":"Create will fail if provided ID already exists. Default: true","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json;version=1":{"schema":{"$ref":"#/components/schemas/Project"}},"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/properties/{name}":{"get":{"tags":["Properties"],"summary":"Get properties with name","description":"Returns CWMS Property Data","operationId":"getPropertiesWithName","parameters":[{"name":"name","in":"path","description":"Specifies the name of the property to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the property to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"category-id","in":"query","description":"Specifies the category id of the property to be retrieved.","required":true,"schema":{"type":"string"}},{"name":"default-value","in":"query","description":"Specifies the default value if the property does not exist.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Properties"],"summary":"Delete properties with name","description":"Delete CWMS Property","operationId":"deletePropertiesWithName","parameters":[{"name":"name","in":"path","description":"Specifies the name of the property to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the property to be deleted.","required":true,"schema":{"type":"string"}},{"name":"category-id","in":"query","description":"Specifies the category id of the property to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the property was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Property successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["Properties"],"summary":"Patch properties with name","description":"Update CWMS Property","operationId":"patchPropertiesWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Property successfully updated in CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/properties":{"get":{"tags":["Properties"],"summary":"Get properties","description":"Returns matching CWMS Property Data.","operationId":"getProperties","parameters":[{"name":"office-mask","in":"query","description":"Filters properties to the specified office mask","schema":{"type":"string"}},{"name":"category-id","in":"query","description":"Filters properties to the specified category mask","schema":{"type":"string"}},{"name":"name-mask","in":"query","description":"Filters properties to the specified name mask","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Property"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Properties"],"summary":"Post properties","description":"Create CWMS Property","operationId":"postProperties","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Property successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/lookup-types":{"get":{"tags":["LookupTypes"],"summary":"Get lookupTypes","description":"Returns matching CWMS Lookup Type Data.","operationId":"getLookupTypes","parameters":[{"name":"category","in":"query","description":"Filters lookup types to the specified category","required":true,"schema":{"type":"string"}},{"name":"prefix","in":"query","description":"Filters lookup types to the specified prefix","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Filters lookup types to the specified office ID","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LookupType"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["LookupTypes"],"summary":"Post lookupTypes","description":"Create CWMS Lookup Type","operationId":"postLookupTypes","parameters":[{"name":"category","in":"query","description":"Specifies the category id of the lookup type to be created.","required":true,"schema":{"type":"string"}},{"name":"prefix","in":"query","description":"Specifies the prefix of the lookup type to be created.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupType"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"Lookup Type successfully stored to CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/lookup-types/{name}":{"delete":{"tags":["LookupTypes"],"summary":"Delete lookupTypes with name","description":"Delete CWMS Lookup Type","operationId":"deleteLookupTypesWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"category","in":"query","description":"Specifies the category id of the lookup type to be deleted.","required":true,"schema":{"type":"string"}},{"name":"prefix","in":"query","description":"Specifies the prefix of the lookup type to be deleted.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the owning office of the lookup type to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Based on the combination of inputs provided the lookup type was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Lookup Type successfully deleted from CWMS."}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"patch":{"tags":["LookupTypes"],"summary":"Patch lookupTypes with name","description":"Update CWMS Lookup Type","operationId":"patchLookupTypesWithName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"category","in":"query","description":"Specifies the category id of the lookup type to be updated.","required":true,"schema":{"type":"string"}},{"name":"prefix","in":"query","description":"Specifies the prefix of the lookup type to be updated.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupType"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"Updated Lookup Type"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/project-locks/{name}":{"get":{"tags":["Project Locks"],"summary":"Get projectLocks with name","description":"Return a lock if the specified project is locked. Otherwise 404","operationId":"getProjectLocksWithName","parameters":[{"name":"name","in":"path","description":"The id of the project.","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"The office id.","required":true,"schema":{"type":"string"}},{"name":"application-id","in":"query","description":"The application-id","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"No matching Lock was found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectLock"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["Project Locks"],"summary":"Delete projectLocks with name","description":"Revokes a project lock, if successful the lock is deleted","operationId":"deleteProjectLocksWithName","parameters":[{"name":"name","in":"path","description":"Specifies the project-id to be deleted","required":true,"schema":{"type":"string"}},{"name":"office","in":"query","description":"Specifies the office of the lock.","required":true,"schema":{"type":"string"}},{"name":"revoke-timeout","in":"query","description":"time in seconds to wait for existing lock to be revoked. Default: 10","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/project-locks":{"get":{"tags":["Project Locks"],"summary":"Get projectLocks","description":"Get a list of project locks","operationId":"getProjectLocks","parameters":[{"name":"office-mask","in":"query","description":"Specifies the office mask to be used to filter the locks. Supports '*' but is typically a single office.","required":true,"schema":{"type":"string"}},{"name":"project-mask","in":"query","description":"Specifies the project mask to be used to filter the locks. Defaults to '*'","schema":{"type":"string"}},{"name":"application-mask","in":"query","description":"Specifies the application mask to be used to filter the locks. Defaults to '*'","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectLock"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"post":{"tags":["Project Locks"],"summary":"Post projectLocks","description":"Requests the creation of a new Reservoir Project Lock","operationId":"postProjectLocks","parameters":[{"name":"revoke-existing","in":"query","description":"If an existing lock is found should a revoke be attempted? Default: false","schema":{"type":"boolean"}},{"name":"revoke-timeout","in":"query","description":"time in seconds to wait for existing lock to be revoked. Default: 10","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Users must provide a Lock object specifying the officeId, projectId and applicationId. Other fields will be ignored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectLock"}}},"required":true},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectLockId"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/project-locks/deny":{"post":{"tags":["Project Locks"],"summary":"Post projectLocks deny","description":"Deny a Lock revoke request.","operationId":"postProjectLocksDeny","parameters":[{"name":"lock-id","in":"query","description":"The id of the lock.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/project-locks/release":{"post":{"tags":["Project Locks"],"summary":"Post projectLocks release","description":"Releases a project lock","operationId":"postProjectLocksRelease","parameters":[{"name":"office","in":"query","description":"The user's office.","required":true,"schema":{"type":"string"}},{"name":"lock-id","in":"query","description":"The id of the lock to release.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/project-lock-rights":{"get":{"tags":["Project Lock Revoker Rights"],"summary":"Get projectLockRights","description":"Get a list of project lock revoker rights ","operationId":"getProjectLockRights","parameters":[{"name":"office-mask","in":"query","description":"Specifies the office mask to be used to filter the lock revoker rights. Supports '*' but is typically a single office.","required":true,"schema":{"type":"string"}},{"name":"project-mask","in":"query","description":"Specifies the project mask to be used to filter the lock revoker rights. Defaults to '*'","schema":{"type":"string"}},{"name":"application-mask","in":"query","description":"Specifies the application mask to be used to filter the lock revoker rights. Defaults to '*'","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LockRevokerRights"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/project-lock-rights/remove-all":{"post":{"tags":["Project Lock Revoker Rights"],"summary":"Post projectLockRights removeAll","description":"Revokes a project lock, if successful the lock is deleted","operationId":"postProjectLockRightsRemoveAll","parameters":[{"name":"office","in":"query","description":"Specifies the session office.","required":true,"schema":{"type":"string"}},{"name":"application-id","in":"query","description":"Specifies the application id.","required":true,"schema":{"type":"string"}},{"name":"user-id","in":"query","description":"Specifies the user.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/project-lock-rights/update":{"post":{"tags":["Project Lock Revoker Rights"],"summary":"Post projectLockRights update","description":"Update Lock Revoker Rights.","operationId":"postProjectLockRightsUpdate","parameters":[{"name":"office","in":"query","description":"Specifies the session office.","required":true,"schema":{"type":"string"}},{"name":"project-mask","in":"query","description":"Specifies the project mask to be used Defaults to '*'","schema":{"type":"string"}},{"name":"application-id","in":"query","description":"Specifies the application id.","required":true,"schema":{"type":"string"}},{"name":"user-id","in":"query","description":"Specifies the user.","required":true,"schema":{"type":"string"}},{"name":"allow","in":"query","description":"True to add the user to the allow list, False to add to the deny list","required":true,"schema":{"type":"boolean"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/users/{user-name}":{"get":{"tags":["User Management"],"summary":"Get users with userName","description":"View specific user","operationId":"getUsersWithUserName","parameters":[{"name":"user-name","in":"path","description":"Specific user to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/users":{"get":{"tags":["User Management"],"summary":"Get users","description":"View all users","operationId":"getUsers","parameters":[{"name":"office","in":"query","description":"Show only users with active privileges in a given office.Office Identifier 3/4 letter as returned by the office endpoint.","allowEmptyValue":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"This end point can return a lot of data, this identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"How many entries per page returned. Default 100.","schema":{"type":"integer","format":"int32"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/roles":{"get":{"tags":["User Management"],"summary":"Get roles","description":"View all roles","operationId":"getRoles","responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/user/profile":{"get":{"tags":["User Management"],"summary":"Get user profile","description":"View users' own information","operationId":"getUserProfile","responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/user/{user-name}/roles/{office-id}":{"post":{"tags":["User Management"],"summary":"Post user with userName roles with officeId","description":"Add roles to user","operationId":"postUserWithUserNameRolesWithOfficeId","parameters":[{"name":"user-name","in":"path","description":"Name of the user to alter","required":true,"schema":{"type":"string"}},{"name":"office-id","in":"path","description":"Office for these roles.Office Identifier 3/4 letter as returned by the office endpoint.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"No Content"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]},"delete":{"tags":["User Management"],"summary":"Delete user with userName roles with officeId","description":"Remove roles from user","operationId":"deleteUserWithUserNameRolesWithOfficeId","parameters":[{"name":"user-name","in":"path","description":"Username of the user to alter","required":true,"schema":{"type":"string"}},{"name":"office-id","in":"path","description":"Office for these roles.Office Identifier 3/4 letter as returned by the office endpoint.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"204":{"description":"No Content"}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/version":{"get":{"tags":["Version"],"summary":"Get version","description":"Determine the current active version of CWMS Data API.","operationId":"getVersion","responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaVersion"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/rss/{office}/{name}":{"get":{"tags":["RSS"],"summary":"Get rss with office with name","description":"Returns RSS feed items limited to the last week.","operationId":"getRssWithOfficeWithName","parameters":[{"name":"office","in":"path","description":"Office id for feed.","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Specifies the name of the feed. eg TS_STORED, STATUS, REALTIME_OPS","required":true,"schema":{"type":"string"}},{"name":"since","in":"query","description":"The start the feed time window. The endpoint will not retrieve more than the last week of messages.","schema":{"type":"string"}},{"name":"page-size","in":"query","description":"The number of feed items to include.","schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"This end point can return a lot of data, this identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response.","schema":{"type":"string"}}],"responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Unknown Feed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"200":{"description":"OK","content":{"application/rss+xml":{"schema":{"$ref":"#/components/schemas/RssFeed"}}}}},"security":[{"ApiKey":[]},{"CwmsAAACacAuth":[]},{"OpenIDConnect":[]}]}},"/*":{"options":{"summary":"Options with wildcard","operationId":"optionsWithWildcard","responses":{"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdaError"}}}}}}}},"components":{"schemas":{"CdaError":{"type":"object","properties":{"message":{"type":"string"},"incidentIdentifier":{"type":"string","description":"A randomly generated UUID to help identify your request in the logs for analysis.."},"source":{"type":"string"},"details":{"type":"object","additionalProperties":{"type":"object"}}}},"ApiKey":{"required":["key-name","user-id"],"type":"object","properties":{"user-id":{"type":"string"},"key-name":{"type":"string"},"api-key":{"type":"string"},"created":{"type":"string","description":"The instant this Key was created, in ISO-8601 format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'')","format":"date-time","readOnly":true},"expires":{"type":"string","description":"When this key expires, in ISO-8601 format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'')","format":"date-time"}}},"location_category":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"description":{"type":"string"}},"description":"A representation of a location category"},"LocationCategory":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"description":{"type":"string"}},"description":"A representation of a location category"},"AssignedLocation":{"type":"object","properties":{"location-id":{"type":"string"},"office-id":{"type":"string"},"alias-id":{"type":"string"},"attribute":{"type":"number"},"ref-location-id":{"type":"string"}}},"location_group":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"location-category":{"$ref":"#/components/schemas/location_category"},"description":{"type":"string"},"shared-loc-alias-id":{"type":"string"},"shared-ref-location-id":{"type":"string"},"loc-group-attribute":{"type":"number"},"assigned-locations":{"type":"array","items":{"$ref":"#/components/schemas/AssignedLocation"}}},"description":"A representation of a location group"},"LocationGroup":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"location-category":{"$ref":"#/components/schemas/location_category"},"description":{"type":"string"},"shared-loc-alias-id":{"type":"string"},"shared-ref-location-id":{"type":"string"},"loc-group-attribute":{"type":"number"},"assigned-locations":{"type":"array","items":{"$ref":"#/components/schemas/AssignedLocation"}}},"description":"A representation of a location group"},"LocationGroup_CSV":{"type":"object","description":"Single LocationGroup or List of LocationGroups in comma separated format","example":"#LocationGroup Id, OfficeId, Description, CategoryId, CategoryOfficeId, SharedLocAliasId, SharedRefLocationId, LocGroupAttribute\r\nCERL,Construction Engineering Research Laboratory,Field Operating Activity\tERD\r\nCHL,Coastal and Hydraulics Laboratory,Field Operating Activity\tERD\r\nNAB,Baltimore District,District,NAD\r\nNAD,North Atlantic Division,Division Headquarters,HQ"},"CsvV1LocationGroup":{"type":"object","description":"Single LocationGroup or List of LocationGroups in comma separated format","example":"#LocationGroup Id, OfficeId, Description, CategoryId, CategoryOfficeId, SharedLocAliasId, SharedRefLocationId, LocGroupAttribute\r\nCERL,Construction Engineering Research Laboratory,Field Operating Activity\tERD\r\nCHL,Coastal and Hydraulics Laboratory,Field Operating Activity\tERD\r\nNAB,Baltimore District,District,NAD\r\nNAD,North Atlantic Division,Division Headquarters,HQ"},"Unit":{"type":"object"},"CwmsId":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"name":{"type":"string"}}},"CwmsIdLocationKind":{"type":"object","properties":{"location-kind-id":{"type":"string"},"location-id":{"$ref":"#/components/schemas/CwmsId"}}},"Location":{"required":["name","office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"name":{"type":"string"},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"active":{"type":"boolean"},"public-name":{"type":"string"},"long-name":{"type":"string"},"description":{"type":"string"},"timezone-name":{"type":"string"},"location-type":{"type":"string"},"location-kind":{"type":"string"},"nation":{"type":"string","enum":["US","CANADA","MEXICO"]},"state-initial":{"type":"string"},"county-name":{"type":"string"},"nearest-city":{"type":"string"},"horizontal-datum":{"type":"string"},"published-longitude":{"type":"number","format":"double"},"published-latitude":{"type":"number","format":"double"},"vertical-datum":{"type":"string"},"elevation":{"type":"number","format":"double"},"map-label":{"type":"string"},"bounding-office-id":{"type":"string"},"elevation-units":{"type":"string"},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/alias"}}}},"alias":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"Entity":{"required":["id"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/CwmsId"},"parent-entity-id":{"type":"string"},"category-id":{"type":"string"},"long-name":{"type":"string"}}},"state":{"required":["name","state-initial"],"type":"object","properties":{"state-initial":{"type":"string"},"name":{"type":"string"}},"description":"A representation of a state"},"State":{"required":["name","state-initial"],"type":"object","properties":{"state-initial":{"type":"string"},"name":{"type":"string"}},"description":"A representation of a state"},"county":{"required":["county-id","name","state-initial"],"type":"object","properties":{"name":{"type":"string"},"county-id":{"type":"string"},"state-initial":{"type":"string"}},"description":"A representation of a county"},"County":{"required":["county-id","name","state-initial"],"type":"object","properties":{"name":{"type":"string"},"county-id":{"type":"string"},"state-initial":{"type":"string"}},"description":"A representation of a county"},"OfficeFormatV1":{"type":"object","properties":{"offices":{"$ref":"#/components/schemas/OfficesFMT"}}},"OfficesFMT":{"type":"object","properties":{"offices":{"type":"array","items":{"$ref":"#/components/schemas/office"}}}},"office":{"type":"object","properties":{"name":{"type":"string"},"long-name":{"type":"string"},"type":{"type":"string","enum":["unknown","corps headquarters","division headquarters","division regional","district","filed operating activity"]},"reports-to":{"type":"string","description":"Reference to another office, like a division, that this office reports to."}},"description":"A representation of a CWMS office"},"Office":{"type":"object","properties":{"name":{"type":"string"},"long-name":{"type":"string"},"type":{"type":"string","enum":["unknown","corps headquarters","division headquarters","division regional","district","filed operating activity"]},"reports-to":{"type":"string","description":"Reference to another office, like a division, that this office reports to."}},"description":"A representation of a CWMS office"},"parameter":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"name":{"type":"string"},"base-parameter":{"type":"string"},"sub-parameter":{"type":"string"},"sub-parameter-description":{"type":"string"},"db-unit-id":{"type":"string"},"unit-long-name":{"type":"string"},"unit-description":{"type":"string"}}},"Parameter":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"name":{"type":"string"},"base-parameter":{"type":"string"},"sub-parameter":{"type":"string"},"sub-parameter-description":{"type":"string"},"db-unit-id":{"type":"string"},"unit-long-name":{"type":"string"},"unit-description":{"type":"string"}}},"time-zone":{"required":["time-zone"],"type":"object","properties":{"time-zone":{"type":"string"}}},"time-zones":{"type":"object","properties":{"time-zones":{"type":"array","items":{"$ref":"#/components/schemas/time-zone"}}}},"TimeZoneIds":{"type":"object","properties":{"time-zones":{"type":"array","items":{"$ref":"#/components/schemas/time-zone"}}}},"ConstantLocationLevel":{"required":["location-level-id","office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"location-level-id":{"type":"string","description":"Name of the location level"},"specified-level-id":{"type":"string","description":"Timeseries ID (e.g. from the times series catalog) to use as the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue"},"expiration-date":{"type":"string","description":"The expiration date of the location level.","format":"date-time"},"parameter-id":{"type":"string","description":"Data Type such as Stage, Elevation, or others."},"parameter-type-id":{"type":"string","description":"To indicate if single or aggregate value","enum":["Inst","Ave","Min","Max","Total"]},"interpolate-string":{"type":"string","description":"Indicating whether or not to interpolate between seasonal values.","enum":["T","F"]},"level-units-id":{"type":"string","description":"Units the provided levels are in"},"level-date":{"type":"string","description":"The date/time at which this location level configuration takes effect.","format":"date-time"},"level-comment":{"type":"string"},"duration-id":{"type":"string","description":"0 if parameterTypeId is Inst. Otherwise duration indicating the time window of the aggregate value."},"attribute-value":{"type":"number"},"attribute-units-id":{"type":"string"},"attribute-parameter-type-id":{"type":"string"},"attribute-parameter-id":{"type":"string"},"attribute-duration-id":{"type":"string"},"attribute-comment":{"type":"string"},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/alias"}},"constant-value":{"type":"number","description":"Single value for this location level.","format":"double"}}},"LocationLevel":{"required":["location-level-id","office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"location-level-id":{"type":"string","description":"Name of the location level"},"specified-level-id":{"type":"string","description":"Timeseries ID (e.g. from the times series catalog) to use as the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue"},"expiration-date":{"type":"string","description":"The expiration date of the location level.","format":"date-time"},"parameter-id":{"type":"string","description":"Data Type such as Stage, Elevation, or others."},"parameter-type-id":{"type":"string","description":"To indicate if single or aggregate value","enum":["Inst","Ave","Min","Max","Total"]},"interpolate-string":{"type":"string","description":"Indicating whether or not to interpolate between seasonal values.","enum":["T","F"]},"level-units-id":{"type":"string","description":"Units the provided levels are in"},"level-date":{"type":"string","description":"The date/time at which this location level configuration takes effect.","format":"date-time"},"level-comment":{"type":"string"},"duration-id":{"type":"string","description":"0 if parameterTypeId is Inst. Otherwise duration indicating the time window of the aggregate value."},"attribute-value":{"type":"number"},"attribute-units-id":{"type":"string"},"attribute-parameter-type-id":{"type":"string"},"attribute-parameter-id":{"type":"string"},"attribute-duration-id":{"type":"string"},"attribute-comment":{"type":"string"},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/alias"}}},"readOnly":true,"oneOf":[{"$ref":"#/components/schemas/ConstantLocationLevel"},{"$ref":"#/components/schemas/TimeSeriesLocationLevel"},{"$ref":"#/components/schemas/SeasonalLocationLevel"},{"$ref":"#/components/schemas/VirtualLocationLevel"}]},"LocationLevelConstituent":{"type":"object","allOf":[{"$ref":"#/components/schemas/RATING"},{"type":"object","properties":{"attribute-id":{"type":"string"},"attribute-value":{"type":"number","format":"double"},"attribute-units":{"type":"string"}}}]},"RATING":{"type":"object","properties":{"abbr":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"constituent-list":{"type":"array","items":{"type":"string"}}},"discriminator":{"propertyName":"type"}},"SeasonalLocationLevel":{"required":["location-level-id","office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"location-level-id":{"type":"string","description":"Name of the location level"},"specified-level-id":{"type":"string","description":"Timeseries ID (e.g. from the times series catalog) to use as the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue"},"expiration-date":{"type":"string","description":"The expiration date of the location level.","format":"date-time"},"parameter-id":{"type":"string","description":"Data Type such as Stage, Elevation, or others."},"parameter-type-id":{"type":"string","description":"To indicate if single or aggregate value","enum":["Inst","Ave","Min","Max","Total"]},"interpolate-string":{"type":"string","description":"Indicating whether or not to interpolate between seasonal values.","enum":["T","F"]},"level-units-id":{"type":"string","description":"Units the provided levels are in"},"level-date":{"type":"string","description":"The date/time at which this location level configuration takes effect.","format":"date-time"},"level-comment":{"type":"string"},"duration-id":{"type":"string","description":"0 if parameterTypeId is Inst. Otherwise duration indicating the time window of the aggregate value."},"attribute-value":{"type":"number"},"attribute-units-id":{"type":"string"},"attribute-parameter-type-id":{"type":"string"},"attribute-parameter-id":{"type":"string"},"attribute-duration-id":{"type":"string"},"attribute-comment":{"type":"string"},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/alias"}},"interval-origin":{"type":"string","description":"The start point of provided seasonal values","format":"date-time"},"interval-months":{"type":"integer","format":"int32"},"interval-minutes":{"type":"integer","format":"int32"},"seasonal-values":{"type":"array","description":"List of Repeating seasonal values. The values repeat after the specified interval. A yearly interval seasonable could have 12 different values, one for each month for example. Mutually exclusive with seasonalTimeSeriesId and siParameterUnitsConstantValue","items":{"$ref":"#/components/schemas/SeasonalValueBean"}}}},"SeasonalValueBean":{"type":"object","properties":{"value":{"type":"number","format":"double"},"offset-months":{"type":"integer","format":"int32"},"offset-minutes":{"type":"integer"}},"description":"List of Repeating seasonal values. The values repeat after the specified interval. A yearly interval seasonable could have 12 different values, one for each month for example. Mutually exclusive with seasonalTimeSeriesId and siParameterUnitsConstantValue"},"TimeSeriesLocationLevel":{"required":["location-level-id","office-id","seasonal-time-series-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"location-level-id":{"type":"string","description":"Name of the location level"},"specified-level-id":{"type":"string","description":"Timeseries ID (e.g. from the times series catalog) to use as the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue"},"expiration-date":{"type":"string","description":"The expiration date of the location level.","format":"date-time"},"parameter-id":{"type":"string","description":"Data Type such as Stage, Elevation, or others."},"parameter-type-id":{"type":"string","description":"To indicate if single or aggregate value","enum":["Inst","Ave","Min","Max","Total"]},"interpolate-string":{"type":"string","description":"Indicating whether or not to interpolate between seasonal values.","enum":["T","F"]},"level-units-id":{"type":"string","description":"Units the provided levels are in"},"level-date":{"type":"string","description":"The date/time at which this location level configuration takes effect.","format":"date-time"},"level-comment":{"type":"string"},"duration-id":{"type":"string","description":"0 if parameterTypeId is Inst. Otherwise duration indicating the time window of the aggregate value."},"attribute-value":{"type":"number"},"attribute-units-id":{"type":"string"},"attribute-parameter-type-id":{"type":"string"},"attribute-parameter-id":{"type":"string"},"attribute-duration-id":{"type":"string"},"attribute-comment":{"type":"string"},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/alias"}},"seasonal-time-series-id":{"type":"string","description":"Timeseries ID (e.g. from the times series catalog) to use as the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue"}}},"VirtualLocationLevel":{"required":["location-level-id","office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"location-level-id":{"type":"string","description":"Name of the location level"},"specified-level-id":{"type":"string","description":"Timeseries ID (e.g. from the times series catalog) to use as the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue"},"expiration-date":{"type":"string","description":"The expiration date of the location level.","format":"date-time"},"parameter-id":{"type":"string","description":"Data Type such as Stage, Elevation, or others."},"parameter-type-id":{"type":"string","description":"To indicate if single or aggregate value","enum":["Inst","Ave","Min","Max","Total"]},"interpolate-string":{"type":"string","description":"Indicating whether or not to interpolate between seasonal values.","enum":["T","F"]},"level-units-id":{"type":"string","description":"Units the provided levels are in"},"level-date":{"type":"string","description":"The date/time at which this location level configuration takes effect.","format":"date-time"},"level-comment":{"type":"string"},"duration-id":{"type":"string","description":"0 if parameterTypeId is Inst. Otherwise duration indicating the time window of the aggregate value."},"attribute-value":{"type":"number"},"attribute-units-id":{"type":"string"},"attribute-parameter-type-id":{"type":"string"},"attribute-parameter-id":{"type":"string"},"attribute-duration-id":{"type":"string"},"attribute-comment":{"type":"string"},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/alias"}},"constituents":{"type":"array","items":{"$ref":"#/components/schemas/RATING"}},"constituent-connections":{"type":"string"}}},"location-levels":{"type":"object","properties":{"levels":{"type":"array","description":"List of retrieved location levels","items":{"$ref":"#/components/schemas/LocationLevel"}},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"LocationLevels":{"type":"object","properties":{"levels":{"type":"array","description":"List of retrieved location levels","items":{"$ref":"#/components/schemas/LocationLevel"}},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"Offset":{"type":"object","properties":{"estimate":{"type":"boolean"},"to-datum":{"type":"string"},"value":{"type":"number","format":"double"}}},"TimeSeries.Column":{"type":"object","properties":{"name":{"type":"string"},"ordinal":{"type":"integer","format":"int32"},"datatype":{"type":"string"}},"readOnly":true},"TimeSeries.Record":{"type":"object","properties":{"date-time":{"type":"integer","description":"Milliseconds since 1970-01-01 (Unix Epoch), always UTC","format":"int64"},"value":{"type":"number","description":"Requested time-series data value","format":"double"},"quality-code":{"type":"integer","format":"int32"}},"description":"List of rated time-series values"},"timeseries":{"required":["units"],"type":"object","properties":{"begin":{"type":"string","description":"The requested start time of the data, in ISO-8601 format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'')","format":"date-time","readOnly":true},"date-version-type":{"type":"string","description":"Version type specifies the type of timeseries response to be received. Can be max aggregate or single version. Max aggregate cannot be run if version date field is specified.","enum":["MAX_AGGREGATE","SINGLE_VERSION","UNVERSIONED"]},"end":{"type":"string","description":"The requested end time of the data, in ISO-8601 format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'')","format":"date-time","readOnly":true},"interval":{"type":"object","properties":{"seconds":{"type":"integer","format":"int64"},"zero":{"type":"boolean"},"units":{"type":"array","items":{"type":"object","properties":{"timeBased":{"type":"boolean"},"duration":{"type":"object","properties":{"seconds":{"type":"integer","format":"int64"},"zero":{"type":"boolean"},"negative":{"type":"boolean"},"nano":{"type":"integer","format":"int32"}}},"durationEstimated":{"type":"boolean"},"dateBased":{"type":"boolean"}}}},"negative":{"type":"boolean"},"nano":{"type":"integer","format":"int32"}},"description":"The interval of the time-series, in ISO-8601 duration format","format":"Java Duration","readOnly":true},"interval-offset":{"type":"integer","description":"Offset from top of interval","format":"int64","readOnly":true},"name":{"type":"string","description":"Time-series name"},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"office-id":{"type":"string","description":"Office ID that owns the time-series"},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"time-zone":{"type":"string","description":"Only on 21.1.1 Database. The timezone the Interval Offset is from.","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true},"units":{"type":"string","description":"The units of the time series data"},"value-columns":{"type":"array","description":"The columns of the time-series data array returned, this property is used to describe the data structure of the records array. Contains [name, ordinal, datatype]. Name corresponds to the variable described by the data, ordinal is the order of the column in the data value array returned (starts at index 1), and datatype is the class name of the data type for the variable. Since the records array can be of variable length, the column index value is used to identify the position of the data in the array.","readOnly":true,"items":{"$ref":"#/components/schemas/TimeSeries.Column"}},"values":{"type":"array","items":{"type":"array","description":"Time is Milliseconds since the UNIX Epoch. Value is Double (for missing data you can use null, or -Float.MAX_VALUE (-340282346638528859811704183484516925440), quality is an integer.) If you are using missing data set the quality to 5.Failure to do this may result in silently ignoring that value on not storing a placeholder which can be important in irregular and psuedo regular timeseries.","example":[1509654000000,54.3,0],"items":{"type":"object","properties":{"date-time":{"type":"integer","description":"Milliseconds since 1970-01-01 (Unix Epoch), always UTC","format":"int64"},"value":{"type":"number","description":"Requested time-series data value","format":"double"},"quality-code":{"type":"integer","format":"int32"}},"description":"List of retrieved time-series values. The values-columns property describes the structure of the data value array. Refer to the value-columns property for more information."}}},"version-date":{"type":"string","description":"The version date of the time series trace","format":"date-time"},"vertical-datum-info":{"$ref":"#/components/schemas/vertical-datum-info"}}},"vertical-datum-info":{"type":"object","properties":{"office":{"type":"string"},"unit":{"type":"string"},"location":{"type":"string"},"native-datum":{"type":"string"},"elevation":{"type":"number","format":"double"},"local-datum-name":{"type":"string"},"offsets":{"type":"array","items":{"$ref":"#/components/schemas/Offset"}}}},"TimeSeries":{"required":["units"],"type":"object","properties":{"begin":{"type":"string","description":"The requested start time of the data, in ISO-8601 format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'')","format":"date-time","readOnly":true},"date-version-type":{"type":"string","description":"Version type specifies the type of timeseries response to be received. Can be max aggregate or single version. Max aggregate cannot be run if version date field is specified.","enum":["MAX_AGGREGATE","SINGLE_VERSION","UNVERSIONED"]},"end":{"type":"string","description":"The requested end time of the data, in ISO-8601 format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'')","format":"date-time","readOnly":true},"interval":{"type":"object","properties":{"seconds":{"type":"integer","format":"int64"},"zero":{"type":"boolean"},"units":{"type":"array","items":{"type":"object","properties":{"timeBased":{"type":"boolean"},"duration":{"type":"object","properties":{"seconds":{"type":"integer","format":"int64"},"zero":{"type":"boolean"},"negative":{"type":"boolean"},"nano":{"type":"integer","format":"int32"}}},"durationEstimated":{"type":"boolean"},"dateBased":{"type":"boolean"}}}},"negative":{"type":"boolean"},"nano":{"type":"integer","format":"int32"}},"description":"The interval of the time-series, in ISO-8601 duration format","format":"Java Duration","readOnly":true},"interval-offset":{"type":"integer","description":"Offset from top of interval","format":"int64","readOnly":true},"name":{"type":"string","description":"Time-series name"},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"office-id":{"type":"string","description":"Office ID that owns the time-series"},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"time-zone":{"type":"string","description":"Only on 21.1.1 Database. The timezone the Interval Offset is from.","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true},"units":{"type":"string","description":"The units of the time series data"},"value-columns":{"type":"array","description":"The columns of the time-series data array returned, this property is used to describe the data structure of the records array. Contains [name, ordinal, datatype]. Name corresponds to the variable described by the data, ordinal is the order of the column in the data value array returned (starts at index 1), and datatype is the class name of the data type for the variable. Since the records array can be of variable length, the column index value is used to identify the position of the data in the array.","readOnly":true,"items":{"$ref":"#/components/schemas/TimeSeries.Column"}},"values":{"type":"array","items":{"type":"array","description":"Time is Milliseconds since the UNIX Epoch. Value is Double (for missing data you can use null, or -Float.MAX_VALUE (-340282346638528859811704183484516925440), quality is an integer.) If you are using missing data set the quality to 5.Failure to do this may result in silently ignoring that value on not storing a placeholder which can be important in irregular and psuedo regular timeseries.","example":[1509654000000,54.3,0],"items":{"type":"object","properties":{"date-time":{"type":"integer","description":"Milliseconds since 1970-01-01 (Unix Epoch), always UTC","format":"int64"},"value":{"type":"number","description":"Requested time-series data value","format":"double"},"quality-code":{"type":"integer","format":"int32"}},"description":"List of retrieved time-series values. The values-columns property describes the structure of the data value array. Refer to the value-columns property for more information."}}},"version-date":{"type":"string","description":"The version date of the time series trace","format":"date-time"},"vertical-datum-info":{"$ref":"#/components/schemas/vertical-datum-info"}}},"UnitSystem":{"type":"string","description":"Unit System desired in response. Can be SI (International Scientific) or EN (Imperial.) If unspecified, defaults to SI.","enum":["SI","EN"]},"Tsv":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TsvId"},"value":{"type":"number","format":"double"},"qualityCode":{"type":"integer","format":"int64"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"}}},"TsvId":{"type":"object","properties":{"tsCode":{"type":"integer","format":"int64"},"dateTime":{"type":"string","format":"date-time"},"versionDate":{"type":"string","format":"date-time"},"dataEntryDate":{"type":"string","format":"date-time"}}},"StandardTextId":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"}}},"StandardTextValue":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StandardTextId"},"standard-text":{"type":"string"}}},"StandardTextCatalog":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/StandardTextValue"}}}},"DeleteMethod":{"type":"string","enum":["DELETE_ALL","DELETE_KEY","DELETE_DATA"]},"RegularTextTimeSeriesRow":{"type":"object","properties":{"date-time":{"type":"string","format":"date-time"},"data-entry-date":{"type":"string","format":"date-time"},"text-value":{"type":"string"},"filename":{"type":"string"},"media-type":{"type":"string"},"quality-code":{"type":"integer","format":"int64"},"dest-flag":{"type":"integer","format":"int32"},"value-url":{"type":"string"}}},"TextTimeSeries":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"name":{"type":"string"},"interval-offset":{"type":"integer","format":"int64"},"time-zone":{"type":"string"},"date-version-type":{"type":"string","description":"Version type specifies the type of timeseries response to be received. Can be max aggregate or single version. Max aggregate cannot be run if version date field is specified.","enum":["MAX_AGGREGATE","SINGLE_VERSION","UNVERSIONED"]},"version-date":{"type":"string","description":"The version date of the time series trace","format":"date-time"},"regular-text-values":{"type":"array","items":{"$ref":"#/components/schemas/RegularTextTimeSeriesRow"}}}},"BinaryTimeSeries":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"name":{"type":"string"},"interval-offset":{"type":"integer","format":"int64"},"time-zone":{"type":"string"},"date-version-type":{"type":"string","description":"Version type specifies the type of timeseries response to be received. Can be max aggregate or single version. Max aggregate cannot be run if version date field is specified.","enum":["MAX_AGGREGATE","SINGLE_VERSION","UNVERSIONED"]},"version-date":{"type":"string","description":"The version date of the time series trace","format":"date-time"},"binary-values":{"type":"array","items":{"$ref":"#/components/schemas/BinaryTimeSeriesRow"}}}},"BinaryTimeSeriesRow":{"type":"object","properties":{"date-time":{"type":"string","format":"date-time"},"data-entry-date":{"type":"string","format":"date-time"},"media-type":{"type":"string"},"filename":{"type":"string"},"dest-flag":{"type":"integer","format":"int32"},"binary-value":{"type":"string","format":"byte"},"value-url":{"type":"string"},"quality-code":{"type":"integer","format":"int64"}}},"TimeSeriesProfile":{"type":"object","properties":{"location-id":{"$ref":"#/components/schemas/CwmsId"},"description":{"type":"string","description":"Description"},"parameter-list":{"type":"array","description":"Dependent Parameters","items":{"type":"string","description":"Dependent Parameters"}},"key-parameter":{"type":"string","description":"Independent Parameter"},"reference-ts-id":{"$ref":"#/components/schemas/CwmsId"}}},"TimeSeriesProfileList":{"type":"object","properties":{"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"profile-list":{"type":"array","items":{"$ref":"#/components/schemas/TimeSeriesProfile"}},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"ParameterInfo":{"required":["type"],"type":"object","properties":{"parameter":{"type":"string"},"unit":{"type":"string"},"parameterInfoString":{"type":"string"},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"ParameterInfoColumnar":{"type":"object","allOf":[{"$ref":"#/components/schemas/ParameterInfo"},{"type":"object","properties":{"start-column":{"type":"integer","format":"int32"},"end-column":{"type":"integer","format":"int32"}}}]},"ParameterInfoIndexed":{"type":"object","allOf":[{"$ref":"#/components/schemas/ParameterInfo"},{"type":"object","properties":{"index":{"type":"integer","format":"int32"}}}]},"TimeSeriesProfileParser":{"type":"object","properties":{"location-id":{"$ref":"#/components/schemas/CwmsId"},"key-parameter":{"type":"string"},"record-delimiter":{"type":"string"},"time-format":{"type":"string"},"time-zone":{"type":"string"},"parameter-info-list":{"type":"array","items":{"$ref":"#/components/schemas/ParameterInfo"}},"time-in-two-fields":{"type":"boolean"},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"TimeSeriesProfileParserColumnar":{"type":"object","allOf":[{"$ref":"#/components/schemas/TimeSeriesProfileParser"},{"type":"object","properties":{"time-start-column":{"type":"integer","format":"int32"},"time-end-column":{"type":"integer","format":"int32"}}}]},"TimeSeriesProfileParserIndexed":{"required":["field-delimiter","time-field"],"type":"object","allOf":[{"$ref":"#/components/schemas/TimeSeriesProfileParser"},{"type":"object","properties":{"field-delimiter":{"type":"string"},"time-field":{"type":"integer","format":"int64"}}}]},"DataColumnInfo":{"type":"object","properties":{"name":{"type":"string"},"ordinal":{"type":"integer","format":"int32"},"datatype":{"type":"string"}}},"ParameterColumnInfo":{"type":"object","properties":{"parameter":{"type":"string"},"ordinal":{"type":"integer","format":"int32"},"unit":{"type":"string"}}},"TimeSeriesData":{"type":"object","properties":{"value":{"type":"number","format":"double"},"quality":{"type":"integer","format":"int32"}}},"TimeSeriesProfileInstance":{"type":"object","properties":{"data-columns":{"type":"array","items":{"$ref":"#/components/schemas/DataColumnInfo"}},"first-date":{"type":"string","format":"date-time"},"last-date":{"type":"string","format":"date-time"},"location-time-zone":{"type":"string"},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-first-date":{"type":"string","format":"date-time"},"page-last-date":{"type":"string","format":"date-time"},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"parameter-columns":{"type":"array","items":{"$ref":"#/components/schemas/ParameterColumnInfo"}},"time-series-list":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/TimeSeriesData"}}},"time-series-profile":{"$ref":"#/components/schemas/TimeSeriesProfile"},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true},"version":{"type":"string"},"version-date":{"type":"string","format":"date-time"}}},"StoreRule":{"type":"string","enum":["REPLACE ALL","DO NOT REPLACE","REPLACE MISSING VALUES ONLY","REPLACE WITH NON MISSING","DELETE INSERT"]},"timeseries-category":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"description":{"type":"string"}},"description":"A representation of a TimeSeries category"},"TimeSeriesCategory":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"description":{"type":"string"}},"description":"A representation of a TimeSeries category"},"TimeSeriesIdentifierDescriptor":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"time-series-id":{"type":"string"},"timezone-name":{"type":"string"},"interval-offset-minutes":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"aliases":{"type":"array","items":{"type":"string"}}}},"TimeSeriesIdentifierDescriptors":{"type":"object","properties":{"descriptors":{"type":"array","items":{"$ref":"#/components/schemas/TimeSeriesIdentifierDescriptor"}},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"AssignedTimeSeries":{"type":"object","properties":{"officeId":{"type":"string"},"timeseriesId":{"type":"string"},"aliasId":{"type":"string"},"refTsId":{"type":"string"},"attribute":{"type":"integer","format":"int32"}}},"timeseries-group":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"time-series-category":{"$ref":"#/components/schemas/timeseries-category"},"description":{"type":"string"},"shared-alias-id":{"type":"string"},"shared-ref-ts-id":{"type":"string"},"assigned-time-series":{"type":"array","items":{"$ref":"#/components/schemas/AssignedTimeSeries"}}},"description":"A representation of a timeseries group"},"TimeSeriesGroup":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"time-series-category":{"$ref":"#/components/schemas/timeseries-category"},"description":{"type":"string"},"shared-alias-id":{"type":"string"},"shared-ref-ts-id":{"type":"string"},"assigned-time-series":{"type":"array","items":{"$ref":"#/components/schemas/AssignedTimeSeries"}}},"description":"A representation of a timeseries group"},"VerticalDatum":{"type":"string","enum":["NAVD88","NGVD29","NATIVE","OTHER"]},"RateInputValues":{"required":["input-units","output-unit","values"],"type":"object","properties":{"output-unit":{"type":"string","description":"The units of the output values"},"rating-time":{"type":"integer","description":"A specific date/time to use as the \"current time\" of the rating. No ratings with a create date later than this will be used. Useful for performing historical ratings. If not specified or NULL, the current time is use.","format":"int64"},"round":{"type":"boolean","description":"A flag specifying whether to round the rated values according to the rounding spec contained in the rating specification. Defaults to false."},"values":{"type":"array","items":{"type":"array","description":"The input values. Each value array must be the same length. Must be length 1 for reverse rate.","items":{"type":"number","description":"The input values. Each value array must be the same length. Must be length 1 for reverse rate.","format":"double"}}},"value-times":{"type":"array","items":{"type":"integer","format":"int64"}},"input-units":{"type":"array","items":{"type":"string","description":"The unit of input values and the desired unit of the output. Length of the array must be equal to the number of input value arrays."}}}},"RatedOutputValues":{"required":["rating-id","unit","values"],"type":"object","properties":{"rating-id":{"$ref":"#/components/schemas/CwmsId"},"unit":{"type":"string","description":"The unit of the rated output data"},"values":{"type":"array","items":{"type":"number","description":"List of rated values","format":"double"}}}},"RateInputTimeSeries":{"required":["end-time","output-unit","start-time","time-series-ids"],"type":"object","properties":{"output-unit":{"type":"string","description":"The units of the output values"},"rating-time":{"type":"integer","description":"A specific date/time to use as the \"current time\" of the rating. No ratings with a create date later than this will be used. Useful for performing historical ratings. If not specified or NULL, the current time is use.","format":"int64"},"round":{"type":"boolean","description":"A flag specifying whether to round the rated values according to the rounding spec contained in the rating specification. Defaults to false."},"time-series-ids":{"type":"array","items":{"type":"string","description":"A collection of time series identifiers of the time series to rate, in position order of the parameters of the rating.Must be size 1 for reverse rate."}},"start-time":{"type":"integer","description":"The start of the time window to rate.Represents milliseconds since 1970-01-01 (Unix Epoch), always UTC.","format":"int64"},"end-time":{"type":"integer","description":"The end of the time window to rate.Represents milliseconds since 1970-01-01 (Unix Epoch), always UTC.","format":"int64"},"version-date":{"type":"integer","description":"Specifies the version date of the retrieve time series. Represents milliseconds since 1970-01-01 (Unix Epoch), always UTC.","format":"int64"},"trim":{"type":"boolean","description":"Specifies whether to trim missing values from the ends of the retrieved time series. Defaults to false."},"start-inclusive":{"type":"boolean","description":"Specifies whether the time window starts on or after the specified time. Defaults to true."},"end-inclusive":{"type":"boolean","description":"Specifies whether the time window ends on or before the specified time. Defaults to true;"},"previous":{"type":"boolean","description":"Specifies whether to retrieve the latest value before the start of the time window. Defaults to false."},"next":{"type":"boolean","description":"Specifies whether to retrieve the earliest value after the end of the time window. Defaults to false."}}},"RatedOutputTimeSeries":{"required":["rating-id","unit"],"type":"object","properties":{"rating-id":{"$ref":"#/components/schemas/CwmsId"},"unit":{"type":"string","description":"The unit of the rated output data"},"values":{"type":"array","items":{"type":"array","description":"Time is Milliseconds since the UNIX Epoch. Value is Double (for missing data you can use null, or -Float.MAX_VALUE (-340282346638528859811704183484516925440), quality is an integer.) If you are using missing data set the quality to 5.Failure to do this may result in silently ignoring that value on not storing a placeholder which can be important in irregular and psuedo regular timeseries.","example":[1509654000000,54.3,0],"items":{"type":"object","properties":{"date-time":{"type":"integer","description":"Milliseconds since 1970-01-01 (Unix Epoch), always UTC","format":"int64"},"value":{"type":"number","description":"Requested time-series data value","format":"double"},"quality-code":{"type":"integer","format":"int32"}},"description":"List of rated time-series values"}}},"value-columns":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/TimeSeries.Column"}}}},"ParameterSpec":{"type":"object","properties":{"parameter":{"type":"string"},"in-range-method":{"type":"string"},"out-range-low-method":{"type":"string"},"out-range-high-method":{"type":"string"}}},"RatingTemplate":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"version":{"type":"string"},"description":{"type":"string"},"dependent-parameter":{"type":"string"},"independent-parameter-specs":{"type":"array","items":{"$ref":"#/components/schemas/ParameterSpec"}},"rating-ids":{"type":"array","items":{"type":"string"}}}},"RatingTemplates":{"type":"object","properties":{"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"templates":{"type":"array","items":{"$ref":"#/components/schemas/RatingTemplate"}},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"IndependentRoundingSpec":{"type":"object","properties":{"position":{"type":"integer","format":"int32"},"value":{"type":"string"}}},"RatingSpec":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"rating-id":{"type":"string"},"template-id":{"type":"string"},"location-id":{"type":"string"},"version":{"type":"string"},"source-agency":{"type":"string"},"in-range-method":{"type":"string"},"out-range-low-method":{"type":"string"},"out-range-high-method":{"type":"string"},"active":{"type":"boolean"},"auto-update":{"type":"boolean"},"auto-activate":{"type":"boolean"},"auto-migrate-extension":{"type":"boolean"},"independent-rounding-specs":{"type":"array","items":{"$ref":"#/components/schemas/IndependentRoundingSpec"}},"dependent-rounding-spec":{"type":"string"},"description":{"type":"string"},"effective-dates":{"type":"array","items":{"type":"string","format":"date-time"}}}},"RatingSpecs":{"type":"object","properties":{"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"specs":{"type":"array","items":{"$ref":"#/components/schemas/RatingSpec"}},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"AbstractRatingMetadata":{"type":"object","properties":{"office-id":{"type":"string"},"rating-spec-id":{"type":"string"},"units-id":{"type":"string"},"active":{"type":"boolean"},"effective-date":{"type":"string","format":"date-time"},"create-date":{"type":"string","format":"date-time"},"transition-date":{"type":"string","format":"date-time"},"description":{"type":"string"},"vertical-datum-info":{"$ref":"#/components/schemas/vertical-datum-info"},"rating-type":{"type":"string"}},"description":"Rating Metadata","discriminator":{"propertyName":"rating-type","mapping":{"table":"#/components/schemas/TableRating","transitional":"#/components/schemas/TransitionalRating","virtual":"#/components/schemas/VirtualRating","expression-rating":"#/components/schemas/ExpressionRating","usgs":"#/components/schemas/UsgsStreamRating"}},"oneOf":[{"$ref":"#/components/schemas/TableRating"},{"$ref":"#/components/schemas/TransitionalRating"},{"$ref":"#/components/schemas/VirtualRating"},{"$ref":"#/components/schemas/ExpressionRating"},{"$ref":"#/components/schemas/UsgsStreamRating"}]},"ExpressionRating":{"type":"object","allOf":[{"$ref":"#/components/schemas/AbstractRatingMetadata"},{"type":"object","properties":{"expression":{"type":"string"}}}]},"RatingMetadata":{"type":"object","properties":{"rating-spec":{"$ref":"#/components/schemas/RatingSpec"},"ratings":{"type":"array","items":{"$ref":"#/components/schemas/AbstractRatingMetadata"}}}},"RatingMetadataList":{"type":"object","properties":{"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"rating-metadata":{"type":"array","items":{"$ref":"#/components/schemas/RatingMetadata"}},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"SourceRating":{"type":"object"},"TableRating":{"type":"object","allOf":[{"$ref":"#/components/schemas/AbstractRatingMetadata"},{"type":"object","properties":{"in-range-method":{"type":"string"},"out-range-low-method":{"type":"string"},"out-range-high-method":{"type":"string"}}}]},"TransitionalRating":{"type":"object","allOf":[{"$ref":"#/components/schemas/AbstractRatingMetadata"},{"type":"object","properties":{"source-ratings":{"type":"array","items":{"type":"string"}},"conditions":{"type":"array","items":{"type":"string"}},"evaluations":{"type":"array","items":{"type":"string"}}}}]},"UsgsStreamRating":{"type":"object","allOf":[{"$ref":"#/components/schemas/TableRating"}]},"VirtualRating":{"type":"object","allOf":[{"$ref":"#/components/schemas/AbstractRatingMetadata"},{"type":"object","properties":{"source-ratings":{"type":"array","items":{"$ref":"#/components/schemas/SourceRating"}},"connections":{"type":"string"}}}]},"RatingEffectiveDatesMap":{"type":"object","properties":{"office-to-spec-dates":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/RatingSpecEffectiveDates"}}}}},"RatingSpecEffectiveDates":{"required":["rating-spec-id"],"type":"object","properties":{"rating-spec-id":{"type":"string"},"effective-dates":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"date-time"}}}},"DatabaseLoadMethod":{"type":"string","enum":["EAGER","LAZY","REFERENCE"]},"CatalogableEndpoint":{"type":"string","description":"Set of data for which a larger catalog can be built.","enum":["TIMESERIES","LOCATIONS"]},"CatalogEntry":{"type":"object","properties":{"office":{"type":"string"}},"oneOf":[{"$ref":"#/components/schemas/LocationCatalogEntry"},{"$ref":"#/components/schemas/TimeseriesCatalogEntry"}]},"LocationCatalogEntry":{"type":"object","properties":{"office":{"type":"string"},"name":{"type":"string"},"nearest-city":{"type":"string"},"public-name":{"type":"string"},"long-name":{"type":"string"},"description":{"type":"string"},"kind":{"type":"string"},"type":{"type":"string"},"time-zone":{"type":"string"},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"published-latitude":{"type":"number","format":"double"},"published-longitude":{"type":"number","format":"double"},"horizontal-datum":{"type":"string"},"elevation":{"type":"number","format":"double"},"unit":{"type":"string"},"vertical-datum":{"type":"string"},"nation":{"type":"string"},"state":{"type":"string"},"county":{"type":"string"},"bounding-office":{"type":"string"},"map-label":{"type":"string"},"active":{"type":"boolean"},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/alias"}}}},"TimeSeriesExtents":{"type":"object","properties":{"earliest-time":{"type":"string","description":"Earliest value in the timeseries","format":"date-time"},"latest-time":{"type":"string","description":"Latest value in the timeseries","format":"date-time"},"version-time":{"type":"string","description":"TimeSeries version to which this extent information applies","format":"date-time"},"last-update":{"type":"string","description":"Last update in the timeseries","format":"date-time"}},"description":"TimeSeries extent information"},"TimeseriesCatalogEntry":{"type":"object","properties":{"office":{"type":"string"},"name":{"type":"string"},"units":{"type":"string"},"interval":{"type":"string"},"interval-offset":{"type":"integer","description":"Offset from top of interval","format":"int64"},"time-zone":{"type":"string","description":"Only on 21.1.1 Database. The timezone the Interval Offset is from."},"extents":{"type":"array","items":{"$ref":"#/components/schemas/TimeSeriesExtents"}},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/alias"}}}},"catalog":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/CatalogEntry"}},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"Catalog":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/CatalogEntry"}},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"Basin":{"required":["basin-id"],"type":"object","properties":{"basin-id":{"$ref":"#/components/schemas/CwmsId"},"sort-order":{"type":"number","format":"double"},"total-drainage-area":{"type":"number","format":"double"},"contributing-drainage-area":{"type":"number","format":"double"},"parent-basin-id":{"$ref":"#/components/schemas/CwmsId"},"area-unit":{"type":"string"},"primary-stream-id":{"$ref":"#/components/schemas/CwmsId"}}},"Stream":{"required":["id"],"type":"object","properties":{"starts-downstream":{"type":"boolean"},"flows-into-stream-node":{"$ref":"#/components/schemas/StreamNode"},"diverts-from-stream-node":{"$ref":"#/components/schemas/StreamNode"},"length":{"type":"number","format":"double"},"average-slope":{"type":"number","format":"double"},"length-units":{"type":"string"},"slope-units":{"type":"string"},"comment":{"type":"string"},"id":{"$ref":"#/components/schemas/CwmsId"}}},"StreamLocation":{"required":["stream-location-node"],"type":"object","properties":{"stream-location-node":{"$ref":"#/components/schemas/StreamLocationNode"},"published-station":{"type":"number","format":"double"},"navigation-station":{"type":"number","format":"double"},"lowest-measurable-stage":{"type":"number","format":"double"},"total-drainage-area":{"type":"number","format":"double"},"ungaged-drainage-area":{"type":"number","format":"double"},"area-units":{"type":"string"},"stage-units":{"type":"string"}}},"StreamReach":{"required":["downstream-node","id","stream-id","upstream-node"],"type":"object","properties":{"comment":{"type":"string"},"downstream-node":{"$ref":"#/components/schemas/StreamLocationNode"},"upstream-node":{"$ref":"#/components/schemas/StreamLocationNode"},"configuration-id":{"$ref":"#/components/schemas/CwmsId"},"stream-id":{"$ref":"#/components/schemas/CwmsId"},"id":{"$ref":"#/components/schemas/CwmsId"}}},"StreamNode":{"required":["stream-id"],"type":"object","properties":{"stream-id":{"$ref":"#/components/schemas/CwmsId"},"bank":{"type":"string","enum":["L","R"]},"station":{"type":"number","format":"double"},"station-units":{"type":"string"}}},"StreamLocationNode":{"required":["id","stream-node"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/CwmsId"},"stream-node":{"$ref":"#/components/schemas/StreamNode"}}},"CwmsIdTimeExtentsEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CwmsId"},"time-extents":{"$ref":"#/components/schemas/TimeExtents"}}},"TimeExtents":{"type":"object","properties":{"earliest-time":{"type":"string","description":"Earliest value in the timeseries","format":"date-time"},"latest-time":{"type":"string","description":"Latest value in the timeseries","format":"date-time"}},"description":"Represents the start and end times of an extent"},"Measurement":{"required":["id","instant","number"],"type":"object","properties":{"height-unit":{"type":"string"},"flow-unit":{"type":"string"},"temp-unit":{"type":"string"},"velocity-unit":{"type":"string"},"area-unit":{"type":"string"},"used":{"type":"boolean"},"agency":{"type":"string"},"party":{"type":"string"},"wm-comments":{"type":"string"},"instant":{"type":"string","format":"date-time"},"id":{"$ref":"#/components/schemas/CwmsId"},"number":{"type":"string"},"streamflow-measurement":{"$ref":"#/components/schemas/StreamflowMeasurement"},"supplemental-streamflow-measurement":{"$ref":"#/components/schemas/SupplementalStreamflowMeasurement"},"usgs-measurement":{"$ref":"#/components/schemas/UsgsMeasurement"}}},"StreamflowMeasurement":{"type":"object","properties":{"gage-height":{"type":"number","format":"double"},"flow":{"type":"number","format":"double"},"quality":{"type":"string"}}},"SupplementalStreamflowMeasurement":{"type":"object","properties":{"channel-flow":{"type":"number","format":"double"},"overbank-flow":{"type":"number","format":"double"},"overbank-max-depth":{"type":"number","format":"double"},"channel-max-depth":{"type":"number","format":"double"},"avg-velocity":{"type":"number","format":"double"},"surface-velocity":{"type":"number","format":"double"},"max-velocity":{"type":"number","format":"double"},"effective-flow-area":{"type":"number","format":"double"},"cross-sectional-area":{"type":"number","format":"double"},"mean-gage":{"type":"number","format":"double"},"top-width":{"type":"number","format":"double"},"main-channel-area":{"type":"number","format":"double"},"overbank-area":{"type":"number","format":"double"}}},"UsgsMeasurement":{"type":"object","properties":{"remarks":{"type":"string"},"current-rating":{"type":"string"},"control-condition":{"type":"string"},"shift-used":{"type":"number","format":"double"},"percent-difference":{"type":"number","format":"double"},"flow-adjustment":{"type":"string"},"delta-height":{"type":"number","format":"double"},"delta-time":{"type":"number","format":"double"},"air-temp":{"type":"number","format":"double"},"water-temp":{"type":"number","format":"double"}}},"Blob":{"required":["id","office-id","value"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"description":{"type":"string"},"media-type-id":{"type":"string"},"value":{"type":"string","format":"byte"}}},"blobs":{"type":"object","properties":{"blobs":{"type":"array","description":"List of retrieved blobs","items":{"$ref":"#/components/schemas/Blob"}},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"Blobs":{"type":"object","properties":{"blobs":{"type":"array","description":"List of retrieved blobs","items":{"$ref":"#/components/schemas/Blob"}},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"clob":{"required":["id","office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"description":{"type":"string"},"value":{"type":"string"}}},"Clob":{"required":["id","office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"description":{"type":"string"},"value":{"type":"string"}}},"clobs":{"type":"object","properties":{"clobs":{"type":"array","description":"List of retrieved clobs","items":{"$ref":"#/components/schemas/clob"}},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"Clobs":{"type":"object","properties":{"clobs":{"type":"array","description":"List of retrieved clobs","items":{"$ref":"#/components/schemas/clob"}},"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"Pool":{"type":"object","properties":{"poolName":{"$ref":"#/components/schemas/PoolNameType"},"projectId":{"type":"string"},"bottomLevelId":{"type":"string"},"topLevelId":{"type":"string"},"implicit":{"type":"boolean"},"attribute":{"type":"number"},"description":{"type":"string"},"clobText":{"type":"string"}},"description":"List of retrieved pools"},"PoolNameType":{"type":"object","properties":{"pool-name":{"type":"string"},"office-id":{"type":"string"}}},"pools":{"type":"object","properties":{"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"pools":{"type":"array","description":"List of retrieved pools","items":{"$ref":"#/components/schemas/Pool"}},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"Pools":{"type":"object","properties":{"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"pools":{"type":"array","description":"List of retrieved pools","items":{"$ref":"#/components/schemas/Pool"}},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"SpecifiedLevel":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"id":{"type":"string"},"description":{"type":"string"}}},"forecast-instance":{"type":"object","properties":{"spec":{"$ref":"#/components/schemas/forecast-spec"},"date-time":{"type":"string","format":"date-time"},"issue-date-time":{"type":"string","format":"date-time"},"first-date-time":{"type":"string","format":"date-time"},"last-date-time":{"type":"string","format":"date-time"},"max-age":{"type":"integer","format":"int32"},"notes":{"type":"string","description":"Forecast Instance Notes"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"filename":{"type":"string","description":"Forecast Filename"},"file-description":{"type":"string","description":"Description of Forecast File"},"file-media-type":{"type":"string","description":"Forecast File Media Type"},"file-data":{"type":"string","description":"Forecast File binary data","format":"byte"},"file-data-url":{"type":"string","description":"Link to Forecast File binary data"}}},"forecast-spec":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"spec-id":{"type":"string","description":"Forecast Spec ID"},"designator":{"type":"string","description":"Forecast Designator"},"location-id":{"type":"string","description":"Location IDs"},"source-entity-id":{"type":"string","description":"Source Entity ID"},"description":{"type":"string","description":"Description of Forecast"},"time-series-ids":{"type":"array","description":"List of Time Series IDs belonging to this Forecast Spec","items":{"type":"string","description":"List of Time Series IDs belonging to this Forecast Spec"}}}},"ForecastInstance":{"type":"object","properties":{"spec":{"$ref":"#/components/schemas/forecast-spec"},"date-time":{"type":"string","format":"date-time"},"issue-date-time":{"type":"string","format":"date-time"},"first-date-time":{"type":"string","format":"date-time"},"last-date-time":{"type":"string","format":"date-time"},"max-age":{"type":"integer","format":"int32"},"notes":{"type":"string","description":"Forecast Instance Notes"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"filename":{"type":"string","description":"Forecast Filename"},"file-description":{"type":"string","description":"Description of Forecast File"},"file-media-type":{"type":"string","description":"Forecast File Media Type"},"file-data":{"type":"string","description":"Forecast File binary data","format":"byte"},"file-data-url":{"type":"string","description":"Link to Forecast File binary data"}}},"ForecastSpec":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"spec-id":{"type":"string","description":"Forecast Spec ID"},"designator":{"type":"string","description":"Forecast Designator"},"location-id":{"type":"string","description":"Location IDs"},"source-entity-id":{"type":"string","description":"Source Entity ID"},"description":{"type":"string","description":"Description of Forecast"},"time-series-ids":{"type":"array","description":"List of Time Series IDs belonging to this Forecast Spec","items":{"type":"string","description":"List of Time Series IDs belonging to this Forecast Spec"}}}},"LookupType":{"required":["display-value","office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"display-value":{"type":"string"},"tooltip":{"type":"string"},"active":{"type":"boolean"}}},"WaterUser":{"required":["entity-name","project-id","water-right"],"type":"object","properties":{"entity-name":{"type":"string"},"project-id":{"$ref":"#/components/schemas/CwmsId"},"water-right":{"type":"string"}}},"WaterUserContract":{"required":["contract-effective-date","contract-expiration-date","contract-id","contract-type","contracted-storage","future-use-allocation","future-use-percent-activated","initial-use-allocation","office-id","storage-units-id","total-alloc-percent-activated","water-user"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"water-user":{"$ref":"#/components/schemas/WaterUser"},"contract-id":{"$ref":"#/components/schemas/CwmsId"},"contract-type":{"$ref":"#/components/schemas/LookupType"},"contract-effective-date":{"type":"string","format":"date-time"},"contract-expiration-date":{"type":"string","format":"date-time"},"contracted-storage":{"type":"number","format":"double"},"initial-use-allocation":{"type":"number","format":"double"},"future-use-allocation":{"type":"number","format":"double"},"storage-units-id":{"type":"string"},"future-use-percent-activated":{"type":"number","format":"double"},"total-alloc-percent-activated":{"type":"number","format":"double"},"pump-out-location":{"$ref":"#/components/schemas/water_supply_pump"},"pump-out-below-location":{"$ref":"#/components/schemas/water_supply_pump"},"pump-in-location":{"$ref":"#/components/schemas/water_supply_pump"}}},"water_supply_pump":{"required":["pumpLocation","pumpType"],"type":"object","properties":{"pumpLocation":{"$ref":"#/components/schemas/Location"},"pumpType":{"type":"string","enum":["IN","OUT","BELOW"]}}},"PumpLocation":{"type":"object","properties":{"pump-in":{"$ref":"#/components/schemas/CwmsId"},"pump-out":{"$ref":"#/components/schemas/CwmsId"},"pump-below":{"$ref":"#/components/schemas/CwmsId"}}},"PumpTransfer":{"required":["comment","flow","pump-type","transfer-type-display"],"type":"object","properties":{"pump-type":{"type":"string","enum":["IN","OUT","BELOW"]},"transfer-type-display":{"type":"string"},"flow":{"type":"number","format":"double"},"comment":{"type":"string"}}},"WaterSupplyAccounting":{"required":["contract-name","pump-locations","water-user"],"type":"object","properties":{"contract-name":{"type":"string"},"water-user":{"$ref":"#/components/schemas/WaterUser"},"pump-locations":{"$ref":"#/components/schemas/PumpLocation"},"pump-accounting":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/PumpTransfer"}}}}},"PumpType":{"type":"string","enum":["IN","OUT","BELOW"]},"Embankment":{"required":["location","project-id"],"type":"object","properties":{"project-id":{"$ref":"#/components/schemas/CwmsId"},"location":{"$ref":"#/components/schemas/Location"},"structure-type":{"$ref":"#/components/schemas/LookupType"},"upstream-side-slope":{"type":"number","format":"double"},"downstream-side-slope":{"type":"number","format":"double"},"structure-length":{"type":"number","format":"double"},"max-height":{"type":"number","format":"double"},"top-width":{"type":"number","format":"double"},"length-units":{"type":"string"},"downstream-protection-type":{"$ref":"#/components/schemas/LookupType"},"upstream-protection-type":{"$ref":"#/components/schemas/LookupType"}}},"Turbine":{"required":["location","project-id"],"type":"object","properties":{"project-id":{"$ref":"#/components/schemas/CwmsId"},"location":{"$ref":"#/components/schemas/Location"}}},"Lock":{"required":["location","project-id"],"type":"object","properties":{"project-id":{"$ref":"#/components/schemas/CwmsId"},"location":{"$ref":"#/components/schemas/Location"},"chamber-type":{"$ref":"#/components/schemas/LookupType"},"lock-width":{"type":"number","format":"double"},"lock-length":{"type":"number","format":"double"},"normal-lock-lift":{"type":"number","format":"double"},"maximum-lock-lift":{"type":"number","format":"double"},"length-units":{"type":"string"},"volume-units":{"type":"string"},"volume-per-lockage":{"type":"number","format":"double"},"minimum-draft":{"type":"number","format":"double"},"high-water-upper-pool-location-level":{"$ref":"#/components/schemas/LockLocationLevelRef"},"low-water-lower-pool-location-level":{"$ref":"#/components/schemas/LockLocationLevelRef"},"high-water-lower-pool-location-level":{"$ref":"#/components/schemas/LockLocationLevelRef"},"low-water-upper-pool-location-level":{"$ref":"#/components/schemas/LockLocationLevelRef"},"high-water-upper-pool-warning-level":{"type":"number","format":"double"},"high-water-lower-pool-warning-level":{"type":"number","format":"double"},"elevation-units":{"type":"string"}}},"LockLocationLevelRef":{"type":"object","properties":{"level-link":{"type":"string"},"level-value":{"type":"number","format":"double"}}},"TurbineChange":{"required":["change-date","discharge-computation-type","project-id","reason-type"],"type":"object","properties":{"project-id":{"$ref":"#/components/schemas/CwmsId"},"change-date":{"type":"string","format":"date-time"},"protected":{"type":"boolean"},"discharge-computation-type":{"$ref":"#/components/schemas/LookupType"},"reason-type":{"$ref":"#/components/schemas/LookupType"},"notes":{"type":"string"},"new-total-discharge-override":{"type":"number","format":"double"},"old-total-discharge-override":{"type":"number","format":"double"},"discharge-units":{"type":"string"},"tailwater-elevation":{"type":"number","format":"double"},"elevation-units":{"type":"string"},"settings":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/TurbineSetting"}},"pool-elevation":{"type":"number","format":"double"}}},"TurbineSetting":{"required":["discharge-units","generation-units","location-id","new-discharge","old-discharge"],"type":"object","properties":{"location-id":{"$ref":"#/components/schemas/CwmsId"},"discharge-units":{"type":"string"},"old-discharge":{"type":"number","format":"double"},"new-discharge":{"type":"number","format":"double"},"generation-units":{"type":"string"},"scheduled-load":{"type":"number","format":"double"},"real-power":{"type":"number","format":"double"}}},"Outlet":{"required":["location","project-id"],"type":"object","properties":{"project-id":{"$ref":"#/components/schemas/CwmsId"},"location":{"$ref":"#/components/schemas/Location"},"rating-group-id":{"$ref":"#/components/schemas/CwmsId"},"rating-spec-id":{"type":"string"},"rating-category-id":{"$ref":"#/components/schemas/CwmsId"}}},"GateChange":{"required":["change-date","discharge-computation-type","project-id","reason-type"],"type":"object","properties":{"project-id":{"$ref":"#/components/schemas/CwmsId"},"change-date":{"type":"string","format":"date-time"},"reference-elevation":{"type":"number","format":"double"},"pool-elevation":{"type":"number","format":"double"},"protected":{"type":"boolean"},"discharge-computation-type":{"$ref":"#/components/schemas/LookupType"},"reason-type":{"$ref":"#/components/schemas/LookupType"},"notes":{"type":"string"},"type":{"type":"string"},"new-total-discharge-override":{"type":"number","format":"double"},"old-total-discharge-override":{"type":"number","format":"double"},"discharge-units":{"type":"string"},"tailwater-elevation":{"type":"number","format":"double"},"elevation-units":{"type":"string"},"settings":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/GateSetting"}}},"discriminator":{"propertyName":"type"}},"GateSetting":{"required":["invert-elevation","location-id","opening","opening-parameter","opening-units"],"type":"object","properties":{"location-id":{"$ref":"#/components/schemas/CwmsId"},"opening":{"type":"number","format":"double"},"opening-parameter":{"type":"string"},"opening-units":{"type":"string"},"invert-elevation":{"type":"number","format":"double"},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"VirtualOutlet":{"required":["project-id","virtual-outlet-id"],"type":"object","properties":{"project-id":{"$ref":"#/components/schemas/CwmsId"},"virtual-outlet-id":{"$ref":"#/components/schemas/CwmsId"},"virtual-records":{"type":"array","items":{"$ref":"#/components/schemas/VirtualOutletRecord"}}}},"VirtualOutletRecord":{"required":["outlet-id"],"type":"object","properties":{"outlet-id":{"$ref":"#/components/schemas/CwmsId"},"downstream-outlet-ids":{"type":"array","items":{"$ref":"#/components/schemas/CwmsId"}}}},"LocationsWithProjectKind":{"type":"object","properties":{"kind":{"type":"string","enum":["EMBANKMENT","TURBINE","OUTLET","LOCK","GATE"]},"location-ids":{"type":"array","items":{"$ref":"#/components/schemas/CwmsId"}}}},"ProjectChildLocations":{"type":"object","properties":{"project-id":{"$ref":"#/components/schemas/CwmsId"},"locations-by-kind":{"type":"array","items":{"$ref":"#/components/schemas/LocationsWithProjectKind"}}}},"Project":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/Location"},"federal-cost":{"type":"number"},"non-federal-cost":{"type":"number"},"cost-year":{"type":"string","format":"date-time"},"cost-unit":{"type":"string"},"federal-o-and-m-cost":{"type":"number"},"non-federal-o-and-m-cost":{"type":"number"},"authorizing-law":{"type":"string"},"project-owner":{"type":"string"},"hydropower-desc":{"type":"string"},"sedimentation-desc":{"type":"string"},"downstream-urban-desc":{"type":"string"},"bank-full-capacity-desc":{"type":"string"},"pump-back-location":{"$ref":"#/components/schemas/Location"},"near-gage-location":{"$ref":"#/components/schemas/Location"},"yield-time-frame-start":{"type":"string","format":"date-time"},"yield-time-frame-end":{"type":"string","format":"date-time"},"project-remarks":{"type":"string"}}},"Projects":{"type":"object","properties":{"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"projects":{"type":"array","items":{"$ref":"#/components/schemas/Project"}},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true}}},"property":{"required":["category","name","office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"category":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"comment":{"type":"string"}}},"Property":{"required":["category","name","office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"category":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"comment":{"type":"string"}}},"ProjectLock":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"project-id":{"type":"string"},"application-id":{"type":"string"},"acquire-time":{"type":"string","format":"date-time"},"session-user":{"type":"string"},"os-user":{"type":"string"},"session-program":{"type":"string"},"session-machine":{"type":"string"}}},"ProjectLockId":{"type":"object","properties":{"id":{"type":"string"}}},"LockRevokerRights":{"required":["office-id"],"type":"object","properties":{"office-id":{"type":"string","description":"Owning office of object."},"project-id":{"type":"string"},"application-id":{"type":"string"},"user-id":{"type":"string"}}},"User":{"required":["email","principal","user-name"],"type":"object","properties":{"user-name":{"type":"string"},"principal":{"type":"string","description":"Unique identifier in the upstream identity management system."},"cac-auth":{"type":"boolean","description":"Is the current session based on CAC Authentication","readOnly":true},"email":{"type":"string","format":"email"},"roles":{"type":"object","additionalProperties":{"type":"array","description":"Assigned user roles per office.","items":{"type":"string","description":"Assigned user roles per office."}},"description":"Assigned user roles per office."}}},"users":{"type":"object","properties":{"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true},"users":{"type":"array","description":"List of retrieved users","items":{"$ref":"#/components/schemas/User"}}}},"Users":{"type":"object","properties":{"next-page":{"type":"string","description":"The cursor to the next page of data; null if there is no more data","readOnly":true},"page":{"type":"string","description":"The cursor to the current page of data","readOnly":true},"page-size":{"type":"integer","description":"The number of records fetched per-page; this may be larger than the number of records actually retrieved","format":"int32","readOnly":true},"total":{"type":"integer","description":"The total number of records retrieved; null or not present if not supported or unknown","format":"int32","readOnly":true},"users":{"type":"array","description":"List of retrieved users","items":{"$ref":"#/components/schemas/User"}}}},"CdaVersion":{"required":["version"],"type":"object","properties":{"version":{"type":"string"},"features":{"type":"object","additionalProperties":{"type":"object"}}}},"AtomLink":{"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"type":{"type":"string"}},"description":"Atom link for pagination to the next page of RSS items"},"Guid":{"type":"object","properties":{"guid":{"type":"string"}},"description":"Globally unique identifier for the RSS item"},"RssChannel":{"required":["description","title"],"type":"object","properties":{"title":{"type":"string","description":"Title of the RSS channel"},"nextLink":{"$ref":"#/components/schemas/AtomLink"},"description":{"type":"string","description":"Description of the RSS channel"},"items":{"type":"array","description":"List of RSS items in the channel","items":{"$ref":"#/components/schemas/RssItem"}}},"description":"The RSS channel containing feed metadata and items"},"RssFeed":{"type":"object","properties":{"version":{"type":"string"},"channel":{"$ref":"#/components/schemas/RssChannel"}}},"RssItem":{"type":"object","properties":{"description":{"type":"string","description":"Description of the RSS item content"},"pubDate":{"type":"string","description":"Publication date and time of the RSS item","format":"date-time"},"guid":{"$ref":"#/components/schemas/Guid"}},"description":"List of RSS items in the channel"}},"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Key value as generated from the /auth/keys endpoint. NOTE: you MUST manually prefix your key with 'apikey ' (without the single quotes).","name":"Authorization","in":"header","scheme":"apikey"},"CwmsAAACacAuth":{"type":"apiKey","description":"Auth handler running on same tomcat instance as the data api.","name":"JSESSIONIDSSO","in":"cookie"},"OpenIDConnect":{"type":"openIdConnect","name":"Authorization","in":"header","flows":{"implicit":{"authorizationUrl":"https://identityc.sec.usace.army.mil/auth/realms/cwbi/.well-known/openid-configuration/auth/realms/cwbi/protocol/openid-connect/auth","tokenUrl":"https://identityc.sec.usace.army.mil/auth/realms/cwbi/.well-known/openid-configuration/auth/realms/cwbi/protocol/openid-connect/token","scopes":{"openid":"","preferred_username":"","x509_presented":"","roles":"","acr":"","cacUID":"","groups":"","microprofile-jwt":"","phone":"","offline_access":"","email":"","profile":"","web-origins":"","subjectDN":"","address":""}},"password":{"authorizationUrl":"https://identityc.sec.usace.army.mil/auth/realms/cwbi/.well-known/openid-configuration/auth/realms/cwbi/protocol/openid-connect/auth","tokenUrl":"https://identityc.sec.usace.army.mil/auth/realms/cwbi/.well-known/openid-configuration/auth/realms/cwbi/protocol/openid-connect/token","scopes":{"openid":"","preferred_username":"","x509_presented":"","roles":"","acr":"","cacUID":"","groups":"","microprofile-jwt":"","phone":"","offline_access":"","email":"","profile":"","web-origins":"","subjectDN":"","address":""}},"clientCredentials":{"authorizationUrl":"https://identityc.sec.usace.army.mil/auth/realms/cwbi/.well-known/openid-configuration/auth/realms/cwbi/protocol/openid-connect/auth","tokenUrl":"https://identityc.sec.usace.army.mil/auth/realms/cwbi/.well-known/openid-configuration/auth/realms/cwbi/protocol/openid-connect/token","scopes":{"openid":"","preferred_username":"","x509_presented":"","roles":"","acr":"","cacUID":"","groups":"","microprofile-jwt":"","phone":"","offline_access":"","email":"","profile":"","web-origins":"","subjectDN":"","address":""}},"authorizationCode":{"authorizationUrl":"https://identityc.sec.usace.army.mil/auth/realms/cwbi/.well-known/openid-configuration/auth/realms/cwbi/protocol/openid-connect/auth","tokenUrl":"https://identityc.sec.usace.army.mil/auth/realms/cwbi/.well-known/openid-configuration/auth/realms/cwbi/protocol/openid-connect/token","scopes":{"openid":"","preferred_username":"","x509_presented":"","roles":"","acr":"","cacUID":"","groups":"","microprofile-jwt":"","phone":"","offline_access":"","email":"","profile":"","web-origins":"","subjectDN":"","address":""}}},"openIdConnectUrl":"https://identityc.sec.usace.army.mil/auth/realms/cwbi/.well-known/openid-configuration/auth/realms/cwbi/.well-known/openid-configuration"}}}}