Connectors Reference
SAS Decisioning combines AI and business rules to automate operational decisions at scale. Use this connector to run decision models that are deployed on the SAS Viya platform.
|
Status: Preview |
Tier: Premium |
Version: 1 |
|
Name |
Summary |
|
Get loaded modules |
|
|
Get module |
|
|
getSteps (string moduleId, [internal]integer start, [internal]integer limit) |
Get module steps |
|
Get a specific step of the module |
|
|
executeStep (string moduleId, string stepId, stepInput input) |
Run step |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get loaded modules
Description: Retrieves the collection of modules that are loaded in memory by the service. Standard paging options are supported. The returned collection items are of type application/vnd.sas.microanalytic.module.
Syntax:
SASDecisioning.getModules ([internal]integer start, [internal]integer limit, [internal][Optional]string filter, [internal][Optional]string sortBy)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
start |
integer(int64) (start) |
The index of the first module to return. |
True |
|
|
limit |
integer (limit) |
The maximum number of modules to return. |
True |
|
|
filter |
string(filter-criteria) (filter) |
The criteria for filtering the modules. See [Filtering in REST APIs](https://developer.sas.com/apis/rest/Topics/#filters). |
False |
|
|
sortBy |
string(sort-criteria) (sortBy) |
The criteria for sorting the modules. See [Sorting in REST APIs](https://developer.sas.com/apis/rest/Topics/#sorting). |
False |
Returns:
Type:moduleCollectionModule Collection
Title: Module Collection
Description: A collection of module representations.
Summary: Get module
Description: For the specified module, returns detailed information including the steps that are contained in the module.
Syntax:
SASDecisioning.getModule (string moduleId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
moduleId |
string (module) |
The identifier of the module to retrieve. |
True |
Returns:
Type:moduleModule
Title: Module
Description: Describes a module that has been compiled and loaded by the service.
Summary: Get module steps
Description: Retrieves the collection of steps that correspond to a specific module.
Syntax:
SASDecisioning.getSteps (string moduleId, [internal]integer start, [internal]integer limit)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
moduleId |
string (module) |
The identifier of the module that contains the step collection. |
True |
|
|
start |
integer(int64) (start) |
The index of the first step to return. |
True |
|
|
limit |
integer (limit) |
The maximum number of steps to return. |
True |
Returns:
Type:stepCollectionStep Collection
Title: Step Collection
Description: A collection of step representations.
Summary: Get a specific step of the module
Description: Returns detailed information about the input and output signatures used to execute a specific step of the module.
Syntax:
SASDecisioning.getStep (string moduleId, string stepId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
moduleId |
string (module) |
The identifier of the module containing the step. |
True |
|
|
stepId |
string (step) |
The identifier of the step. |
True |
Returns:
Type:stepStep
Title: Step
Description: A representation of a unit of code to be executed, and its inputs and outputs.
Summary: Run step
Description: Executes the step with the specified input values. The `outputs` variable in the reply contains the output of the execution.
Syntax:
SASDecisioning.executeStep (string moduleId, string stepId, stepInput input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
moduleId |
string (module) |
The identifier of the module that contains the step to execute. |
True |
|
|
stepId |
string (step) |
The identifier of the step to execute. |
True |
|
|
input |
|
Describes the input values that are required when a step is validated or executed. |
True |
Returns:
Type:stepOutputStep Output
Title: Step Output
Description: This type describes the output values that are returned when a step is executed.
Summary:
Description: The value of the variable.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Describes a module that has been compiled and loaded by the service.
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
A generated unique string that identifies a module in an installation. |
|
name |
string
|
The name that is associated with a module. |
|
description |
string
|
Text that describes the rules and logic performed by the module. |
Summary:
Description: A collection of module representations.
Properties:
|
Name |
Type |
Summary |
|
items |
array of (module)
|
An array that contains module resources. |
Summary:
Description: A representation of a unit of code to be executed, and its inputs and outputs.
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
The identifier of a step that is included in the compiled module. The identifier is user-specified and is often a name for the step. |
|
moduleId |
string
|
The identifier of the module that contains the step. |
|
description |
string
|
Text that describes the logic performed by the step. |
|
inputs |
array of (stepParameter)
|
Describes information about the specific input values that should be specified in the request body when a step is executed. |
|
outputs |
array of (stepParameter)
|
Describes information about the specific output values that should be expected in the response body of step execution. |
Summary:
Description: A collection of step representations.
Properties:
|
Name |
Type |
Summary |
|
items |
array of (step)
|
An array that contains step resources. |
Summary:
Description: Describes the input values that are required when a step is validated or executed.
Properties:
|
Name |
Type |
Summary |
|
inputs |
array of (variable)
|
The values to pass to the step as inputs for validation or execution. The order of the variables should match the order presented in the input signature. |
Summary:
Description: This type describes the output values that are returned when a step is executed.
Properties:
|
Name |
Type |
Summary |
|
moduleId |
string
|
The identifier of the module that contains the executed step. |
|
stepId |
string
|
The name of the step that produced this output. |
|
outputs |
array of (variable)
|
The output values that are returned from an executed step. The order of the variables matches the order presented in the output signature. |
Summary:
Description: An object that describes the format of an input or output to a step.
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
The name of the input or output variable. |
|
type |
string
|
The data type of a variable. If the variable's type is (array of) integer, long, or decimal, the value must be a JSON (array of) number. If the variable's type is (array of) string or char, the value must be a JSON (array of) string. Only one-dimensional arrays are supported. Null is used to represent missing values. For DS2, decimal corresponds to the double data type. Values: [decimal, bigint, integer, string, binary, decimalArray, bigintArray, integerArray, stringArray, binaryArray] |
|
size |
integer
|
For a string type, this field indicates the length of the string and is at least one. For non-string types, this field is ignored. |
|
dim |
integer
|
For an array type, this field indicates the length of the array and is at least one. For non-array types, this field is ignored. |
Summary:
Description: A name/value pair that represents an input or output variable.
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Name of the variable. |
|
value |
|
The value of the variable. |
|
encoding |
string
|
The encoding of the variable value. It can be null or 'b64'. |