Summary of ORCA web service API operations - Documentation for BMC Atrium Orchestrator Platform 7.8

Operation or response

Message

queryProcessNames

Executes an ad hoc workflow names query using regular expression pattern matching

Patterns must be expressed as Java Regular Expressions.

Perl Compatible Regular Expressions (PCRE) patterns are not supported.

<xs:element name="queryProcessNames"> <xs:complexType> <xs:sequence> <xs:element name="gridName" type="xs:string"/> <xs:element name="moduleName" type="xs:string"/> <xs:element name="pattern" type="xs:string"/> </xs:sequence> </xs:complexType>
</xs:element>

queryProcessNamesResponse

Returns a response for the queryProcessNames request and can contain zero or more matching workflow names, depending on the request

<xs:element name="queryProcessNamesResponse"> <xs:complexType> <xs:sequence> <xs:element name="ProcessName" type="xs:string" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>
</xs:element>

queryModuleNames

Executes an ad hoc modules query using regular expression pattern matching

Patterns must be expressed as Java Regular Expressions. PCRE patterns are not supported.

<xs:element name="queryModuleNames"> <xs:complexType> <xs:sequence> <xs:element name="gridName" type="xs:string"/> <xs:element name="pattern" type="xs:string"/> </xs:sequence> </xs:complexType>
</xs:element>

queryModuleNamesResponse

Response returned for the queryModuleNames request

Depending on the request, the response contains zero or more matching module names.

<xs:element name="queryModuleNamesResponse"> <xs:complexType> <xs:sequence> <xs:element name="ModuleName" type="xs:string" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>
</xs:element>

getGridProcessDescriptions

Executes a workflow description query, by grid name, that is used to scope or filter the results from a particular grid

<xs:element name="getGridProcessDescriptions"> <xs:complexType> <xs:sequence> <xs:element name="gridName" type="xs:string"/> </xs:sequence> </xs:complexType>
</xs:element>

getGridProcessDescriptionsResponse

Returns a response for a getGridProcessDescriptions request

Depending on the request, the response contains zero or more descriptions.

<xs:element
name="getGridProcessDescriptionsResponse"> <xs:complexType> <xs:sequence> <xs:element name="Descriptions" type="tns:ArrayOfDescriptions" minOccurs="0" /> </xs:sequence> </xs:complexType>
</xs:element>

getModuleProcessDescriptions

Executes a workflow description query, by grid name, that is used to scope or filter the results to a particular grid

<xs:element name="getModuleProcessDescriptions"> <xs:complexType> <xs:sequence> <xs:element name="gridName" type="xs:string" minOccurs="0" /> <xs:element name="moduleName" type="xs:string" minOccurs="0"/> </xs:sequence> </xs:complexType>
</xs:element>

getModuleProcessDescriptionsResponse

Returns a response for the getModuleProcessDescriptions request

Depending on the request, the response might return no descriptions.

<xs:element name="getModuleProcessDescriptionsResponse"> <xs:complexType> <xs:sequence> <xs:element name="Descriptions" type="tns:ArrayOfDescriptions" minOccurs="0"/> </xs:sequence> </xs:complexType>
</xs:element>

getProcessDescription

Executes a request for a workflow description

<xs:element name="getProcessDescription"> <xs:complexType> <xs:sequence> <xs:element name="gridName" type="xs:string"/> <xs:element name="processName" type="xs:string"/> </xs:sequence> </xs:complexType>
</xs:element>

getProcessDescriptionResponse

Depending on the specified request, the response might not return a description.

<xs:element
name="getProcessDescriptionResponse"> <xs:complexType> <xs:sequence> <xs:element name="Description" type="tns:ProcessDescriptionType" minOccurs="0"/> </xs:sequence> </xs:complexType>
</xs:element>

executeProcess

Synchronously executes a particular workflow on a specified grid

This call will block until the workflow is finished.

<xs:element name="executeProcess"> <xs:complexType> <xs:sequence> <xs:element name="gridName" type="xs:string"/> <xs:element name="processName"type="xs:string" /> <xs:element name="parameters"type="tns:ParametersType" /> </xs:sequence> </xs:complexType>
</xs:element>

executeProcessResponse

Returns a response for a single workflow execution

