URL:
https://<root>/services/<serviceName>.<serviceType>/buildDatastoreRelationships
Methods:
POST
Version Introduced:
12.2

Access requirements

Required privileges

The Server 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 ArcGIS 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 ArcGIS Server Administrator API generateToken operation. For security reasons, all POST requests made to the ArcGIS Server Administrator API must include a token in the request body.


Learn how to generate a token

Description

The buildDatastoreRelationships operation builds the relationship mapping between the given service and the data stores the service uses. The mapping is stored as a JSON file in the configuration store and can be accessed through the service's Data Stores resource.

If run asynchronously, this operation starts an asynchronous job. If the response's format is set to HTML, the operation redirects to the initiated job's resource page. Otherwise, the operation returns a job ID that you can use to access the job resource directly.

Request parameters

ParameterDetails

runAsync

Specifies if the operation needs to be run asynchronously. The default value is false.

Values: true | false

f

(Optional)

The response format. The default format is html.

Values: html | json | pjson

Example usage

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /<context>/services/myService.FeatureServer/buildDatastoreRelationships HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

runAync=false&f=pjson&token=<ACCESS_TOKEN>

JSON Response example

The following is a sample JSON response returned by the buildDatastoreRelationships operation if run synchronously:

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

The following is a sample JSON response returned by the buildDatastoreRelationships operation if run asynchronously:

Use dark colors for code blocksCopy
1
2
3
4
{
  "status": "success",
  "jobid": "j1f2c26f4-9b96-4c9d-897d-1987909fc217"
}

The following is a sample JSON response returned by the job resource once the job has completed:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "jobid": "j1f2c26f4-9b96-4c9d-897d-1987909fc217",
  "status": "COMPLETED",
  "totalsteps": 1,
  "currentstep": 1,
  "stepInfo": [""],
  "operationResponse": {"status": "success"}
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.