Query a feature layer (SQL)

In this tutorial, you access and query a hosted feature layer.

Query a feature layer using API key authentication

A feature layer can contain a large number of features. To access a subset of the features, you can execute a SQL or spatial query, or both at the same time. You can also return the attributes, geometry, or both attributes and geometry for each record. SQL and spatial queries are useful when a feature layer is very large and you just want to access a subset of the data.

Prerequisites

Steps

Create a private feature layer

For this tutorial, you will use the Santa Monica Parcels dataset to create a private hosted feature layer in your portal.

  1. In your web browser, go to the Santa Monica Parcels item.

  2. Click the Download button to download the zip file locally. Do not unzip this file.

  3. Import the shapefile into ArcGIS.

    1. In your web browser, go to ArcGIS.com and sign in with your ArcGIS Location Platform account.

    2. In the top navigation bar, click Content.

    3. Click New item. To upload the Santa Monica Parcels shapefile, you can either:

      • Drag and drop the file.
      • Or, click Your device and navigate to the file path.
    4. Select Add Santa Monica Parcels.zip to publish the file as a hosted feature layer.

    5. In Fields, leave all fields at their default settings and click Next.

    6. In Location settings, leave the default settings and click Next.

    7. Set the following information in the item details pane:

      • Title: Santa Monica Parcels
      • Tags: Santa Monica Parcels.
      • Summary: Parcels in the Santa Monica Mountains.
    8. Click Next to create the new feature layer and feature service.

    9. In the feature service item page, make sure the Share setting is set to Owner.

    10. Scroll down to the URL section and copy the URL into a safe location. You will use this in a later step. The URL will look something like: https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Santa_Monica_Parcels/FeatureServer.

Get the starter app

Select a type of authentication below and follow the steps to create a new application.

  1. If you are using the CDN libraries, to get started.

Set up authentication

Create developer credentials in your portal for the type of authentication you selected.

Create a new API key credential with the correct privileges to access the resources used in this tutorial.

  1. Go to the Create an API key tutorial and create an API key with the following privilege(s):
    • Privileges:
    • Item access
      • Note: If you are using your own custom data layer for this tutorial, you need to grant the API key credentials access to the layer item. Learn more in Item access privileges.
  2. Copy the API key access token to your clipboard when prompted.

Set developer credentials

Use the API key or OAuth developer credentials so your application can access location services.

  1. Update the accessToken variable to use your API key.

    Use dark colors for code blocks
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
        const accessToken = "YOUR_ACCESS_TOKEN";
    

Make the request

Copy and paste the code below, following the steps to make a request to the feature service.

  1. Reference the arcgis-rest-request and arcgis-rest-feature-service libraries either through CDN, ES Modules, or Node JS.

  2. Paste the feature layer URL you copied earlier to the featureLayerUrl variable and append /0 at the end of the URL.

  3. Define the parameters needed for the request.

  4. Call the feature service and handle the results.

Expand
Use dark colors for code blocks
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
  <script>
    /* when including ArcGIS REST JS all exports are available
  from the same arcgisRest global */
    /* Use for API key authentication */

    const accessToken = "YOUR_ACCESS_TOKEN";
    const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);

    // or

    /* Use for user authentication */
    // const authentication = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
    //   clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
    //   redirectUri: "YOUR_REDIRECT_URL", // The redirect URL registered in your OAuth credentials
    //   portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    // })

    // Replace the following with your own layer URL
    const featureLayerUrl = "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Santa_Monica_public_parcels/FeatureServer/0" // Your feature layer URL goes here

    arcgisRest
      .queryFeatures({
        url: featureLayerUrl,
        where: "usetype = 'Commercial'",
        resultRecordCount: 1,
        authentication
      })
      .then((response) => {
        console.log(response.features);
        document.getElementById("result").textContent = JSON.stringify(response.features, null, 2);
      });

  </script>
Expand

Run the app

Run the app.

The result should look similar to this.

What's next?

Learn how to use additional ArcGIS location services in these tutorials:

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.