Find Items | ArcGIS REST APIs

URL:: https://<root>/data/findItems
Methods:: POST
Version Introduced:: 10.9

Access requirements

Required privileges

The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Publisher role Update

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

Description

The findItems operation searches the various data items registered to the data store and returns a list of items found at a specified location. The list of items is dynamic, as the results can be fine-tuned to return items with a certain item type or item ID. At least one of the parameters below must be defined for this operation to run successfully.

Request parameters

Parameter	Details
`parentPath` (Optional)	The main path used to find items.
`ancestorPath` (Optional)	The related path used to find items.
`types` (Optional)	A filter to search by the types of items.
`id` (Optional)	A filter to search by the ID of an item.
`isManaged` (Optional)	Specifies whether the data store is system managed (`true`). Values: `true` \| `false`
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample POST request for the findItems operation:

Use dark colors for code blocksCopy
POST /<context>/admin/datas/findItems HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

parentPath=&ancestorPath=&types=egdb&id=&isManaged=true&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8Cis

The following is a sample GET request for the findItems operation:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/data/findItems?types=egdb&f=pjson

JSON Response example

Use dark colors for code blocksCopy
{
  "items": [
    {
      "id": "ed243751-49ff-48c6-9c38-21880621a4a0",
      "name": "relds-ayvvq",
      "description": "Managed relation data store for site gis",
      "provider": "ArcGIS Data Store",
      "type": "egdb",
      "systemManaged": true,
      "purposes": [
        "configure",
        "feature"
      ],
      "revision": "3",
      "path": "/enterpriseDatabases/ed243751-49ff-48c6-9c38-21880621a4a0",
      "encryptAttributes": [
        "info.JDBCConnection.username",
        "info.JDBCConnection.password"
      ],
      "info": {
        "provider": "ArcGIS Data Store",
        "isManaged": true,
        "systemManaged": true,
        "isManagedData": true,
        "category": "database",
        "implementation": "PostgreSQL",
        "factory": "egdb",
        "purposes": [
          "configure",
          "feature"
        ],
        "dsFeature": "relational",
        "dbType": "managedPostgres",
        "dataStoreConnectionType": "serverOnly",
        "JDBCConnection": {...},
        "machines": [
          {
            "name": "machine-primary",
            "dbPort": 7654,
            "platform": "Linux",
            "role": "PRIMARY"
          },
          {
            "name": "machine-standby",
            "dbPort": 7654,
            "platform": "Linux",
            "role": "STANDBY"
          }
        ],
        "connectionString": "ENCRYPTED_PASSWORD=00022e6859334a323438527770496d4752776153354e77716258443238596e6c5062304571337141734859543957453d2a00;SERVER=gis-rdbms-v1o45-primary,gis-rdbms-v1o45-standby;INSTANCE=sde:postgresql:gis-rdbms-v1o45-primary,7654;DBCLIENT=postgresql;DB_CONNECTION_PROPERTIES=gis-rdbms-v1o45-primary,7654;DATABASE=hgdb_ayvvq;USER=mu_qlkbp;VERSION=sde.DEFAULT;AUTHENTICATION_MODE=DBMS",
        "connectionStringHA": "ENCRYPTED_PASSWORD=00022e683279464246757a6b6d48722f34625a385456655457464e795147644d376c6b566c79516963414f577359413d2a00;SERVER=relds-ayvvq;INSTANCE=\"sde:postgresql:DSID=relds-ayvvq\";DBCLIENT=postgresql;DATABASE=hgdb_ayvvq;USER=mu_qlkbp;VERSION=sde.DEFAULT;AUTHENTICATION_MODE=DBMS"
      },
      "encryptedAttributes": [],
      "meta": {
        "created": 1598306821,
        "modified": 1598307592
      }
    }
  ]
}