Validate Data Item | ArcGIS REST APIs

URL:: https://<root>/data/validateDataItem
Methods:: POST
Version Introduced:: 10.9

Access requirements

Required privileges

The Enterprise 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.

Publisher role Update

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise 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 generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

Description

The validateDataItem operation validates that the path (for file shares) or connection string (for databases) for a specific data item is accessible to every server node in the site by checking against the JSON representing the data item, ensuring that the data item can be registered and used successfully in the server's data store.

Validating a data item does not automatically register it. You must explicitly register a data item by invoking the Register operation.

Request parameters

Parameter Details

Parameter	Details
`item` (Required)	The JSON representing the data item. Starting with ArcGIS Enterprise on Kubernetes 10.9.1, specific user-defined information must be provided to validate new folder paths in a deployment. For more information, see User-managed store properties. Example Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 item={ "clientPath": "\\\\sample_server\\SharedPath\\Data", "type": "folder", "info": { "fileServerHost": "nfsHost.example.com", "fileServerType": "nfs", "fileServerPath": "/SharedPath/Data" } }`
`options` (Optional; required for new file share locations)	Introduced at 11.0. A JSON array of additional properties used during validation. 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 validation of the new file share location to fail. Note This parameter is not required for paths that were previously registered with the organization: Examples Use dark colors for code blocksCopy `1 2 3 4 5 6 //Example one: a new path. Requires allowServicesRestart to be set to true and services will restart /myshare/folder1 //Example two: an extension to the path (above) that was previously registered. Does not require allowServicesRestart to be set to true, and services will not restart /myshare/folder1/subfolder2/subfolder3` Example Use dark colors for code blocksCopy `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 format is `html`. Values: `html` \| `json` \| `pjson`

item

(Required)

The JSON representing the data item.

Starting with ArcGIS Enterprise on Kubernetes 10.9.1, specific user-defined information must be provided to validate new folder paths in a deployment. For more information, see User-managed store properties.

Example
Use dark colors for code blocksCopy
item={
  "clientPath": "\\\\sample_server\\SharedPath\\Data",
  "type": "folder",
  "info": {
    "fileServerHost": "nfsHost.example.com",
    "fileServerType": "nfs",
    "fileServerPath": "/SharedPath/Data"
  }
}

options

(Optional; required for new file share locations)

Introduced at 11.0. A JSON array of additional properties used during validation. 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 validation of the new file share location to fail.

Note

This parameter is not required for paths that were previously registered with the organization:

Examples
Use dark colors for code blocksCopy
//Example one: a new path. Requires allowServicesRestart to be set to true and services will restart
/myshare/folder1

//Example two: an extension to the path (above) that was previously registered.
Does not require allowServicesRestart to be set to true, and services will not restart
/myshare/folder1/subfolder2/subfolder3

Example
Use dark colors for code blocksCopy
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 format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the validateDataItem operation, formatted for readability:

Use dark colors for code blocksCopy
POST /<context>/admin/data/validateDataItem HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

item={
  "path": "/fileShares/folder_shared",
  "type": "folder",
  "id": null,
  "clientPath": null,
  "info": {
    "path": "\\\\server\\share_data\\map_data",
    "dataStoreConnectionType": "shared"
  }
}&options={"allowServicesRestart": true}&async=false&f=json&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8Cis

JSON Response examples

If async is false, the following response is returned:

Use dark colors for code blocksCopy
{"status": "success"}

If async is true, the following response is returned. The value returned for jobsUrl can be used to access the job resource to track a job's status after it's been submitted. For more information, see the Job resource documentation.

Use dark colors for code blocksCopy
{
  "jobsUrl": "https://organization.example.com/<context>/admin/jobs/ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobID": "ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobStatus": "SUBMITTED"
}