info@ismena.com
Ismena websiteIsmena websiteIsmena websiteIsmena website
  • Home
  • About us
  • Technologies
    • Cloud Services
      • Google Cloud Platform
        • Networking
        • Compute
        • Storage
        • SAP on GCP
        • Google Maps
        • Data Center Modernization
    • Infrastructure
      • iSolution Services
      • Unified Communication
      • Network Security
      • Access Security & Control
      • Computing Platforms
      • Structured Cabling Infrastructure
      • Datacenter Infrastructure
      • Networking Infrastructure
      • Retail Analytics
      • Cloud Infrastructure
    • Integration
      • Apigee
      • IBM
      • Custom Connectors
      • UnifAI
    • Security
      • Security Consulting Services
      • Security Solutions
    • Data & AI
      • BigQuery, Looker
      • Gemini
    • Collaboration Tools
      • Google Workspace For Enterprise
    • ERP-CRM
      • Odoo
      • Salesforce
      • SAP on GCP
    • DevOps
      • GCP
      • SonarSource
    • Managed Service Provider
      • Managed Service Provider
    • App Development
      • App Development
    • Open Banking
      • Open banking
    • Chrome Devices
  • Unplugged Podcast
  • Blog
    • Success Stories
    • News
    • Articles
  • Careers
  • Contact Us

Technologies

Integration

Custom Connectors

Explore All Connectors

USGS Water Data OGC Connector

USGS Water Data OGC Connector

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

Documentation

Pricing

Support

Overview

The USGSWaterDataOGC Connector enables seamless integration with the USGS Water Data OGC APIs, providing access to geospatial water data, including continuous sensor measurements, daily data, field measurements, and metadata about monitoring locations, aquifers, and more. Built to support Open Geospatial Consortium (OGC) standards, this connector allows users to efficiently retrieve and process hydrologic data for analysis within Google Cloud Platform workflows. Ideal for applications requiring real-time or historical water data, such as environmental monitoring, research, and resource management. This supports JSON, HTML, JSON-LD, and CSV response formats.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the USGSWaterDataOGC Connector.

Supported Integration Action Points:

  • igetLandingPage: Retrieves the API landing page with title, description, links, and conformance details.
  • getCollections: Retrieves the list of available collections in the API.
  • describeAgencyCodesCollection: Retrieves metadata for the agency-codes collection.
  • getAgencyCodesFeatures: Retrieves features (items) from the agency-codes collection.
  • getAgencyCodesFeature: Retrieves a specific feature by ID from the agency-codes collection.
  • getAgencyCodesQueryables: Retrieves queryable properties for the agency-codes collection.
  • getAgencyCodesSchema: Retrieves the schema for the agency-codes collection.
  • optionsAgencyCodesFeatures: Retrieves options for the agency-codes items endpoint.
  • optionsAgencyCodesFeature: Retrieves options for a specific agency-codes item by ID.
  • describeAltitudeDatumsCollection: Retrieves metadata for the altitude-datums collection.
  • getAltitudeDatumsFeatures: Retrieves features (items) from the altitude-datums collection.
  • getAltitudeDatumsFeature: Retrieves a specific feature by ID from the altitude-datums collection.
  • getAltitudeDatumsQueryables: Retrieves queryable properties for the altitude-datums collection.
  • getAltitudeDatumsSchema: Retrieves the schema for the altitude-datums collection.
  • optionsAltitudeDatumsFeatures: Retrieves options for the altitude-datums items endpoint.
  • optionsAltitudeDatumsFeature: Retrieves options for a specific altitude-datums item by ID.
  • describeAquiferCodesCollection: Retrieves metadata for the aquifer-codes collection.
  • getAquiferCodesFeatures: Retrieves features (items) from the aquifer-codes collection.
  • getAquiferCodesFeature: Retrieves a specific feature by ID from the aquifer-codes collection.
  • getAquiferCodesQueryables: Retrieves queryable properties for the aquifer-codes collection.
  • getAquiferCodesSchema: Retrieves the schema for the aquifer-codes collection.
  • optionsAquiferCodesFeatures: Retrieves options for the aquifer-codes items endpoint.
  • optionsAquiferCodesFeature: Retrieves options for a specific aquifer-codes item by ID.
  • describeAquiferTypesCollection: Retrieves metadata for the aquifer-types collection.
  • getAquiferTypesFeatures: Retrieves features (items) from the aquifer-types collection.
  • getAquiferTypesFeature: Retrieves a specific feature by ID from the aquifer-types collection.
  • getAquiferTypesQueryables: Retrieves queryable properties for the aquifer-types collection.
  • getAquiferTypesSchema: Retrieves the schema for the aquifer-types collection.
  • optionsAquiferTypesFeatures: Retrieves options for the aquifer-types items endpoint.
  • optionsAquiferTypesFeature: Retrieves options for a specific aquifer-types item by ID.
  • describeCoordinateAccuracyCodesCollection: Retrieves metadata for the coordinate-accuracy-codes collection.
  • getCoordinateAccuracyCodesFeatures: Retrieves features (items) from the coordinate-accuracy-codes collection.
  • getCoordinateAccuracyCodesFeature: Retrieves a specific feature by ID from the coordinate-accuracy-codes collection.
  • getCoordinateAccuracyCodesQueryables: Retrieves queryable properties for the coordinate-accuracy-codes collection.
  • getCoordinateAccuracyCodesSchema: Retrieves the schema for the coordinate-accuracy-codes collection.
  • optionsCoordinateAccuracyCodesFeatures: Retrieves options for the coordinate-accuracy-codes items endpoint.
  • optionsCoordinateAccuracyCodesFeature: Retrieves options for a specific coordinate-accuracy-codes item by ID.
  • describeCoordinateDatumCodesCollection: Retrieves metadata for the coordinate-datum-codes collection.
  • getCoordinateDatumCodesFeatures: Retrieves features (items) from the coordinate-datum-codes collection.
  • getCoordinateDatumCodesFeature: Retrieves a specific feature by ID from the coordinate-datum-codes collection.
  • getCoordinateDatumCodesQueryables: Retrieves queryable properties for the coordinate-datum-codes collection.
  • getCoordinateDatumCodesSchema: Retrieves the schema for the coordinate-datum-codes collection.
  • optionsCoordinateDatumCodesFeatures: Retrieves options for the coordinate-datum-codes items endpoint.
  • optionsCoordinateDatumCodesFeature: Retrieves options for a specific coordinate-datum-codes item by ID.
  • describeCoordinateMethodCodesCollection: Retrieves metadata for the coordinate-method-codes collection.
  • getCoordinateMethodCodesFeatures: Retrieves features (items) from the coordinate-method-codes collection.
  • getCoordinateMethodCodesFeature: Retrieves a specific feature by ID from the coordinate-method-codes collection.
  • getCoordinateMethodCodesQueryables: Retrieves queryable properties for the coordinate-method-codes collection.
  • getCoordinateMethodCodesSchema: Retrieves the schema for the coordinate-method-codes collection.
  • optionsCoordinateMethodCodesFeatures: Retrieves options for the coordinate-method-codes items endpoint.
  • optionsCoordinateMethodCodesFeature: Retrieves options for a specific coordinate-method-codes item by ID.
  • describeHydrologicUnitCodesCollection: Retrieves metadata for the hydrologic-unit-codes collection.
  • getHydrologicUnitCodesFeatures: Retrieves features (items) from the hydrologic-unit-codes collection.
  • getHydrologicUnitCodesFeature: Retrieves a specific feature by ID from the hydrologic-unit-codes collection.
  • getHydrologicUnitCodesQueryables: Retrieves queryable properties for the hydrologic-unit-codes collection.
  • getHydrologicUnitCodesSchema: Retrieves the schema for the hydrologic-unit-codes collection.
  • optionsHydrologicUnitCodesFeatures: Retrieves options for the hydrologic-unit-codes items endpoint.
  • optionsHydrologicUnitCodesFeature: Retrieves options for a specific hydrologic-unit-codes item by ID.
  • describeMediumCodesCollection: Retrieves metadata for the medium-codes collection.
  • getMediumCodesFeatures: Retrieves features (items) from the medium-codes collection.
  • getMediumCodesFeature: Retrieves a specific feature by ID from the medium-codes collection.
  • getMediumCodesQueryables: Retrieves queryable properties for the medium-codes collection.
  • getMediumCodesSchema: Retrieves the schema for the medium-codes collection.
  • optionsMediumCodesFeatures: Retrieves options for the medium-codes items endpoint.
  • optionsMediumCodesFeature: Retrieves options for a specific medium-codes item by ID.
  • describeNationalAquiferCodesCollection: Retrieves metadata for the national-aquifer-codes collection.
  • getNationalAquiferCodesFeatures: Retrieves features (items) from the national-aquifer-codes collection.
  • getNationalAquiferCodesFeature: Retrieves a specific feature by ID from the national-aquifer-codes collection.
  • getNationalAquiferCodesQueryables: Retrieves queryable properties for the national-aquifer-codes collection.
  • getNationalAquiferCodesSchema: Retrieves the schema for the national-aquifer-codes collection.
  • optionsNationalAquiferCodesFeatures: Retrieves options for the national-aquifer-codes items endpoint.
  • optionsNationalAquiferCodesFeature: Retrieves options for a specific national-aquifer-codes item by ID.
  • describeParameterCodesCollection: Retrieves metadata for the parameter-codes collection.
  • getParameterCodesFeatures: Retrieves features (items) from the parameter-codes collection.
  • getParameterCodesFeature: Retrieves a specific feature by ID from the parameter-codes collection.
  • getParameterCodesQueryables: Retrieves queryable properties for the parameter-codes collection.
  • getParameterCodesSchema: Retrieves the schema for the parameter-codes collection.
  • optionsParameterCodesFeatures: Retrieves options for the parameter-codes items endpoint.
  • optionsParameterCodesFeature: Retrieves options for a specific parameter-codes item by ID.
  • describeReliabilityCodesCollection: Retrieves metadata for the reliability-codes collection.
  • getReliabilityCodesFeatures: Retrieves features (items) from the reliability-codes collection.
  • getReliabilityCodesFeature: Retrieves a specific feature by ID from the reliability-codes collection.
  • getReliabilityCodesQueryables: Retrieves queryable properties for the reliability-codes collection.
  • getReliabilityCodesSchema: Retrieves the schema for the reliability-codes collection.
  • optionsReliabilityCodesFeatures: Retrieves options for the reliability-codes items endpoint.
  • optionsReliabilityCodesFeature: Retrieves options for a specific reliability-codes item by ID.
  • describeSiteTypesCollection: Retrieves metadata for the site-types collection.
  • getSiteTypesFeatures: Retrieves features (items) from the site-types collection.
  • getSiteTypesFeature: Retrieves a specific feature by ID from the site-types collection.
  • getSiteTypesQueryables: Retrieves queryable properties for the site-types collection.
  • getSiteTypesSchema: Retrieves the schema for the site-types collection.
  • optionsSiteTypesFeatures: Retrieves options for the site-types items endpoint.
  • optionsSiteTypesFeature: Retrieves options for a specific site-types item by ID.
  • describeStatisticCodesCollection: Retrieves metadata for the statistic-codes collection.
  • getStatisticCodesFeatures: Retrieves features (items) from the statistic-codes collection.
  • getStatisticCodesFeature: Retrieves a specific feature by ID from the statistic-codes collection.
  • getStatisticCodesQueryables: Retrieves queryable properties for the statistic-codes collection.
  • getStatisticCodesSchema: Retrieves the schema for the statistic-codes collection.
  • optionsStatisticCodesFeatures: Retrieves options for the statistic-codes items endpoint.
  • optionsStatisticCodesFeature: Retrieves options for a specific statistic-codes item by ID.
  • describeTopographicCodesCollection: Retrieves metadata for the topographic-codes collection.
  • getTopographicCodesFeatures: Retrieves features (items) from the topographic-codes collection.
  • getTopographicCodesFeature: Retrieves a specific feature by ID from the topographic-codes collection.
  • getTopographicCodesQueryables: Retrieves queryable properties for the topographic-codes collection.
  • getTopographicCodesSchema: Retrieves the schema for the topographic-codes collection.
  • optionsTopographicCodesFeatures: Retrieves options for the topographic-codes items endpoint.
  • optionsTopographicCodesFeature: Retrieves options for a specific topographic-codes item by ID.
  • describeTimeZoneCodesCollection: Retrieves metadata for the time-zone-codes collection.
  • getTimeZoneCodesFeatures: Retrieves features (items) from the time-zone-codes collection.
  • getTimeZoneCodesFeature: Retrieves a specific feature by ID from the time-zone-codes collection.
  • getTimeZoneCodesQueryables: Retrieves queryable properties for the time-zone-codes collection.
  • getTimeZoneCodesSchema: Retrieves the schema for the time-zone-codes collection.
  • optionsTimeZoneCodesFeatures: Retrieves options for the time-zone-codes items endpoint.
  • optionsTimeZoneCodesFeature: Retrieves options for a specific time-zone-codes item by ID.
  • describeLatestContinuousCollection: Retrieves metadata for the latest-continuous collection.
  • getLatestContinuousFeatures: Retrieves features (items) from the latest-continuous collection.
  • getLatestContinuousFeature: Retrieves a specific feature by ID from the latest-continuous collection.
  • getLatestContinuousQueryables: Retrieves queryable properties for the latest-continuous collection.
  • getLatestContinuousSchema: Retrieves the schema for the latest-continuous collection.
  • optionsLatestContinuousFeatures: Retrieves options for the latest-continuous items endpoint.
  • optionsLatestContinuousFeature: Retrieves options for a specific latest-continuous item by ID.
  • describeDailyCollection: Retrieves metadata for the daily collection.
  • getDailyFeatures: Retrieves features (items) from the daily collection.
  • getDailyFeature: Retrieves a specific feature by ID from the daily collection.
  • getDailyQueryables: Retrieves queryable properties for the daily collection.
  • getDailySchema: Retrieves the schema for the daily collection.
  • optionsDailyFeatures: Retrieves options for the daily items endpoint.
  • optionsDailyFeature: Retrieves options for a specific daily item by ID.
  • describeLatestDailyCollection: Retrieves metadata for the latest-daily collection.
  • getLatestDailyFeatures: Retrieves features (items) from the latest-daily collection.
  • getLatestDailyFeature: Retrieves a specific feature by ID from the latest-daily collection.
  • getLatestDailyQueryables: Retrieves queryable properties for the latest-daily collection.
  • getLatestDailySchema: Retrieves the schema for the latest-daily collection.
  • optionsLatestDailyFeatures: Retrieves options for the latest-daily items endpoint.
  • optionsLatestDailyFeature: Retrieves options for a specific latest-daily item by ID.
  • describeFieldMeasurementsCollection: Retrieves metadata for the field-measurements collection.
  • getFieldMeasurementsFeatures: Retrieves features (items) from the field-measurements collection.
  • getFieldMeasurementsFeature: Retrieves a specific feature by ID from the field-measurements collection.
  • getFieldMeasurementsQueryables: Retrieves queryable properties for the field-measurements collection.
  • getFieldMeasurementsSchema: Retrieves the schema for the field-measurements collection.
  • optionsFieldMeasurementsFeatures: Retrieves options for the field-measurements items endpoint.
  • optionsFieldMeasurementsFeature: Retrieves options for a specific field-measurements item by ID.
  • describeTimeSeriesMetadataCollection: Retrieves metadata for the time-series-metadata collection.
  • getTimeSeriesMetadataFeatures: Retrieves features (items) from the time-series-metadata collection.
  • getTimeSeriesMetadataFeature: Retrieves a specific feature by ID from the time-series-metadata collection.
  • getTimeSeriesMetadataQueryables: Retrieves queryable properties for the time-series-metadata collection.
  • getTimeSeriesMetadataSchema: Retrieves the schema for the time-series-metadata collection.
  • optionsTimeSeriesMetadataFeatures: Retrieves options for the time-series-metadata items endpoint.
  • optionsTimeSeriesMetadataFeature: Retrieves options for a specific time-series-metadata item by ID.
  • describeMonitoringLocationsCollection: Retrieves metadata for the monitoring-locations collection.
  • getMonitoringLocationsFeatures: Retrieves features (items) from the monitoring-locations collection.
  • getMonitoringLocationsFeature: Retrieves a specific feature by ID from the monitoring-locations collection.
  • getMonitoringLocationsQueryables: Retrieves queryable properties for the monitoring-locations collection.
  • getMonitoringLocationsSchema: Retrieves the schema for the monitoring-locations collection.
  • optionsMonitoringLocationsFeatures: Retrieves options for the monitoring-locations items endpoint.
  • optionsMonitoringLocationsFeature: Retrieves options for a specific monitoring-locations item by ID.
  • getConformance: Retrieves the API conformance declaration with supported standards.
  • getOpenapi: Retrieves the OpenAPI specification document.

Detailed Integration Documentation

Landing Page Retrieval

Action getLandingPage
Purpose Retrieves the API landing page, serving as the entry point with basic information, links to collections and conformance, and conformance declarations. Useful for discovering API capabilities and navigation.
Parameters
  • Required: None.
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
Configuration Ensure the connector is configured with the base URL via the CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL environment variable (e.g., https://api.waterdata.usgs.gov/ogcapi/v0).
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • title: API title (string, e.g., USGS Water Data OGC APIs)
    • description: API description (string, e.g., These APIs provide OGC-compliant interfaces to USGS water data...)
    • links: Array of link objects (each with href, rel, type, title, hreflang)
    • conformsTo: Array of conformance URIs (array of strings)
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value)
Workflow Example
  • Configure the connector with the base URL.
  • Execute the getLandingPage action with optional format=json.
  • Process the response to extract links for further navigation, such as to collections.

Collections Retrieval

Action getCollections
Purpose Retrieves the list of available collections in the API, including their IDs, titles, descriptions, and links. This serves as the primary entry point for discovering data collections like monitoring-locations or parameter-codes.
Parameters
  • Required: None.
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
Configuration Ensure the connector is configured with the base URL via the CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL environment variable.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • collections: Array of collection objects (each with id, title, description, extent, itemType, links)
    • links: Array of link objects (each with href, rel, type, title, hreflang)
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value)
Workflow Example
  • Configure the connector with the base URL.
  • Execute the getCollections action with optional format=json.
  • Process the response to identify available collections for further queries, such as monitoring-locations or aquifer-codes.

Agency Codes Collection Metadata Retrieval

Action describeAgencyCodesCollection
Purpose Retrieves metadata for the agency-codes collection, including its ID, title, description, extent, and links. Useful for understanding the scope of agency codes used in site information and data sources.
Parameters
  • Required:
    • resourceId: Collection identifier (string, default: agency-codes)
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
Configuration Ensure the connector is configured with the base URL via the CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL environment variable.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • id: Collection identifier (string, e.g., agency-codes)
    • title: Collection title (string, e.g., Agency codes)
    • description: Collection description (string, e.g., Code identifying the agency or organization...)
    • extent: Spatial and temporal extent of the collection (object)
    • itemType: Type of items in the collection (string)
    • links: Array of link objects (each with href, rel, type, title, hreflang)
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL.
  • Execute the describeAgencyCodesCollection action with resourceId=agency-codes and optional format=json.
  • Process the response to understand the agency-codes collection for further queries.

Agency Codes Features Retrieval

Action getAgencyCodesFeatures
Purpose Retrieves features (items) from the agency-codes collection, supporting filtering by bounding box, properties, and sorting. Useful for obtaining agency code data for site information or permitting agencies.
Parameters
  • Required: None.
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • bbox: Bounding box coordinates (array of 4 or 6 numbers, e.g., [minX, minY, maxX, maxY])
    • bbox-crs: Coordinate reference system for bbox (string, format: URI)
    • crs: Coordinate reference system for results (string, format: URI)
    • limit: Maximum number of items to return (integer, default: 10000, max: 10000, min: 1)
    • properties: Comma-separated list of properties to include (array, enum: [id, agency_name])
    • skipGeometry: Skip response geometries (boolean, default: false)
    • sortby: Sort expression (string, e.g., +agency_name for ascending)
    • offset: Index to start results (integer, default: 0, min: 0)
    • id: Party identification number (string)
    • agency_name: Agency code (string)
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via the CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • type: FeatureCollection (string)
    • timeStamp: Response timestamp (string, format: date-time)
    • numberMatched: Number of matched items (number)
    • numberReturned: Number of returned items (number)
    • features: Array of feature objects (each with id, geometry, properties, links)
    • links: Array of link objects (each with href, rel, type, title, hreflang)
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAgencyCodesFeatures action with optional limit=100 and properties=id,agency_name.
  • Process the response to extract agency code data for analysis or display.

Agency Codes Feature Retrieval

Action getAgencyCodesFeature
Purpose Retrieves a specific feature by ID from the agency-codes collection. Useful for obtaining detailed information about a specific agency code.
Parameters
  • Required:
    • featureId: Unique feature identifier (string)
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • crs: Coordinate reference system for results (string, format: URI)
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via the CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • type: Feature (string)
    • id: Feature identifier (string or number)
    • geometry: Feature geometry (object)
    • properties: Feature properties (object, e.g., {id, agency_name})
    • links: Array of link objects (each with href, rel, type, title, hreflang)
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAgencyCodesFeature action with featureId=USGS and format=json.
  • Process the response to display detailed agency code information.

Agency Codes Queryables Retrieval

Action getAgencyCodesQueryables
Purpose Retrieves queryable properties for the agency-codes collection, supporting profiles for actual or valid domains. Useful for understanding which properties can be queried.
Parameters
  • Required: None.
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • properties: Comma-separated list of properties to include (array, enum: [id, agency_name])
    • profile: Profile to apply (string, enum: [actual-domain, valid-domain])
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via the CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • queryables: Array of queryable objects (each with queryable, type, description, title, language, type-ref)
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAgencyCodesQueryables action with profile=actual-domain.
  • Process the response to determine queryable properties for building dynamic queries.

Agency Codes Schema Retrieval

Action getAgencyCodesSchema
Purpose Retrieves the schema for the agency-codes collection. Useful for understanding the structure of agency code data.
Parameters
  • Required: None.
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via the CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • queryables: Array of queryable objects (each with queryable, type, description, title, language, type-ref)
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAgencyCodesSchema action with format=json.
  • Process the response to understand the schema for data validation or integration.

Agency Codes Features Options

Action optionsAgencyCodesFeatures
Purpose Retrieves options for the agency-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None.
  • Optional:
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsAgencyCodesFeatures action.
  • Process the response to determine supported operations for the agency-codes items endpoint.

Agency Codes Feature Options

Action optionsAgencyCodesFeature
Purpose Retrieves options for a specific agency-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string)
  • Optional:
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsAgencyCodesFeature action with featureId=USGS.
  • Process the response to determine supported operations for the specific feature.

Altitude Datums Collection Metadata Retrieval

Action describeAltitudeDatumsCollection
Purpose Retrieves metadata for the altitude-datums collection, including its ID, title, description, extent, and links. Useful for understanding vertical datums like NAVD88 or NGVD29.
Parameters
  • Required:
    • resourceId: Collection identifier (string, default: altitude-datums)
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
Configuration Ensure the connector is configured with the base URL via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL environment variable.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with id, title, description, extent, itemType, and links.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL.
  • Execute the describeAltitudeDatumsCollection action with resourceId=altitude-datums and format=json.
  • Process the response to understand the altitude-datums collection for further queries.

Altitude Datums Features Retrieval

Action getAltitudeDatumsFeatures
Purpose Retrieves features (items) from the altitude-datums collection, supporting filtering by bounding box, properties, and sorting. Useful for obtaining vertical datum data.
Parameters
  • Required: None.
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • bbox: Bounding box coordinates (array of 4 or 6 numbers)
    • bbox-crs: Coordinate reference system for bbox (string, URI)
    • crs: Coordinate reference system for results (string, URI)
    • limit: Maximum number of items to return (integer, default: 10000)
    • properties: Comma-separated list of properties (array, enum: [id, altitude_datum_description])
    • skipGeometry: Skip response geometries (boolean, default: false)
    • sortby: Sort expression (string, e.g., +altitude_datum_description)
    • offset: Index to start results (integer, default: 0)
    • id: Feature identifier (string)
    • altitude_datum_description: Altitude datum description (string)
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with type, timeStamp, numberMatched, numberReturned, features, and links.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAltitudeDatumsFeatures action with limit=100 and properties=id,altitude_datum_description.
  • Process the response to extract altitude datum data for analysis or display.

Altitude Datums Feature Retrieval

Action getAltitudeDatumsFeature
Purpose Retrieves a specific feature by ID from the altitude-datums collection. Useful for obtaining detailed information about a specific vertical datum.
Parameters
  • Required:
    • featureId: Unique feature identifier (string)
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, standard: en-US, enum: [en-US])
    • crs: Coordinate reference system for results (string, format: URI)
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with type, id, geometry, properties, and links.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAltitudeDatumsFeature action with featureId=NAVD88 and format=json.
  • Process the response to display detailed vertical datum information.

Altitude Datums Queryables Retrieval

Action getAltitudeDatumsQueryables
Purpose Retrieves queryable properties for the altitude-datums collection, supporting profiles for actual or valid domains. Useful for understanding which properties can be queried.
Parameters
  • Required: None.
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • properties: Comma-separated list of properties to include (array, enum: [id, altitude_datum_description])
    • profile: Profile to apply (string, enum: [actual-domain, valid-domain])
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with queryables (each with queryable, type, description, title, language, type-ref).
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAltitudeDatumsQueryables action with profile=actual-domain.
  • Process the response to determine queryable properties for building dynamic queries.

Altitude Datums Schema Retrieval

Action getAltitudeDatumsSchema
Purpose Retrieves the schema for the altitude-datums collection. Useful for understanding the structure of vertical datum data.
Parameters
  • Required: None.
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with queryables (each with queryable, type, description, title, language, type-ref).
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAltitudeDatumsSchema action with format=json.
  • Process the response to understand the schema for data validation or integration.

Altitude Datums Features Options

Action optionsAltitudeDatumsFeatures
Purpose Retrieves options for the altitude-datums items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None.
  • Optional:
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsAltitudeDatumsFeatures action.
  • Process the response to determine supported operations for the altitude-datums items endpoint.

Altitude Datums Feature Options

Action optionsAltitudeDatumsFeature
Purpose Retrieves options for a specific altitude-datums item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string)
  • Optional:
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsAltitudeDatumsFeature action with featureId=NAVD88.
  • Process the response to determine supported operations for the specific feature.

Aquifer Codes Collection Metadata Retrieval

Action describeAquiferCodesCollection
Purpose Retrieves metadata for the aquifer-codes collection, including its ID, title, description, extent, and links. Useful for understanding local aquifer data and geohydrologic unit codes.
Parameters
  • Required:
    • resourceId: Collection identifier (string, default: aquifer-codes)
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
Configuration Ensure the connector is configured with the base URL via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL environment variable.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • id: Collection identifier (string, e.g., aquifer-codes)
    • title: Collection title (string, e.g., Aquifer codes)
    • description: Collection description (string, e.g., Local aquifers in USGS data...)
    • extent: Spatial and temporal extent of the collection (object)
    • itemType: Type of items in the collection (string)
    • links: Array of link objects (each with href, rel, type, title, hreflang)
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL.
  • Execute the describeAquiferCodesCollection action with resourceId=aquifer-codes and format=json.
  • Process the response to understand the aquifer-codes collection for further queries.

Aquifer Codes Features Retrieval

Action getAquiferCodesFeatures
Purpose Retrieves features (items) from the aquifer-codes collection, supporting filtering by bounding box, properties, and sorting. Useful for obtaining aquifer code data.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • bbox: Bounding box coordinates (array of 4 or 6 numbers, e.g., [minX, minY, maxX, maxY])
    • bbox-crs: Coordinate reference system for bbox (string, format: URI)
    • crs: Coordinate reference system for results (string, format: URI)
    • limit: Maximum number of items to return (integer, default: 10000, max: 10000, min: 1)
    • properties: Comma-separated list of properties to include (array, enum: [id, aquifer_name])
    • skipGeometry: Skip response geometries (boolean, default: false)
    • sortby: Sort expression (string, e.g., +aquifer_name)
    • offset: Index to start results (integer, default: 0, min: 0)
    • id: Feature identifier (string)
    • aquifer_name: Aquifer name (string)
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • type: FeatureCollection (string)
    • timeStamp: Response timestamp (string, format: date-time)
    • numberMatched: Number of matched items (number)
    • numberReturned: Number of returned items (number)
    • features: Array of feature objects (each with id, geometry, properties, links)
    • links: Array of link objects (each with href, rel, type, title, hreflang)
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAquiferCodesFeatures action with limit=100 and properties=id,aquifer_name.
  • Process the response to extract aquifer code data for analysis or display.

Aquifer Codes Feature Retrieval

Action getAquiferCodesFeature
Purpose Retrieves a specific feature by ID from the aquifer-codes collection. Useful for obtaining detailed information about a specific aquifer code.
Parameters
  • Required:
    • featureId: Unique feature identifier (string)
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • crs: Coordinate reference system for results (string, format: URI)
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • type: Feature (string)
    • id: Feature identifier (string or number)
    • geometry: Feature geometry (object)
    • properties: Feature properties (object, e.g., {id, aquifer_name})
    • links: Array of link objects (each with href, rel, type, title, hreflang)
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAquiferCodesFeature action with featureId=example-id and format=json.
  • Process the response to display detailed aquifer code information.

Aquifer Codes Queryables Retrieval

Action getAquiferCodesQueryables
Purpose Retrieves queryable properties for the aquifer-codes collection, supporting profiles for actual or valid domains. Useful for understanding which properties can be queried.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • properties: Comma-separated list of properties to include (array, enum: [id, aquifer_name])
    • profile: Profile to apply (string, enum: [actual-domain, valid-domain])
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • queryables: Array of queryable objects (each with queryable, type, description, title, language, type-ref)
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAquiferCodesQueryables action with profile=actual-domain.
  • Process the response to determine queryable properties for building dynamic queries.

Aquifer Codes Schema Retrieval

Action getAquiferCodesSchema
Purpose Retrieves the schema for the aquifer-codes collection. Useful for understanding the structure of aquifer code data.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • queryables: Array of queryable objects (each with queryable, type, description, title, language, type-ref)
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAquiferCodesSchema action with format=json.
  • Process the response to understand the schema for data validation or integration.

Aquifer Codes Features Options

Action optionsAquiferCodesFeatures
Purpose Retrieves options for the aquifer-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional:
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsAquiferCodesFeatures action.
  • Process the response to determine supported operations for the aquifer-codes items endpoint.

Aquifer Codes Feature Options

Action optionsAquiferCodesFeature
Purpose Retrieves options for a specific aquifer-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string)
  • Optional:
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsAquiferCodesFeature action with featureId=example-id.
  • Process the response to determine supported operations for the specific feature.

Aquifer Types Collection Metadata Retrieval

Action describeAquiferTypesCollection
Purpose Retrieves metadata for the aquifer-types collection, including its ID, title, description, extent, and links. Useful for understanding confined and unconfined aquifer types.
Parameters
  • Required:
    • resourceId: Collection identifier (string, default: aquifer-types)
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
Configuration Ensure the connector is configured with the base URL via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL environment variable.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • id, title, description, extent, itemType
    • links: Array of link objects
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL.
  • Execute the describeAquiferTypesCollection action with resourceId=aquifer-types and format=json.
  • Process the response to understand the aquifer-types collection for further queries.

Aquifer Types Features Retrieval

Action getAquiferTypesFeatures
Purpose Retrieves features (items) from the aquifer-types collection, supporting filtering by bounding box, properties, and sorting. Useful for obtaining aquifer type data.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • bbox, bbox-crs, crs, limit, properties, skipGeometry, sortby, offset
    • id: Feature identifier (string)
    • aquifer_type: Aquifer type (string)
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • type, timeStamp, numberMatched, numberReturned
    • features: Array of feature objects (id, geometry, properties, links)
    • links: Array of link objects
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAquiferTypesFeatures action with limit=100 and properties=id,aquifer_type.
  • Process the response to extract aquifer type data for analysis or display.

Aquifer Types Feature Retrieval

Action getAquiferTypesFeature
Purpose Retrieves a specific feature by ID from the aquifer-types collection. Useful for obtaining detailed information about a specific aquifer type.
Parameters
  • Required:
    • featureId: Unique feature identifier (string)
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • crs: Coordinate reference system for results (string, format: URI)
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • type: Feature
    • id: Feature identifier (string or number)
    • geometry: Feature geometry (object)
    • properties: Feature properties (object, e.g., {id, aquifer_type})
    • links: Array of link objects (href, rel, type, title, hreflang)
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAquiferTypesFeature action with featureId=example-id and format=json.
  • Process the response to display detailed aquifer type information.

Aquifer Types Queryables Retrieval

Action getAquiferTypesQueryables
Purpose Retrieves queryable properties for the aquifer-types collection, supporting profiles for actual or valid domains. Useful for understanding which properties can be queried.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • properties: Comma-separated list of properties to include (array, enum: [id, aquifer_type])
    • profile: Profile to apply (string, enum: [actual-domain, valid-domain])
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • queryables: Array of queryable objects (queryable, type, description, title, language, type-ref)
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAquiferTypesQueryables action with profile=actual-domain.
  • Process the response to determine queryable properties for building dynamic queries.

Aquifer Types Schema Retrieval

Action getAquiferTypesSchema
Purpose Retrieves the schema for the aquifer-types collection. Useful for understanding the structure of aquifer type data.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • queryables: Array of queryable objects (queryable, type, description, title, language, type-ref)
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getAquiferTypesSchema action with format=json.
  • Process the response to understand the schema for data validation or integration.

Aquifer Types Features Options

Action optionsAquiferTypesFeatures
Purpose Retrieves options for the aquifer-types items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional:
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters
  • Failure: Returns error details (e.g., status: 500, detail: Server error)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsAquiferTypesFeatures action.
  • Process the response to determine supported operations for the aquifer-types items endpoint.

Aquifer Types Feature Options

Action optionsAquiferTypesFeature
Purpose Retrieves options for a specific aquifer-types item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string)
  • Optional:
    • api_key: API key for higher rate limits (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsAquiferTypesFeature action with featureId=example-id.
  • Process the response to determine supported operations for the specific feature.

Coordinate Accuracy Codes Collection Metadata Retrieval

Action describeCoordinateAccuracyCodesCollection
Purpose Retrieves metadata for the coordinate-accuracy-codes collection, including its ID, title, description, extent, and links. Useful for understanding the accuracy of latitude-longitude values.
Parameters
  • Required: resourceId (string, default: coordinate-accuracy-codes)
  • Optional:
    • format: Response format (string, enum: [json, html, jsonld, csv], default: json)
    • lang: Language for the response (string, default: en-US, enum: [en-US])
Configuration Ensure the connector is configured with the base URL via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with:
    • id, title, description, extent, itemType, links
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL.
  • Execute the describeCoordinateAccuracyCodesCollection action with resourceId=coordinate-accuracy-codes and format=json.
  • Process the response to understand the collection for further queries.

Coordinate Accuracy Codes Features Retrieval

Action getCoordinateAccuracyCodesFeatures
Purpose Retrieves features from the coordinate-accuracy-codes collection, supporting filtering by bounding box, properties, and sorting. Useful for obtaining coordinate accuracy code data.
Parameters
  • Required: None
  • Optional:
    • format (string, enum: [json, html, jsonld, csv], default: json)
    • lang (string, default: en-US, enum: [en-US])
    • bbox (array of 4 or 6 numbers)
    • bbox-crs (string, format: URI)
    • crs (string, format: URI)
    • limit (integer, default: 10000, max: 10000, min: 1)
    • properties (array, enum: [id, accuracy_code])
    • skipGeometry (boolean, default: false)
    • sortby (string, e.g., +accuracy_code)
    • offset (integer, default: 0, min: 0)
    • id (string)
    • accuracy_code (string)
    • api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a FeatureCollection with type, timeStamp, numberMatched, numberReturned, features, and links.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateAccuracyCodesFeatures action with limit=100 and properties=id,accuracy_code.
  • Process the response to extract coordinate accuracy code data for analysis or display.

Coordinate Accuracy Codes Feature Retrieval

Action getCoordinateAccuracyCodesFeature
Purpose Retrieves a specific feature by ID from the coordinate-accuracy-codes collection. Useful for obtaining detailed information about a specific coordinate accuracy code.
Parameters
  • Required: featureId (string)
  • Optional:
    • format (string, enum: [json, html, jsonld, csv], default: json)
    • lang (string, default: en-US, enum: [en-US])
    • crs (string, format: URI)
    • api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a Feature object with type, id, geometry, properties, and links.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateAccuracyCodesFeature action with featureId=example-id and format=json.
  • Process the response to display detailed coordinate accuracy code information.

Coordinate Accuracy Codes Queryables Retrieval

Action getCoordinateAccuracyCodesQueryables
Purpose Retrieves queryable properties for the coordinate-accuracy-codes collection, supporting profiles for actual or valid domains. Useful for understanding which properties can be queried.
Parameters
  • Required: None
  • Optional:
    • format (string, enum: [json, html, jsonld, csv], default: json)
    • lang (string, default: en-US, enum: [en-US])
    • properties (array, enum: [id, accuracy_code])
    • profile (string, enum: [actual-domain, valid-domain])
    • api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an array of queryable objects (each with queryable, type, description, title, language, type-ref).
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateAccuracyCodesQueryables action with profile=actual-domain.
  • Process the response to determine queryable properties for building dynamic queries.

Coordinate Accuracy Codes Schema Retrieval

Action getCoordinateAccuracyCodesSchema
Purpose Retrieves the schema for the coordinate-accuracy-codes collection. Useful for understanding the structure of coordinate accuracy code data.
Parameters
  • Required: None
  • Optional:
    • format (string, enum: [json, html, jsonld, csv], default: json)
    • lang (string, default: en-US, enum: [en-US])
    • api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an array of queryable objects (each with queryable, type, description, title, language, type-ref).
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateAccuracyCodesSchema action with format=json.
  • Process the response to understand the schema for data validation or integration.

Coordinate Accuracy Codes Features Options

Action optionsCoordinateAccuracyCodesFeatures
Purpose Retrieves options for the coordinate-accuracy-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional: api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsCoordinateAccuracyCodesFeatures action.
  • Process the response to determine supported operations for the coordinate-accuracy-codes items endpoint.

Coordinate Accuracy Codes Feature Options

Action optionsCoordinateAccuracyCodesFeature
Purpose Retrieves options for a specific coordinate-accuracy-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required: featureId (string)
  • Optional: api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsCoordinateAccuracyCodesFeature action with featureId=example-id.
  • Process the response to determine supported operations for the specific feature.

Coordinate Datum Codes Collection Metadata Retrieval

Action describeCoordinateDatumCodesCollection
Purpose Retrieves metadata for the coordinate-datum-codes collection, including its ID, title, description, extent, and links. Useful for understanding horizontal datum codes like NAD83 or NAD27.
Parameters
  • Required: resourceId (string, default: coordinate-datum-codes)
  • Optional:
    • format (string, enum: [json, html, jsonld, csv], default: json)
    • lang (string, default: en-US, enum: [en-US])
Configuration Ensure the connector is configured with the base URL via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with collection metadata (id, title, description, extent, itemType, links).
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL.
  • Execute the describeCoordinateDatumCodesCollection action with resourceId=coordinate-datum-codes and format=json.
  • Process the response to understand the coordinate-datum-codes collection for further queries.

Coordinate Datum Codes Features Retrieval

Action getCoordinateDatumCodesFeatures
Purpose Retrieves features (items) from the coordinate-datum-codes collection, supporting filtering by bounding box, properties, and sorting. Useful for obtaining horizontal datum code data.
Parameters
  • Required: None
  • Optional:
    • format (string, enum: [json, html, jsonld, csv], default: json)
    • lang (string, default: en-US, enum: [en-US])
    • bbox (array of 4 or 6 numbers)
    • bbox-crs (string, format: URI)
    • crs (string, format: URI)
    • limit (integer, default: 10000, max: 10000, min: 1)
    • properties (array, enum: [id, datum_code])
    • skipGeometry (boolean, default: false)
    • sortby (string)
    • offset (integer, default: 0, min: 0)
    • id (string)
    • datum_code (string)
    • api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a FeatureCollection with type, timeStamp, numberMatched, numberReturned, features array, and links.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateDatumCodesFeatures action with limit=100 and properties=id,datum_code.
  • Process the response to extract coordinate datum code data for analysis or display.

Coordinate Datum Codes Feature Retrieval

Action getCoordinateDatumCodesFeature
Purpose Retrieves a specific feature by ID from the coordinate-datum-codes collection. Useful for obtaining detailed information about a specific horizontal datum code.
Parameters
  • Required: featureId (string)
  • Optional:
    • format (string, enum: [json, html, jsonld, csv], default: json)
    • lang (string, default: en-US, enum: [en-US])
    • crs (string, format: URI)
    • api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with type, id, geometry, properties, and links.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateDatumCodesFeature action with featureId=NAD83 and format=json.
  • Process the response to display detailed horizontal datum code information.

Coordinate Datum Codes Queryables Retrieval

Action getCoordinateDatumCodesQueryables
Purpose Retrieves queryable properties for the coordinate-datum-codes collection, supporting profiles for actual or valid domains. Useful for understanding which properties can be queried.
Parameters
  • Required: None
  • Optional:
    • format (string, enum: [json, html, jsonld, csv], default: json)
    • lang (string, default: en-US, enum: [en-US])
    • properties (array, enum: [id, datum_code])
    • profile (string, enum: [actual-domain, valid-domain])
    • api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with queryables array (each with queryable, type, description, title, language, type-ref).
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateDatumCodesQueryables action with profile=actual-domain.
  • Process the response to determine queryable properties for building dynamic queries.

Coordinate Datum Codes Schema Retrieval

Action getCoordinateDatumCodesSchema
Purpose Retrieves the schema for the coordinate-datum-codes collection. Useful for understanding the structure of horizontal datum code data.
Parameters
  • Required: None
  • Optional:
    • format (string, enum: [json, html, jsonld, csv], default: json)
    • lang (string, default: en-US, enum: [en-US])
    • api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with queryables array (each with queryable, type, description, title, language, type-ref).
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found)
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateDatumCodesSchema action with format=json.
  • Process the response to understand the schema for data validation or integration.

Coordinate Datum Codes Features Options

Action optionsCoordinateDatumCodesFeatures
Purpose Retrieves options for the coordinate-datum-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional: api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsCoordinateDatumCodesFeatures action.
  • Process the response to determine supported operations for the coordinate-datum-codes items endpoint.

Coordinate Datum Codes Feature Options

Action optionsCoordinateDatumCodesFeature
Purpose Retrieves options for a specific coordinate-datum-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required: featureId (string)
  • Optional: api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsCoordinateDatumCodesFeature action with featureId=NAD83.
  • Process the response to determine supported operations for the specific feature.

Coordinate Method Codes Collection Metadata Retrieval

Action describeCoordinateMethodCodesCollection
Purpose Retrieves metadata for the coordinate-method-codes collection, including its ID, title, description, extent, and links. Useful for understanding methods used to determine coordinates.
Parameters
  • Required: resourceId (string, default: coordinate-method-codes)
  • Optional:
    • format (string, enum: [json, html, jsonld, csv], default: json)
    • lang (string, default: en-US, enum: [en-US])
Configuration Ensure the connector is configured with the base URL via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL.
Output
  • Successful: Returns a JSON, HTML, JSON-LD, or CSV object with id, title, description, extent, itemType, and links.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL.
  • Execute the describeCoordinateMethodCodesCollection action with resourceId=coordinate-method-codes and format=json.
  • Process the response to understand the coordinate-method-codes collection for further queries.

Coordinate Method Codes Features Retrieval

Action getCoordinateMethodCodesFeatures
Purpose Retrieves features (items) from the coordinate-method-codes collection, supporting filtering by bounding box, properties, and sorting. Useful for obtaining coordinate method code data.
Parameters
  • Required: None
  • Optional:
    • format (string, enum: [json, html, jsonld, csv], default: json)
    • lang (string, default: en-US, enum: [en-US])
    • bbox (array of 4 or 6 numbers)
    • bbox-crs (string, URI)
    • crs (string, URI)
    • limit (integer, default: 10000)
    • properties (array, enum: [id, method_code])
    • skipGeometry (boolean, default: false)
    • sortby (string)
    • offset (integer, default: 0)
    • id (string)
    • method_code (string)
    • api_key (string)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a FeatureCollection with timestamp, numberMatched, numberReturned, features array, and links.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateMethodCodesFeatures action with limit=100 and properties=id,method_code.
  • Process the response to extract coordinate method code data for analysis or display.

Coordinate Method Codes Feature Retrieval

Action getCoordinateMethodCodesFeature
Purpose Retrieves a specific feature by ID from the coordinate-method-codes collection. Useful for obtaining detailed information about a specific coordinate method code.
Parameters
  • Required: featureId (string)
  • Optional: format, lang, crs, api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a Feature object with id, geometry, properties, and links.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateMethodCodesFeature action with featureId=example-id and format=json.
  • Process the response to display detailed coordinate method code information.

Coordinate Method Codes Queryables Retrieval

Action getCoordinateMethodCodesQueryables
Purpose Retrieves queryable properties for the coordinate-method-codes collection, supporting profiles for actual or valid domains. Useful for understanding which properties can be queried.
Parameters
  • Required: None
  • Optional: format, lang, properties (id, method_code), profile (actual-domain, valid-domain), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an array of queryable objects with queryable, type, description, title, language, and type-ref.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateMethodCodesQueryables action with profile=actual-domain.
  • Process the response to determine queryable properties for building dynamic queries.

Coordinate Method Codes Schema Retrieval

Action getCoordinateMethodCodesSchema
Purpose Retrieves the schema for the coordinate-method-codes collection. Useful for understanding the structure of coordinate method code data.
Parameters
  • Required: None
  • Optional: format (json, html, jsonld, csv), lang (default: en-US), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an array of queryable objects with queryable, type, description, title, language, type-ref.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getCoordinateMethodCodesSchema action with format=json.
  • Process the response to understand the schema for data validation or integration.

Coordinate Method Codes Features Options

Action optionsCoordinateMethodCodesFeatures
Purpose Retrieves options for the coordinate-method-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional: api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsCoordinateMethodCodesFeatures action.
  • Process the response to determine supported operations for the coordinate-method-codes items endpoint.

Coordinate Method Codes Feature Options

Action optionsCoordinateMethodCodesFeature
Purpose Retrieves options for a specific coordinate-method-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required: featureId
  • Optional: api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsCoordinateMethodCodesFeature action with featureId=example-id.
  • Process the response to determine supported operations for the specific feature.

Hydrologic Unit Codes Collection Metadata Retrieval

Action describeHydrologicUnitCodesCollection
Purpose Retrieves metadata for the hydrologic-unit-codes collection, including its ID, title, description, extent, and links. Useful for understanding hydrologic unit codes like HUC8 or HUC12.
Parameters
  • Required: resourceId (default: hydrologic-unit-codes)
  • Optional: format (json, html, jsonld, csv), lang (default: en-US)
Configuration Ensure the connector is configured with the base URL via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL.
Output
  • Successful: Returns collection metadata including id, title, description, extent, itemType, and links.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL.
  • Execute the describeHydrologicUnitCodesCollection action with resourceId=hydrologic-unit-codes and format=json.
  • Process the response to understand the hydrologic-unit-codes collection for further queries.

Hydrologic Unit Codes Features Retrieval

Action getHydrologicUnitCodesFeatures
Purpose Retrieves features (items) from the hydrologic-unit-codes collection, supporting filtering by bounding box, properties, and sorting. Useful for obtaining hydrologic unit code data.
Parameters
  • Required: None
  • Optional: format, lang, bbox, bbox-crs, crs, limit, properties, skipGeometry, sortby, offset, id, huc_code, api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a FeatureCollection with timeStamp, numberMatched, numberReturned, features, and links.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getHydrologicUnitCodesFeatures action with limit=100 and properties=id,huc_code.
  • Process the response to extract hydrologic unit code data for analysis or display.

Hydrologic Unit Codes Feature Retrieval

Action getHydrologicUnitCodesFeature
Purpose Retrieves a specific feature by ID from the hydrologic-unit-codes collection. Useful for obtaining detailed information about a specific hydrologic unit code.
Parameters
  • Required: featureId
  • Optional: format (json, html, jsonld, csv), lang (default: en-US), crs, api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a Feature object with id, geometry, properties (e.g., {id, huc_code}), and links.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getHydrologicUnitCodesFeature action with featureId=example-id and format=json.
  • Process the response to display detailed hydrologic unit code information.

Hydrologic Unit Codes Queryables Retrieval

Action getHydrologicUnitCodesQueryables
Purpose Retrieves queryable properties for the hydrologic-unit-codes collection, supporting profiles for actual or valid domains. Useful for understanding which properties can be queried.
Parameters
  • Required: None
  • Optional: format, lang, properties (id, huc_code), profile (actual-domain, valid-domain), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an array of queryable objects with queryable, type, description, title, language, type-ref.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getHydrologicUnitCodesQueryables action with profile=actual-domain.
  • Process the response to determine queryable properties for building dynamic queries.

Hydrologic Unit Codes Schema Retrieval

Action getHydrologicUnitCodesSchema
Purpose Retrieves the schema for the hydrologic-unit-codes collection. Useful for understanding the structure of hydrologic unit code data.
Parameters
  • Required: None
  • Optional: format, lang, api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an array of queryable objects for schema understanding and validation.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getHydrologicUnitCodesSchema action with format=json.
  • Process the response to understand the schema for data validation or integration.

Hydrologic Unit Codes Features Options

Action optionsHydrologicUnitCodesFeatures
Purpose Retrieves options for the hydrologic-unit-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional: api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsHydrologicUnitCodesFeatures action.
  • Process the response to determine supported operations for the hydrologic-unit-codes items endpoint.

Hydrologic Unit Codes Feature Options

Action optionsHydrologicUnitCodesFeature
Purpose Retrieves options for a specific hydrologic-unit-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required: featureId
  • Optional: api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsHydrologicUnitCodesFeature action with featureId=example-id.
  • Process the response to determine supported operations for the specific feature.

Medium Codes Collection Metadata Retrieval

Action describeMediumCodesCollection
Purpose Retrieves metadata for the medium-codes collection, including its ID, title, description, extent, and links. Useful for understanding medium codes like surface water or groundwater.
Parameters
  • Required: resourceId (default: medium-codes)
  • Optional: format (json, html, jsonld, csv), lang (default: en-US)
Configuration Ensure the connector is configured with the base URL via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL.
Output
  • Successful: Returns a collection object with id, title, description, extent, itemType, and links.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL.
  • Execute the describeMediumCodesCollection action with resourceId=medium-codes and format=json.
  • Process the response to understand the medium-codes collection for further queries.

Medium Codes Features Retrieval

Action getMediumCodesFeatures
Purpose Retrieves features (items) from the medium-codes collection, supporting filtering by bounding box, properties, and sorting. Useful for obtaining medium code data.
Parameters
  • Required: None
  • Optional: format, lang, bbox, bbox-crs, crs, limit, properties, skipGeometry, sortby, offset, id, medium_code, api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a FeatureCollection object with type, timeStamp, numberMatched, numberReturned, features, and links.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getMediumCodesFeatures action with limit=100 and properties=id,medium_code.
  • Process the response to extract medium code data for analysis or display.

Medium Codes Feature Retrieval

Action getMediumCodesFeature
Purpose Retrieves a specific feature by ID from the medium-codes collection. Useful for obtaining detailed information about a specific medium code.
Parameters
  • Required: featureId
  • Optional: format, lang, crs, api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a Feature object with type, id, geometry, properties, and links.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getMediumCodesFeature action with featureId=example-id and format=json.
  • Process the response to display detailed medium code information.

Medium Codes Queryables Retrieval

Medium Codes Schema Retrieval

Action getMediumCodesQueryables
Purpose Retrieves queryable properties for the medium-codes collection, supporting profiles for actual or valid domains. Useful for understanding which properties can be queried.
Parameters
  • Required: None
  • Optional: format, lang, properties, profile, api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an array of queryable objects with queryable, type, description, title, language, and type-ref.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getMediumCodesQueryables action with profile=actual-domain.
  • Process the response to determine queryable properties for building dynamic queries.
Action getMediumCodesSchema
Purpose Retrieves the schema for the medium-codes collection. Useful for understanding the structure of medium code data.
Parameters
  • Required: None
  • Optional: format, lang, api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an object with queryables (array of queryable objects with queryable, type, description, title, language, type-ref).
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getMediumCodesSchema action with format=json.
  • Process the response to understand the schema for data validation or integration.

Medium Codes Features Options

Action optionsMediumCodesFeatures
Purpose Retrieves options for the medium-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional: api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsMediumCodesFeatures action.
  • Process the response to determine supported operations for the medium-codes items endpoint.

Medium Codes Feature Options

Action optionsMediumCodesFeature
Purpose Retrieves options for a specific medium-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required: featureId
  • Optional: api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsMediumCodesFeature action with featureId=example-id.
  • Process the response to determine supported operations for the specific feature.

National Aquifer Codes Collection Metadata Retrieval

Action describeNationalAquiferCodesCollection
Purpose Retrieves metadata for the national-aquifer-codes collection, providing details about standardized aquifer codes and their attributes. Useful for understanding the structure of the dataset.
Parameters
  • Required: None
  • Optional: format (json, xml), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns metadata including codes, names, descriptions, and extent.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeNationalAquiferCodesCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

National Aquifer Codes Features Retrieval

Action getNationalAquiferCodesFeatures
Purpose Retrieves features (items) from the national-aquifer-codes collection, providing detailed records of aquifer codes and their attributes. Useful for accessing specific aquifer data.
Parameters
  • Required: None
  • Optional: limit, offset, filter (CQL expression), format (json, xml), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a list of national aquifer code items with attributes such as code, name, and description.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getNationalAquiferCodesFeatures action with optional parameters (e.g., filter=national_aquifer_code='N100HGHPLN').
  • Process the response to analyze aquifer code data.

National Aquifer Codes Feature Retrieval

Action getNationalAquiferCodesFeature
Purpose Retrieves a specific feature by ID from the national-aquifer-codes collection. Useful for accessing detailed information about a single aquifer code.
Parameters
  • Required: featureId
  • Optional: format (json, xml), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns details of the specified aquifer code item, including code, name, and description.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getNationalAquiferCodesFeature action with featureId=N100HGHPLN.
  • Process the response to extract details of the specific aquifer code.

National Aquifer Codes Queryables Retrieval

Action getNationalAquiferCodesQueryables
Purpose Retrieves queryable properties for the national-aquifer-codes collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional: format (json, xml), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a list of queryable properties for the national-aquifer-codes collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getNationalAquiferCodesQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

National Aquifer Codes Schema Retrieval

Action getNationalAquiferCodesSchema
Purpose Retrieves the schema for the national-aquifer-codes collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional: format (json, xml), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns the schema for the national-aquifer-codes collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getNationalAquiferCodesSchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

National Aquifer Codes Features Options

Action optionsNationalAquiferCodesFeatures
Purpose Retrieves options for the national-aquifer-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional: api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsNationalAquiferCodesFeatures action.
  • Process the response to determine supported operations for the national-aquifer-codes items endpoint.

National Aquifer Codes Feature Options

Action optionsNationalAquiferCodesFeature
Purpose Retrieves options for a specific national-aquifer-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required: featureId (string), e.g., featureId=N100HGHPLN
  • Optional: api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsNationalAquiferCodesFeature action with featureId=N100HGHPLN.
  • Process the response to determine supported operations for the specific feature.

Parameter Codes Collection Metadata Retrieval

Action describeParameterCodesCollection
Purpose Retrieves metadata for the parameter-codes collection, providing details about standardized parameter codes used in water data. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional: format (json, xml), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns metadata for the parameter-codes collection, including codes, names, and descriptions.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeParameterCodesCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

Parameter Codes Features Retrieval

Action getParameterCodesFeatures
Purpose Retrieves features (items) from the parameter-codes collection, providing detailed records of parameter codes and their attributes. Useful for accessing specific parameter data.
Parameters
  • Required: None
  • Optional: limit (integer, default 10, max 1000), offset (integer), filter (CQL string), format (json, xml), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a list of parameter code items with attributes such as code, name, and description.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getParameterCodesFeatures action with optional parameters (e.g., filter=parameter_code='00060').
  • Process the response to analyze parameter code data.

Parameter Codes Feature Retrieval

Action getParameterCodesFeature
Purpose Retrieves a specific feature by ID from the parameter-codes collection. Useful for accessing detailed information about a single parameter code.
Parameters
  • Required: featureId (string), e.g., featureId=00060
  • Optional: format (json, xml), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns details of the specified parameter code item, including code, name, and description.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getParameterCodesFeature action with featureId=00060.
  • Process the response to extract details of the specific parameter code.

Parameter Codes Queryables Retrieval

Action getParameterCodesQueryables
Purpose Retrieves queryable properties for the parameter-codes collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional: format (json, xml), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns a list of queryable properties for the parameter-codes collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getParameterCodesQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

Parameter Codes Schema Retrieval

Action getParameterCodesSchema
Purpose Retrieves the schema for the parameter-codes collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional: format (json, xml), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns the schema for the parameter-codes collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getParameterCodesSchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

Parameter Codes Features Options

Action optionsParameterCodesFeatures
Purpose Retrieves options for the parameter-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional: api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsParameterCodesFeatures action.
  • Process the response to determine supported operations for the parameter-codes items endpoint.

Parameter Codes Feature Options

Action optionsParameterCodesFeature
Purpose Retrieves options for a specific parameter-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required: featureId (string), e.g., featureId=00060
  • Optional: api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsParameterCodesFeature action with featureId=00060.
  • Process the response to determine supported operations for the specific feature.

Reliability Codes Collection Metadata Retrieval

Action describeReliabilityCodesCollection
Purpose Retrieves metadata for the reliability-codes collection, providing details about standardized reliability codes for water data. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional: format (json, xml), api_key
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY.
Output
  • Successful: Returns metadata for the reliability-codes collection, including codes, names, and descriptions.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeReliabilityCodesCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.
Here’s the content you provided filled into your saved HTML template. I kept strictly to your content with no additions: ---

Reliability Codes Features Retrieval

Action getReliabilityCodesFeatures
Purpose Retrieves features (items) from the reliability-codes collection, providing detailed records of reliability codes and their attributes. Useful for accessing specific reliability data.
Parameters
  • Required: None
  • Optional:
    • limit: Maximum number of items to return (integer, default: 10, maximum: 1000). Example: limit=50
    • offset: Starting index for pagination (integer, default: 0). Example: offset=100
    • filter: Common Query Language (CQL) expression to filter items (string). Example: filter=reliability_code='A'
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of reliability code items with attributes such as code, name, and description.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getReliabilityCodesFeatures action with optional parameters (e.g., filter=reliability_code='A').
  • Process the response to analyze reliability code data.

Reliability Codes Feature Retrieval

Action getReliabilityCodesFeature
Purpose Retrieves a specific feature by ID from the reliability-codes collection. Useful for accessing detailed information about a single reliability code.
Parameters
  • Required:
    • featureId: Unique identifier for the reliability code item (string). Example: featureId=A
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns details of the specified reliability code item, including code, name, and description.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getReliabilityCodesFeature action with featureId=A.
  • Process the response to extract details of the specific reliability code.

Reliability Codes Queryables Retrieval

Action getReliabilityCodesQueryables
Purpose Retrieves queryable properties for the reliability-codes collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of queryable properties for the reliability-codes collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getReliabilityCodesQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

Reliability Codes Schema Retrieval

Action getReliabilityCodesSchema
Purpose Retrieves the schema for the reliability-codes collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the schema for the reliability-codes collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getReliabilityCodesSchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

Reliability Codes Features Options

Action optionsReliabilityCodesFeatures
Purpose Retrieves options for the reliability-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsReliabilityCodesFeatures action.
  • Process the response to determine supported operations for the reliability-codes items endpoint.

Reliability Codes Feature Options

Action optionsReliabilityCodesFeature
Purpose Retrieves options for a specific reliability-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string). Example: featureId=A
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsReliabilityCodesFeature action with featureId=A.
  • Process the response to determine supported operations for the specific feature.

Site Types Collection Metadata Retrieval

Action describeSiteTypesCollection
Purpose Retrieves metadata for the site-types collection, providing details about standardized site types for monitoring locations. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns metadata for the site-types collection, including types, names, and descriptions.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeSiteTypesCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

Site Types Features Retrieval

Action getSiteTypesFeatures
Purpose Retrieves features (items) from the site-types collection, providing detailed records of site types and their attributes. Useful for accessing specific site type data.
Parameters
  • Required: None
  • Optional:
    • limit: Maximum number of items to return (integer, default: 10, maximum: 1000). Example: limit=50
    • offset: Starting index for pagination (integer, default: 0). Example: offset=100
    • filter: Common Query Language (CQL) expression to filter items (string). Example: filter=site_type_code='ST'
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of site type items with attributes such as code, name, and description.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getSiteTypesFeatures action with optional parameters (e.g., filter=site_type_code='ST').
  • Process the response to analyze site type data.

Site Types Feature Retrieval

Action getSiteTypesFeature
Purpose Retrieves a specific feature by ID from the site-types collection. Useful for accessing detailed information about a single site type.
Parameters
  • Required:
    • featureId: Unique identifier for the site type item (string). Example: featureId=ST
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns details of the specified site type item, including code, name, and description.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getSiteTypesFeature action with featureId=ST.
  • Process the response to extract details of the specific site type.

Site Types Queryables Retrieval

Action getSiteTypesQueryables
Purpose Retrieves queryable properties for the site-types collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of queryable properties for the site-types collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getSiteTypesQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

Site Types Schema Retrieval

Action getSiteTypesSchema
Purpose Retrieves the schema for the site-types collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the schema for the site-types collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getSiteTypesSchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

Site Types Features Options

Action optionsSiteTypesFeatures
Purpose Retrieves options for the site-types items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsSiteTypesFeatures action.
  • Process the response to determine supported operations for the site-types items endpoint.

Site Types Feature Options

Action optionsSiteTypesFeature
Purpose Retrieves options for a specific site-types item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string). Example: featureId=ST
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsSiteTypesFeature action with featureId=ST.
  • Process the response to determine supported operations for the specific feature.

Statistic Codes Collection Metadata Retrieval

Action describeStatisticCodesCollection
Purpose Retrieves metadata for the statistic-codes collection, providing details about standardized statistic codes for water data. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns metadata for the statistic-codes collection, including codes, names, and descriptions.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeStatisticCodesCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

Statistic Codes Features Retrieval

Action getStatisticCodesFeatures
Purpose Retrieves features (items) from the statistic-codes collection, providing detailed records of statistic codes and their attributes. Useful for accessing specific statistic data.
Parameters
  • Required: None
  • Optional:
    • limit: Maximum number of items to return (integer, default: 10, maximum: 1000). Example: limit=50
    • offset: Starting index for pagination (integer, default: 0). Example: offset=100
    • filter: Common Query Language (CQL) expression to filter items (string). Example: filter=statistic_code='00001'
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of statistic code items with attributes such as code, name, and description.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getStatisticCodesFeatures action with optional parameters (e.g., filter=statistic_code='00001').
  • Process the response to analyze statistic code data.

Statistic Codes Feature Retrieval

Action getStatisticCodesFeature
Purpose Retrieves a specific feature by ID from the statistic-codes collection. Useful for accessing detailed information about a single statistic code.
Parameters
  • Required:
    • featureId: Unique identifier for the statistic code item (string). Example: featureId=00001
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns details of the specified statistic code item, including code, name, and description.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getStatisticCodesFeature action with featureId=00001.
  • Process the response to extract details of the specific statistic code.

Statistic Codes Queryables Retrieval

Action getStatisticCodesQueryables
Purpose Retrieves queryable properties for the statistic-codes collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of queryable properties for the statistic-codes collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getStatisticCodesQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

Statistic Codes Schema Retrieval

Action getStatisticCodesSchema
Purpose Retrieves the schema for the statistic-codes collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the schema for the statistic-codes collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getStatisticCodesSchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.
Here’s your content for 2.99–2.101 in the saved HTML template format: ---

Statistic Codes Features Options

Action optionsStatisticCodesFeatures
Purpose Retrieves options for the statistic-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsStatisticCodesFeatures action.
  • Process the response to determine supported operations for the statistic-codes items endpoint.

Statistic Codes Feature Options

Action optionsStatisticCodesFeature
Purpose Retrieves options for a specific statistic-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string). Example: featureId=00001
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsStatisticCodesFeature action with featureId=00001.
  • Process the response to determine supported operations for the specific feature.

Topographic Codes Collection Metadata Retrieval

Action describeTopographicCodesCollection
Purpose Retrieves metadata for the topographic-codes collection, providing details about standardized topographic codes for water data. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns metadata for the topographic-codes collection, including codes, names, and descriptions.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeTopographicCodesCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

Topographic Codes Features Retrieval

Action getTopographicCodesFeatures
Purpose Retrieves features (items) from the topographic-codes collection, providing detailed records of topographic codes and their attributes. Useful for accessing specific topographic data.
Parameters
  • Required: None
  • Optional:
    • limit: Maximum number of items to return (integer, default: 10, maximum: 1000). Example: limit=50
    • offset: Starting index for pagination (integer, default: 0). Example: offset=100
    • filter: Common Query Language (CQL) expression to filter items (string). Example: filter=topographic_code='FLAT'
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of topographic code items with attributes such as code, name, and description.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTopographicCodesFeatures action with optional parameters (e.g., filter=topographic_code='FLAT').
  • Process the response to analyze topographic code data.

