Find Items | ArcGIS REST APIs

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

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

Parameter	Details
`managed` (Optional)	The managed property can be utilized to specifically find either managed or unmanaged data items. Values: `true` \| `false`
`types` (Required)	A filter for the type of the items. Example Use dark colors for code blocksCopy `1 types=folder`
`id` (Optional)	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` (Required)	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`
`token` (Required)	Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

managed

(Optional)

The managed property can be utilized to specifically find either managed or unmanaged data items.

Values: true | false

types

(Required)

A filter for the type of the items.

Example
Use dark colors for code blocksCopy
types=folder

id

(Optional)

A filter to search by the ID of the item.

Example
Use dark colors for code blocksCopy
id=f4d7549a-c603-4a2b-a2e6-9727bbc7e9c4

f

(Required)

The response format. The default response format is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

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?types=objectStore&ID=<optional_id>&managed=true&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": "/fileShares/VideoDataStore_folder_sample",
        "name": "Video Server Config Store",
        "id": "a41517b0-4c6c-495d-aa94-127ee76de0f2",
        "type": "folder",
        "info": {"path": "C:\\arcgisvideoserver\\directories\\arcgisvideoservices"}
    },
    {
        "path": "/fileShares/videoSharing_ds_sample",
        "name": "sample",
        "id": "cbf6f88546b14b0388242a3a8fb57a3f",
        "type": "folder",
        "info": {
            "dataStoreConnectionType": "shared",
            "hostName": null,
            "path": "\\\\HOSTNAME\\sample",
            "portalProperties": {"itemID": "cbf6f88546b14b0388242a3a8fb57a3f"},
            "isManaged": false
        }
    }
]}