- URL:
- https://<root>/data/relationalDatastoreTypes/register
- Methods:
POST- Version Introduced:
- 10.5
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
This operation registers a new relational data store type with the server. Once registered, a relational data store type enables Insights users to create Relational Database Connection portal items to browse and query data from relational databases.
This operation should only be called on an ArcGIS Server site that has been designated as a Portal for ArcGIS hosting server. In order to register a relational data store type, you must obtain the correct Java Database Connectivity (JDBC) driver from your database vendor. These drivers are typically delivered as one or more Java Archive (.jar) files, which you must compress/package into a ZIP file. The name of the ZIP file does not matter, except that the file extension must be .zip. Before calling this Register operation, you must first upload the ZIP file to your server. Be sure to make note of the Item ID property of the newly created upload item. Repeat the upload step for each database platform your organization supports.
The ZIP file should only contain the driver files for a single platform. For example, if your organization supports the use of Microsoft SQL Server and SAP HANA, you would create two ZIP files.
Once all relational data store types have been registered, do not delete the upload items created for the zipped database drivers. They might be needed at a later date.
Request parameters
| Parameter | Details |
|---|---|
| Identifier of the uploaded ZIP file containing JDBC driver file(s). Example |
| Identifier of the relational data store type you are registering. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the register operation:
POST /<context>/admin/data/relationalDatastoreTypes/register HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
uploadedItemId=ic600379e-be10-4fd2-ab7e-76d37989d3bf&typeId=esri.hana&f=pjsonJSON Response example
{"status": "success"}