Find Items

URL:: https://<root>/data/findItems
Methods:: GET
Version Introduced:: 10.1

Access requirements

Required privileges

The Sever 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.

Register data stores Feature layer Update Delete Security and infrastructure Servers Organization webhooks Geoprocessing Publisher role

Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server 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 Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.

Learn how to generate a token

Description

The findItems operation searches through the various data items registered in the server's data store and returns a list of items found at a specified location. This list of items is dynamic, as the results can be find 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`	The path of the parent under which to find items. Example Use dark colors for code blocksCopy `1 parentPath=/arcgisdata`
`ancestorPath`	The path of the ancestor under which to find items.
`types`	A filter for the type of the items. Example Use dark colors for code blocksCopy `1 types=egdb`
`id`	A filter to search by the ID of the item. Example Use dark colors for code blocksCopy `1 id=f4d7549a-c603-4a2b-a2e6-9727bbc7e9c4`
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

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?parentPath=/enterpriseDatabases&ancestorPath=&types=egdb&id=&managed=f&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "items":[ item1, item2, ...]
}

JSON Response example

Use dark colors for code blocksCopy
{"items": [
  {
    "path": "/enterpriseDatabases/database1",
    "type": "egdb",
    "id": "f4d7549a-c603-4a2b-a2e6-9727bbc7e9c4",
    "totalRefCount": 0,
    "info": {
      "dataStoreConnectionType": "shared",
      "isManaged": false,
      "connectionString": "ENCRYPTED_PASSWORD=00022e684444467965724a4c52664858344d686a5545427734513d3d2a00;SERVER=server;INSTANCE=sde:oracle$server/ant11gr2;DBCLIENT=oracle;DB_CONNECTION_PROPERTIES=server/ant11gr2;USER=gdb;VERSION=SDE.DEFAULT;AUTHENTICATION_MODE=DBMS"
    }
  },
  {
    "path": "/enterpriseDatabases/database2",
    "type": "egdb",
    "id": "97311325-8c27-4c4b-aa06-884968e82562",
    "totalRefCount": 0,
    "info": {
      "dataStoreConnectionType": "shared",
      "isManaged": false,
      "connectionString": "ENCRYPTED_PASSWORD=00022e6876422b4e5767734369325534667a394d4165356962513d3d2a00;SERVER=server;INSTANCE=sde:oracle$server/qs22;DBCLIENT=oracle;DB_CONNECTION_PROPERTIES=server/qs22;USER=Elec;AUTHENTICATION_MODE=DBMS;BRANCH=SDE.DEFAULT"
    }
  },
  {
    "path": "/enterpriseDatabases/database3",
    "type": "egdb",
    "id": "8b315733-8067-4e68-a7c7-139db81c817f",
    "totalRefCount": 0,
    "info": {
      "dataStoreConnectionType": "shared",
      "isManaged": false,
      "connectionString": "ENCRYPTED_PASSWORD=00022e68496241443741654872307249696e37493143702b65773d3d2a00;SERVER=server;INSTANCE=sde:postgresql:server;DBCLIENT=postgresql;DB_CONNECTION_PROPERTIES=server;DATABASE=qs22;USER=elec;AUTHENTICATION_MODE=DBMS;BRANCH=sde.DEFAULT"
    }
  },
  {
    "path": "/enterpriseDatabases/database4",
    "type": "egdb",
    "id": "e6ced063-63c8-494f-bd8e-cc6fd7fa239d",
    "totalRefCount": 0,
    "info": {
      "dataStoreConnectionType": "shared",
      "isManaged": false,
      "connectionString": "ENCRYPTED_PASSWORD=00022e6873326e307a4d39494e38476474717a4358514b4762773d3d2a00;SERVER=server;INSTANCE=sde:sqlserver:server;DBCLIENT=sqlserver;DB_CONNECTION_PROPERTIES=server;DATABASE=qs22;USER=elec;AUTHENTICATION_MODE=DBMS;BRANCH=sde.DEFAULT"
    }
  },
  {
    "path": "/enterpriseDatabases/database5",
    "type": "egdb",
    "id": "fd692166-4fec-46bc-81e5-73ae07a7e583",
    "totalRefCount": 0,
    "info": {
      "dataStoreConnectionType": "shared",
      "isManaged": false,
      "connectionString": "ENCRYPTED_PASSWORD=00022e68576f39342f716d424e682f3566446a5453446d6e69773d3d2a00;SERVER=RagsSQL2014;INSTANCE=sde:postgresql:RagsSQL2014;DBCLIENT=postgresql;DB_CONNECTION_PROPERTIES=RagsSQL2014;DATABASE=RPubRH75051;USER=gdb;VERSION=sde.DEFAULT;AUTHENTICATION_MODE=DBMS"
    }
  },
  {
    "path": "/enterpriseDatabases/database6",
    "type": "egdb",
    "id": "b9928bc5-f5b5-4f2c-bfee-62359b5b5de4",
    "totalRefCount": 0,
    "info": {
      "dataStoreConnectionType": "shared",
      "isManaged": false,
      "connectionString": "ENCRYPTED_PASSWORD=00022e682f654456732f724c4a6b6f76573755765855716e53413d3d2a00;SERVER=server;INSTANCE=sde:oracle$server4/gdb1;DBCLIENT=oracle;DB_CONNECTION_PROPERTIES=server/gdb1;USER=map;VERSION=SDE.DEFAULT;AUTHENTICATION_MODE=DBMS"
    }
  }
]}