Register Item (Data Stores)

item

The JSON representation of the data item.

Starting with ArcGIS Enterprise on Kubernetes 10.9.1, you must provide the file server host name and path on the file server as part of registering new folder paths in a deployment. This workflow is recommended for registering new folder paths.

To register these folder paths, the following user-defined information must be provided:

• clientPath: Either a drive or shared location where source data can be accessed and published by clients, such as ArcGIS Pro. If the clientPath value is a drive location, the hostName property must be included as well.
• fileServerHost: The machine name where shared data is stored and can be accessed through an NFS path.
• filerServerPath: An NFS path on the host machine where shared data can be accessed across the organization.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
//Shared location
item={
  "clientPath": "\\\\sample_server\\SharedPath\\Data",
  "type": "folder",
  "info": {
    "fileServerHost": "nfsHost.domain.com",
    "fileServerType": "nfs",
    "fileServerPath": "/SharedPath/Data"
  }
}

//Drive location
item={
  "clientPath": "C:\\data",
  "type": "folder",
  "info": {
    "fileServerHost": "nfsHost.domain.com",
    "fileServerType": "nfs",
    "fileServerPath": "/data",
    "hostName": "yourclienthost.domain.com"
  }
}

options

(Optional; required for new file share locations)

Introduced at 11.0. A JSON array of additional properties used during registration. Currently, only the allowServicesRestart property is supported. Adding a new file share location requires the pods for all system and utility services to restart, as well as restarting the shared pods for map and tile services. Affected services will be unavailable during this time and may take some time before they are once again available. By setting allowServicesRestart to true, administrators are acknowledging that registering a new file share location will disrupt their organization. Not providing allowServicesRestart, or setting it to false, will cause the registration of the new file share location to fail.

1
options={"allowServicesRestart": true}

async

(Optional)

Introduced at 11.0. This parameter specifies whether the operation will run synchronously or asynchronously. If false, the operation is run synchronously. If true, the operation is run asynchronously and the response returns a JSON object containing job information that can be used to track the job's status. The default value is false.

Values: true | false

f

The response format. The default response format is html.

Values: html | json | pjson