RestApiCategories.modelsAndDecisions.desc

models_and_decisions

2024.09

2024.03

Viya_35

2025.08

2025.09

2025.10

2025.03

2025.11

2025.07

The Score Definitions API is used for creating and maintaining score definitions.

Score Definitions

The unique identifier for the score definition.

definitionId

Delete a score definition

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

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

Error

Input Data that will be scored.  This doesn't represent any top-level media type.

Input Data

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

Descriptor of a Score Object whose logic is used to produce a score for Input Data. This doesn't represent any top-level media type.

Object Descriptor

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

Resource Summary

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

Score Code Generation Request

A definition containing details about Input Data, Score Object and Mapping. This represents application/vnd.sas.score.definition media type (version 1).

Score Definition

One page of the score definition representations, with optional links to first, prev, next, and last page of the list.

Score Definition Collection

A definition containing details about Score Object and Properties. This represents application/vnd.sas.score.definition.summary media type (version 1).

Score Definition Definition Summary

Code_file_9130_Test_1

Code_file_9130

scoreDefinitions

Indicates whether the response is coming from a SAS service.

The version number of the API representation. This is version 1.

application/vnd.sas.api

A space-delimited list of media types from which an `Accept` header may be constructed.

If populated indicates the number of items in the collection.

The number of items that were requested for the collection.

The zero-based index of the first item in the collection.

The version number of the collection representation. This representation is version 2.

Messages that provide additional details about the cause of the error.

A message that describes how to resolve the error.

The version number of the error representation. This representation is version 2.

application/vnd.sas.error

Code containing inline data. Valid only if the type is Inline.

CAS Library name where CAS table is located. Valid only if the type is CASTable.

Name of the output table that will be generated when the inline code is executed. Valid only if the type is Inline.

CAS Server name where CAS table is located. Valid only if the type is CASTable.

Name of the CAS table. Valid only if the type is CASTable.

If this is a link to a container, `itemType` is the media type or link type for the items in the container.

The relationship of the link to the resource.

The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.

The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.

The media type or link type for the link.

The executable code generated by a score object.

The name of the library where the table is generated when the code is executed.

The name of the table that is generated when the code is executed.

This media type's schema version number. This representation is version 2.

Hints for generating mapped code. The mapped code request is forwarded to the score object of the score definition. The score object should understand these hints.

The score definition ID that is used for generating mapped code.

The user who created the score definition.

The date and time that the score definition was created.

Indicates the kind of folder where the score definition is housed.

The system-assigned unique ID for this object

Zero or more links to related resources or operations.

Array of mappings between Score Object variables and Input Data columns.

The userId of the authenticated user who last updated the score definition.

The date and time that the score definition was last modified.

Preprocessing code that is executed before executing the Mapped Code.

The properties for this score definition that support scoring for decisions and business rules. <ul> <li>outputServerName: The name of a Cloud Analytic Server. <li>outputLibraryName: The name of a Cloud Analytic Server library. <li>tableBaseName: The name of a table in the output library. <li>test: A flag that indicates whether the score definition is used for test scoring. Valid values are "true" and "false". </ul> These additional properties support publish validation for decisions and business rules. <ul> <li>asssetUri: The URI of the decision or business rule that is being validated. <li>publishDestination: The name of a publish destination. <li>publishType: The type of publish destination. <li>publishName: The name for publishing the asset. </ul> 

The timestamp in YYYY-MM-DDThh:mm:ss.sssZ format when the resource was created.

(version 2) The URI of an icon assigned to this resource, overrides default icons for the type.

The user who most recently modified the resource.

The timestamp in YYYY-MM-DDThh:mm:ss.sssZ format when the resource was last modified.

(version 2) The name of the type definition that describes the contents of this resource.

The version number of the resource. This representation is version 2.

application/vnd.sas.summary

Value that is assigned to Score Object's variable. If the mappingType is dataSource then this should be column name of the Input Data. If the mappingType is static then this should be a constant value. If the mappingType is expected then this is the expected value of the output and it is always constant. Required if the mappingType is datasource.

SAS Developers

Returns the links to the top-level resources for the API.

Returns the headers for the API. Also used to determine whether the service provided by the API is available.

Returns a list of the score definitions based on the specified pagination, filtering, and sorting options. The items in the list depend on the `Accept-Item` header.

Used for selecting the desired item representation.

Accept-Item

Returns the index of the first score definition.

start

Returns the maximum number of score definitions.

limit

The criteria used for filtering the score definitions. See [Filtering in REST APIs](https://developer.sas.com/rest-apis/scoreDefinitions-v3/docs/getting-started/usage-notes#filtering).

filter

The criteria used for sorting the score definitions. See [Sorting in REST APIs](https://developer.sas.com/rest-apis/scoreDefinitions-v3/docs/getting-started/usage-notes#sorting).

sortBy

Get a collection of the score definitions

Creates a new score definition based on the representation in the request body.

Adds the score definition as a member of a folder.

parentFolderUri

Score definition details that need to be created.

The timestamp when the score definition was last modified. The timestamp is in the format `EEE, dd MMM yyyy HH:mm:ss GMT`.

Returns the representation of the specified score definition.

No score definition exists at the requested path.

Returns the headers for the specified score definition. Also used to determine whether a particular score definition exists.

Updates the specified score definition based on the representation in the request body.

The entity tag obtained from the most recent `ETag` response header. Must match the current entity tag for the score definition.

If-Match

The representation of a score definition.

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

The request headers did not include a `If-Match` precondition.

Generates mapped code from the score definition by forwarding the request to the score object.

Representation of the score code generation request containing the score definition ID and hints.

Delete a score definition

Request Samples

Response Samples

Path Parameters

Responses