RestApiCategories.modelsAndDecisions.desc

models_and_decisions

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

Updates the contents of a decision type with a given ID.

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

The representation of an existing decision type with updates.

The `ETag` value from when the originating object was retrieved.

If-Match

flowTypeId

Indicates whether the response is coming from a SAS service.

Sas-Service-Response-Flag

ETag

The timestamp in the format `EEE, dd MMM yyyy HH:mm:ss GMT` for when the decision type content was last modified.

Last-Modified

Location

Error

application/vnd.sas.error

The `If-Match` request header did not match the resource's entity tag.

The request headers did not include an `If-Match`.

Update a decision type by ID

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

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

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

Decision Collection

A collection of decision node reference objects.

Decision Node Reference Object Collection

Contains the details about the external artifact.

External Artifact

A collection of external artifact representations.

External Artifacts Collection

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

Code File Collection

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

Segmentation Tree Collection

A collection of variables for a decision.

Decision Variable Collection

A collection of validation errors for a decision.

Decision Validation Errors Collection

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

An un-paginated list of term usage summaries.

Term Usage Summary Collection

A collection of error markers for a decision scoring test.

Decision Error Marker Collection

An un-paginated list of tag merge decision components.

Tag Merge Decision Component 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

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

Decision Type Collection

The error reported from CAS while validating the expression.

CAS Error from Expression Validation

The response from validating the expression.

Decision Expression Validation Response

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

Decision Expression Validation Request

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


Code File

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 representation of a segmentation tree.

Segmentation Tree

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

Decision Error Marker

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

Score Code Generation Request

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

Unbound Code Generation Request

The summarized representation of a decisioning revision resource.

Revision Resource Summary

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

Term Usage Summary

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

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

Resource Summary

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

Decision Step Code

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

Decision Node Type

Decision Validation Error

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

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

Decision Condition Term

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

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

Decision

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

Tag Merge Decision Component

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

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

Analysis Code

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.


Outcome contains actions to assign values to variables.

Segmentation Tree Outcome

Code File Signature Term

Named boolean expression which evaluates to a boolean value.

Segmentation Tree Boolean Expression

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

Referencing Decision

A link to a related operation or resource.

Link

Represents the parent decision associated with the decision component

Tag Merge Component Parent Decision

Segmentation Tree Matrix Node

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

Decision Error Marker Message

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

Signature Term Extension

Decision Flow

Segmentation Tree Variable Node

Code file which is internal to the segmentation tree

Segmentation Tree Internal Code File

Segmentation Tree Boolean Expression Node

Represents a term that is used within a segmentation tree.

Segmentation Tree Signature Term

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 the revision for the component that has the specified tags associated with it

Tag Merge Component Revision Reference

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

Decision Step Code Signature Term

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

Segmentation Tree Matrix

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

Segmentation Tree Code Assignment Outcome Action

Decision Record Contact Step

Decision Rule Set Step

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

Outcome action in which a variable is assigned a value

Segmentation Tree Variable Assignment Outcome Action

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

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

Decision Custom Object Step

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

Code File Signature Term DataGrid Extension

Segmentation Tree Value Node

Decision Model Step

Decision Condition 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

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

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

Decision Step Mapping

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

Model Decision Step

Represents a condition step within a decision flow.

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

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

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

Audit Term

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

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.

Name	Type	Required	Description
id	string	false	The unique identifier of the decision type.
name	string	false	The name of the decision type.
l10nKey	string	false	The key for looking up the decision type name in the user's locale.
denyDecisionNodeTypes	array [string]	false	The decision node types from the core types to not make available in the decision. The available core types are "branch", "crossBranchLink", "dataQuery", "decision", "ds2CodeFile", "microAnalyticModule", "model", "pythonCodeFile", "recordContacts", "ruleSet" and "treatmentGroup".
allowDecisionNodeTypes	array [string]	false	The decision node types not in the core types to make available in the decision.
createdBy	string	false	The user who created the decision type.
creationTimeStamp	string<date-time>	false	The date and time that the decision type was created.
modifiedBy	string	false	The user ID of the authenticated user who last updated the decision type.
modifiedTimeStamp	string<date-time>	false	The date and time that the decision type was last modified.
links	array [Link]	false	Zero or more links to related resources or operations.
version	integer	false	This media type's schema version number.

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
201	Created	The decision type content was updated.	Headers	Schema
400	Bad Request	The request was invalid.	Headers	Schema
412	Precondition Failed	The `If-Match` request header did not match the resource's entity tag.	Headers	Schema
428	Precondition Required	The request headers did not include an `If-Match`.	Headers	Schema

Update a decision type by ID

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses