77namespace WorkflowServer . CallbackApi . Controllers ;
88
99/// <summary>
10- /// This controller implements all possible requests from Callback API of WFS 3.0.0.
10+ /// This controller implements all possible requests from Callback API of Workflow Server 3.0.0.
1111/// Callback API allows hosting your code of Actions, Conditions or Rules on third-party servers.
1212/// Callback server should be connected in the admin panel on the Callback API page.
1313/// More details on the <see href="https://workflowserver.io/documentation/callback-api">workflowserver.io</see>
@@ -23,17 +23,28 @@ public ApiController(ILogger<ApiController> logger)
2323 _actionProvider = new ActionProvider ( ) ;
2424 _conditionProvider = new ConditionProvider ( ) ;
2525 _identityProvider = new IdentityProvider ( ) ;
26+
27+ //The parameters will not be saved, this is an example. You should add the provider as a dependency injection.
2628 _parameterProvider = new ParameterProvider ( ) ;
2729 }
2830
2931 #region Actions & Conditions Execution
3032
33+ /// <summary>
34+ /// Returns a list of actions that can be executed on the callback server.
35+ /// When the Workflow Server should execute an Action with a certain name,
36+ /// it calls the action execution method on the server that has returned this
37+ /// name in response to the request for the list of actions.
38+ /// </summary>
3139 [ HttpGet ]
3240 public Task < IActionResult > GetActions ( string schemeCode , string token )
3341 {
3442 return Task . FromResult < IActionResult > ( Ok ( ApiResponse . Ok ( _actionProvider . ActionNames ) ) ) ;
3543 }
3644
45+ /// <summary>
46+ /// Request to execute the action. Which of callback servers is called to execute this method, depends on the list of actions returned.
47+ /// </summary>
3748 [ HttpPost ]
3849 public async Task < IActionResult > ExecuteAction ( InstanceRequest request )
3950 {
@@ -42,12 +53,22 @@ public async Task<IActionResult> ExecuteAction(InstanceRequest request)
4253 return Ok ( ApiResponse . Ok ( ) ) ;
4354 }
4455
56+ /// <summary>
57+ /// Returns a list of conditions that can be executed on the callback server.
58+ /// When the Workflow Server should execute a condition with a certain name,
59+ /// it calls the condition execution method on the server that has returned
60+ /// this name in response to the request for the list of conditions.
61+ /// </summary>
4562 [ HttpGet ]
4663 public Task < IActionResult > GetConditions ( string schemeCode , string token )
4764 {
4865 return Task . FromResult < IActionResult > ( Ok ( ApiResponse . Ok ( _conditionProvider . ConditionNames ) ) ) ;
4966 }
5067
68+ /// <summary>
69+ /// Request to execute the condition. Which of the callback servers
70+ /// is called to execute this method, depends on the list of conditions returned.
71+ /// </summary>
5172 [ HttpPost ]
5273 public async Task < IActionResult > ExecuteCondition ( InstanceRequest request )
5374 {
@@ -63,19 +84,31 @@ public async Task<IActionResult> ExecuteCondition(InstanceRequest request)
6384
6485 #region Authorization Rules Execution
6586
87+ /// <summary>
88+ /// Returns a list of Authorization Rules that can be executed on the callback server.
89+ /// When the Workflow Server should execute an Authorization Rule with a certain name,
90+ /// it calls the Authorization Rule execution method on the server that has returned
91+ /// this name in response to the request for the list of Authorization Rules.
92+ /// </summary>
6693 [ HttpGet ]
6794 public Task < IActionResult > GetRules ( string schemeCode , string token )
6895 {
6996 return Task . FromResult < IActionResult > ( Ok ( ApiResponse . Ok ( _identityProvider . RuleNames ) ) ) ;
7097 }
7198
99+ /// <summary>
100+ /// Check if the User has the access to the command.
101+ /// </summary>
72102 [ HttpPost ]
73103 public async Task < IActionResult > CheckRule ( CheckRuleRequest request )
74104 {
75105 var result = await _identityProvider . RuleCheck ( request . Name , request . IdentityId , request . Parameter , request . ProcessInstance ) ;
76106 return Ok ( ApiResponse . Ok ( result ) ) ;
77107 }
78108
109+ /// <summary>
110+ /// Returns the list of all Users who have the access.
111+ /// </summary>
79112 [ HttpPost ]
80113 public async Task < IActionResult > GetIdentities ( InstanceRequest request )
81114 {
@@ -89,6 +122,11 @@ public async Task<IActionResult> GetIdentities(InstanceRequest request)
89122
90123 #region Remote Scheme Generation
91124
125+ /// <summary>
126+ /// Workflow Engine (is a part of WorkflowServer) supports scheme generation. If you include this method, then,
127+ /// to initialize a new scheme, the Workflow Server calls it on all the connected
128+ /// servers with the settings containing the address of this method.
129+ /// </summary>
92130 [ HttpPost ]
93131 public Task < IActionResult > Generate ( GenerateRequest request )
94132 {
@@ -103,6 +141,10 @@ public Task<IActionResult> Generate(GenerateRequest request)
103141
104142 #region Event Handlers
105143
144+ /// <summary>
145+ /// The ProcessStatusChanged event is called only after switching to
146+ /// the statuses of Idled and Finalized. It is not called for subprocesses.
147+ /// </summary>
106148 [ HttpPost ]
107149 public Task < IActionResult > ProcessStatusChanged ( StatusChangedRequest request )
108150 {
@@ -114,6 +156,9 @@ public Task<IActionResult> ProcessStatusChanged(StatusChangedRequest request)
114156 return Task . FromResult < IActionResult > ( Ok ( ApiResponse . Ok ( ) ) ) ;
115157 }
116158
159+ /// <summary>
160+ /// The ProcessActivityChanged event.
161+ /// </summary>
117162 [ HttpPost ]
118163 public Task < IActionResult > ProcessActivityChanged ( ActivityChangedRequest request )
119164 {
@@ -125,6 +170,9 @@ public Task<IActionResult> ProcessActivityChanged(ActivityChangedRequest request
125170 return Task . FromResult < IActionResult > ( Ok ( ApiResponse . Ok ( ) ) ) ;
126171 }
127172
173+ /// <summary>
174+ /// The processLogs event.
175+ /// </summary>
128176 [ HttpPost ]
129177 public Task < IActionResult > ProcessLog ( LogRequest request )
130178 {
@@ -137,19 +185,28 @@ public Task<IActionResult> ProcessLog(LogRequest request)
137185
138186 #region Parameters Providing
139187
188+ /// <summary>
189+ /// Used to get parameters list.
190+ /// </summary>
140191 [ HttpGet ]
141192 public Task < IActionResult > GetParameterNames ( string schemeCode , string token )
142193 {
143194 return Task . FromResult < IActionResult > ( Ok ( ApiResponse . Ok ( _parameterProvider . GetNames ) ) ) ;
144195 }
145196
197+ /// <summary>
198+ /// The method returns a JSON serialized parameter value.
199+ /// </summary>
146200 [ HttpPost ]
147201 public Task < IActionResult > GetParameter ( ParameterRequest request )
148202 {
149203 var result = _parameterProvider . GetParameter ( request . Name ) ;
150204 return Task . FromResult < IActionResult > ( Ok ( ApiResponse . Ok ( result ) ) ) ;
151205 }
152206
207+ /// <summary>
208+ /// Used for set parameter value.
209+ /// </summary>
153210 [ HttpPost ]
154211 public Task < IActionResult > SetParameter ( ParameterRequest request )
155212 {
0 commit comments