<S:Envelope xmlns:S=""> <S:Body> <ns1:executeProcessResponse xmlns:ns1=""> <ns1:Output> <ns1:Output> <ns1:Parameter> <ns1:Name>adapter response</ns1:Name> <ns1:Value ns1:type="xs:anyType"> <ns1:XmlDoc>
... </ns1:Output> </ns1:executeProcessResponse> </S:Body>
</S:Envelope>

executeProcessAsync

Asynchronously executes a specified workflow

The call will return a response immediately.

<xs:element name="executeProcessAsync"> <xs:complexType> <xs:sequence> <xs:element name="gridName" type="xs:string"/> <xs:element name="processName"type="xs:string" /> <xs:element name="parameters"type="tns:ParametersType"/> </xs:sequence> </xs:complexType>
</xs:element>

executeProcessAsyncResponse

Returns a response for the executeProcessAsync request

The response contains the context identifier, or variable, that you can use to request the workflow execution status.

<xs:element name="executeProcessAsyncResponse"> <xs:complexType> <xs:sequence> <xs:element name="ProcessContext"type="tns:ProcessContextType"/> </xs:sequence> </xs:complexType>
</xs:element>

executeProcessGraph

Synchronously executes a request for a graph of workflows

<xs:element name="executeProcessGraph"> <xs:complexType> <xs:sequence> <xs:element name="gridName" type="xs:string"/> <xs:element name="processGraph"type="tns:ProcessGraphType"/> </xs:sequence> </xs:complexType>
</xs:element>

This operation is not available in version 7.6.02 and later.

executeProcessGraphResponse

Returns a response for the executeProcessGraph request

<xs:element name="executeProcessGraphResponse"> <xs:complexType> <xs:sequence> <xs:element name="Context" type="tns:ProcessContextType"/> </xs:sequence> </xs:complexType> </xs:element>

This response has been disabled in version 7.6.02 and later.

getProcessStatus

Executes a request for workflow status

<xs:element name="getProcessStatus"> <xs:complexType> <xs:sequence> <xs:element name="processContext" type="tns:ProcessContextType"/> <xs:element name="outputTypes" type="tns:OutputType" minOccurs="0"/> </xs:sequence> </xs:complexType>
</xs:element>

getProcessStatusResponse

Returns a response for the getProcessStatus request

The response includes information pertaining to a previously scheduled workflow.

<xs:element name="getProcessStatusResponse"> <xs:complexType> <xs:sequence> <xs:element name="ProcessStatus" type="tns:ProcessStatusType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType>
</xs:element>

pauseProcess

Pauses the workflow execution The timeout is expected to be a value in milliseconds.

If the job identifier is valid and represents an in-progress job that can be paused, the job will be paused. Invalid job identifiers are silently ignored.

<xs:element name="pauseProcess"> <xs:complexType> <xs:sequence> <xs:element name="gridName" type="xs:string"/> <xs:element name="pattern" type="xs:string"/> </xs:sequence> </xs:complexType>
</xs:element>

pauseProcessResponse

Pause workflow void response

<xs:element name="pauseProcessResponse"> <xs:annotation> <xs:documentation>Pause process void response</xs:documentation> </xs:annotation> <xs:complexType/>
</xs:element>

cancelProcess

Executes a cancellation request for a single workflow

The cancelPolicy value can be nil or omitted.

If you omit cancelPolicy, the default policy WITH_COMPENSATION is assumed, and a recovery workflow is launched.

<xs:element name="cancelProcess"> <xs:complexType> <xs:sequence> <xs:element name="processContext" type="tns:ProcessContextType"/> <xs:element name="cancelPolicy" type="tns:CancelPolicy" default="WITH_COMPENSATION"/> </xs:sequence> </xs:complexType>
</xs:element>

cancelProcessResponse

Returns a response for the cancelProcess request-a workflow cancellation void response

<xs:element name="cancelProcessResponse"> <xs:complexType/> </xs:element>

resumeProcess

Resumes a paused workflow

If the job identifier is valid and represents an in-progress job that is currently paused, the job will resume processing. Invalid job identifiers are silently ignored.

<xs:element name="resumeProcess"> <xs:complexType> <xs:sequence> <xs:element name="processContext" type="tns:ProcessContextType"/> </xs:sequence> </xs:complexType>
</xs:element>

resumeProcessResponse

Returns a response for the resumeProcess operation

<xs:element name="resumeProcessResponse"> <xs:complexType />
</xs:element>