RestApiCategories.modelsAndDecisions.desc

models_and_decisions

2025.02

2023.03

2025.01

2024.03

2024.12

2024.08

2024.11

2024.09

2024.10

2023.10

The Treatment Definitions API is used for creating and maintaining treatment definitions and treatment definition groups.

Treatment Definitions

Viya_35

Determines whether an update to treatment definition is valid.

The representation of a treatment definition.

Treatment Definition

Etag value from when the originating object was retrieved.

If-Match

The unique identifier for the treatment definition.

definitionId

The response from a pre-flight validation request. For APIs which support validation, the client can run operations (typically on resources in the `/commons/validation`) with `application/vnd.sas.validation+json` as the requested response type (via the `Accept:` request header). The service will validate the request but not execute the request, and return this response to indicate if the request was valid at the time it was made.

Validation Response

application/vnd.sas.validation

Indicates whether the response is coming from a SAS service.

Sas-Service-Response-Flag

Validate an update to treatment 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

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

The object contains an unpaginated list of URIs of the direct dependents of this treatment definition.

Direct dependent objects

The object contains an unpaginated list of URIs of the direct dependents of this treatment definition group.

Error

A link to a related operation or resource.

Link

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

Resource Summary

One page of the webhook as resource summary representations, with optional links to first, prev, 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 webhook as revision summary representations, with optional links to first, prev, next, and last page of the list.

Revision Summary Collection

Selection

Represents a treatment definition attribute. This does not represent any of the top-level media types.

Treatment Definition Attribute

Represents the attribute value constraints for a treatment definition. This does not represent any of the top-level media types.

Treatment Definition Attribute Value Constraints

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

Treatment Definition Collection

Represents the eligibility details for a treatment definition. This does not represent any of the top-level media types.

Treatment Definition Eligibility

The representation of a treatment definition group.

Treatment Definition Group

Represents the treatment definition attribute name and its alias name. This doesn't represent any top-level media type.


Treatment Definition Group Attribute Name Alias

Represents the mapping of treatment definition attributes and source of its value. This doesn't represent any top-level media type.


Treatment Definition Group Attribute Value Mapping

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

Treatment Definition Group Collection

A treatment definition that belongs to a treatment definition group. This doesn't represent any top-level media type.


Name	Type	Required	Description
id	string	false	The system-assigned unique ID for this object.
name	string	true	The treatment definition name.
description	string	false	The treatment definition description.
createdBy	string	false	The user who created the treatment definition.
creationTimeStamp	string<date-time>	false	The date and time that the treatment definition was created.
modifiedBy	string	false	The user ID of the authenticated user who last updated the treatment definition.
modifiedTimeStamp	string<date-time>	false	The date and time that the treatment definition was last modified.
majorRevision	integer	false	Major version number of the revision being viewed of the treatment definition. This value is assigned by the service, the user only has control on whether the major number or minor number is incremented when creating a new revision.
minorRevision	integer	false	Minor version number of the current revision of the treatment definition. This value is assigned by the service, the user only has control on whether the major number or minor number is incremented when creating a new revision.
checkout	boolean	false	Flag that indicates that the treatment definition is a user's working copy of another treatment definition.
locked	boolean	false	Flag that indicates whether the content of the revision being viewed is locked or editable.
status	string<enumeration>	false	The status of the treatment definition. Allowed values: validerror
eligibility	Treatment Definition Eligibility	false	Represents the eligibility details for a treatment definition. This does not represent any of the top-level media types.
attributes	array [Treatment Definition Attribute]	false	An array of treatment definition attributes.
folderType	string	false	Indicates the type of folder where the treatment definition is stored.
sourceRevisionUri	string	false	The URI of the treatment definition revision that the treatment definition is being created from.
copyTimeStamp	string<date-time>	false	The time stamp when the treatment definition revision was copied.
links	array [Link]	false	Zero or more links to related resources or operations.
version	integer	false	This media type's schema version number. This representation is version 4.

Validate an update to treatment definition

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses