@arcgis/core/rest/networks/queryAssociations.d.ts

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

/**
 * The utility network associations model connectivity, containment, and structure relations between assets.
 * This function queries the associations table and return associations for network features in a utility network.
 *
 * @since 4.24
 * @see [Utility Network Associations](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/associations.htm)
 */
import type QueryAssociationsParameters from "./support/QueryAssociationsParameters.js";
import type QueryAssociationsResult from "./support/QueryAssociationsResult.js";
import type { RequestOptions } from "../../request/types.js";

/**
 * Returns all associations filtered by the [QueryAssociationsParameters](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/QueryAssociationsParameters/) in a utility network.
 *
 * @param url - URL to the ArcGIS Server REST resource that represents a UttilityNetwork.
 * @param parameters - The parameters required by this functions include [QueryAssociationsParameters.elements](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/QueryAssociationsParameters/#elements), what [QueryAssociationsParameters.types](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/QueryAssociationsParameters/#types) of associations to return, [QueryAssociationsParameters.moment](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/QueryAssociationsParameters/#moment) and more.
 * @param requestOptions - Additional [options](https://developers.arcgis.com/javascript/latest/references/core/request/#request) to be used for the data request.
 * @returns When resolved, the [associations](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/Association/) results are returned.
 */
export function queryAssociations(url: string, parameters: QueryAssociationsParameters, requestOptions?: RequestOptions): Promise<QueryAssociationsResult>;