Create a project

post/projects
Internal-Use Only

Creates a project associated with the specified path or folder.

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 "status": "string",
11 "location": "string",
12 "repositoryId": "string",
13 "folderId": "string",
14 "championModelName": "string",
15 "candidateChampionName": "string",
16 "externalProjectId": "string",
17 "externalUrl": "string",
18 "candidateChampionHonored": true,
19 "variables": [
20 {
21 "createdBy": "string",
22 "modifiedBy": "string",
23 "creationTimeStamp": "2019-08-24T14:15:22Z",
24 "modifiedTimeStamp": "2019-08-24T14:15:22Z",
25 "name": "string",
26 "description": "string",
27 "role": "string",
28 "type": "string",
29 "level": "string",
30 "format": "string",
31 "length": 0,
32 "version": 2
33 }
34 ],
35 "multiVariateTargetReps": [
36 {
37 "predictedValue": "string",
38 "predictedTargetColumn": "string"
39 }
40 ],
41 "testTable": "string",
42 "scoreInputTable": "string",
43 "scoreOutputTable": "string",
44 "performanceTable": "string",
45 "trainTable": "string",
46 "targetVariable": "string",
47 "targetEventValue": "string",
48 "predictionVariable": "string",
49 "segmentationVariable": "string",
50 "properties": [
51 {
52 "name": "string",
53 "value": "string",
54 "type": "string"
55 }
56 ],
57 "challengerModels": [
58 "string"
59 ],
60 "classTargetValues": "string",
61 "targetLevel": "string",
62 "eventProbabilityVariable": "string",
63 "latestVersion": "string",
64 "version": 2
65}

Request Body

The representation of a new project.

Contains information about a modeling project.

NameTypeRequiredDescription
createdBy
string
false

The user that created the project.

modifiedBy
string
false

The user that last modified the project.

creationTimeStamp
string<date-time>
false

The timestamp for when the project was created, in the format of YYYY-MM-DDThh:mm:ss.sssZ.

modifiedTimeStamp
string<date-time>
false

The timestamp for when the project was last modified, in the format of YYYY-MM-DDThh:mm:ss.sssZ.

id
string
false

The unique identifier for the project.

name
string
false

The name of the project.

description
string
false

The description of the project.

function
string
false

The model function of the project. Valid values: analytical, classification, cluster, forecasting, prediction, Text categorization, Text extraction, Text sentiment, Text topics, transformation

status
string
false

The status of the project.

location
string
false

The location of the project.

repositoryId
string
false

The repository ID for the repository that contains the project.

folderId
string
false

The project folder ID

championModelName
string
false

The name of the champion model.

candidateChampionName
string
false

The name of the candidate champion model.

externalProjectId
string
false

The identifier for the external project.

externalUrl
string
false

The url for the external project.

candidateChampionHonored
boolean
false

Indicates to set the candidate champion as the project champion during import.

variables
array [Variable]
false

The variables for the project.

multiVariateTargetReps
array [Multivariate Target Event Values]
false

Indicates the association between the target event values and a column within the specified training table.

testTable
string
false

The data table for testing.

scoreInputTable
string
false

The score input data table.

scoreOutputTable
string
false

The score output data table.

performanceTable
string
false

The model performance data table.

trainTable
string
false

The model train table.

targetVariable
string
false

The name of the target variable.

targetEventValue
string
false

The target event value.

predictionVariable
string
false

The name of the prediction variable.

segmentationVariable
string
false

The name of the segmentation variable.

properties
array [Model Property]
false

The properties for the project.

challengerModels
array [string]
false

A list of challenger models.

classTargetValues
string
false

A list of target values.

targetLevel
string
false

Indicates a class target level of binary, nominal, ordinal, or interval.

eventProbabilityVariable
string
false

The name of the event probability variable.

latestVersion
string
false

The latest project version in the project.

version
integer
false

The project representation version. The version is 2.

Default:
2

Responses

StatusMeaningDescription
201CreatedA project was created.HeadersSchema
400Bad RequestThe request was invalid.Schema