ORCA web service API operations samples

This section describes the ORCA web service API operations and provides a sample request and response for each operation. 

queryProcessNames operation

The queryProcessNames operation is an ad hoc query operation that returns the names of workflows available for execution. This operation uses regular expression pattern matching, and you must express the patterns as Java regular expressions.

Note

The ORCA web service does not support PCRE patterns.

Sample request for queryProcessNames operation

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:queryProcessNames>
         <soa:gridName>My_GRID</soa:gridName>
         <soa:moduleName>RBA-AD-BMC_Configuration_Automation_Networks</soa:moduleName>
         <soa:pattern>Custom</soa:pattern>
      </soa:queryProcessNames>
   </soapenv:Body>
</soapenv:Envelope>


Sample response for queryProcessNames operation

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns1:queryProcessNamesResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa">
         <ns1:ProcessName>:RBA-AD-BMC_Configuration_Automation_Networks:Setup_Validation:v5.2:Jobs:Test Perform Custom Action</ns1:ProcessName>
         <ns1:ProcessName>:RBA-AD-BMC_Configuration_Automation_Networks:v5.2:Jobs:Perform Custom Action</ns1:ProcessName>
      </ns1:queryProcessNamesResponse>
   </S:Body>
</S:Envelope>

queryModuleNames operation

The queryModuleNames operation is an ad hoc query operation that returns the names of modules activated on TrueSight Orchestration. This operation uses regular expression pattern matching, and you must express the patterns as Java regular expressions.

Note

The ORCA web service does not support PCRE patterns.

Sample request for queryModuleNames operation

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:queryModuleNames>
         <soa:gridName>BCAN_GRID</soa:gridName>
         <soa:pattern>ARS</soa:pattern>
      </soa:queryModuleNames>
   </soapenv:Body>
</soapenv:Envelope>

Sample response for queryModuleNames operation

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns1:queryModuleNamesResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa">
         <ns1:ModuleName>AMP-AD-BMC-Remedy-ARS</ns1:ModuleName>
      </ns1:queryModuleNamesResponse>
   </S:Body>
</S:Envelope>

getGridProcessDescriptions operation

The getGridProcessDescriptions operation returns a list of descriptions for all active workflows on a specified grid.

Sample request for getGridProcessDescriptions operation

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:getGridProcessDescriptions>
         <soa:gridName>My_GRID</soa:gridName>
      </soa:getGridProcessDescriptions>
   </soapenv:Body>
</soapenv:Envelope>

Note

Due to the size of the response, the following sample contains only the initial portion of the response.

Sample response for getGridProcessDescriptions operation

 <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns1:getGridProcessDescriptionsResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa">
         <ns1:Descriptions>
            <ns1:Process>
               <ns1:Name>:RBA-AD-BMC_Configuration_Automation_Networks:v5.2:Jobs:Perform Custom Action</ns1:Name>
               <ns1:PeerLocation>ANY</ns1:PeerLocation>
               <ns1:Description>Perform Custom Action operation executes a Custom Action on the specified device(s)</ns1:Description>
               <ns1:Parameters>
                  <ns1:Input>
                     <ns1:Parameter>
                        <ns1:Name>adapter name</ns1:Name>
                        <ns1:Description>Perform Custom Action operation executes a Custom Action on the specified device(s)
</ns1:Description>
                     </ns1:Parameter>
                     <ns1:Parameter>
                        <ns1:Name>connection parameters</ns1:Name>
                        <ns1:Description>Perform Custom Action operation executes a Custom Action on the specified device(s)
</ns1:Description>
                     </ns1:Parameter>
                     <ns1:Parameter>
                        <ns1:Name>items</ns1:Name>
                        <ns1:Description>Perform Custom Action operation executes a CustomAction on the specified device(s)
</ns1:Description>
                     </ns1:Parameter>
                  </ns1:Input>
                  <ns1:Output>
                     <ns1:Parameter>
                        <ns1:Name>adapter response</ns1:Name>
                        <ns1:Description>Perform Custom Action operation executes a Custom Action on the specified device(s)
