Import a model through an octet stream

post/models
Internal-Use Only

Imports 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.

Request Samples

1

Response Samples

1{
2 "name": "string",
3 "start": 0,
4 "limit": 0,
5 "count": 0,
6 "accept": "string",
7 "links": [
8 {
9 "method": "string",
10 "rel": "string",
11 "uri": "string",
12 "href": "string",
13 "title": "string",
14 "type": "string",
15 "itemType": "string",
16 "responseType": "string",
17 "responseItemType": "string"
18 }
19 ],
20 "version": 0,
21 "items": [
22 {
23 "createdBy": "string",
24 "modifiedBy": "string",
25 "creationTimeStamp": "2019-08-24T14:15:22Z",
26 "modifiedTimeStamp": "2019-08-24T14:15:22Z",
27 "id": "string",
28 "name": "string",
29 "description": "string",
30 "function": "string",
31 "algorithm": "string",
32 "tool": "string",
33 "modeler": "string",
34 "scoreCodeType": "string",
35 "trainTable": "string",
36 "eventProbVar": "string",
37 "targetEvent": "string",
38 "champion": true,
39 "role": "string",
40 "location": "string",
41 "targetLevel": "string",
42 "targetVariable": "string",
43 "projectId": "string",
44 "projectName": "string",
45 "projectVersionId": "string",
46 "projectVersionName": "string",
47 "folderId": "string",
48 "repositoryId": "string",
49 "championStartTime": "string",
50 "championEndTime": "string",
51 "suggestedChampion": true,
52 "retrainable": true,
53 "immutable": true,
54 "modelVersionName": "string",
55 "dataUris": [
56 "string"
57 ],
58 "properties": [
59 {
60 "name": "string",
61 "value": "string",
62 "type": "string"
63 }
64 ],
65 "inputVariables": [
66 {
67 "createdBy": "string",
68 "modifiedBy": "string",
69 "creationTimeStamp": "2019-08-24T14:15:22Z",
70 "modifiedTimeStamp": "2019-08-24T14:15:22Z",
71 "name": "string",
72 "description": "string",
73 "role": "string",
74 "type": "string",
75 "level": "string",
76 "format": "string",
77 "length": 0,
78 "version": 2
79 }
80 ],
81 "outputVariables": [
82 {
83 "createdBy": "string",
84 "modifiedBy": "string",
85 "creationTimeStamp": "2019-08-24T14:15:22Z",
86 "modifiedTimeStamp": "2019-08-24T14:15:22Z",
87 "name": "string",
88 "description": "string",
89 "role": "string",
90 "type": "string",
91 "level": "string",
92 "format": "string",
93 "length": 0,
94 "version": 2
95 }
96 ],
97 "version": 2
98 }
99 ]
100}

Query Parameters

NameTypeRequiredDescription
description
string<sort-criteria>
false

The description of the model.

folderId
string<sort-criteria>
false

You must specify a folder ID or project version ID.

function
string<sort-criteria>
false

The function of the model.

projectName
string<sort-criteria>
false

The model is imported into this project.

projectVersionId
string<sort-criteria>
false

You must specify a folder ID or project version ID.

versionOption
string<sort-criteria>
false

This parameter indicates to create a new version, use the latest version, or use an existing version to import the model into. Valid values are NEW, LATEST, or a number.

name
string
true

The model name.

type
string<sort-criteria>
true

The value for type can be SPK, ZIP, or CAS.

Default:
SPK

Request Body

Select a model content from your local machine to import a model.

Responses

StatusMeaningDescription
201CreatedThe 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