- URL:
- https://<root>/data/relationalDatastoreTypes/register
- Methods:
POST
- Required Capability:
- Access allowed with either the "Update", "Delete", "Security and Infrastructure", or "Servers" privileges
- Version Introduced:
- 10.5
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 /webadaptor/admin/data/relationalDatastoreTypes/register HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
uploadedItemId=ic600379e-be10-4fd2-ab7e-76d37989d3bf&typeId=esri.hana&f=pjson
JSON Response example
{"status": "success"}