List Datastore Content | ArcGIS REST APIs

URL:: https://<rasteranalysistools-url>/ListDatastoreContent
Methods:: GET
Version Introduced:: 10.4

Description

The ListDatastoreContent operation can be used to return a list of all ArcGIS supported imagery data from a registered ArcGIS Server data store.

Request parameters

Parameter Details

Parameter	Details
`dataStoreName` (Required)	The name of a registered data store item. Only folder, cloud store, and raster store data item types are supported. Example: Use dark colors for code blocksCopy 1 2 3 `/cloudStores/s3datastore` `/fileShares/sharedfolder` `/rasterStores/rasters3store`
`filter` (Optional)	This is the regular expression filter to narrow your search. Example: Use dark colors for code blocksCopy `1 *.tif`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

dataStoreName

(Required)

The name of a registered data store item. Only folder, cloud store, and raster store data item types are supported.

Example:

Use dark colors for code blocksCopy
`/cloudStores/s3datastore`
`/fileShares/sharedfolder`
`/rasterStores/rasters3store`

filter

(Optional)

This is the regular expression filter to narrow your search.

Example:

Use dark colors for code blocksCopy
*.tif

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL for the ListDatastoreContent operation:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/System/RasterAnalysisTools/GPServer/ListDatastoreContent/submitJob?dataStoreName=/cloudStores/s3datastore&f=pjson

Response

When you submit a request, the task assigns a unique job ID for the transaction.

Syntax:

Use dark colors for code blocksCopy
{ "jobId": "<unique job identifier>", "jobStatus": "<job status>" }

After the initial request is submitted, you can use the jobId to periodically check the status of the job and messages, as described in Check job status. Once the job has successfully completed, use the jobId to retrieve the results. To track the status, you can make a request of the following form:

Use dark colors for code blocksCopy
https://<raster analysis tools url>/ListDatastoreContent/jobs/<jobId>

When the status of the job request is esriJobSucceeded , you can access the results of the analysis by making a request of the following form:

Use dark colors for code blocksCopy
https://<raster analysis tools url>/ListDatastoreContent/jobs/<jobId>/results/contentList

JSON Response example

The response returns the contentList output parameter, which has properties for parameter name, data type, and value. The content of the value is the list of the datastore contents.

Use dark colors for code blocksCopy
{
    "paramName": "contentList",
    "dataType": "GPString",
    "value": {
        "contentList": "[\"/cloudStores/s3cloudstore/AWSLogs/\",
        \"/cloudStores/s3cloudstore/Hosted_Vineyard_201803231100235/\",
        \"/cloudStores/s3cloudstore/Hosted_om201804042213474ortho/\",
        \"/cloudStores/s3cloudstore/data/\",
        \"/cloudStores/s3cloudstore/hillshadedem_1.crf/\",
        \"/cloudStores/s3cloudstore/hillshadedem_10.crf/\",
        \"/cloudStores/s3cloudstore/hillshadedem_11.crf/\",
        \"/cloudStores/s3cloudstore/hillshadedem_12.crf/\"]"
    }
}