RestApiCategories.modelsAndDecisions.desc

models_and_decisions

2024.09

2024.11

2024.10

2024.12

The Business Rules API supports the creation and management of business rules. These business rules are organized within rule sets.

Business Rules

2024.08

2024.03

2023.03

2023.10

Viya_35

Verifies that the custom function compiles without errors.

A new reusable DS2 method with additional metadata.

New Function

A collection of errors and warnings from the rule validation. No paging is required for this end point.

Error Collection

The validations for the custom function were created.

Last-Modified

Indicates whether the response is coming from a SAS service.

Sas-Service-Response-Flag

Error

application/vnd.sas.error

This is an example of a base URL for businessRules service API guider.

Validate a custom function

A request that contains hints to generate the mapped code using the scoring definition by score object.

Request for Generating Score Code

A request that contains hints to generate the analysis code using the scoring execution.

Request for Generating Analysis Code

One page of rule set representations, with optional links to first, prev, next, and last page of the collection.

Rule Set Collection

One page of rule representations with optional links to first, prev, next, and last page of the collection.

Rule Collection

Rule Variable Collection

A collection of rules using the query response format.

A request to convert a rule action to a different type.

Rule Action Conversion

A request to convert a rule condition to a different type.

Rule Condition Conversion

One page of function category representations with optional links to the first, previous, next, and last pages of the collection.


Function Category Collection

One page of function representations with optional links to the first, previous, next, and last pages of the collection.


Function Collection

Lookup Collection

A collection of referenced resource representations.

Referenced Resources Collection

An un-paginated list of term usage summaries.

Term Usage Summary Collection

The object contains an unpaginated list of URIs of the direct dependents of this rule set.

Direct Dependent Objects

One page of the objects as resource summary representations, with optional links to the first, previous, next, and last page of the list.

Resource Summary Collection

Contains the structure of code that is needed to generate the decision code.

Decision Step Code

The summarized representation of a resource. Often used in collection responses when more specific details aren't needed.

Resource Summary

Executable code generated by a score object using a score definition and input data. This represents application/vnd.sas.score.mapped.code media type (version 1).

Mapped Code

The summarized representation of a decisioning revision resource.

Revision Resource Summary

The definition of a set of conditions and actions for use within a rule set. The defintion can also contain a rule that references a common rule, reference IDs and mappings. This represents application/vnd.sas.business.rule media type (version 4).

Rule

Business term defined by the user to be used as a variable for usage in expressions and mappings within rule sets or decisions. Terms of type data grid can have their internal structure defined further using extensions, these are fields that are found within each row of a data grid term.


Signature Term

The list of links to top-level resources and operations available from the root of the API.

An advanced list that is referenced by a business rule.

Advanced List in Business Rules

A named group to hold a related set of functions.

Function Category

Request containing hints and mappings to generate Mapped Code not bound to a score definition.

Unbound Code Generation Request

Conditional that evaluates to true or false.

Rule Condition

Rule query result representation for displaying rule logic from rule fired tables. This represents application/vnd.sas.business.rule.query.result media type (version 1).

Rule Query Result

A link to a related operation or resource.

Link

Action that is performed if a rule evaluated to true.

Rule Action

Analysis Code generated by a Score Object using Score Execution. This represents application/vnd.sas.score.analysis.code media type (version 1).

Analysis Code

The definition of a set of rules and the associated signature for them. This represents the `application/vnd.sas.business.rule.set.integral` media type (version 2).


Rule Set With Rules

Lookup

This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

Base Collection

The definition of a set of rules and the associated signature for them. This represents the `application/vnd.sas.business.rule.set` media type (version 10).


Rule Set

Selection

A summary representation of a term and it's usage.

Term Usage Summary

A reusable DS2 method with additional metadata.

Function

Describes the substitution of local rule set signature terms for signature terms from the referenced common rule set version.

Reference Rule Mapping

Lookup Value

An input parameter to a user-defined function.

Function Signature Term

Action referencing an Advanced List that is performed if a rule evaluated to true.

Rule Advanced List Action

The signature term extension is used to store the column information of a data grid variable.


Signature Term Extension

Terms that are a part of the signature for the object that is used in a decision step.

Decision Step Code Signature Term

List Data

Assigning Input Data column to a variable of the generated Mapped Code of Score Object. This doesn't represent any top-level media type.

Mapping

A reference to a lookup within a condition or action of a rule.

Lookup Reference

List Column

A reference to an Advanced List within an action of a rule.

Advanced List Reference

Function Signature Term DataGrid Extension is used to store the column information of a DataGrid variable.

Function Signature Term DataGrid Extension

A unit of the total expression. Each unit is logically AND'ed together.

Advanced List Expression Unit

Decision Step Code Signature Term DataGrid Extension is used to store the column information of a DataGrid variable.

Decision Step Code Signature Term DataGrid Extension

Describes the substitution of a local rule set signature term for a term of an expression.

Expression Term Mapping

A restriction or redaction on the presentation of a column's value when retrieving a list's contents.

Name	Type	Required	Description
description	string	false	A description of the function.
signature	array [Function Signature Term]	false	An ordered array of the input parameters to the function determined by parsing the function's code.
code	string	true	The DS2 function implementation, starting with the `method my_func();` statement.
testCustomContextUri	string	false	The URI of a Custom Context DS2 code file that provides a custom context to this function. Normally, this function's custom context is provided by the decision that utimately utilizes it. For syntax validation purpose, you can specify a testing-only custom context.

Status	Meaning	Description
200	OK	The validations for the custom function were created.	Headers	Schema
400	Bad Request	The request was invalid.		Schema

Validate a custom function

Request Samples

Response Samples

Request Body

Responses