Create a model version

post/models/{modelId}/modelVersions

Internal-Use Only

Creates a new model version for the specified model ID.

Request Samples

application/json
1

Response Samples

201
application/json
1{
2  "createdBy": "string",
3  "modifiedBy": "string",
4  "creationTimeStamp": "2019-08-24T14:15:22Z",
5  "modifiedTimeStamp": "2019-08-24T14:15:22Z",
6  "id": "string",
7  "name": "string",
8  "description": "string",
9  "function": "string",
10  "algorithm": "string",
11  "tool": "string",
12  "modeler": "string",
13  "scoreCodeType": "string",
14  "trainTable": "string",
15  "eventProbVar": "string",
16  "targetEvent": "string",
17  "champion": true,
18  "role": "string",
19  "location": "string",
20  "targetVariable": "string",
21  "projectId": "string",
22  "projectName": "string",
23  "projectVersionId": "string",
24  "projectVersionName": "string",
25  "folderId": "string",
26  "repositoryId": "string",
27  "championStartTime": "string",
28  "championEndTime": "string",
29  "suggestedChampion": true,
30  "retrainable": true,
31  "immutable": true,
32  "modelVersionName": "string",
33  "properties": [
34    {
35      "name": "string",
36      "value": "string",
37      "type": "string"
38    }
39  ],
40  "inputVariables": [
41    {
42      "createdBy": "string",
43      "modifiedBy": "string",
44      "creationTimeStamp": "2019-08-24T14:15:22Z",
45      "modifiedTimeStamp": "2019-08-24T14:15:22Z",
46      "name": "string",
47      "description": "string",
48      "role": "string",
49      "type": "string",
50      "level": "string",
51      "format": "string",
52      "length": 0,
53      "version": 2
54    }
55  ],
56  "outputVariables": [
57    {
58      "createdBy": "string",
59      "modifiedBy": "string",
60      "creationTimeStamp": "2019-08-24T14:15:22Z",
61      "modifiedTimeStamp": "2019-08-24T14:15:22Z",
62      "name": "string",
63      "description": "string",
64      "role": "string",
65      "type": "string",
66      "level": "string",
67      "format": "string",
68      "length": 0,
69      "version": 2
70    }
71  ],
72  "version": 2
73}

Path Parameters

Name	Type	Required	Description
modelId	string	true	You must specify a valid model ID.

Request Body

The new model version.

Contains information about a model version.

Name	Type	Required	Description
createdBy	string	false	The user that created the model.
modifiedBy	string	false	The user that last modified the model.
creationTimeStamp	string<date-time>	false	The timestamp for when the model version was created, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.
modifiedTimeStamp	string<date-time>	false	The timestamp for when the model version was last modified, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.
id	string	false	Model ID
name	string	false	The name of the model.
description	string	false	The description of this model.
function	string	false	The function of the model. Valid values are: classification, prediction, segmentation, unknown
algorithm	string	false	The name of model algorithm.
tool	string	false	The tool name that was used to create the model.
modeler	string	false	The user that created or built the model.
scoreCodeType	string	false	The score code type of the model.
trainTable	string	false	The name of the train data table.
eventProbVar	string	false	The name of the classification event probability variable.
targetEvent	string	false	The classification target event value.
champion	boolean	false	Indicates whether the project has a champion model or not.
role	string	false	The role of a model. Valid values are: plain, champion, challenger
location	string	false	The location of this model.
targetVariable	string	false	The name of the target variable.
projectId	string	false	The unique identifier for the project that contains the model.
projectName	string	false	The project name for the project that contains the model.
projectVersionId	string	false	The project version ID for the project version that contains the model
projectVersionName	string	false	The project version display name for the project version that contains the model
folderId	string	false	The folder ID for the folder that contains the model
repositoryId	string	false	The repository ID for the repository that contains the model.
championStartTime	string	false	The time at which the model was set as the project champion model.
championEndTime	string	false	The time at which the model was unset (cleared) as the project champion model.
suggestedChampion	boolean	false	Indicates that the model was the suggested champion model at import time.
retrainable	boolean	false	Indicates whether the model can be retrained or not.
immutable	boolean	false	Indicates whether the model can be changed or not.
modelVersionName	string	false	The model version display name.
properties	array [Model Property]	false	The properties for the model version.
inputVariables	array [Variable]	false	The input variables for the model version.
outputVariables	array [Variable]	false	The output variables for the model version.
version	integer	false	The model version representation version. The version is 2. Default: 2

Responses

Status	Meaning	Description
201	Created	A new model version was created.	Headers	Schema
400	Bad Request	The request was invalid.		Schema