Execute Web API definition

Description

Executes a Web API that runs until the Workflow is requested to stop.

Assembly: iCore.Workflow.Activites
Category: iCPS

Arguments

	Name	Type	Description
	Arguments	Object	The startup arguments to pass as argument to the Web APIs controller constructor. Must be of same type as the startup argument of the controller constructor. Add a reference to the Web APIs type assembly using the Modify references tool to get access to the type to use. Set to Nothing or leave empty if the controller does not have a startup argument. For more information about startup arguments, see Web API startup arguments.
	Endpoint	String	The endpoint address for the hosted Web API.
	Web API	Guid	The ID of the Web API to execute.
	Startup timeout	TimeSpan	The startup timeout for the Web API.
	Shutdown timeout	TimeSpan	The shutdown timeout for the Web API, i.e. the amount of time that the Web API is allotted for shutdown. During this time, the shutdown will wait for ongoing requests to complete. Any request that does not complete within this time window will be terminated. The timeout is only taken into consideration if the activity performs graceful shutdown of the Web API host.
	Certificate file	String	The certificate file used for secure connections.
	Certificate file password	String	The password for the certificate file.
	Certificate store name	StoreName	The store name of the certificate.
	Certificate store location	StoreLocation	The store location of the certificate.
	Certificate subject	String	The subject of the certificate to load from the store.
	Allow invalid certificate	Boolean	If true, an invalid certificates will be considered, such as self-signed certificates.

Remarks

Setting up HTTPS hosting

HTTPS is automatically used by the host when the endpoint address starts with 'https://'. When using HTTPS a certificate should be defined by configuring either a certificate from a file or a certificate from the system store, but not both.

A certificate from a file can be specified using the Certificate file and Certificate file password arguments. A certificate from the system store can be specified by using the Certificate store name, Certificate store location, Certificate subject and Allow invalid certificate arguments.

note

HTTPS is not supported when using legacy WebAPI definitions.

See Also

Entities

Web API

Web APIs

Creating a Web API
Creating a Workflow for hosting a Web API