RestApiCategories.modelsAndDecisions.desc

models_and_decisions

2025.01

2025.02

2024.12

The Decisions API supports the life cycle of decision data.

Decisions

2024.11

2024.10

2024.09

2024.03

2024.08

2023.10

2023.03

Viya_35

Terminates the workflow for the specified decision revision.

decisionId

The identifier for the decision revision.

revisionId

An indicator for whether the response is coming from a SAS service.

Sas-Service-Response-Flag

errorResponse

No workflow exists at the requested path.

An error occurred while terminating the workflow.

Terminate a workflow

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

Analysis Code

Request containing hints to generate Analysis Code using the Scoring Execution. This represents application/vnd.sas.dcm.score.analysis.code.generation.request media type (version 1).

Analysis Code Generation Request

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

Represents a term that is being recorded for auditing purposes during contact recording.

Audit Term

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 error reported from CAS while validating the expression.

CAS Error from Expression Validation

A code file that accepts its code as a property. This represents
application/vnd.sas.decision.code.file.with.code media type (version 1).

This variant of code file is useful for creating a code file revision without
managing the creation of the underlying file resources used to store the code.


Code File

Wrapper to file resource, which contains the signature of the code. This represents application/vnd.sas.decision.code.file media type (version 9).


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

Code File Collection

Code File Signature Term

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

Code File Signature Term DataGrid Extension

Represents a step containing a custom implemented step within the decision flow. Treatment groups, code files, and other decisions can be referenced using a custom object step.

Custom Object Decision Step

Decision

Represents a branch decision flow step. A branch step contains a list of branchCases and a defaultCase. During the execution of a branch step each branchCases condition is evaluated in order. The decision flow will follow the first branchCases condition that evaluates as true. If a branchCases condition does not evaluate as true, then the defaultCase path for the branchStep is followed.

Decision Branch Step

Represents a single case within a branch step of a decision flow. A case can contain a simpleCondition or compoundCondition, but not both.

Decision Case

A paginated list of decision representations, with optional links to first, prev, next, and last page of the collection.

Decision Collection

Represents a compound condition.  The left hand side (lhs), right hand side (rhs) and operator of the condition are evaluated to produce a boolean result of "true" or "false".  A compound condition has a left hand side (lhsSimpleCondition or lhsCompoundCondition) a right hand side (rhsSimpleCondition or rhsCompoundCondition) and a boolean operator.

Decision Compound Branch Condition

Decision Condition Step

Represents a condition step within a decision flow.

Represents a term that is used for a condition comparison within a decision.

Decision Condition Term

Decision Custom Object Step

Represents where an error occurred during execution of a decision scoring test.

Decision Error Marker

A collection of error markers for a decision scoring test.

Decision Error Marker Collection

Represents an error that occurred during execution of a decision scoring test

Decision Error Marker Message

Contains information about an expression to be validated. The expression may contain literals, terms, built in functions and custom functions.

Decision Expression Validation Request

The response from validating the expression.

Decision Expression Validation Response

Decision Flow

Decision Model Step

The representation of a rule set, model, treatment group, code file, or sub-decision used in a decision flow, including those used by sub-decisions.

Decision Node Reference Object

A collection of decision node reference objects.

Decision Node Reference Object Collection

Contains information needed to extend the decision flow with a new node type

Decision Node Type

Contains information needed to extend the decision flow with a new node type including the decision node type's signature and provision for acquiring decision step code for the associated decision node type.

Decision Node Type Content

A paginated list of decision node type representations, with optional links to first, prev, next, and last page of the collection.

Decision Node Types Collection

Decision Record Contact Step

Decision Rule Set Step

Represents a simple condition.  The left hand side (lhs), right hand side (rhs) and operator of the condition are evaluated to produce a boolean result of "true" or "false".  The left hand side may be a variable or an experssion.

Decision Simple Branch Condition

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

Decision Step Code

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

Decision Step Code Signature Term

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

Represents the mapping between the terms input and output by a decision step and the signature entries of the decision.

Decision Step Mapping

A decision type modifies the available functionality that can be used to build a decision. 
Currently it controls the available decision node types that can be used to build a decision.


Decision Type

A paginated list of decision type representations, with optional links to first, prev, next, and last page of the collection.

Decision Type Collection

Decision Validation Error

A collection of validation errors for a decision.

Decision Validation Errors Collection

A collection of variables for a decision.

Decision Variable Collection

The object contains an unpaginated list of URIs of the direct dependents of this resource. A resource can be a decision or a code file.

Direct Dependent Objects

Error

Contains the details about the external artifact.

External Artifact

A collection of external artifact representations.

External Artifacts Collection

A link to a related operation or resource.

Link

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

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

Represents a model be referenced as a step within a decision flow.

Model Decision Step

Represents a link within a decision flow, which directs the execution flow of the decision to an arbitrary node based on the linkLabel of the target node.

Node Link Decision Step

Represents the user specifying that contact information should be recorded at this step within the flow and details that should be recorded.

Record Decision Contact Step

The representation of a decision, which may be the parent or a sub-decision, that references a specific decision node reference object.

Referencing Decision

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

Resource Summary

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

The summarized representation of a decisioning revision resource.

Revision Resource Summary

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

Revision Summary Collection

Specifies the rule set that is being referenced for this step. Required if type is set to 'application/vnd.sas.decision.step.ruleset'.

Rule Set Decision Step

Request containing hints to generate mapped code using the Scoring Definition by Score Object.

Score Code Generation Request

The representation of a segmentation tree.

Segmentation Tree

Named boolean expression which evaluates to a boolean value.

Segmentation Tree Boolean Expression

Segmentation Tree Boolean Expression Node

Outcome action in which a specified code is executed to assign values to variables.

Segmentation Tree Code Assignment Outcome Action

A paginated list of segmentation tree representations, with optional links to the first, previous, next, and last page of the collection.

Segmentation Tree Collection

Code file which is internal to the segmentation tree

Segmentation Tree Internal Code File

Two dimensional array with down and across variable values with their intersection outcomes.

Segmentation Tree Matrix

Segmentation Tree Matrix Node

Outcome contains actions to assign values to variables.

Segmentation Tree Outcome

Represents a term that is used within a segmentation tree.

Segmentation Tree Signature Term

Segmentation Tree Value Node

Outcome action in which a variable is assigned a value

Segmentation Tree Variable Assignment Outcome Action

Segmentation Tree Variable Node

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

Signature Term Extension

Represents the parent decision associated with the decision component

Tag Merge Component Parent Decision

Represents the revision for the component that has the specified tags associated with it

Tag Merge Component Revision Reference

Represents an individual decision component to be included in a tag based merge.

Tag Merge Decision Component

An un-paginated list of tag merge decision components.

Tag Merge Decision Component Collection

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

Term Usage Summary

An un-paginated list of term usage summaries.

Term Usage Summary Collection

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

Status	Meaning	Description
204	No Content	The workflow was terminated.	Headers
400	Bad Request	The request was invalid.	Headers	Schema
404	Not Found	No workflow exists at the requested path.	Headers	Schema
500	Internal Server Error	An error occurred while terminating the workflow.	Headers	Schema

Terminate a workflow

Request Samples

Response Samples

Path Parameters

Responses

Name	Type	Required	Description
decisionId	string	true	The identifier for the decision.
revisionId	string	true	The identifier for the decision revision.