- URL:
- https://<root>/stores/<storeId>/describe
- Methods:
POST- Version Introduced:
- 12.0
Description
The describe operation queries a user-managed data store, outputting information regarding its status and any usable files contained within.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The user-managed data store ID. |
(Optional) | The data store path to search. The default path is |
(Optional) | The filter applied to the request to limit the results to match the provided pattern. This parameter accepts a user-input string value. This is used for targeting files or folders with specific names; the strings must match completely, aside from capitalization, in order for the filter to work successfully. If filtering for a specific file, the file extension must be included. Example |
(Optional) | The start index for listing the describe results. The default value is 0. |
(Optional) | The number of results to list per page. The default value is 100. |
(Required) | The output format for this operation. The default value is Values: |
(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 POST request for the describe operation. Prior to performing this operation, administrators can send a GET requests to the Stores resource to retrieve the data store ID for the user-managed data store.
POST /arcgis/rest/stores/01/describe HTTP/1.1
Host: organization.example.com:21443
Content-Type: application/x-www-form-urlencoded
Content-Length: [ ]
path=%2F&filter=SampleFilter&start=0&num=100&f=pjsonJSON Response syntax
{
"total": integer,
"children": [{
"path": "/video.ts",
"name": "video.ts",
"type": "file"
}],
"num": integer,
"start": integer,
"nextStart": integer
}JSON Response example
{
"total": 1,
"children": [{
"path": "/video.ts",
"name": "video.ts",
"type": "file"
}],
"num": 100,
"start": 0,
"nextStart": -1
}