Federate Data Item

URL:: https://<root>/data/federateDataItem
Methods:: POST
Required Capability:: Access allowed with either the "Update", "Delete", "Security and Infrastructure", or "Servers" privileges
Version Introduced:: 10.7.1

Description

The federateDataItem 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

Parameter	Details
`itemPath`	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 Use dark colors for code blocksCopy `1 itemPath=/enterpriseDatabases/GISDataStore`
`f`	The response format. The default format is `html`. Value: `html` \| `json` \| `pjson`

itemPath

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
Use dark colors for code blocksCopy
itemPath=/enterpriseDatabases/GISDataStore

f

The response format. The default format is html.

Value: html | json | pjson

Example usage

The following is a sample POST request for the federateDataItem operation:

Use dark colors for code blocksCopy
POST /webadaptor/admin/data/federateDataItem HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

itemPath=/enterpriseDatabases/GISDataStore&f=pjson

Response

If successful, federateDataItem will return the following success message:

Use dark colors for code blocksCopy
{"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.