RestApiCategories.modelsAndDecisions.desc

models_and_decisions

2024.09

2024.08

2024.10

2024.11

2024.12

2023.10

2024.03

2023.03

The Model Publish API provides support for publishing objects to a predefined destination.

Model Publish

Viya_35

The Model Publish API provides support for publishing objects (such as models) to Amazon Web Services (AWS), CAS, Hadoop, Private Docker, SAS Micro Analytic Service, or Teradata.

Contains information about a publishing destination.

Publishing Destination

Contains information about a CAS destination.

CAS Destination

Contains information about a Hadoop destination.

Hadoop Destination

Contains information about a SAS Micro Analytic Service destination.

SAS Micro Analytic Service Destination

Contains information about a Teradata destination.

Teradata Destination

If-Match

destinationName

A tag that identifies the revision of this object.

Etag

Error

application/vnd.sas.error

The request headers did not include a 'If-Match' or 'If-Unmodified-Since' precondition.

Update a publishing destination

A collection of destination representations.

Destination Resource Collection

Contains information about a destination property.

Destination Property

Contains information about an Amazon Web Services (AWS) destination.

Amazon Web Services Destination

Contains information about a private Docker destination.

Private Docker Destination

Contains information about an Azure destination.

Azure Destination

Contains information about an Azure Machine Learning destination.

Azure Machine Learning Destination

Contains information about a Git repository destination.

Git Repository Destination

Contains information about a Git repository folder request.

Git Repository Folder

Contains information about a Git repository folder.

A collection of Git repository resources.

Git Repository Resource Collection

A collection of published model representations.

Published Model Resource Collection

Contains information about a published model.

Published Model

Contains information about a published model manifest.

Published Model Manifest

Returns the deployment descriptors for an object that was published to a container.

Published Object Deployment Descriptor

Returns the deployment descriptor content for an object that was published to a container.

Published Object Deployment Descriptor Content

Contains information about an URI reference.

URI Reference

Contains information about the resource version.

Resource Version

Contains information about a model variable.

Model Variable

Published Model Log

Returns the Dockerfile metadata for a model that was published to a container.

Published Model Dockerfile

Returns the Dockerfile content for a model that was published to a container.

Published Model Dockerfile Content

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

Score Code Generation Request

A link to a related operation or resource.

Link

Contains information about a publishing model request.

Publishing Model Request

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

Contains information about publishing model content.

Publishing Model Content

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

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)

Name	Type	Required	Description
name	string	true	The name of the publishing destination server.
casServerName	string	false	The name of the CAS server.
casLibrary	string	false	The name of the CAS library.
description	string	false	The description of the publishing destination server.
destinationTable	string	false	The name of the publishing destination table.
destinationType	string	false	The destination type can be "cas", "microAnalyticServer", "teradata", "hadoop", "aws", "azure", "aml", "git", and "privateDocker".
databaseCasLibrary	string	false	The pre-defined CAS library that was used by Teradata.
user	string	false	The user name of Hadoop.
hdfsDirectory	string	false	The root HDFS folder where the model directory is to be created.
configurationDirectory	string	false	The class path for Hadoop JAR files. For example: /opt/hadoopjars
authenticationDomain	string	false	The name of the authentication domain that contains the remote login information for publishing users to gain access to the remote environment for the SAS Micro Analytic Service. For example: remoteAuthDomain
masUri	string	false	The base URI that contains the host, the protocol, and an optional port, which addresses the remote SAS Micro Analytic Service that this destination publishes to for this destination. For example: http://hostA.com
links	array [Link]	false	links
createdBy	string	false	The user who created the object.
creationTimeStamp	string<date-time>	false	The timestamp for when the object was created, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.
modifiedBy	string	false	The user who most recently modified the object.
modifiedTimeStamp	string<date-time>	false	The timestamp for when the object was last modified, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.
version	integer	false	The API representation version. Default: 1

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
412	Precondition Failed	ETag is not matched.		Schema
428	Precondition Required	The request headers did not include a 'If-Match' or 'If-Unmodified-Since' precondition.		Schema

Update a publishing destination

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses