- URL:
- https://<root>/data
- Methods:
GET- Operations:
- Federate Data Item, Find Items, Register Item, Unregister Item, Validate All Data Items, Validate Data Items
- Child Resources:
- Items, Datastore Configuration, Relational Data store Types
- 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.
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 generate 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.
Description
The data resource provides information about the data holdings of the server. Data items are used by ArcGIS Pro and other clients to validate data paths referenced by GIS services.
A relational data store type represents a database platform that has been registered for use on a portal’s hosting server by the ArcGIS Server administrator. Each relational data store type describes the properties ArcGIS Server requires in order to connect to an instance of a database for a particular platform. At least one registered relational data store type is required before client applications such as ArcGIS Insights can create Relational Database Connection portal items.
You can register new data items with the server by using the Register Data Item operation, search through the hierarchy of data items using the Find Data Items operation, and view all references to a specific data item using the Compute Ref Count operation. The compute operation helps you determine if a particular data item can be safely deleted or refreshed.
Request parameters
| Parameter | Description |
|---|---|
| The response format. The only supported response format is |
Example usage
The following is a sample request URL used to access the data resource:
https://organization.example.com/<context>/admin/data?f=html