CommandWebService
Click here for a complete list of operations.
getDatabaseLinksStatus
Takes multiple space IDs as input. For each of the space IDs, the API would find out whether joins/grains in the space would require database links to be enabled for the space.
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /CommandWebService.asmx HTTP/1.1 Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.birst.com/getDatabaseLinksStatus" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <getDatabaseLinksStatus xmlns="http://www.birst.com/"> <token>string</token> <spaceIDs> <string>string</string> <string>string</string> </spaceIDs> </getDatabaseLinksStatus> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <getDatabaseLinksStatusResponse xmlns="http://www.birst.com/"> <getDatabaseLinksStatusResult> <databaseLinksStatusResult> <DatabaseLinksStatusResultForSpace> <spaceId>string</spaceId> <databaseLinksEnabledInSpace>boolean</databaseLinksEnabledInSpace> <databaseLinksNeededInSpace>boolean</databaseLinksNeededInSpace> <databaseLinksNeededReason>string</databaseLinksNeededReason> <errorMessage>string</errorMessage> </DatabaseLinksStatusResultForSpace> <DatabaseLinksStatusResultForSpace> <spaceId>string</spaceId> <databaseLinksEnabledInSpace>boolean</databaseLinksEnabledInSpace> <databaseLinksNeededInSpace>boolean</databaseLinksNeededInSpace> <databaseLinksNeededReason>string</databaseLinksNeededReason> <errorMessage>string</errorMessage> </DatabaseLinksStatusResultForSpace> </databaseLinksStatusResult> </getDatabaseLinksStatusResult> </getDatabaseLinksStatusResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /CommandWebService.asmx HTTP/1.1 Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <getDatabaseLinksStatus xmlns="http://www.birst.com/"> <token>string</token> <spaceIDs> <string>string</string> <string>string</string> </spaceIDs> </getDatabaseLinksStatus> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <getDatabaseLinksStatusResponse xmlns="http://www.birst.com/"> <getDatabaseLinksStatusResult> <databaseLinksStatusResult> <DatabaseLinksStatusResultForSpace> <spaceId>string</spaceId> <databaseLinksEnabledInSpace>boolean</databaseLinksEnabledInSpace> <databaseLinksNeededInSpace>boolean</databaseLinksNeededInSpace> <databaseLinksNeededReason>string</databaseLinksNeededReason> <errorMessage>string</errorMessage> </DatabaseLinksStatusResultForSpace> <DatabaseLinksStatusResultForSpace> <spaceId>string</spaceId> <databaseLinksEnabledInSpace>boolean</databaseLinksEnabledInSpace> <databaseLinksNeededInSpace>boolean</databaseLinksNeededInSpace> <databaseLinksNeededReason>string</databaseLinksNeededReason> <errorMessage>string</errorMessage> </DatabaseLinksStatusResultForSpace> </databaseLinksStatusResult> </getDatabaseLinksStatusResult> </getDatabaseLinksStatusResponse> </soap12:Body> </soap12:Envelope>