Interface IProcessEngineService
Assembly: Terrasoft.Core.ServiceModelContract.dll
Syntax
[ServiceContract(Name = "ProcessEngineService", Namespace = "http://Terrasoft.WebApp.ServiceModel")]
public interface IProcessEngineService
Methods
CancelExecution(Stream)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, UriTemplate = "CancelExecution")]
void CancelExecution(Stream data)
Parameters
Type |
Name |
Description |
System.IO.Stream |
data |
|
CancelExecutionBySchemaId(String)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "CancelExecutionBySchemaId?schemaId={schemaId}")]
string CancelExecutionBySchemaId(string schemaId)
Parameters
Type |
Name |
Description |
System.String |
schemaId |
|
Returns
Type |
Description |
System.String |
|
ChangeProcessElementState(ChangeProcessElementStateRequest)
Makes changes to inner state of the running process element.
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "ChangeProcessElementState")]
BaseResponse ChangeProcessElementState(ChangeProcessElementStateRequest request)
Parameters
Returns
ChangeToAppropriateDcmInstance(ChangeToAppropriateDcmInstanceRequest)
Changes to appropriate DCM instance.
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "ChangeToAppropriateDcmInstance")]
BaseRunProcessResponse ChangeToAppropriateDcmInstance(ChangeToAppropriateDcmInstanceRequest request)
Parameters
Returns
CompleteExecuting(String, String, String)
Declaration
[OperationContract]
[WebGet(BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "CompleteExecuting?procElUId={procElUId}&entitySchemaName={entitySchemaName}&entityId={entityId}")]
void CompleteExecuting(string procElUId, string entitySchemaName, string entityId)
Parameters
Type |
Name |
Description |
System.String |
procElUId |
|
System.String |
entitySchemaName |
|
System.String |
entityId |
|
CompleteExecuting(CompleteExecutingRequest)
Completes executing of specified process element.
Declaration
[OperationContract(Name = "CompleteExecutingRequest")]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "CompleteExecuting")]
CompleteExecutingResponse CompleteExecuting(CompleteExecutingRequest request)
Parameters
Returns
CompleteExecution(String)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "{procElUId}/CompleteExecution", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]
string CompleteExecution(string procElUId)
Parameters
Type |
Name |
Description |
System.String |
procElUId |
|
Returns
Type |
Description |
System.String |
|
ContinueExecuting(String)
Declaration
[OperationContract]
[WebGet(UriTemplate = "{processUId}/ContinueExecuting", RequestFormat = WebMessageFormat.Json)]
void ContinueExecuting(string processUId)
Parameters
Type |
Name |
Description |
System.String |
processUId |
|
ContinueExecutingPost(String, Stream)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "{processUId}/ContinueExecuting", RequestFormat = WebMessageFormat.Json)]
void ContinueExecutingPost(string processUId, Stream input)
Parameters
Type |
Name |
Description |
System.String |
processUId |
|
System.IO.Stream |
input |
|
DisableProcess(String)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "DisableProcess?sysSchemaId={sysSchemaId}")]
DisableProcessResponse DisableProcess(string sysSchemaId)
Parameters
Type |
Name |
Description |
System.String |
sysSchemaId |
|
Returns
EnableProcess(String)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "EnableProcess?sysSchemaId={sysSchemaId}")]
EnableProcessResponse EnableProcess(string sysSchemaId)
Parameters
Type |
Name |
Description |
System.String |
sysSchemaId |
|
Returns
ExecuteProcess(String)
Declaration
[OperationContract]
[WebGet(UriTemplate = "{processSchemaName}/Execute")]
void ExecuteProcess(string processSchemaName)
Parameters
Type |
Name |
Description |
System.String |
processSchemaName |
|
ExecuteProcessByCaptionPost(Stream)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "ExecuteByCaption", RequestFormat = WebMessageFormat.Json)]
void ExecuteProcessByCaptionPost(Stream input)
Parameters
Type |
Name |
Description |
System.IO.Stream |
input |
|
ExecuteProcessByUId(String)
Declaration
[OperationContract]
[WebGet(UriTemplate = "{processSchemaUId}/ExecuteByUId")]
void ExecuteProcessByUId(string processSchemaUId)
Parameters
Type |
Name |
Description |
System.String |
processSchemaUId |
|
ExecuteProcessByUIdPost(String, Stream)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", UriTemplate = "{processSchemaUId}/ExecuteByUId")]
void ExecuteProcessByUIdPost(string processSchemaUId, Stream input)
Parameters
Type |
Name |
Description |
System.String |
processSchemaUId |
|
System.IO.Stream |
input |
|
ExecuteProcessElementByUId(String)
Declaration
[OperationContract]
[WebGet(BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "ExecProcElByUId/{procElUId}?")]
void ExecuteProcessElementByUId(string procElUId)
Parameters
Type |
Name |
Description |
System.String |
procElUId |
|
ExecuteProcessPost(String, Stream)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", UriTemplate = "{processSchemaName}/Execute")]
void ExecuteProcessPost(string processSchemaName, Stream input)
Parameters
Type |
Name |
Description |
System.String |
processSchemaName |
|
System.IO.Stream |
input |
|
ExecuteProcessWithResult(String, String)
Declaration
[OperationContract]
[WebGet(UriTemplate = "{processSchemaName}/Execute?ResultParameterName={resultParameterName}")]
string ExecuteProcessWithResult(string processSchemaName, string resultParameterName)
Parameters
Type |
Name |
Description |
System.String |
processSchemaName |
|
System.String |
resultParameterName |
|
Returns
Type |
Description |
System.String |
|
ExecuteProcessWithResultPost(String, String, Stream)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", UriTemplate = "{processSchemaName}/Execute?ResultParameterName={resultParameterName}")]
string ExecuteProcessWithResultPost(string processSchemaName, string resultParameterName, Stream input)
Parameters
Type |
Name |
Description |
System.String |
processSchemaName |
|
System.String |
resultParameterName |
|
System.IO.Stream |
input |
|
Returns
Type |
Description |
System.String |
|
GetDcmExecutionData(DcmExecutionDataRequest)
Returns data for the opening page by the specified dcm elements.
Declaration
[OperationContract(Name = "DcmExecutionDataRequest")]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "GetDcmExecutionData")]
ProcessExecutionDataResponse GetDcmExecutionData(DcmExecutionDataRequest request)
Parameters
Returns
GetExecutionData(String, String)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "GetExecutionData?ProcElUId={procElUId}&RecordId={recordId}")]
string GetExecutionData(string procElUId, string recordId)
Parameters
Type |
Name |
Description |
System.String |
procElUId |
|
System.String |
recordId |
|
Returns
Type |
Description |
System.String |
|
GetExecutionData(ProcessExecutionDataRequest)
Returns data for the opening page by the specified elements.
Declaration
[OperationContract(Name = "ProcessExecutionDataRequest")]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "GetExecutionData")]
ProcessExecutionDataResponse GetExecutionData(ProcessExecutionDataRequest request)
Parameters
Returns
GetProcessElementStatus(ProcessElementStatusRequest)
Gets the specified process element running status.
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "GetProcessElementStatus")]
ProcessElementStatusResponse GetProcessElementStatus(ProcessElementStatusRequest request)
Parameters
Returns
GetProcessSchemaDebugInfo(String, String, String)
Returns process schema internal information.
Declaration
[OperationContract]
[WebGet(UriTemplate = "GetProcessSchemaDebugInfo?schema={schema}&manager={manager}&type={type}")]
void GetProcessSchemaDebugInfo(string schema, string manager, string type)
Parameters
Type |
Name |
Description |
System.String |
schema |
Schema name or UId.
|
System.String |
manager |
Manager name.
|
System.String |
type |
Debug information type.
|
GetRunningProcessCount(GetRunningProcessCountRequest)
Gets running process count for all process schema versions.
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "GetRunningProcessCount", ResponseFormat = WebMessageFormat.Json)]
int GetRunningProcessCount(GetRunningProcessCountRequest request)
Parameters
Returns
Type |
Description |
System.Int32 |
The number of running processes for all process schema versions.
|
GetTimerEventsInfo(Guid)
Gets timer events information.
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "GetTimerEventsInfo")]
TimerEventsInfoResponse GetTimerEventsInfo(Guid processSchemaUId)
Parameters
Type |
Name |
Description |
System.Guid |
processSchemaUId |
UId of process schema.
|
Returns
RunProcess(String)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "{processName}/RunProcess")]
string RunProcess(string processName)
Parameters
Type |
Name |
Description |
System.String |
processName |
|
Returns
Type |
Description |
System.String |
|
RunProcess(RunProcessRequest)
Declaration
[OperationContract(Name = "Run")]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "RunProcess", ResponseFormat = WebMessageFormat.Json)]
RunProcessResponse RunProcess(RunProcessRequest request)
Parameters
Returns
RunProcessForEachValue(RunProcessForEachValueRequest)
Runs process for each specified record.
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "RunProcessForEachValue")]
BaseRunProcessResponse RunProcessForEachValue(RunProcessForEachValueRequest request)
Parameters
Returns
Runs process for each record matched with specified filter.
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "RunProcessForMatchingRecords")]
BaseRunProcessResponse RunProcessForMatchingRecords(RunProcessForMatchingRecordsRequest request)
Parameters
Returns
RunSpecifiedProcessVersion(RunSpecifiedProcessVersionRequest)
Runs the specified process version.
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "RunSpecifiedProcessVersion", ResponseFormat = WebMessageFormat.Json)]
RunProcessResponse RunSpecifiedProcessVersion(RunSpecifiedProcessVersionRequest request)
Parameters
Returns
ThrowSignal(String)
Declaration
[OperationContract]
[WebGet(BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "ThrowSignal?signal={signal}")]
void ThrowSignal(string signal)
Parameters
Type |
Name |
Description |
System.String |
signal |
|
ThrowSignalPost(String, Stream)
Declaration
[OperationContract]
[WebInvoke(Method = "POST", BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json, UriTemplate = "ThrowSignal?signal={signal}")]
void ThrowSignalPost(string signal, Stream input)
Parameters
Type |
Name |
Description |
System.String |
signal |
|
System.IO.Stream |
input |
|
Extension Methods