Model Repository

Loading...
The Model Repository API provides support for registering, organizing, and managing models within a common model repository.

Models

Contains operations for searching and managing models.
head
Check if models exist
Internal-Use OnlyReturns header information for a list of models that are within the common model repository. Also used to determine whether models exist.
/models
get
Get a list of models
Internal-Use OnlyReturns a list of models that are within the common model repository.
/models
post
Create a model
Internal-Use OnlyCreates a model into a project or folder using a model JSON object.
/models
post
Import models into a model project
Internal-Use OnlyImports one or more models from the project request object. The model contains project properties and a list of model links.
/models
post
Import a model into a folder
Internal-Use OnlyImports a model into a folder within the common model repository.
/models
post
Import a model from an SPK file
Internal-Use OnlyImports a model from a SAS package (SPK) file. Select an SPK file from a local machine and then import it. The folder ID or project version ID is required. If importing a model into a folder, use folder ID. Otherwise, use project version ID.
/models
post
Import a model through an octet stream
Internal-Use OnlyImports a model through input stream. The folder ID or project version ID is required. If the model should be imported into a folder, use the folder ID. Otherwise, use project version ID.
/models
get
Get a model
Internal-Use OnlyReturns the model information for the specified model ID.
/models/{modelId}
head
Check if a model exists
Internal-Use OnlyReturns the header information for the specified model ID. Also used to determine whether a model exists.
/models/{modelId}
put
Update a model
Internal-Use OnlyUpdates the model information for the model that matches the specified criteria and model ID.
/models/{modelId}
delete
Delete a model
Internal-Use OnlyDeletes the model with the specified ID from the model repository.
/models/{modelId}
get
Get a list of model analytic stores
Internal-Use OnlyReturns a list of metadata for analytic stores (application/vnd.sas.models.analytic.store) that are associated with the model. Note that this does not allow retrieval of the analytic store, only the metadata.
/models/{modelId}/analyticStore
put
Copy analytic stores for a model
Internal-Use OnlyCopies all of the analytic stores for a model to the pre-defined server location (/config/data/modelsvr/astore) that is used for integration with Event Stream Processing and others. This request invokes an asynchronous call to copy the analytic store files. Check the individual analytic store URIs to get the completion state: pending, copying, success, or failure. Please review the SAS Model Manager documentation before using this operation. Returns a collection of application/vnd.sas.models.analytic.store.
/models/{modelId}/analyticStore
get
Get an analytic store
Internal-Use OnlyReturns the detailed metadata for an analytic store that is associated with the model.
/models/{modelId}/analyticStore/{analyticStoreName}
put
Copy an analytic store for a model
Internal-Use OnlyCopy one of the analytic stores for this model to the pre-defined server location (/config/data/modelsvr/astore) that is used for integration with SAS Event Stream Processing and others. This request invokes an asynchronous call to copy the analytic store file. Access the URI again to get the completion state: pending, copying, success, or failure. Please review the SAS Model Manager documentation before using this operation.
/models/{modelId}/analyticStore/{analyticStoreName}
get
Get model score code
Internal-Use OnlyReturns the model score code for the specified model ID.
/models/{modelId}/code
get
Get model contents
Internal-Use OnlyReturns the contents of a model for the specified model ID.
/models/{modelId}/contents
post
Add model contents
Internal-Use OnlyAdds the specified model contents to the model associated with the specified model ID.
/models/{modelId}/contents
get
Get model content metadata
Internal-Use OnlyReturns the metadata information for the model content that is associated with the specified model ID and content ID.
/models/{modelId}/contents/{contentId}
head
Check if model content exists
Internal-Use OnlyReturns the metadata and header information for the model content that is associated with the specified model ID and content ID. Also used to determine whether model content exists.
/models/{modelId}/contents/{contentId}
put
Update model content metadata
Internal-Use OnlyUpdates the metadata information for the model content that is associated with the specified model ID and content ID.
/models/{modelId}/contents/{contentId}
delete
Delete model content
Internal-Use OnlyDeletes the model content that is associated with the specified model ID and content ID.
/models/{modelId}/contents/{contentId}
get
Get model content
Internal-Use OnlyReturns the model content that is associated with the specified model ID and content ID.
/models/{modelId}/contents/{contentId}/content
get
Get model content in stream
Internal-Use OnlyReturns the model content in stream that is associated with the specified model ID and content ID.
/models/{modelId}/contents/{contentId}/stream
put
Update model content
Internal-Use OnlyUpdates the model content that is associated with the specified model ID and content ID.
/models/{modelId}/contents/{contentId}/stream
get
Get a list of model versions
Internal-Use OnlyReturns a list of model versions for the specified model ID.
/models/{modelId}/modelVersions
head
Check if model versions exist
Internal-Use OnlyReturns the header information for the model versions that are associated with the specified model ID. Also used to determine whether model versions exist.
/models/{modelId}/modelVersions
post
Create a model version
Internal-Use OnlyCreates a new model version for the specified model ID.
/models/{modelId}/modelVersions
get
Get a model version
Internal-Use OnlyReturns the model version that is associated with the specified model ID and version ID.
/models/{modelId}/modelVersions/{versionId}
get
Get the contents of a model version
Internal-Use OnlyReturns the contents for the model version that is associated with the specified model ID and version ID. The contents of a model version includes a list of model contents and metadata information.
/models/{modelId}/modelVersions/{versionId}/contents
get
Get metadata for model version content
Internal-Use OnlyReturns the metadata information for the model version content that is associated with the specified model ID, version ID, and content ID.
/models/{modelId}/modelVersions/{versionId}/contents/{contentId}
get
Get model version content
Internal-Use OnlyReturns the model version content that is associated with the specified model ID, version ID, and content ID.
/models/{modelId}/modelVersions/{versionId}/contents/{contentId}/content
get
Get a model with a list of versions
Internal-Use OnlyReturns a list of model versions with the model itself for the specified model ID.
/models/{modelId}/versions
get
Get a model version or model
Internal-Use OnlyReturns the model version or the model that is associated with the specified model ID and version ID. If the model ID and version ID are the same, the model is returned.
/models/{modelId}/versions/{versionId}
get
Get model variables
Internal-Use OnlyReturns the input variables and output variables that are associated with the specified model ID.
/models/{modelId}/variables
post
Add model variables
Internal-Use OnlyAdds one or more variables to the model that is associated with the specified model ID.
/models/{modelId}/variables
get
Get a model variable
Internal-Use OnlyReturns the model variable associated with the specified model ID and variable ID.
/models/{modelId}/variables/{variableId}
put
Update a model variable
Internal-Use OnlyUpdates the model variable that is associated with the specified model ID and variable ID.
/models/{modelId}/variables/{variableId}
delete
Delete a model variable
Internal-Use OnlyDeletes the model variable associated with the specified model ID and variable ID.
/models/{modelId}/variables/{variableId}
get
Get a model's score resource files
Internal-Use OnlyReturns the model files that have a file role of score resource, which are used for scoring.
/models/{modelId}/scoreResources
put
Move the score resources to Compute server
Internal-Use OnlyMoves a model's score resources to Compute server.
/models/{modelId}/scoreResources
get
Get a list of locks for a model
Internal-Use OnlyReturns a list of locks that are set for a model using the specified model ID.
/models/{modelId}/locks
get
Get model publish lock
Internal-Use OnlyReturns the model publish lock for the specified model ID.
/models/{modelId}/locks/{lockName}
post
Set model publish lock
Internal-Use OnlySets the model publish lock for the specified model ID.
/models/{modelId}/locks/{lockName}
delete
Unset model publish lock
Internal-Use OnlyClears the model publish lock for the specified model ID.
/models/{modelId}/locks/{lockName}
get
Get all model user-defined properties
Internal-Use OnlyReturns all distinct user-defined properties at the model-level.
/models/userProperties
head
Check if model health metrics exist
Internal-Use OnlyReturns a list of header information for the model health metrics. Used to determine whether the model health metrics exist for the training data.
/models/{modelId}/healthMetrics
get
Get model health metrics
Internal-Use OnlyReturns the model health metrics for the training data that are associated with the specified model ID.
/models/{modelId}/healthMetrics
head
Check if misclassification metrics exist
Internal-Use OnlyReturns a list of header information for the misclassification metrics. Used to determine whether the misclassification metrics exist.
/models/{modelId}/classificationMatrix
get
Get misclassification metrics
Internal-Use OnlyReturns the misclassification metrics that are associated with the specified model ID.
/models/{modelId}/classificationMatrix
head
Check if metrics exist
Internal-Use OnlyReturns a list of header information for the evaluation metrics. Used to determine whether the evaluation metrics exist.
/models/{modelId}/metrics
get
Get model metrics
Internal-Use OnlyReturns the training, validation, and testing metrics that is associated with the specified model ID.
/models/{modelId}/metrics
head
Check if generalizability metrics exist
Internal-Use OnlyReturns a list of header information for the generalizability metrics. Used to determine whether the generalizability metrics exist.
/models/{modelId}/generalizability
get
Get generalizability metrics
Internal-Use OnlyReturns the generalizability metrics for the specified model ID.
/models/{modelId}/generalizability
head
Check if variable importance exists
Internal-Use OnlyReturns a list of header information for the variable importance. Used to determine whether the variable importance exists.
/models/{modelId}/variableImportance
get
Get variable importance
Internal-Use OnlyReturns the variable importance for the model variables that are associated with the specified model ID.
/models/{modelId}/variableImportance
head
Check if fairness metrics exist
Internal-Use OnlyReturns a list of header information for the fairness metrics. Used to determine whether the fairness metrics exist.
/models/{modelId}/fairnessMetrics
get
Get fairness metrics
Internal-Use OnlyReturns the fairness metrics that are associated with the specified model ID.
/models/{modelId}/fairnessMetrics
head
Check if lift statistics exist
Internal-Use OnlyReturns a list of header information for the lift statistics. Used to determine whether the lift statistics exist.
/models/{modelId}/liftData
get
Get lift statistics
Internal-Use OnlyReturns the lift statistics that are associated with the specified model ID.
/models/{modelId}/liftData
get
Get data table information
Internal-Use OnlyReturns the information for the data table that is associated with the specified URL.
/commons/tableInfo

