Web Service Call
A dynamic web-service call to custom URL. Uses proxy settings defined in application variables PROXY and PROXYBYPASSLOCAL to make the request.
New to the component?
There's a tutorial.
Component mode: Batch mode
The batch mode is designed to make multiple web service calls. Either enqueue all calls in the "Get Requests" SQL call, or add them in the "Store Response" SQL call.
Component settings
<guid> is an automatically generated guid which is unique for each credential and should only be shown to developers.
<credentialsName> refers to the internal name of the credential to substitute with.
<credentialsField> refers to the credential value to substitute with. The possible fields are shown below.
| Possible value | Description |
|---|---|
| AccountName | Account name of credentials with type "Account". |
| Password | Password of credentials with type "Account". |
| Base64 | A base64-encoded string containing <AccountName>:<Password> of credentials with type "Account". |
| Secret | Secret of credentials with type "Secret". |
SQL
SQL Call: Get requests (mandatory)
Parameters
Resultset: Batch (optional)
Columns
BatchId optional string
Resultset: Requests
Columns
RequestId mandatory string
MethodName mandatory string
Username optional string
Password optional string
Url optional string
Credentials optional string
ProgressTitle optional string
ProgressText optional string
ProgressStepsCompleted optional int
ProgressStepsTotal optional int
BeginExtraParams optional any
Marker that indicates that all columns with a higher ordinal than this column will be passed as parameters to the procedure in the subsequent calls belonging to the same RequestId. This column must only contain NULL.
<xxx> optional any
Values in columns to the right of the BeginExtraParams column are passed as parameters to the procedure for the calls created by the command.
SQL Call: Get URL data
The call is only made if there is a UrlSuffix set in the meta data.
Parameters
Resultset: Get url data
Columns
<xxx> optional string
SQL Call: Get HTTP headers
The call is only made if there are headers in the meta data.
Parameters
Resultset: Http headers
Columns
<ColumnName> mandatory string
SQL Call: Get data
Get the data to send to the receiver. This is only called when the method does not use raw input. Otherwise the Get raw data call is used instead.
Parameters
Resultset: Data (optional)
Columns
<Primarykey_Column> optional int
<Foreignkey_Column> optional int
<xxx> optional string
SQL Call: Get raw data
Get the data to send to the receiver. This is only called when the method uses raw requests. Otherwise the Get data call is used instead.
Parameters
Resultset: Multipart extra info (optional)
Columns
MultipartContentType optional string
Resultset: Headers (optional)
Columns
PartId optional string
HttpHeaderName mandatory string
HttpHeaderValue mandatory string
Resultset: Content (optional)
Columns
PartId optional string
ContentType optional string
Encoding optional string
TextContent optional string
BinaryContent optional binary
SQL Call: Store response
Prior to this call data will be stored in the staging tables. This is only called when the method does not use raw output. Otherwise the Store raw response call is used instead.
Parameters
Resultset: Clear request queue (optional)
Columns
ClearQueue mandatory bit
Resultset: Requests (optional)
Columns
RequestId mandatory string
MethodName mandatory string
Username optional string
Password optional string
Url optional string
Credentials optional string
ProgressTitle optional string
ProgressText optional string
ProgressStepsCompleted optional int
ProgressStepsTotal optional int
BeginExtraParams optional any
Marker that indicates that all columns with a higher ordinal than this column will be passed as parameters to the procedure in the subsequent calls belonging to the same RequestId. This column must only contain NULL.
<xxx> optional any
Values in columns to the right of the BeginExtraParams column are passed as parameters to the procedure for the calls created by the command.
Resultset: #IdValues (optional)
Columns
Id mandatory bigint
Resultset: #HttpHeader (optional)
Columns
HttpHeaderName mandatory string
HttpHeaderValue mandatory string
SQL Call: Store raw response
Store the data recieved from the call. This is only called when the method uses raw responses. Otherwise the Store data call is used instead. The temporary tables #Content and #HttpHeader will be passed to the procedure.
Parameters
Resultset: Clear request queue (optional)
Columns
ClearQueue mandatory bit
Resultset: Requests (optional)
Columns
RequestId mandatory string
MethodName mandatory string
Username optional string
Password optional string
Url optional string
Credentials optional string
ProgressTitle optional string
ProgressText optional string
ProgressStepsCompleted optional int
ProgressStepsTotal optional int
BeginExtraParams optional any
Marker that indicates that all columns with a higher ordinal than this column will be passed as parameters to the procedure in the subsequent calls belonging to the same RequestId. This column must only contain NULL.
<xxx> optional any
Values in columns to the right of the BeginExtraParams column are passed as parameters to the procedure for the calls created by the command.
Resultset: #Content
Columns
ContentType mandatory string
TextContent mandatory string
BinaryContent mandatory binary
Resultset: #HttpHeader
Columns
HttpHeaderName mandatory string
HttpHeaderValue mandatory string
SQL Call: Store error (mandatory)
Parameters
Not set if the method uses raw responses.
Not set if the method uses raw responses.
SQL Call: Finished (mandatory)
Parameters
Resultset: Forwarding definitions (optional)
Columns
ADMIN_ErrorMessage optional string
Displays a user friendly error message to the user. This blocks any forwarding for the user.
ADMIN_ConfirmDelete optional string
Displays a user friendly confirmation message to the user with a delete button as the confirm button. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Delete'.
ADMIN_ConfirmQuestion optional string
Displays a user friendly confirmation message to the user with a question style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.
ADMIN_ConfirmWarning optional string
Displays a user friendly confirmation message to the user with a warning style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.
ADMIN_InfoMessage optional string
Displays a user friendly info message to the user. When the user clicks OK the user is forwarded.
ADMIN_SuccessMessage optional string
Displays a user friendly success message to the user. When the user clicks OK the user is forwarded.
ADMIN_Dialog optional string
The dialog alias of a predefined dialog to show the user. Must be the first column in the result set table. Use multiple result set tables to combine with other forwarding.
Use the menu item "Admin > Dialogs" to register new dialogs or find aliases for existing ones.
<xxx> (for ADMIN_Dialog) optional any
Any column without special meaning in the result set with the first column ADMIN_Dialog will be used to make replacements of placeholders in the message and title text.
ADMIN_DebugInfo optional string
Additional information to show the developer when using ADMIN_Dialog.
<passing_field> optional string
ADMIN_CancelCidStepsBack optional int
ADMIN_CancelReturnToMenuItem optional string
ADMIN_CancelMenuItem optional string
ADMIN_CancelMenuItemId optional int
Deprecated. Use ADMIN_CancelMenuItem instead.
Id of the menuitem to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.
ADMIN_CidStepsBack optional int
ADMIN_ReturnToMenuItem optional string
ADMIN_Force optional string
ADMIN_Forward optional string
ADMIN_ForwardLink optional string
ADMIN_ForwardMenuGroup optional string
Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.
ADMIN_ForwardMenuGroupId optional int
Deprecated. Use ADMIN_ForwardMenuGroup instead.
Id of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.
ADMIN_ForwardMenuItem optional string
ADMIN_ForwardMenuItemId optional int
Deprecated. Use ADMIN_ForwardMenuItem instead.
Id of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.
ADMIN_Message optional string
Displays a user friendly error message to the user.
ADMIN_PasteHtmlFromPopup optional string
ADMIN_SetFieldValueFromPopup optional string
ADMIN_ClosePopup optional bit
ADMIN_ClosePopupAndReloadOpener optional bit
If this column is anything but NULL the popup will be closed and the parent will be reloaded. Only select this column if the menu item is opened in a popup. Avoid using this feature if the opener is a newEdit as that may interrupt the user's ongoing input.
ADMIN_ClearHistory optional any
ADMIN_RefreshMenu optional bit
Cache optional string
CacheUserId optional string
Clears all caches (e.g. access permissions) related to the specified user id.
Use '%' to clear caches for all users.
CancelButtonText optional string
Changes the text of the Cancel button when used with ADMIN_Force, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete.
OkButtonText optional string
Changes the text of the OK button when used with ADMIN_ErrorMessage, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete, ADMIN_InfoMessage, ADMIN_SuccessMessage, ADMIN_Message, ADMIN_Force, or ADMIN_Forward. ADMIN_Force,
SQL Call: Validate parameters
Allows you to validate the SQL parameters before any other SQL is run in the component. This call is only made if the SQL is a stored procedure and Validate parameters is checked.
Parameters
Resultset: Messages (optional)
Columns
ADMIN_Force optional string
ADMIN_Message optional string
Custom access control and logging
SQL Call: Custom access control and logging
Use this call to restrict which entries a user is allowed to view and edit, and to log which entries a user views.
Access to a menu item is normally controlled through functions and roles alone but some entities need more fine grained control. For example, a user may have access to the View Member menu item for normal members but not for members with a protected identity.
The menu items a user visits are always logged (in ADMINLogMenuItem) but for sensitive data you may need to log exactly what entries are viewed. Do the logging in this call as the common ways of viewing data (grid and InfoSQL) are not allowed to modify the database.
If you bind a scalar function instead of a stored procedure to this call then its name must end with '_GrantAccess'.
Resultset: Access permissions
Columns
GrantAccess mandatory bit
If 0 then an error will be logged as the user should not have been able to reach the menu item with the given parameters in the first place.
Examples
Example requests
CREATE PROCEDURE [dbo].[WebServiceCall]
@Action nvarchar(max) = NULL,
@RequestId int = NULL,
@BatchId nvarchar(max) = NULL,
@ResponseEntityStagingId int = NULL,
@RequestXml nvarchar(max) = NULL,
@ResponseXml nvarchar(max) = NULL,
@ErrorMessage nvarchar(max) = NULL
AS
BEGIN
IF @Action = 'GetRequests'
BEGIN
SELECT
NEWID() AS BatchId;
SELECT
'MyMethod' AS MethodName,
CallQueueId AS RequestId
FROM
dbo.CallQueue;
RETURN;
END;
IF @Action = 'GetUrlData'
BEGIN
SELECT
DataValue AS UrlParameter
FROM
dbo.Data;
RETURN;
END;
IF @Action = 'GetData'
BEGIN
SELECT
DataId,
DataValue
FROM
dbo.Data;
SELECT
DataRowId,
DataId,
DataRowValue
FROM
dbo.DataRow;
RETURN;
END;
IF @Action = 'StoreError'
BEGIN
-- Depending on your situation
SELECT
@ErrorMessage = CONCAT('Error in procedure: ' + OBJECT_NAME(@@PROCID), @ErrorMessage);
-- INSERT INTO LogTable (and possibly display error in Finished call)
EXEC SoftadminApi.Log_LogError
@LogMessage = @ErrorMessage;
RETURN;
END;
IF @Action = 'StoreResponse'
BEGIN
DECLARE
@ResponseValue int;
SELECT
@ResponseValue = ResponseValue
FROM
ResponseEntityStaging
WHERE
ResponseEntityStagingId = @ResponseEntityStagingId;
EXEC dbo.InsertResponse
@ResponseValue = @ResponseValue;
-- Example: Cancel remaining requests if the response is incorrect
IF @ResponseValue = -1
BEGIN
SELECT
1 AS [ClearQueue];
END;
RETURN;
END;
IF @Action = 'Finished'
BEGIN
SELECT
1 AS ADMIN_ForwardMenuitemId,
@BatchId AS BatchId;
RETURN;
END;
END;
Minimal example
CREATE PROCEDURE [dbo].[WebServiceCall]
@Action nvarchar(max) = NULL,
@RequestId int = NULL,
@BatchId nvarchar(max) = NULL,
@RequestXml nvarchar(max) = NULL,
@ResponseXml nvarchar(max) = NULL,
@ErrorMessage nvarchar(max) = NULL
AS
BEGIN
IF @Action = 'GetRequests'
BEGIN
SELECT
'MyMethod' AS MethodName,
1 AS RequestId;
RETURN;
END;
IF @Action = 'GetUrlData'
BEGIN
RETURN;
END;
IF @Action = 'GetData'
BEGIN
RETURN;
END;
IF @Action = 'StoreError'
BEGIN
SELECT
@ErrorMessage = CONCAT('Error in procedure: ' + OBJECT_NAME(@@PROCID), @ErrorMessage);
EXEC SoftadminApi.Log_LogError
@LogMessage = @ErrorMessage;
RETURN;
END;
IF @Action = 'StoreResponse'
BEGIN
RETURN;
END;
IF @Action = 'Finished'
BEGIN
RETURN;
END;
END;
Raw example
CREATE PROCEDURE [dbo].[WebServiceCallRaw]
@Action nvarchar(max) = NULL,
@RequestId int = NULL,
@BatchId nvarchar(max) = NULL,
@RequestXml nvarchar(max) = NULL,
@ResponseXml nvarchar(max) = NULL,
@ErrorMessage nvarchar(max) = NULL,
@HttpStatusCode int = NULL
AS
BEGIN
IF @Action = 'GetRequests'
BEGIN
SELECT
'MyMethod' AS MethodName,
1 AS RequestId;
RETURN;
END;
IF @Action = 'GetUrlData'
BEGIN
RETURN;
END;
IF @Action = 'GetRawData'
BEGIN
SELECT
'MyHeader' AS HttpHeaderName,
'MyValue' AS HttpHeaderValue;
SELECT
'application/json' AS ContentType,
'{ "FirstName": "Adam" }' AS TextContent;
RETURN;
END;
IF @Action = 'StoreError'
BEGIN
SELECT
@ErrorMessage = CONCAT('Error in procedure: ' + OBJECT_NAME(@@PROCID), @ErrorMessage);
EXEC SoftadminApi.Log_LogError
@LogMessage = @ErrorMessage;
RETURN;
END;
IF @Action = 'StoreRawResponse'
BEGIN
DECLARE @ResponseText nvarchar(max);
IF (SELECT COUNT(*) FROM #Content) > 1
BEGIN
RAISERROR('Unexpected multipart reponse.', 16, 1);
END;
SELECT
@ResponseText = TextContent
FROM
#Content;
IF @HttpStatusCode = 200
BEGIN
EXEC dbo.StoreResponse
@ResponseText = @ResponseText;
END;
ELSE
BEGIN
SELECT
@ErrorMessage = CONCAT('WebServiceCall did not return an expected status code. Status code was ', @HttpStatusCode, '. ', @ResponseText);
EXEC SoftadminApi.Log_LogError
@LogMessage = @ErrorMessage;
END;
RETURN;
END;
IF @Action = 'Finished'
BEGIN
RETURN;
END;
END;