RestApiCategories.modelsAndDecisions.desc

models_and_decisions

2023.03

2024.10

2023.10

2024.12

2024.03

2024.08

2024.11

2024.09

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

Treatment Definitions

Viya_35

Determines whether a new treatment definition is valid.

The representation of a treatment definition.

Treatment Definition

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 a new treatment definition

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

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

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

Treatment Definition Collection

A collection of checkouts for a treatment definition version.

Treatment Definition Version Checkouts Collection

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 collection of checkouts for a treatment definition group version.

Treatment Definition Group Version Checkouts Collection

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.

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

Decision Step Code

The representation of a treatment definition group.

Treatment Definition Group

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

The summarized representation of a decisioning revision resource.

Revision Resource Summary

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

Resource Summary

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

Selection

Error

A link to a related operation or resource.

Link

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


Treatment Definition Group Member

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

Decision Step Code Signature Term

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

Treatment Definition Attribute

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

Treatment Definition Eligibility

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

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

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 of treatment definition attributes and source of its value. This doesn't represent any top-level media type.


Name	Type	Required	Description
name	string	true	The treatment definition name.
description	string	false	The treatment definition description.
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.
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 a new treatment definition

Request Samples

Response Samples

Request Body

Responses