Topographic Codes Feature Retrieval

Action getTopographicCodesFeature
Purpose Retrieves a specific feature by ID from the topographic-codes collection. Useful for accessing detailed information about a single topographic code.
Parameters
  • Required:
    • featureId: Unique identifier for the topographic code item (string). Example: featureId=FLAT
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns details of the specified topographic code item, including code, name, and description.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTopographicCodesFeature action with featureId=FLAT.
  • Process the response to extract details of the specific topographic code.

Topographic Codes Queryables Retrieval

Action getTopographicCodesQueryables
Purpose Retrieves queryable properties for the topographic-codes collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of queryable properties for the topographic-codes collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTopographicCodesQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

Topographic Codes Schema Retrieval

Action getTopographicCodesSchema
Purpose Retrieves the schema for the topographic-codes collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the schema for the topographic-codes collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTopographicCodesSchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

Topographic Codes Features Options

Action optionsTopographicCodesFeatures
Purpose Retrieves options for the topographic-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional: api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsTopographicCodesFeatures action.
  • Process the response to determine supported operations for the topographic-codes items endpoint.

Topographic Codes Feature Options

Action optionsTopographicCodesFeature
Purpose Retrieves options for a specific topographic-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string). Example: featureId=FLAT
  • Optional: api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsTopographicCodesFeature action with featureId=FLAT.
  • Process the response to determine supported operations for the specific feature.

Time Zone Codes Collection Metadata Retrieval

Action describeTimeZoneCodesCollection
Purpose Retrieves metadata for the time-zone-codes collection, providing details about standardized time zone codes for water data. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns metadata for the time-zone-codes collection, including codes, names, and descriptions.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeTimeZoneCodesCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

Time Zone Codes Features Retrieval

Action getTimeZoneCodesFeatures
Purpose Retrieves features (items) from the time-zone-codes collection, providing detailed records of time zone codes and their attributes. Useful for accessing specific time zone data.
Parameters
  • Required: None
  • Optional:
    • limit: Maximum number of items to return (integer, default: 10, maximum: 1000). Example: limit=50
    • offset: Starting index for pagination (integer, default: 0). Example: offset=100
    • filter: CQL expression to filter items (string). Example: filter=time_zone_code='UTC'
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of time zone code items with attributes such as code, name, and description.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTimeZoneCodesFeatures action with optional parameters (e.g., filter=time_zone_code='UTC').
  • Process the response to analyze time zone code data.

Time Zone Codes Feature Retrieval

Action getTimeZoneCodesFeature
Purpose Retrieves a specific feature by ID from the time-zone-codes collection. Useful for accessing detailed information about a single time zone code.
Parameters
  • Required:
    • featureId: Unique identifier for the time zone code item (string). Example: featureId=UTC
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns details of the specified time zone code item, including code, name, and description.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTimeZoneCodesFeature action with featureId=UTC.
  • Process the response to extract details of the specific time zone code.

Time Zone Codes Queryables Retrieval

Action getTimeZoneCodesQueryables
Purpose Retrieves queryable properties for the time-zone-codes collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of queryable properties for the time-zone-codes collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTimeZoneCodesQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

Time Zone Codes Schema Retrieval

Action getTimeZoneCodesSchema
Purpose Retrieves the schema for the time-zone-codes collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the schema for the time-zone-codes collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTimeZoneCodesSchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

Time Zone Codes Features Options

Action optionsTimeZoneCodesFeatures
Purpose Retrieves options for the time-zone-codes items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsTimeZoneCodesFeatures action.
  • Process the response to determine supported operations for the time-zone-codes items endpoint.

Time Zone Codes Feature Options

Action optionsTimeZoneCodesFeature
Purpose Retrieves options for a specific time-zone-codes item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string). Example: featureId=UTC
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsTimeZoneCodesFeature action with featureId=UTC.
  • Process the response to determine supported operations for the specific feature.

Latest Continuous Collection Metadata Retrieval

Action describeLatestContinuousCollection
Purpose Retrieves metadata for the latest-continuous collection, providing details about the latest continuous water data measurements. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns metadata for the latest-continuous collection, including measurement details and extent.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeLatestContinuousCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

Latest Continuous Features Retrieval

Action getLatestContinuousFeatures
Purpose Retrieves features (items) from the latest-continuous collection, providing detailed records of the latest continuous water data measurements. Useful for accessing specific measurement data.
Parameters
  • Required: None
  • Optional:
    • limit: Maximum number of items to return (integer, default: 10, maximum: 1000). Example: limit=50
    • offset: Starting index for pagination (integer, default: 0). Example: offset=100
    • filter: CQL expression to filter items (string). Example: filter=parameter_code='00060'
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of latest continuous measurement items with attributes such as parameter code, value, and timestamp.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getLatestContinuousFeatures action with optional parameters (e.g., filter=parameter_code='00060').
  • Process the response to analyze measurement data.

Latest Continuous Feature Retrieval

Action getLatestContinuousFeature
Purpose Retrieves a specific feature by ID from the latest-continuous collection. Useful for accessing detailed information about a single continuous measurement.
Parameters
  • Required:
    • featureId: Unique identifier for the measurement item (string). Example: featureId=123456
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns details of the specified measurement item, including parameter code, value, and timestamp.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getLatestContinuousFeature action with featureId=123456.
  • Process the response to extract details of the specific measurement.

Latest Continuous Queryables Retrieval

Action getLatestContinuousQueryables
Purpose Retrieves queryable properties for the latest-continuous collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of queryable properties for the latest-continuous collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getLatestContinuousQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

Latest Continuous Schema Retrieval

Action getLatestContinuousSchema
Purpose Retrieves the schema for the latest-continuous collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the schema for the latest-continuous collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getLatestContinuousSchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

Latest Continuous Features Options

Action optionsLatestContinuousFeatures
Purpose Retrieves options for the latest-continuous items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsLatestContinuousFeatures action.
  • Process the response to determine supported operations for the latest-continuous items endpoint.

Latest Continuous Feature Options

Action optionsLatestContinuousFeature
Purpose Retrieves options for a specific latest-continuous item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string). Example: featureId=123456
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsLatestContinuousFeature action with featureId=123456.
  • Process the response to determine supported operations for the specific feature.

Daily Collection Metadata Retrieval

Action describeDailyCollection
Purpose Retrieves metadata for the daily collection, providing details about daily water data measurements. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns metadata for the daily collection, including measurement details and extent.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeDailyCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

Daily Features Retrieval

Action getDailyFeatures
Purpose Retrieves features (items) from the daily collection, providing detailed records of daily water data measurements. Useful for accessing specific daily measurement data.
Parameters
  • Required: None
  • Optional:
    • limit: Maximum number of items to return (integer, default: 10, maximum: 1000). Example: limit=50
    • offset: Starting index for pagination (integer, default: 0). Example: offset=100
    • filter: CQL expression to filter items (string). Example: filter=parameter_code='00060'
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of daily measurement items with attributes such as parameter code, value, and date.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getDailyFeatures action with optional parameters (e.g., filter=parameter_code='00060').
  • Process the response to analyze daily measurement data.

Daily Feature Retrieval

Action getDailyFeature
Purpose Retrieves a specific feature by ID from the daily collection. Useful for accessing detailed information about a single daily measurement.
Parameters
  • Required:
    • featureId: Unique identifier for the daily measurement item (string). Example: featureId=123456
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns details of the specified daily measurement item, including parameter code, value, and date.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getDailyFeature action with featureId=123456.
  • Process the response to extract details of the specific daily measurement.

Daily Schema Retrieval

Action getDailySchema
Purpose Retrieves the schema for the daily collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the schema for the daily collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getDailySchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

Daily Features Options

Action optionsDailyFeatures
Purpose Retrieves options for the daily items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsDailyFeatures action.
  • Process the response to determine supported operations for the daily items endpoint.

Daily Feature Options

Action optionsDailyFeature
Purpose Retrieves options for a specific daily item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string). Example: featureId=123456
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsDailyFeature action with featureId=123456.
  • Process the response to determine supported operations for the specific feature.

Latest Daily Collection Metadata Retrieval

Action describeLatestDailyCollection
Purpose Retrieves metadata for the latest-daily collection, providing details about the most recent daily water data measurements. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns metadata for the latest-daily collection, including measurement details and extent.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeLatestDailyCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

Latest Daily Features Retrieval

Action getLatestDailyFeatures
Purpose Retrieves features (items) from the latest-daily collection, providing detailed records of the most recent daily water data measurements. Useful for accessing specific daily measurement data.
Parameters
  • Required: None
  • Optional:
    • limit: Maximum number of items to return (integer, default: 10, maximum: 1000). Example: limit=50
    • offset: Starting index for pagination (integer, default: 0). Example: offset=100
    • filter: Common Query Language (CQL) expression to filter items (string). Example: filter=parameter_code='00060'
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of latest daily measurement items with attributes such as parameter code, value, and date.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getLatestDailyFeatures action with optional parameters (e.g., filter=parameter_code='00060').
  • Process the response to analyze daily measurement data.

Latest Daily Feature Retrieval

Action getLatestDailyFeature
Purpose Retrieves a specific feature by ID from the latest-daily collection. Useful for accessing detailed information about a single daily measurement.
Parameters
  • Required:
    • featureId: Unique identifier for the daily measurement item (string). Example: featureId=123456
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns details of the specified daily measurement item, including parameter code, value, and date.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getLatestDailyFeature action with featureId=123456.
  • Process the response to extract details of the specific daily measurement.

Latest Daily Queryables Retrieval

Action getLatestDailyQueryables
Purpose Retrieves queryable properties for the latest-daily collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of queryable properties for the latest-daily collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getLatestDailyQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

Latest Daily Schema Retrieval

Action getLatestDailySchema
Purpose Retrieves the schema for the latest-daily collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the schema for the latest-daily collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getLatestDailySchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

Latest Daily Features Options

Action optionsLatestDailyFeatures
Purpose Retrieves options for the latest-daily items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsLatestDailyFeatures action.
  • Process the response to determine supported operations for the latest-daily items endpoint.

Latest Daily Feature Options

Action optionsLatestDailyFeature
Purpose Retrieves options for a specific latest-daily item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string). Example: featureId=123456
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsLatestDailyFeature action with featureId=123456.
  • Process the response to determine supported operations for the specific feature.

Field Measurements Collection Metadata Retrieval

Action describeFieldMeasurementsCollection
Purpose Retrieves metadata for the field-measurements collection, providing details about field-collected water data measurements. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns metadata for the field-measurements collection, including measurement details and extent.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeFieldMeasurementsCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

Field Measurements Features Retrieval

