- URL:
- https://<root>/services/exists
- 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.
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 generate 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.
Description
The exists operation checks whether a folder or service exists in the organization. It is recommended that you run this operation before creating a folder or a service. If a folder with the same folder name, or a service with the same name and type, exists in the organization, the response will return the exists property as true. If no conflicting folder or service is found, the exists property returns as false.
Request parameters
| Parameter | Details |
|---|---|
(Optional, or required when checking for existing folders) | The name of the folder. Example |
(Optional, or required when checking for existing services) | The name of the service. Example |
(Optional, or required when checking for existing services) | The type of service. Example |
| The response format. The default response is Values: |
Example usage
The following is a sample POST request for the exists operation:
POST /<context>/admin/services/exists HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
folderName=&serviceName=CommercialDamage&type=FeatureServer&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8CisJSON Response example
{
"folderName": "",
"serviceName": "CommercialDamageAssessment",
"type": "FeatureServer",
"exists": true
}