8.6. Manager API

Content Being Written

This section of the documentation is currently being produced and may be incomplete and/or subject to change.

Table 8.1. Manager REST API Endpoints

HTTP MethodURIDescription
GET/ping 
GET/status 

Description Status information on dataService and compositeDataService
MethodGET /ping
Request Data None
Response Data
PingDescriptor
Authentication Requiredno
Return Codes
200 Request completed successfully.
Description Get dataService status
MethodGET /status/{service}
Request Data None
Response Data
ClusterApiResponse.getOutputPayload() .getDataServiceState()
Authentication Requiredno
Path Arguments  
service dataService or compositeDataService name
 Parametersstring; required
Return Codes
200 Request completed successfully.