Action getFieldMeasurementsFeatures
Purpose Retrieves features (items) from the field-measurements collection, providing detailed records of field-collected water data measurements. Useful for accessing specific measurement data.
Parameters
  • Required: None
  • Optional:
    • limit: Maximum number of items to return (integer, default: 10, maximum: 1000). Example: limit=50
    • offset: Starting index for pagination (integer, default: 0). Example: offset=100
    • filter: Common Query Language (CQL) expression to filter items (string). Example: filter=parameter_code='00060'
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of field measurement items with attributes such as parameter code, value, and timestamp.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getFieldMeasurementsFeatures action with optional parameters (e.g., filter=parameter_code='00060').
  • Process the response to analyze field measurement data.

Field Measurements Feature Retrieval

Action getFieldMeasurementsFeature
Purpose Retrieves a specific feature by ID from the field-measurements collection. Useful for accessing detailed information about a single field measurement.
Parameters
  • Required:
    • featureId: Unique identifier for the field measurement item (string). Example: featureId=123456
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns details of the specified field measurement item, including parameter code, value, and timestamp.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getFieldMeasurementsFeature action with featureId=123456.
  • Process the response to extract details of the specific field measurement.

Field Measurements Queryables Retrieval

Action getFieldMeasurementsQueryables
Purpose Retrieves queryable properties for the field-measurements collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of queryable properties for the field-measurements collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getFieldMeasurementsQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

Field Measurements Schema Retrieval

Action getFieldMeasurementsSchema
Purpose Retrieves the schema for the field-measurements collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the schema for the field-measurements collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getFieldMeasurementsSchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

Field Measurements Features Options

Action optionsFieldMeasurementsFeatures
Purpose Retrieves options for the field-measurements items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional: api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsFieldMeasurementsFeatures action.
  • Process the response to determine supported operations for the field-measurements items endpoint.

Field Measurements Feature Options

Action optionsFieldMeasurementsFeature
Purpose Retrieves options for a specific field-measurements item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string). Example: featureId=123456
  • Optional: api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsFieldMeasurementsFeature action with featureId=123456.
  • Process the response to determine supported operations for the specific feature.

Time Series Metadata Collection Metadata Retrieval

Action describeTimeSeriesMetadataCollection
Purpose Retrieves metadata for the time-series-metadata collection, providing details about time series data for water measurements. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns metadata for the time-series-metadata collection, including time series details and extent.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeTimeSeriesMetadataCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

Time Series Metadata Features Retrieval

Action getTimeSeriesMetadataFeatures
Purpose Retrieves features (items) from the time-series-metadata collection, providing detailed records of time series metadata for water measurements. Useful for accessing specific time series data.
Parameters
  • Required: None
  • Optional:
    • limit: Maximum number of items to return (integer, default: 10, maximum: 1000). Example: limit=50
    • offset: Starting index for pagination (integer, default: 0). Example: offset=100
    • filter: CQL expression to filter items (string). Example: filter=parameter_code='00060'
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of time series metadata items with attributes such as parameter code, time range, and metadata details.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTimeSeriesMetadataFeatures action with optional parameters (e.g., filter=parameter_code='00060').
  • Process the response to analyze time series metadata.

Time Series Metadata Feature Retrieval

Action getTimeSeriesMetadataFeature
Purpose Retrieves a specific feature by ID from the time-series-metadata collection. Useful for accessing detailed information about a single time series metadata item.
Parameters
  • Required:
    • featureId: Unique identifier for the time series metadata item (string). Example: featureId=123456
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns details of the specified time series metadata item, including parameter code, time range, and metadata details.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTimeSeriesMetadataFeature action with featureId=123456.
  • Process the response to extract details of the specific time series metadata item.

Time Series Metadata Queryables Retrieval

Action getTimeSeriesMetadataQueryables
Purpose Retrieves queryable properties for the time-series-metadata collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of queryable properties for the time-series-metadata collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTimeSeriesMetadataQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

Time Series Metadata Schema Retrieval

Action getTimeSeriesMetadataSchema
Purpose Retrieves the schema for the time-series-metadata collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the schema for the time-series-metadata collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getTimeSeriesMetadataSchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

Time Series Metadata Features Options

Action optionsTimeSeriesMetadataFeatures
Purpose Retrieves options for the time-series-metadata items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsTimeSeriesMetadataFeatures action.
  • Process the response to determine supported operations for the time-series-metadata items endpoint.

Time Series Metadata Feature Options

Action optionsTimeSeriesMetadataFeature
Purpose Retrieves options for a specific time-series-metadata item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string). Example: featureId=123456
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsTimeSeriesMetadataFeature action with featureId=123456.
  • Process the response to determine supported operations for the specific feature.

Monitoring Locations Collection Metadata Retrieval

Action describeMonitoringLocationsCollection
Purpose Retrieves metadata for the monitoring-locations collection, providing details about water data monitoring sites. Useful for understanding the dataset structure.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns metadata for the monitoring-locations collection, including site details and extent.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the describeMonitoringLocationsCollection action with optional parameters (e.g., format=json).
  • Process the response to extract metadata for further use.

Monitoring Locations Features Retrieval

Action getMonitoringLocationsFeatures
Purpose Retrieves features (items) from the monitoring-locations collection, providing detailed records of water data monitoring sites. Useful for accessing specific site data.
Parameters
  • Required: None
  • Optional:
    • limit: Maximum number of items to return (integer, default: 10, maximum: 1000). Example: limit=50
    • offset: Starting index for pagination (integer, default: 0). Example: offset=100
    • filter: Common Query Language (CQL) expression to filter items (string). Example: filter=site_type_code='ST'
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of monitoring location items with attributes such as site code, location, and type.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid filter expression).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getMonitoringLocationsFeatures action with optional parameters (e.g., filter=site_type_code='ST').
  • Process the response to analyze monitoring location data.

Monitoring Locations Feature Retrieval

Action getMonitoringLocationsFeature
Purpose Retrieves a specific feature by ID from the monitoring-locations collection. Useful for accessing detailed information about a single monitoring site.
Parameters
  • Required:
    • featureId: Unique identifier for the monitoring location item (string). Example: featureId=123456
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns details of the specified monitoring location item, including site code, location, and type.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getMonitoringLocationsFeature action with featureId=123456.
  • Process the response to extract details of the specific monitoring location.

Monitoring Locations Queryables Retrieval

Action getMonitoringLocationsQueryables
Purpose Retrieves queryable properties for the monitoring-locations collection. Useful for identifying attributes that can be used in filters for querying the collection.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of queryable properties for the monitoring-locations collection.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getMonitoringLocationsQueryables action with optional parameters (e.g., format=json).
  • Process the response to identify queryable properties for filtering.

Monitoring Locations Schema Retrieval

Action getMonitoringLocationsSchema
Purpose Retrieves the schema for the monitoring-locations collection, defining the structure and attributes of the dataset. Useful for understanding the data model.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the schema for the monitoring-locations collection, detailing attributes and their types.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getMonitoringLocationsSchema action with optional parameters (e.g., format=json).
  • Process the response to understand the data structure for further queries.

Monitoring Locations Features Options

Action optionsMonitoringLocationsFeatures
Purpose Retrieves options for the monitoring-locations items endpoint, providing supported HTTP methods and parameters. Useful for understanding available operations.
Parameters
  • Required: None
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 500, detail: Server error).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsMonitoringLocationsFeatures action.
  • Process the response to determine supported operations for the monitoring-locations items endpoint.

Monitoring Locations Feature Options

Action optionsMonitoringLocationsFeature
Purpose Retrieves options for a specific monitoring-locations item by ID, providing supported HTTP methods and parameters. Useful for understanding available operations for a specific feature.
Parameters
  • Required:
    • featureId: Unique feature identifier (string). Example: featureId=123456
  • Optional:
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns an options response with supported methods and parameters.
  • Failure: Returns error details (e.g., status: 404, detail: Resource not found).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the optionsMonitoringLocationsFeature action with featureId=123456.
  • Process the response to determine supported operations for the specific feature.

Conformance Declaration Retrieval

Action getConformance
Purpose Retrieves the conformance declaration for the OGC API, listing the OGC standards and profiles supported by the service. Useful for verifying API compliance.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), xml). Example: format=json
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns a list of conformance classes and standards supported by the API.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getConformance action with optional parameters (e.g., format=json).
  • Process the response to verify the API’s compliance with OGC standards.

OpenAPI Definition Retrieval

Action getOpenapi
Purpose Retrieves the OpenAPI definition for the USGS Water Data OGC Connector, providing a complete specification of the API’s endpoints and operations. Useful for developers integrating with the API.
Parameters
  • Required: None
  • Optional:
    • format: Response format (string, values: json (default), yaml). Example: format=yaml
    • api_key: API key for higher rate limits (string, obtained from https://api.waterdata.usgs.gov/signup)
Configuration Ensure the connector is configured with the base URL and optional API key via CONNECTOR_ENV_USGSWATERDATAOGC_BASE_URL and CONNECTOR_ENV_USGSWATERDATAOGC_API_KEY environment variables.
Output
  • Successful: Returns the OpenAPI specification document detailing all endpoints, parameters, and responses.
  • Failure: Returns error details (e.g., status: 400, detail: Invalid parameter value).
Workflow Example
  • Configure the connector with the base URL and API key.
  • Execute the getOpenapi action with optional parameters (e.g., format=yaml).
  • Process the response to integrate with the API using the provided specification.

Pricing

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

iSolution logo - white - transparent 250 px

iSolution logo - white - transparent 250 px

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

  • Home
  • About us
  • Blog
  • Careers
  • Success Stories
  • News
  • Articles
  • Contact Us
  • Terms and conditions
  • Privacy Policy
© Copyright 2024 iSolution | All Rights Reserved
  • Home
  • About us
  • Technologies
    • Cloud Services
      • Google Cloud Platform
        • Networking
        • Compute
        • Storage
        • SAP on GCP
        • Google Maps
        • Data Center Modernization
    • Infrastructure
      • iSolution Services
      • Unified Communication
      • Network Security
      • Access Security & Control
      • Computing Platforms
      • Structured Cabling Infrastructure
      • Datacenter Infrastructure
      • Networking Infrastructure
      • Retail Analytics
      • Cloud Infrastructure
    • Integration
      • Apigee
      • IBM
      • Custom Connectors
      • UnifAI
    • Security
      • Security Consulting Services
      • Security Solutions
    • Data & AI
      • BigQuery, Looker
      • Gemini
    • Collaboration Tools
      • Google Workspace For Enterprise
    • ERP-CRM
      • Odoo
      • Salesforce
      • SAP on GCP
    • DevOps
      • GCP
      • SonarSource
    • Managed Service Provider
      • Managed Service Provider
    • App Development
      • App Development
    • Open Banking
      • Open banking
    • Chrome Devices
  • Unplugged Podcast
  • Blog
    • Success Stories
    • News
    • Articles
  • Careers
  • Contact Us
Ismena website

Register To Palo Alto & iSolution Event

Register to IBM x iSolution Event

Register to Gemini in Action Workshop

[forminator_form id=”14485″]

Registration To Amman Unplugged Event

[forminator_form id=”14419″]

Register to Gemini in Action Workshop

[forminator_form id=”14298″]

Tech and Culture Riyadh

[forminator_form id=”13094″]