Operation getVariables |
Name: |
getVariables |
Signature: |
getVariables (instanceId {xs:string}) => variable {workflow:Variable}* |
Java signature: |
List<org.matrix.workflow.Variable> getVariables(String instanceId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
instanceId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
variable |
workflow:Variable |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getVariables xmlns:ns2="http://workflow.matrix.org/">
<instanceId>{xs:string}</instanceId>
</ns2:getVariables>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getVariablesResponse xmlns:ns2="http://workflow.matrix.org/">
<variable>
<name>{xs:string}</name>
<value>{xs:string}</value>
<type>{xs:string}</type>
</variable>
</ns2:getVariablesResponse>
</S:Body>
</S:Envelope> |
Operation setVariables |
Name: |
setVariables |
Signature: |
setVariables (instanceId {xs:string}, variable {workflow:Variable}*) => variableCount {xs:int} |
Java signature: |
int setVariables(String instanceId, List<org.matrix.workflow.Variable> variable) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
instanceId |
xs:string |
1 |
false |
false |
|
variable |
workflow:Variable |
0..N |
true |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
variableCount |
xs:int |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:setVariables xmlns:ns2="http://workflow.matrix.org/">
<instanceId>{xs:string}</instanceId>
<variable>
<name>{xs:string}</name>
<value>{xs:string}</value>
<type>{xs:string}</type>
</variable>
</ns2:setVariables>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:setVariablesResponse xmlns:ns2="http://workflow.matrix.org/">
<variableCount>{xs:int}</variableCount>
</ns2:setVariablesResponse>
</S:Body>
</S:Envelope> |
Operation destroyInstance |
Name: |
destroyInstance |
Signature: |
destroyInstance (instanceId {xs:string}) => destroyed {xs:boolean} |
Java signature: |
boolean destroyInstance(String instanceId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
instanceId |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
destroyed |
xs:boolean |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:destroyInstance xmlns:ns2="http://workflow.matrix.org/">
<instanceId>{xs:string}</instanceId>
</ns2:destroyInstance>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:destroyInstanceResponse xmlns:ns2="http://workflow.matrix.org/">
<destroyed>{xs:boolean}</destroyed>
</ns2:destroyInstanceResponse>
</S:Body>
</S:Envelope> |
Operation assignAgent |
Name: |
assignAgent |
Signature: |
assignAgent (instanceId {xs:string}, agentName {xs:string}) => agent {xs:string} |
Java signature: |
String assignAgent(String instanceId, String agentName) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
instanceId |
xs:string |
1 |
false |
false |
|
agentName |
xs:string |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
agent |
xs:string |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:assignAgent xmlns:ns2="http://workflow.matrix.org/">
<instanceId>{xs:string}</instanceId>
<agentName>{xs:string}</agentName>
</ns2:assignAgent>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:assignAgentResponse xmlns:ns2="http://workflow.matrix.org/">
<agent>{xs:string}</agent>
</ns2:assignAgentResponse>
</S:Body>
</S:Envelope> |
Operation processInstance |
Name: |
processInstance |
Signature: |
processInstance (instanceId {xs:string}, variable {workflow:Variable}*, returnVariables {xs:boolean}) => outVariable {workflow:Variable}* |
Java signature: |
List<org.matrix.workflow.Variable> processInstance(String instanceId, List<org.matrix.workflow.Variable> variable, boolean returnVariables) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
instanceId |
xs:string |
1 |
false |
false |
|
variable |
workflow:Variable |
0..N |
true |
false |
|
returnVariables |
xs:boolean |
1 |
false |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
outVariable |
workflow:Variable |
0..N |
true |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:processInstance xmlns:ns2="http://workflow.matrix.org/">
<instanceId>{xs:string}</instanceId>
<variable>
<name>{xs:string}</name>
<value>{xs:string}</value>
<type>{xs:string}</type>
</variable>
<returnVariables>{xs:boolean}</returnVariables>
</ns2:processInstance>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:processInstanceResponse xmlns:ns2="http://workflow.matrix.org/">
<outVariable>
<name>{xs:string}</name>
<value>{xs:string}</value>
<type>{xs:string}</type>
</outVariable>
</ns2:processInstanceResponse>
</S:Body>
</S:Envelope> |
Operation findInstances |
Name: |
findInstances |
Signature: |
findInstances (filter {workflow:InstanceFilter}) => instanceView {workflow:InstanceView}* |
Java signature: |
List<org.matrix.workflow.InstanceView> findInstances(org.matrix.workflow.InstanceFilter filter) |
Parameters: |
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findInstances xmlns:ns2="http://workflow.matrix.org/">
<filter>
<variable>
<name>{xs:string}</name>
<value>{xs:string}</value>
<extendedVisibility>{xs:boolean}</extendedVisibility>
</variable>
<startDate>{mx:date}</startDate>
<endDate>{mx:date}</endDate>
<firstResult>{xs:int}</firstResult>
<maxResults>{xs:int}</maxResults>
</filter>
</ns2:findInstances>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:findInstancesResponse xmlns:ns2="http://workflow.matrix.org/">
<instanceView>
<instanceId>{xs:string}</instanceId>
<name>{xs:string}</name>
<version>{xs:string}</version>
<description>{xs:string}</description>
<state>{xs:string}</state>
<activeNodes>{xs:string}</activeNodes>
<startDateTime>{mx:dateTime}</startDateTime>
<simulation>{xs:boolean}</simulation>
<destroyButtonEnabled>{xs:boolean}</destroyButtonEnabled>
</instanceView>
</ns2:findInstancesResponse>
</S:Body>
</S:Envelope> |
Operation createInstance |
Name: |
createInstance |
Signature: |
createInstance (workflowName {xs:string}, variable {workflow:Variable}*) => instanceId {xs:string} |
Java signature: |
String createInstance(String workflowName, List<org.matrix.workflow.Variable> variable) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
workflowName |
xs:string |
1 |
false |
false |
|
variable |
workflow:Variable |
0..N |
true |
false |
|
|
Response: |
name |
xml type |
occurs |
nillable |
read only |
references |
instanceId |
xs:string |
1 |
false |
false |
|
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createInstance xmlns:ns2="http://workflow.matrix.org/">
<workflowName>{xs:string}</workflowName>
<variable>
<name>{xs:string}</name>
<value>{xs:string}</value>
<type>{xs:string}</type>
</variable>
</ns2:createInstance>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createInstanceResponse xmlns:ns2="http://workflow.matrix.org/">
<instanceId>{xs:string}</instanceId>
</ns2:createInstanceResponse>
</S:Body>
</S:Envelope> |
Operation getInstanceEvents |
Name: |
getInstanceEvents |
Signature: |
getInstanceEvents (instanceId {xs:string}) => instanceEvent {workflow:InstanceEvent}* |
Java signature: |
List<org.matrix.workflow.InstanceEvent> getInstanceEvents(String instanceId) |
Parameters: |
name |
xml type |
occurs |
nillable |
read only |
references |
instanceId |
xs:string |
1 |
false |
false |
|
|
Response: |
|
Sample input message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getInstanceEvents xmlns:ns2="http://workflow.matrix.org/">
<instanceId>{xs:string}</instanceId>
</ns2:getInstanceEvents>
</S:Body>
</S:Envelope> |
Sample output message: |
<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getInstanceEventsResponse xmlns:ns2="http://workflow.matrix.org/">
<instanceEvent>
<instanceId>{xs:string}</instanceId>
<eventNum>{xs:int}</eventNum>
<dateTime>{mx:dateTime}</dateTime>
<actorName>{xs:string}</actorName>
<variableChange>
<name>{xs:string}</name>
<type>{xs:string}</type>
<oldValue>{xs:string}</oldValue>
<newValue>{xs:string}</newValue>
</variableChange>
</instanceEvent>
</ns2:getInstanceEventsResponse>
</S:Body>
</S:Envelope> |