Projects

Contains operations for searching and managing projects.
head
Check if projects exist
Internal-Use OnlyReturns a paginated list of header information for projects that are within the common model repository. Also used to determine whether projects exist.
/projects
get
Get a list of projects
Internal-Use OnlyReturns a paginated list of projects that are within the common model repository.
/projects
post
Create a project
Internal-Use OnlyCreates a project associated with the specified path or folder.
/projects
get
Get a project
Internal-Use OnlyReturns the project information for the specified project ID.
/projects/{projectId}
put
Update a project
Internal-Use OnlyUpdates the information for the project that matches the specified criteria and project ID.
/projects/{projectId}
delete
Delete a project
Internal-Use OnlyDeletes the project with the specified ID from the common model repository.
/projects/{projectId}
get
Get the project champion model
Internal-Use OnlyReturns the champion model for the specified project ID. If a project champion has not been set, an error message is returned. The error message is "No model is currently set as the project champion."
/projects/{projectId}/champion
post
Set a project champion model
Internal-Use OnlySets the model role to champion for the specified project ID and model ID.
/projects/{projectId}/champion
delete
Clear a project champion model
Internal-Use OnlyClears the champion model for the specified project ID.
/projects/{projectId}/champion
get
Get the champion model score code
Internal-Use OnlyReturns the score code for the project champion model in these formats: ds2package, ds2, application/json, raw, and text/plain.
/projects/{projectId}/champion/code
get
Get a list of challenger models
Internal-Use OnlyReturns a list of models for the specified project ID that have a model role of challenger.
/projects/{projectId}/challengers
post
Set a model as a challenger
Internal-Use OnlySets the model role as challenger for the model that is associated with the specified project ID and model ID. A project can have no challengers, as well as one or more challengers. The challenger will be added to the challengers list.
/projects/{projectId}/challengers
delete
Clear project challenger models
Internal-Use OnlyClears the challenger models for the specified project ID.
/projects/{projectId}/challengers
head
Check if models exist within a project
Internal-Use OnlyReturns a list of header information for models associated with the specified project ID. Also used to determine whether models exist.
/projects/{projectId}/models
get
Get a list of models within a project
Internal-Use OnlyReturns a list of models for the specified project ID.
/projects/{projectId}/models
head
Check if project versions exist
Internal-Use OnlyReturns a list of header information for the project versions that are associated with the specified project ID. Also used to determine whether project versions exist.
/projects/{projectId}/projectVersions
get
Get a list of project versions
Internal-Use OnlyReturns a list of project versions for the specified project ID.
/projects/{projectId}/projectVersions
post
Create a project version
Internal-Use OnlyCreates a new project version for the specified project ID.
/projects/{projectId}/projectVersions
get
Get a project version
Internal-Use OnlyReturns the information for the project version that is associated with the specified version ID.
/projects/{projectId}/projectVersions/{versionId}
put
Update a project version
Internal-Use OnlyUpdates the project version that is associated with the specified version ID.
/projects/{projectId}/projectVersions/{versionId}
delete
Delete a project version
Internal-Use OnlyDeletes the project version that is associated with the specified version ID.
/projects/{projectId}/projectVersions/{versionId}
head
Check if models exist within a project version
Internal-Use OnlyReturns a list of header information for the models that are within the project version and that are associated with the specified version ID.
/projects/{projectId}/projectVersions/{versionId}/models
get
Get a list of models within a project version
Internal-Use OnlyReturns a list of models within the project version that is associated with the specified version ID.
/projects/{projectId}/projectVersions/{versionId}/models
head
Check if project variables exist
Internal-Use OnlyReturns the header information for the project input variables and output variables that are associated with the specified project ID. Also used to determine whether project variables exist.
/projects/{projectId}/variables
get
Get project variables
Internal-Use OnlyReturns the input variables and output variables for the project that is associated with the specified project ID.
/projects/{projectId}/variables
post
Add project variables
Internal-Use OnlyAdds one or more variables to the project that is associated with the specified project ID.
/projects/{projectId}/variables
get
Get a project variable
Internal-Use OnlyReturns the project variable associated with the specified project ID and variable ID.
/projects/{projectId}/variables/{variableId}
put
Update a project variable
Internal-Use OnlyUpdates the project variable that is associated with the specified project ID and variable ID.
/projects/{projectId}/variables/{variableId}
delete
Delete a project variable
Internal-Use OnlyDeletes the project variable associated with the specified project ID and variable ID.
/projects/{projectId}/variables/{variableId}
get
Get project contents
Internal-Use OnlyReturns the project contents associated with the specified project ID. Each entry is of the media type application/vnd.sas.models.project.content.
/projects/{projectId}/contents
post
Add project content
Internal-Use OnlyAdds the content to the project that is associated with the specified project ID.
/projects/{projectId}/contents
get
Get project content metadata
Internal-Use OnlyReturns the metadata information for the project content that is associated with the specified project ID and content ID.
/projects/{projectId}/contents/{contentId}
put
Update project content metadata
Internal-Use OnlyUpdates the metadata information for the project content that is associated with the specified model ID and content ID.
/projects/{projectId}/contents/{contentId}
delete
Delete project contents
Internal-Use OnlyDeletes the contents of the project that is associated with the specified project ID and content ID.
/projects/{projectId}/contents/{contentId}
get
Get project content
Internal-Use OnlyReturns the project content that is associated with the specified project ID and content ID.
/projects/{projectId}/contents/{contentId}/content
put
Update project content
Internal-Use OnlyUpdates the project content that is associated with the specified project ID and content ID.
/projects/{projectId}/contents/{contentId}/content
get
Get a project's history
Internal-Use OnlyReturns the project's key historical events.
/projects/{projectId}/history
get
Get all project user-defined properties
Internal-Use OnlyReturns all distinct user-defined properties on the project-level.
/projects/userProperties

Repositories

Contains operations for searching and managing repositories.
head
Check if repositories exist
Internal-Use OnlyReturns a list of header information for repositories. Also used to determine whether repositories exist.
/repositories
get
Get a list of repositories
Internal-Use OnlyReturns a paginated list of repositories.
/repositories
post
Create a repository
Internal-Use OnlyCreates a new repository. The Model Repository service supports multiple repositories to manage models.
/repositories
get
Get a repository
Internal-Use OnlyReturns the repository information for the specified repository ID.
/repositories/{repositoryId}
put
Update a repository
Internal-Use OnlyUpdates the repository information for the specified repository ID. This information includes the name and description of the repository.
/repositories/{repositoryId}
delete
Delete a repository
Internal-Use OnlyDeletes the repository with the specified repository ID.
/repositories/{repositoryId}

User-Defined Tags

Contains operations for searching user-defined tags.
get
Get a list of user-defined tags
Internal-Use OnlyReturns a list of user-defined tags.
/userDefinedTags