The commands object describes the commands available at the current endpoint. Object property names are command names. Each property represents an object of the following structure:
Name | Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | enum |
Obligatory. The command type:
|
||||||||||||||
source | string | Optional. Only makes sense for the sql type. Data source for the stored procedure. If not specified, taken from the parent element. | ||||||||||||||
schema | string | Optional. Only makes sense for the sql type. Name of the SQL schema for the stored procedure. If not specified, taken from the parent element. | ||||||||||||||
procedure | string | Required for the sql type. The name of the stored procedure. | ||||||||||||||
clrType | string | Required for the clr type. A string describing the build and the .NET type. | ||||||||||||||
file | string | String. Ther file name for business processes. | ||||||||||||||
parameters | object |
Optional.
For the sql type, it is an object whose properties are passed to the stored procedure as the static parameters. The property name is the name of the parameter, the value is the value of the parameter. For the callApi type, determine the command’s behavior. Learn more.... |
||||||||||||||
debugOnly | boolean |
The command will be executed only in the debug configuration ( configuration key of the appSettings section is "debug").
|
Sql type command executes a stored procedure. The procedure name is specified by the procedure
property. The Sql-schema is specified
by the schema
property or taken from the parent element (if not specified). The procedure is executed at the source, which is specified by the
source
or is taken from the parent element (if not specified).
The following parameters are passed to the procedure:
parameters
property.
Clr type command calls a method of the type specified by the clrType
property.
The type must implement the IInvokeTarget
. Learn more...
CallApi type command calls an external server via http. The behavior of the command is
determined by the parameters
parameters. Learn more....
SendMessage type command sends a message. The behavior of the command is determined by
the parameters
parameters. Learn more....