</ns1:Description>
                     </ns1:Parameter>
                  </ns1:Output>
               </ns1:Parameters>
            </ns1:Process>
            <ns1:Process>
               <ns1:Name>:AMP-AD-BMC-Remedy-ARS:Query Server Info</ns1:Name>
               <ns1:PeerLocation>ANY</ns1:PeerLocation>
               <ns1:Description>Query Server Info Returns data relating to the current implementation of the Remedy Server.</ns1:Description>
               <ns1:Parameters>
                  <ns1:Input>
                     <ns1:Parameter>
                        <ns1:Name>adapter name</ns1:Name>
                        <ns1:Description>Query Server Info Returns data relating to the current implementation of the Remedy Server.</ns1:Description>
                     </ns1:Parameter>
                  </ns1:Input>
                  <ns1:Output>
                     <ns1:Parameter>
                        <ns1:Name>adapter response</ns1:Name>
                        <ns1:Description>Query Server Info Returns data relating to the current implementation of the Remedy Server.</ns1:Description>
                     </ns1:Parameter>
                  </ns1:Output>
               </ns1:Parameters>
            </ns1:Process>
         </ns1:getGridProcessDescriptionsResponse">
      </ns1:Descriptions>
   </soapenv:Body>
</soapenv:Envelope>

getModuleProcessDescriptions operation

The getModuleProcessDescriptions operation returns a list of descriptions for all available active workflows within a specified module on a grid.

Sample request for getModuleProcessDescriptions operation

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:getModuleProcessDescriptions>
         <soa:gridName>My_GRID</soa:gridName>
         <soa:moduleName>AMP-AD-BMC-Remedy-ARS</soa:moduleName>
      </soa:getModuleProcessDescriptions>
   </soapenv:Body>
</soapenv:Envelope>

Note

Due to the size of the response, the following sample contains only the initial portion of the response.

Sample response for getModuleProcessDescriptions operation

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns1:getModuleProcessDescriptionsResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa">
         <ns1:Descriptions>
            <ns1:Process>
               <ns1:Name>:AMP-AD-BMC-Remedy-ARS:Create Items</ns1:Name>
               <ns1:PeerLocation>ANY</ns1:PeerLocation>
               <ns1:Description>Create Item(s)Creates one or more items within a Remedy datastore.</ns1:Description>
               <ns1:Parameters>
                  <ns1:Input>
                     <ns1:Parameter>
                        <ns1:Name>adapter name</ns1:Name>
                        <ns1:Description>Create Item(s)Creates one or more items within a Remedy datastore.</ns1:Description>
                     </ns1:Parameter>
                     <ns1:Parameter>
                        <ns1:Name>connection parameters</ns1:Name>
                        <ns1:Description>Create Item(s)Creates one or more items within a Remedy datastore.</ns1:Description>
                     </ns1:Parameter>
                     <ns1:Parameter>
                        <ns1:Name>item type</ns1:Name>
                        <ns1:Description>Create Item(s)Creates one or more items within a Remedy datastore.</ns1:Description>
                     </ns1:Parameter>
                     <ns1:Parameter>
                        <ns1:Name>items</ns1:Name>
                        <ns1:Description>Create Item(s)Creates one or more items within a Remedy datastore.</ns1:Description>
                     </ns1:Parameter>
                     <ns1:Parameter>
                        <ns1:Name>version</ns1:Name>
                        <ns1:Description>Create Item(s)Creates one or more items within a Remedy datastore.</ns1:Description>
                     </ns1:Parameter>
                  </ns1:Input>
                  <ns1:Output>
                     <ns1:Parameter>
                        <ns1:Name>adapter response</ns1:Name>
                        <ns1:Description>Create Item(s)Creates one or more items within a Remedy datastore.</ns1:Description>
                     </ns1:Parameter>
                  </ns1:Output>
               </ns1:Parameters>
            </ns1:Process>
         </ns1:getModuleProcessDescriptionsResponse">
      </ns1:Descriptions>
   </soapenv:Body>
</soapenv:Envelope>

getProcessDescription operation

The getProcessDescription operation returns a description of an active workflow on a specific grid.

Sample request for getProcessDescription operation

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:getProcessDescription>
         <soa:gridName>My_GRID</soa:gridName>
         <soa:processName>:AMP-AD-BMC-Remedy-ARS:v6.0:Delete Entry</soa:processName>
      </soa:getProcessDescription>
   </soapenv:Body>
