- URL:
- https://<root>/services/findServices
- Methods:
POST- Required Capability:
- Access allowed with either the "Update", "Delete", or "Security and infrastructure" privileges, or the Publisher role
- Version Introduced:
- 10.9
Description
The find operation queries and returns a list of the services within the deployment. The results can be fine-tuned by specifying the folder location, service type, ID, or service provider. These filters are optional; if no filter is applied, all services are returned by the operation.
Request parameters
| Parameter | Details |
|---|---|
(Optional) | Filters services by their folder location. Example |
| Filters services by their name. Example |
(Optional) | Filters services by their service type. Example |
(Optional) | Filters services by their specific service IDs. Example |
(Optional) | Filters services by their provider types. Values: |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the find operation that queries services for Feature Services with SDS as a provider type in the Hosted folder:
POST /context/admin/services/findServices HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
filterFolderName=Hosted&filterServiceType=FeatureServer&filterServiceId=&filterServiceProvider=SDS&f=pjson&token=yJEfZxDMUpJmeqJlA_A0H-WOROxeSslL8m704pDFu2uwxFSLQnjewhuKpXYXOLVZjAs_HWh6JhldUnjfyG10PrSEOIrZ8O-LzgWVHwl7LaklYuXru_Jkg0UxGxVE9YIHc_M2yi6wT7rS4b7MSStBVIwTL1ZND5JjXJYsvcXJvtqF-58Dz16zuq-JtC03EEvkxF8rxlqRkBs8V_ti_zkBPfLbq_BnhjJAcSsyP5___4P_6UJDt6odF83azx-fobQqJSON Response example
The following is an abbreviated response for the example usage above:
{
"filteredServices": [
{
"id": "s0378d7fd-2731-49da-9ef9-d0c9cae563bb",
"serviceName": "Countries",
"type": "FeatureServer",
"folderName": "Hosted",
"description": "",
"capabilities": "Query",
"provider": "SDS",
"clusterName": "default",
"minInstancesPerNode": 0,
"maxInstancesPerNode": 0,
"instancesPerContainer": 1,
"maxWaitTime": 60,
"maxStartupTime": 300,
"maxIdleTime": 1800,
"maxUsageTime": 600,
"loadBalancing": "ROUND_ROBIN",
"isolationLevel": "HIGH",
"configuredState": "STARTED",
"recycleInterval": 24,
"recycleStartTime": "00:00",
"keepAliveInterval": 1800,
"private": false,
"isDefault": false,
"maxUploadFileSize": 0,
"allowedUploadFileTypes": "",
"properties": {...},
"jsonProperties": {...},
"portalProperties": {...},
"extensions": [],
"frameworkProperties": {},
"datasets": [],
"serverId": "v7bed0815-d718-45bc-8d30-8264c51933af"
}
]
}