ArcGIS REST JS
ArcGIS REST API JavaScript Client

getAvailableDataCollections

Function 
import { getAvailableDataCollections } from '@esri/arcgis-rest-demographics';
//
getAvailableDataCollections()
  .then((response) => {
    response; // => { DataCollections: [ ... ]  }
  });
//
getAvailableDataCollections({
  countryCode: "se",
  dataCollection: "EducationalAttainment"
})
  .then((response) => {
    response.; // => { DataCollections: [ ... ] }
  });

Used to determine the data collections available for usage with the Geoenrichment service. See the REST Documentation for more information.

Parameters

Parameter Type Default Notes
requestOptions Optional IGetAvailableDataCollectionsOptions

Options to pass through to the geoenrichment service.

Available requestOptions

Property Type Notes
addDerivativeVariables Optional string[] | string

Optional parameter to specify an array of string values that describe what derivative variables to include in the output.
countryCode Optional string

View a description for a single data collection within a given country. If not specified, will return a list of data collections that can be run in any country.
dataCollection Optional string
suppressNullValues Optional boolean

Optional parameter to return only values that are not NULL in the output response.
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.
credentials Optional Inherited RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
endpoint Optional Inherited string

Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )
fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.
headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.
hideToken Optional Inherited boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.
httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.
maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
params Optional Inherited IParams

Additional parameters to pass in the request.
portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.
rawResponse Optional Inherited boolean

Return the raw response

Returns

A Promise that will resolve with data collections for the request.

Promise<IGetAvailableDataCollectionsResponse>
Property Type Notes
DataCollections Optional IDataCollection[] | IDataCollection | null
Function defined in packages/arcgis-rest-demographics/src/getAvailableDataCollections.ts:124