</soapenv:Envelope>


Sample response for getProcessDescription operation

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns1:getProcessDescriptionResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa">
         <ns1:Description>
            <ns1:Name>:AMP-AD-BMC-Remedy-ARS:v6.0:Delete Entry</ns1:Name>
            <ns1:PeerLocation>ANY</ns1:PeerLocation>
            <ns1:Description>Delete Entry Deletes an entry from a Remedy datastore.</ns1:Description>
            <ns1:Parameters>
               <ns1:Input>
                  <ns1:Parameter>
                     <ns1:Name>adapter name</ns1:Name>
                     <ns1:Description>Delete Entry Deletes an entry from a Remedy datastore.</ns1:Description>
                  </ns1:Parameter>
                  <ns1:Parameter>
                     <ns1:Name>entry id</ns1:Name>
                     <ns1:Description>Delete Entry Deletes an entry from a Remedy datastore.</ns1:Description>
                  </ns1:Parameter>
                  <ns1:Parameter>
                     <ns1:Name>schema name</ns1:Name>
                     <ns1:Description>Delete Entry Deletes an entry from a Remedy datastore.</ns1:Description>
                  </ns1:Parameter>
               </ns1:Input>
               <ns1:Output>
                  <ns1:Parameter>
                     <ns1:Name>adapter response</ns1:Name>
                     <ns1:Description>Delete Entry Deletes an entry from a Remedy datastore.</ns1:Description>
                  </ns1:Parameter>
               </ns1:Output>
            </ns1:Parameters>
         </ns1:Description>
      </ns1:getProcessDescriptionResponse>
   </S:Body>
</S:Envelope>

executeProcess operation using the xs:string type

The executeProcess operation synchronously executes a workflow on a grid. When the parameter value is text, the xs:string type is used. The call will block until the workflow completes.

Sample request for executeProcess operation using the xs:string type

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:executeProcess>
         <soa:gridName>IMWGrid</soa:gridName>
         <soa:processName>:AutoPilot-AD-Utilities:Terminal:Command Line</soa:processName>
         <soa:parameters>
            <!--Optional:-->
            <soa:Input>
               <!--Zero or more repetitions:-->
               <soa:Parameter>
                  <soa:Name required="true">adapter name</soa:Name>
                  <!--Optional:-->
                  <!--Optional:-->
                  <soa:Value soa:type="xs:string">
                     <!--Optional:-->
                     <!--Optional:-->
                     <soa:Text>CMD_CDP</soa:Text>
                  </soa:Value>
               </soa:Parameter>
               <soa:Parameter>
                  <soa:Name required="true">command</soa:Name>
                  <soa:Value soa:type="xs:string">
                     <soa:Text>ls</soa:Text>
                  </soa:Value>
               </soa:Parameter>
            </soa:Input>
            <!--Optional:-->
         </soa:parameters>
      </soa:executeProcess>
   </soapenv:Body>
</soapenv:Envelope>


Sample response for executeProcess operation using the xs:string type

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns1:executeProcessResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa">
         <ns1:Output>
            <ns1:Output>
               <ns1:Parameter>
                  <ns1:Name>adapter response</ns1:Name>
                  <ns1:Value ns1:type="xs:anyType">
                     <ns1:XmlDoc>
                        <command-result>
                           <metadata>
                              <status>success</status>
                           </metadata>
                           <targets-output>
                              <target-output>
                                 <metadata>
                                    <os-id>Linux</os-id>
                                    <os-version>2.6.9-55.0.2.ELsmp</os-version>
                                    <os-arch>i386</os-arch>
                                    <status>success</status>
                                 </metadata>
                                 <commands-output>
                                    <command-output>
                                       <metadata>
                                          <command>ls</command>
                                          <working-dir/>
                                          <command-dir/>
                                          <line-count>4</line-count>
                                          <execution-milliseconds>120</execution-milliseconds>
                                          <exit-code>0</exit-code>
                                          <status>success</status>
                                       </metadata>
                                       <output>
                                          <line index="1">bao.sh</line>
                                          <line index="2">fix_perm.sh</line>
                                          <line index="3">server.pid</line>
                                          <line index="4">server.sh</line>
                                       </output>
                                    </command-output>
                                 </commands-output>
                              </target-output>
                           </targets-output>
                        </command-result>
                     </ns1:XmlDoc>
                  </ns1:Value>
               </ns1:Parameter>
            </ns1:Output>
         </ns1:Output>
      </ns1:executeProcessResponse>
   </S:Body>
</S:Envelope>

executeProcess operation using xs:anyType type

The xs:anyType type specifies an XML document. XML document is the default type if the Type attribute is not specified.

Sample request for executeProcess operation using xs:anyType type

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:executeProcess>
         <soa:gridName>IMWGrid</soa:gridName>
         <soa:processName>:AutoPilot-AD-Utilities:Terminal:Command Line</soa:processName>
         <soa:parameters>
            <soa:Input>
               <soa:Parameter>
                  <soa:Name>adapter name</soa:Name>
                  <soa:Value soa:type="xs:string">
                     <soa:Text>CMD_CDP</soa:Text>
                  </soa:Value>
               </soa:Parameter>
               <soa:Parameter>
                  <soa:Name>commands</soa:Name>
                  <soa:Value>
                     <soa:XmlDoc>
                        <commands>
                           <command>ls</command>
                        </commands>
                     </soa:XmlDoc>
                  </soa:Value>
               </soa:Parameter>
            </soa:Input>
         </soa:parameters>
      </soa:executeProcess>
   </soapenv:Body>
</soapenv:Envelope>


Sample response for executeProcess operation using xs:anyType

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns1:executeProcessResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa">
         <ns1:Output>
            <ns1:Output>
               <ns1:Parameter>
                  <ns1:Name>adapter response</ns1:Name>
                  <ns1:Value ns1:type="xs:anyType">
                     <ns1:XmlDoc>
                        <command-result>
                           <metadata>
                              <status>success</status>
                           </metadata>
                           <targets-output>
                              <target-output>
                                 <metadata>
                                    <os-id>Linux</os-id>
                                    <os-version>2.6.9-55.0.2.ELsmp</os-version>
                                    <os-arch>i386</os-arch>
                                    <status>success</status>
                                 </metadata>
                                 <commands-output>
                                    <command-output>
                                       <metadata>
                                          <command>ls</command>
                                          <line-count>4</line-count>
                                          <execution-milliseconds>122</execution-milliseconds>
                                          <exit-code>0</exit-code>
                                          <status>success</status>
                                       </metadata>
                                       <output>
                                          <line index="1">bao.sh</line>
                                          <line index="2">fix_perm.sh</line>
                                          <line index="3">server.pid</line>
                                          <line index="4">server.sh</line>
                                       </output>
                                    </command-output>
                                 </commands-output>
                              </target-output>
                           </targets-output>
                        </command-result>
                     </ns1:XmlDoc>
                  </ns1:Value>
               </ns1:Parameter>
            </ns1:Output>
         </ns1:Output>
      </ns1:executeProcessResponse>
   </S:Body>
</S:Envelope>

executeProcess operation using cdata

Using the cdata type with the executeProcess operation enables you to include character data in the SOAP request.

Sample request for executeProcess operation using cdata

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:executeProcess>
         <soa:gridName>IMWGrid</soa:gridName>
         <soa:processName>:AutoPilot-AD-Utilities:Terminal:Command Line</soa:processName>
         <soa:parameters>
            <!--Optional:-->
            <soa:Input>
               <!--Zero or more repetitions:-->
               <soa:Parameter>
                  <soa:Name required="true">adapter name</soa:Name>
                  <!--Optional:-->
                  <!--Optional:-->
                  <soa:Value soa:type="xs:string">
                     <!--Optional:-->
                     <!--Optional:-->
                     <soa:Text>CMD_CDP</soa:Text>
                     <soa:XmlDoc/>
                  </soa:Value>
               </soa:Parameter>
               <soa:Parameter>
                  <soa:Name required="true">commands</soa:Name>
                  <soa:Value soa:type="cdata">
                     <soa:Text><![CDATA[<commands><command>ls</command>
</commands>]]></soa:Text>
                  </soa:Value>
               </soa:Parameter>
            </soa:Input>
         </soa:parameters>
      </soa:executeProcess>
   </soapenv:Body>
