- URL:
- https://<root>/data/federateDataItem
- Methods:
POST- Version Introduced:
- 10.7.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.
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 federate operation creates a data store item in the portal for a data store that has been registered with one of the portal's federated ArcGIS Server sites.
Request parameters
| Parameter | Details |
|---|---|
| The item path for the database, cloud, or file share data store for which you want to create a data store item. The item path is located in data > items > [enterpriseDatabases/fileShares/cloudStores] > Child Items in the Data Item Properties section. Example |
| The response format. The default format is Value: |
Example usage
The following is a sample POST request for the federate operation:
POST /<context>/admin/data/federateDataItem HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
itemPath=/enterpriseDatabases/GISDataStore&f=pjsonResponse
If successful, federate will return the following success message:
{"status": "success"}Once the operation is complete, a data store item is created in the portal with which the ArcGIS Server site is federated. If the data store is registered with only this federated server, no further steps are required. However, if the data store is registered with multiple federated servers and you want any of those servers to access the data store item, you need to bind the data store item with an additional federated server or servers using the Add to Server operation.