Skip to content

Commit 80b980c

Browse files
committed
Improve layout web service connectors readme.
1 parent c2fa416 commit 80b980c

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

ScriptRunner/WebSvcConnector/readme.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,14 @@ using the built-in Loopback WebService Connector instance, but the code is not l
1111
to local execution, it is only the ScriptRunner endpoint URL that needs more attention
1212
from remote.
1313

14+
## API Endpoints
15+
1416
The ScriptRunner WebService Connector provides three different endpoint APIs to start an Action:
1517
- Action OData API, on http[s]://server:port/ScriptRunner/ActionContextItem...
1618
- Action Webhook API, on http[s]://server:port/ScriptRunner/api2/PostWebhook/$ActionID
1719
- Azure PowerAutomate API, on http[s]://server:port/ScriptRunner/api2/StartAction
1820

19-
WebSvcConnector.ps1 is a container of three main functions, one for each of these endpoints.
21+
[WebSvcConnector.ps1](./WebSvcConnector.ps1) is a container of three main functions, one for each of these endpoints.
2022
So after you load (dot-source) the script, you have three functions available:
2123

2224
- Start-AsrWebSvcConnector to call the Action OData API,
@@ -26,13 +28,19 @@ So after you load (dot-source) the script, you have three functions available:
2628
The functions use Windows Integrated Auth (with the current user) by default, but also provide a
2729
$BasicAuthCreds PSCredential parameter for Basic Authentication.
2830
For the constructed API URLs to have the correct protocol, host, and port, you specify either
29-
the appropriate ScriptRunner endpoint (like 'http://server:port/ScriptRunner/' or
30-
'https://server:port/ScriptRunner/'; check your ScriptRunner installation to use the correct
31+
the appropriate ScriptRunner endpoint (like `http://server:port/ScriptRunner/` or
32+
`https://server:port/ScriptRunner/`; check your ScriptRunner installation to use the correct
3133
settings), or the complete API URL.
3234

3335
Other parameters provide the appropriate data for the respective API.
3436

35-
In addition to this WebSvcConnector.ps1 script, there are three scripts, one for each of the
37+
## Example Scripts
38+
39+
In addition to the [WebSvcConnector.ps1](./WebSvcConnector.ps1) script, there are three scripts, one for each of the
3640
APIs, that were formerly integrated as sample scripts in your ScriptRunner installation.
3741
For more details about the scripts, functions, and parameters, check the comprehensive
3842
Powershell help that is integrated into the scripts.
43+
44+
- Action OData API - [CallASRWebSvcConnector.ps1](./CallASRWebSvcConnector.ps1)
45+
- Action Webhook API - [CallASRWebhook.ps1](./CallASRWebhook.ps1)
46+
- Azure PowerAutomate API - [CallASRWebSvcConnector2.ps1](./CallASRWebSvcConnector2.ps1)

0 commit comments

Comments
 (0)