</soapenv:Envelope>Response


Sample response for executeProcess operation using cdata

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns1:executeProcessResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa">
         <ns1:Output>
            <ns1:Output>
               <ns1:Parameter>
                  <ns1:Name>adapter response</ns1:Name>
                  <ns1:Value ns1:type="xs:anyType">
                     <ns1:XmlDoc>
                        <command-result>
                           <metadata>
                              <status>success</status>
                           </metadata>
                           <targets-output>
                              <target-output>
                                 <metadata>
                                    <os-id>Linux</os-id>
                                    <os-version>2.6.9-55.0.2.ELsmp</os-version>
                                    <os-arch>i386</os-arch>
                                    <status>success</status>
                                 </metadata>
                                 <commands-output>
                                    <command-output>
                                       <metadata>
                                          <command>ls</command>
                                          <line-count>4</line-count>
                                          <execution-milliseconds>123</execution-milliseconds>
                                          <exit-code>0</exit-code>
                                          <status>success</status>
                                       </metadata>
                                       <output>
                                          <line index="1">bao.sh</line>
                                          <line index="2">fix_perm.sh</line>
                                          <line index="3">server.pid</line>
                                          <line index="4">server.sh</line>
                                       </output>
                                    </command-output>
                                 </commands-output>
                              </target-output>
                           </targets-output>
                        </command-result>
                     </ns1:XmlDoc>
                  </ns1:Value>
               </ns1:Parameter>
            </ns1:Output>
         </ns1:Output>
      </ns1:executeProcessResponse>
   </S:Body>
</S:Envelope>

executeProcessAsync operation

The executeProcessAsync operation asynchronously executes a specified workflow. The call will return a response immediately.
You can use the returned JobID in the executeProcessAsync operation response to query the workflow status.

Sample request for executeProcessAsync operation

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <ns1:executeProcessAsync xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa">
         <ns1:gridName>My_GRID</ns1:gridName>
         <ns1:processName>:Closed_Loop-SA-Change_Management:Retrieve Tasks by Status</ns1:processName>
         <ns1:parameters>
            <ns1:Input>
               <ns1:Parameter>
                  <ns1:Name required="false">configuration name</ns1:Name>
                  <ns1:Value ns1:type="xs:string">
                     <ns1:Text>My</ns1:Text>
                  </ns1:Value>
               </ns1:Parameter>
               <ns1:Parameter>
                  <ns1:Name required="false">url</ns1:Name>
                  <ns1:Value ns1:type="xs:string">
                     <ns1:Text>http://testing123.com</ns1:Text>
                  </ns1:Value>
               </ns1:Parameter>
            </ns1:Input>
            <ns1:Output>
               <ns1:Parameter>
                  <ns1:Name required="false">tasks</ns1:Name>
                  <ns1:Value ns1:type="xs:anyType"/>
               </ns1:Parameter>
               <ns1:Parameter>
                  <ns1:Name required="false">status code</ns1:Name>
                  <ns1:Value ns1:type="xs:anyType"/>
               </ns1:Parameter>
               <ns1:Parameter>
                  <ns1:Name required="false">error message</ns1:Name>
                  <ns1:Value ns1:type="xs:anyType"/>
               </ns1:Parameter>
            </ns1:Output>
         </ns1:parameters>
      </ns1:executeProcessAsync>
   </soapenv:Body>
</soapenv:Envelope>


Sample response for executeProcessAsync operation

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns1:executeProcessAsyncResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa">
         <ns1:ProcessContext>
            <ns1:ProcessName>:Closed_Loop-SA-Change_Management:Retrieve Tasks by Status</ns1:ProcessName>
            <ns1:JobId>cca37566-e0ad-4258-b0c9-6dde41b62a7e</ns1:JobId>
         </ns1:ProcessContext>
      </ns1:executeProcessAsyncResponse>
   </S:Body>
</S:Envelope>

getProcessStatus operation

The getProcessStatus operation requests the operational status and related information about an executed workflow. You must provide a job ID for the ProcessContextType property.

Sample request for getProcessStatus operation

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:getProcessStatus>
         <soa:processContext gridName="My_GRID">
