The Web Service
Applies To: Opalis 6.3
Opalis Integration Server enables you to start, stop, and collect information about Policies using a web service application programmer interface.
To use the web service API, invoke the following WSDL file:
http://<ServerName>:5314/OpConsoleApp-1.0-OpConsoleServer-1.0/PolicyInfoServiceBean?wsdl
The following table lists the WSDL methods and XML request payloads available in the WSDL file.
| Method | XML request payload |
|---|---|
authenticate |
<authenticate1><username>String</username><password>String</password></authenticate1> |
getActionServerById |
<getActionServerById1><token>String</token><actionServerId>String</actionServerId></getActionServerById1> |
getAllActionServers |
<getAllActionServers1><token>String</token></getAllActionServers1> |
getAllPolicies |
<getAllPolicies1><token>String</token></getAllPolicies1> |
getCustomStartParametersForPolicy |
<getCustomStartParametersForPolicy1><token>String</token><policyId>String</policyId></getCustomStartParametersForPolicy1> |
getFolderById |
<getFolderById1><token>String</token><folderId>String</folderId></getFolderById1> |
getFoldersByFolder |
<getFoldersByFolder1><token>String</token><folderId>String</folderId></getFoldersByFolder1> |
getObjectInstancesByPolicyInstance |
<getObjectInstancesByPolicyInstance1><token>String</token><policyInstanceId>String</policyInstanceId></getObjectInstancesByPolicyInstance1> |
getPoliciesByFolder |
<getPoliciesByFolder1><token>String</token><folderId>String</folderId></getPoliciesByFolder1> |
getPolicyById |
<getPolicyById1><token>String</token><policyId>String</policyId></getPolicyById1> |
getPolicyInstanceById |
<getPolicyInstanceById1><token>String</token><policyInstanceId>String</policyInstanceId></getPolicyInstanceById1> |
getPolicyInstancesByPolicy |
<getPolicyInstancesByPolicy1><token>String</token><policyId>String</policyId></getPolicyInstancesByPolicy1> |
getPolicyInstancesByPolicyRequest |
<getPolicyInstancesByPolicyRequest1><token>String</token><policyRequestId>0</policyRequestId></getPolicyInstancesByPolicyRequest1> |
getPolicyRequestById |
<getPolicyRequestById1><token>String</token><policyRequestId>0</policyRequestId></getPolicyRequestById1> |
getPolicyRequestsByActionServer |
<getPolicyRequestsByActionServer1><token>String</token><actionServerId>String</actionServerId></getPolicyRequestsByActionServer1> |
getPolicyRequestsByPolicy |
<getPolicyRequestsByPolicy1><token>String</token><policyId>String</policyId></getPolicyRequestsByPolicy1> |
isCustomStart |
<isCustomStart1><token>String</token><policyId>String</policyId></isCustomStart1> |
isPolicyStartable |
<isPolicyStartable1><token>String</token><policyId>String</policyId></isPolicyStartable1> |
startCustomPolicy |
<startCustomPolicy1><token>String</token><policyId>String</policyId><parameterIds>String</parameterIds><parameterIds>String</parameterIds><values>String</values><values>String</values></startCustomPolicy1> |
startPolicy |
<startPolicy1><token>String</token><policyId>String</policyId></startPolicy1> |
stopPolicyRequest |
<stopPolicyRequest1><token>String</token><policyRequestId>0</policyRequestId></stopPolicyRequest1> |
stopAllPolicyRequests |
<stopAllPolicyRequests1><token>String</token></stopAllPolicyRequests1> |
stopAllPolicyRequestsForPolicy |
<stopAllPolicyRequestsForPolicy1><token>String</token><policyId>String</policyId></stopAllPolicyRequestsForPolicy1> |
Note
The default value of parameters that accept integers is "0" (zero). The default value of parameters that accept strings is "String".
Tip
Using the Invoke Web Services object, you can use Policy and parameter ID information dynamically in Policies. First, create an instance of the Invoke Web Services method that collects the information you require. To retrieve Policy ID information, use the getAllPolicies method. To retrieve parameter ID information, use the getCustomStartParameters methed. Then you can run other methods in other instances of the Invoke Web Services object and insert the ID information into the XML Request Payload field as a Published Data item.