Create a model

post/models

Internal-Use Only

Creates a model into a project or folder using a model JSON object.

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  "targetLevel": "string",
21  "targetVariable": "string",
22  "projectId": "string",
23  "projectName": "string",
24  "projectVersionId": "string",
25  "projectVersionName": "string",
26  "folderId": "string",
27  "repositoryId": "string",
28  "championStartTime": "string",
29  "championEndTime": "string",
30  "suggestedChampion": true,
31  "retrainable": true,
32  "immutable": true,
33  "modelVersionName": "string",
34  "dataUris": [
35    "string"
36  ],
37  "properties": [
38    {
39      "name": "string",
40      "value": "string",
41      "type": "string"
42    }
43  ],
44  "inputVariables": [
45    {
46      "createdBy": "string",
47      "modifiedBy": "string",
48      "creationTimeStamp": "2019-08-24T14:15:22Z",
49      "modifiedTimeStamp": "2019-08-24T14:15:22Z",
50      "name": "string",
51      "description": "string",
52      "role": "string",
53      "type": "string",
54      "level": "string",
55      "format": "string",
56      "length": 0,
57      "version": 2
58    }
59  ],
60  "outputVariables": [
61    {
62      "createdBy": "string",
63      "modifiedBy": "string",
64      "creationTimeStamp": "2019-08-24T14:15:22Z",
65      "modifiedTimeStamp": "2019-08-24T14:15:22Z",
66      "name": "string",
67      "description": "string",
68      "role": "string",
69      "type": "string",
70      "level": "string",
71      "format": "string",
72      "length": 0,
73      "version": 2
74    }
75  ],
76  "version": 2
77}

Request Body

If the model is defined craftily, then this information is mandatory. The following fields are ignored from the input: id, createdBy, modifiedBy

Contains information about a model.

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 was created, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.
modifiedTimeStamp	string<date-time>	false	The timestamp for when the model was last modified, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.
id	string	false	The unique identifier for the model.
name	string	false	The name of the model.
description	string	false	The description of the model.
function	string	false	The function of the model. Valid values: analytical, classification, cluster, forecasting, prediction, Text analytics, transformation
algorithm	string	false	The name of model algorithm.
tool	string	false	The name of the model tool.
modeler	string	false	This is the user that created or built the model.
scoreCodeType	string	false	The score code type for the model.
trainTable	string	false	The train data table.
eventProbVar	string	false	The name of the event probability variable.
targetEvent	string	false	The target event value.
champion	boolean	false	Indicates whether the project has champion model or not.
role	string	false	The role of the model. Valid values: plain, champion, challenger
location	string	false	The location of this model.
targetLevel	string	false	The level of the target.
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 name of the project that contains the model.
projectVersionId	string	false	The unique identifier for the project version that contains the model.
projectVersionName	string	false	The display name of the project version that contains the model
folderId	string	false	The unique identifier for the folder that contains the model
repositoryId	string	false	The unique identifier 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 the model that was suggested as the 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 display name for a model version.
dataUris	array [string]	false	The URI reference point to an analytic report. It can have zero or multiple URI references.
properties	array [Model Property]	false	The properties for the model.
inputVariables	array [Variable]	false	The input variables for the model.
outputVariables	array [Variable]	false	The output variables for the model.
version	integer	false	The model representation version. The version is 2. Default: 2

Responses

Status	Meaning	Description
201	Created	A model was created.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
409	Conflict	The request could not be completed due to a conflict with the current state of the resource. The model already exists.		Schema