<soa:ProcessName>?</soa:ProcessName>
            <soa:JobId>fbdd5998-bbab-4497-b1b3-21080b51c769</soa:JobId>
         </soa:processContext>
      </soa:getProcessStatus>
   </soapenv:Body>
</soapenv:Envelope>


Sample response for getProcessStatus operation

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns1:getProcessStatusResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa">
         <ns1:ProcessStatus>
            <ns1:ProcessId>:Closed_Loop-SA-Change_Management:Retrieve Tasks by Status</ns1:ProcessId>
            <ns1:Name>Retrieve Tasks by Status</ns1:Name>
            <ns1:PeerId>urn:jxta:uuid-59616261646162614E50472050325033EE551273DD274E498B1E845F54BA14A203</ns1:PeerId>
            <ns1:Status>COMPLETED</ns1:Status>
            <ns1:StartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <ns1:Output>
               <ns1:Parameter>
                  <ns1:Name>error message</ns1:Name>
                  <ns1:Value ns1:type="xs:anyType">
                     <ns1:XmlDoc>
                        <value>No Tasks found.</value>
                     </ns1:XmlDoc>
                  </ns1:Value>
               </ns1:Parameter>
               <ns1:Parameter>
                  <ns1:Name>status code</ns1:Name>
                  <ns1:Value ns1:type="xs:anyType">
                     <ns1:XmlDoc>
                        <value>1</value>
                     </ns1:XmlDoc>
                  </ns1:Value>
               </ns1:Parameter>
               <ns1:Parameter>
                  <ns1:Name>tasks</ns1:Name>
                  <ns1:Value ns1:type="xs:anyType">
                     <ns1:XmlDoc>
                        <value/>
                     </ns1:XmlDoc>
                  </ns1:Value>
               </ns1:Parameter>
            </ns1:Output>
         </ns1:ProcessStatus>
      </ns1:getProcessStatusResponse>
   </S:Body>
</S:Envelope>

pauseProcess operation

The pauseProcess operation halts the execution of an active workflow. After you issue the request, you can use Grid Manager to view the paused workflows.

Sample request for pauseProcess operation

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:pauseProcess>
         <soa:processContext gridName="My_GRID">
            <soa:JobId>98b70dd6-4995-49d7-89fa-e067fa81d6f6</soa:JobId>
         </soa:processContext>
         <soa:timeout>600000</soa:timeout>
      </soa:pauseProcess>
   </soapenv:Body>
</soapenv:Envelope>


Sample response for pauseProcess operation

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns1:pauseProcessResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa"/>
   </S:Body>
</S:Envelope>

cancelProcess operation

The cancelProcess operation cancels the execution of a scheduled workflow. The caller can specify a cancellation policy with or without compensation. If no policy is specified, the policy is canceled with compensation, which means that a recovery workflow is launched. After you issue the request, you can use Grid Manager to see the terminated workflow.

Sample request for cancelProcess operation

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:cancelProcess>
         <soa:processContext gridName="My_GRID">
            <soa:JobId>98b70dd6-4995-49d7-89fa-e067fa81d6f6</soa:JobId>
         </soa:processContext>
         <soa:cancelPolicy>WITH_COMPENSATION</soa:cancelPolicy>
      </soa:cancelProcess>
   </soapenv:Body>
</soapenv:Envelope>


Sample response for cancelProcess operation

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns1:cancelProcessResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa"/>
</S:Body>
</S:Envelope>

resumeProcess operation

The resumeProcess operation resumes a halted workflow. After you issue the request, you can use Grid Manager to see the workflows.

Sample request for resumeProcess operation

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soa="http://bmc.com/ao/xsd/2008/09/soa">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin123</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <soa:resumeProcess>
         <soa:processContext gridName="My_GRID">
            <soa:JobId>98b70dd6-4995-49d7-89fa-e067fa81d6f6</soa:JobId>
         </soa:processContext>
      </soa:resumeProcess>
   </soapenv:Body>
</soapenv:Envelope>

Sample response for resumeProcess operation

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns1:resumeProcessResponse xmlns:ns1="http://bmc.com/ao/xsd/2008/09/soa"/>
</S:Body>
</S:Envelope>

Related topics

RESTful-web-service

Web-services-security-and-permissions

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*