Import a model into a folder

post/models
Internal-Use Only

Imports a model into a folder within the common model repository.

Request Samples

1

Response Samples

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}

Query Parameters

NameTypeRequiredDescription
folderId
string
false

The unique identifier for the folder that contains the model.

Request Body

Contains information about a model request.

NameTypeRequiredDescription
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 are: classification, prediction, segmentation, unknown

algorithm
string
false

The name of model algorithm.

tool
string
false

The name of the tool that was used to create the model.

toolVersion
string
false

The version of the tool that was used to create the model.

modeler
string
false

The user that created the model.

dataUris
array [string]
false

The URI reference point to an analytic report. It can have zero or multiple UI references.

scoreCodeUri
string
false

Contains information about the URI reference.

trainCodeUri
string
false

Contains information about the URI reference.

targetEvent
string
false

The target event.

nondeterministic
boolean
false

nondeterministic

dataSourceUri
string
false

Contains information about the URI reference.

dataSourceNotes
string
false

Additional data source information. This property can contain an intermediate data table.

externalModelId
string
false

The external model ID.

trainTableSummaryUri
string
false

Contains information about the URI reference.

fitStatUri
string
false

Contains information about the URI reference.

sasOptions
string
false

Additional SAS options for this model.

dataPlanUri
string
false

Contains information about the URI reference.

rocDataUri
string
false

Contains information about the URI reference.

liftDataUri
string
false

Contains information about the URI reference.

partitionLevels
array or allOf
false

A collection of partition level representations.

eventLevels
array or allOf
false

A collection of partition level representations.

modelTransformation
Model Transformation
false

Contains information about the content that is included within a model transformation.

trainInputs
array [Variable]
false

The training input variables.

version
integer
false

The model request representation version. The version is 2.

Default:
2

Responses

StatusMeaningDescription
201CreatedA model was imported.HeadersSchema
400Bad RequestThe request was invalid.Schema
409ConflictThe request could not be completed due to a conflict with the current state of the resource. The model already exists.Schema