USACE Corps Water Management System Data API — Time Series

naftiko: 1.0.0-alpha2
info:
  label: USACE Corps Water Management System Data API — Time Series
  description: 'USACE Corps Water Management System Data API — Time Series. 2 operations. Lead operation: Get Time Series
    Data. Self-contained Naftiko capability covering one Us Department Of Defense business surface.'
  tags:
  - Us Department Of Defense
  - Time Series
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    US_DEPARTMENT_OF_DEFENSE_API_KEY: US_DEPARTMENT_OF_DEFENSE_API_KEY
capability:
  consumes:
  - type: http
    namespace: usace-cwms-data-time-series
    baseUri: https://cwms-data.usace.army.mil/cwms-data/api/latest
    description: USACE Corps Water Management System Data API — Time Series business capability. Self-contained, no shared
      references.
    resources:
    - name: timeseries
      path: /timeseries
      operations:
      - name: gettimeseries
        method: GET
        description: Get Time Series Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: office
          in: query
          type: string
          description: USACE district office ID (e.g., CWMS, SWT, LRH)
        - name: name
          in: query
          type: string
          description: Time series ID in format Location.Parameter.Type.Interval.Duration.Version
        - name: begin
          in: query
          type: string
          description: Start of the time window (ISO 8601 or milliseconds since epoch)
        - name: end
          in: query
          type: string
          description: End of the time window (ISO 8601 or milliseconds since epoch)
        - name: datum
          in: query
          type: string
          description: Elevation datum for stage data (e.g., NAVD88, NGVD29)
        - name: unit
          in: query
          type: string
          description: Unit of measure for the output (e.g., EN for English, SI for metric)
        - name: timezone
          in: query
          type: string
          description: Timezone for date/time values in response
        - name: format
          in: query
          type: string
          description: Response format
        - name: page-size
          in: query
          type: integer
          description: Number of values per page
        - name: page
          in: query
          type: string
          description: Page cursor for pagination (from previous response)
    - name: timeseries-catalog
      path: /timeseries/catalog
      operations:
      - name: gettimeseriescatalog
        method: GET
        description: Get Time Series Catalog
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: office
          in: query
          type: string
          description: Filter by USACE district office ID
        - name: timeseries-id-regex
          in: query
          type: string
          description: Regular expression pattern to filter time series IDs
        - name: cursor
          in: query
          type: string
          description: Pagination cursor from previous response
        - name: page-size
          in: query
          type: integer
          description: Number of entries per page
  exposes:
  - type: rest
    namespace: usace-cwms-data-time-series-rest
    port: 8080
    description: REST adapter for USACE Corps Water Management System Data API — Time Series. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/timeseries
      name: timeseries
      description: REST surface for timeseries.
      operations:
      - method: GET
        name: gettimeseries
        description: Get Time Series Data
        call: usace-cwms-data-time-series.gettimeseries
        with:
          office: rest.office
          name: rest.name
          begin: rest.begin
          end: rest.end
          datum: rest.datum
          unit: rest.unit
          timezone: rest.timezone
          format: rest.format
          page-size: rest.page-size
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/timeseries/catalog
      name: timeseries-catalog
      description: REST surface for timeseries-catalog.
      operations:
      - method: GET
        name: gettimeseriescatalog
        description: Get Time Series Catalog
        call: usace-cwms-data-time-series.gettimeseriescatalog
        with:
          office: rest.office
          timeseries-id-regex: rest.timeseries-id-regex
          cursor: rest.cursor
          page-size: rest.page-size
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usace-cwms-data-time-series-mcp
    port: 9090
    transport: http
    description: MCP adapter for USACE Corps Water Management System Data API — Time Series. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-time-series-data
      description: Get Time Series Data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usace-cwms-data-time-series.gettimeseries
      with:
        office: tools.office
        name: tools.name
        begin: tools.begin
        end: tools.end
        datum: tools.datum
        unit: tools.unit
        timezone: tools.timezone
        format: tools.format
        page-size: tools.page-size
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.
    - name: get-time-series-catalog
      description: Get Time Series Catalog
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usace-cwms-data-time-series.gettimeseriescatalog
      with:
        office: tools.office
        timeseries-id-regex: tools.timeseries-id-regex
        cursor: tools.cursor
        page-size: tools.page-size
      outputParameters:
      - type: object
        mapping: $.