Get a list of projects

get/projects

Returns a paginated list of projects that are within the common model repository.

Request Samples

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      "status": "string",
32      "location": "string",
33      "repositoryId": "string",
34      "folderId": "string",
35      "championModelName": "string",
36      "candidateChampionName": "string",
37      "externalProjectId": "string",
38      "externalUrl": "string",
39      "candidateChampionHonored": true,
40      "variables": [
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      "multiVariateTargetReps": [
57        {
58          "predictedValue": "string",
59          "predictedTargetColumn": "string"
60        }
61      ],
62      "testTable": "string",
63      "scoreInputTable": "string",
64      "scoreOutputTable": "string",
65      "performanceTable": "string",
66      "trainTable": "string",
67      "targetVariable": "string",
68      "targetEventValue": "string",
69      "predictionVariable": "string",
70      "segmentationVariable": "string",
71      "properties": [
72        {
73          "name": "string",
74          "value": "string",
75          "type": "string"
76        }
77      ],
78      "challengerModels": [
79        "string"
80      ],
81      "classTargetValues": "string",
82      "targetLevel": "string",
83      "eventProbabilityVariable": "string",
84      "latestVersion": "string",
85      "championModelId": "string",
86      "projectVersionCount": 0,
87      "modelCount": 0,
88      "version": 2
89    }
90  ]
91}

Query Parameters

Name	Type	Required	Description
expand	string	false	Specifies additional information to include in the response. Use `count` to include the number of project versions and models for each project.
filter	string<filter-criteria>	false	The criteria for filtering the models. For more information, see Filtering in REST APIs.
includeChampionModel	boolean	false	Specifies whether to include the champion model ID in the response. When set to true, the `championModelId` parameter is included for each project. Default: false
inputVariables	string	false	A query string that allows a search for projects with input variables.
limit	integer<int32>	false	The maximum number of items to return in this request. Default: 20
name	string<sort-criteria>	false	A query string that allows a search by name to find projects.
outputVariables	string	false	A query string that allows a search for projects with output variables.
properties	string	false	A query string that allows a search for projects with user-defined properties
sortBy	string	false	The criteria for sorting the projects. For more information, see Sorting in REST APIs.
start	integer<int32>	false	The 0-based start index of a paginated request. >= 0 Default: 0

Responses

Status	Meaning	Description
200	OK	The request succeeded.		Schema
400	Bad Request	The request was invalid.		Schema