Update the specified automation project

put/projects/{projectId}

Internal-Use Only

In some cases, the user could select the wrong data set or target variables accidentally when creating an automation project. The project might fail to run or the result might not be what the user intended. The ability to update an automation project comes to rescue in those cases, where the user can update the project's attributes and settings with the following request and rerun the project. This API is solely used for updating a project’s parameters. There is a separate endpoint for updating the state of a project, for example, stopping or restarting a project run. We do not support PATCH operation to update the automation project with changes only. According to standard, the user must enter the full project info in this PUT request, whether or not the parameters are to be changed. List of parameters that can be updated.

name - description - dataTableUri - settings - analyticsProjectAttributes (all analytics attributes can be changed, except analytics project ID)

List of parameters that cannot be updated. Any changes are ignored.

id - type - analyticsProjectId - common fields associated with all revision tracking resources
- creationTimestamp
- modifiedTimestamp
- createdBy
- modifiedBy
- version

List of parameters that cannot be updated. Any changes cause 4xx error responses to be sent back to the client.

state (error code 400) - revision (error code 412)

Request Samples

application/json
1

Response Samples

200
application/json
1{
2  "creationTimeStamp": "2022-03-01T19:55:42.658381Z",
3  "createdBy": "username",
4  "modifiedTimeStamp": "2022-03-02T07:38:25.48095Z",
5  "modifiedBy": "username",
6  "revision": 1,
7  "id": "07d7b51f-6970-4225-8f03-eda03fcc810c",
8  "name": "Project Name",
9  "links": [
10    {
11      "method": "GET",
12      "rel": "up",
13      "href": "/mlPipelineAutomation/projects",
14      "uri": "/mlPipelineAutomation/projects",
15      "type": "application/vnd.sas.collection",
16      "itemType": "application/vnd.sas.analytics.ml.pipeline.automation.project"
17    },
18    {
19      "method": "GET",
20      "rel": "self",
21      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
22      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
23      "type": "application/vnd.sas.analytics.ml.pipeline.automation.project"
24    },
25    {
26      "method": "PUT",
27      "rel": "update",
28      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
29      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
30      "type": "application/vnd.sas.analytics.ml.pipeline.automation.project"
31    },
32    {
33      "method": "DELETE",
34      "rel": "delete",
35      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
36      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c"
37    },
38    {
39      "method": "DELETE",
40      "rel": "propagateDelete",
41      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c?propagate=true",
42      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c?propagate=true"
43    },
44    {
45      "method": "GET",
46      "rel": "state",
47      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/state",
48      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/state",
49      "type": "text/plain"
50    },
51    {
52      "method": "PUT",
53      "rel": "updateState",
54      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/state?value={value}",
55      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/state?value={value}",
56      "responseType": "text/plain"
57    },
58    {
59      "method": "GET",
60      "rel": "projectReports",
61      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/reports",
62      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/reports",
63      "type": "application/vnd.sas.collection"
64    },
65    {
66      "method": "PUT",
67      "rel": "retrainProject",
68      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c?action=retrainProject",
69      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c?action=retrainProject",
70      "type": "application/vnd.sas.analytics.ml.pipeline.automation.project",
71      "responseType": "application/vnd.sas.analytics.ml.pipeline.automation.project"
72    },
73    {
74      "method": "PUT",
75      "rel": "retrainProjectReplacePipelines",
76      "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c?action=retrainProject&replacePreviousPipelines=true",
77      "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c?action=retrainProject&replacePreviousPipelines=true",
78      "type": "application/vnd.sas.analytics.ml.pipeline.automation.project",
79      "responseType": "application/vnd.sas.analytics.ml.pipeline.automation.project"
80    }
81  ],
82  "version": 3,
83  "dataTableUri": "/dataTables/dataSources/cas~fs~cas-shared-default~fs~Public/tables/DATA",
84  "type": "predictive",
85  "state": "completed",
86  "settings": {
87    "locale": "en",
88    "replacePreviousPipelines": false
89  },
90  "analyticsProjectAttributes": {
91    "analyticsProjectId": "0594f275-4c39-4bd1-a50b-3d25714becc3",
92    "pipelineId": "c1f0a700-f737-4cef-9a00-e140c51f3d8d",
93    "targetVariable": "LOAN",
94    "targetEventLevel": "1"
95  },
96  "championModel": {
97    "name": "Forest (2)",
98    "links": [
99      {
100        "method": "GET",
101        "rel": "up",
102        "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
103        "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c",
104        "type": "application/vnd.sas.analytics.ml.pipeline.automation.project"
105      },
106      {
107        "method": "GET",
108        "rel": "self",
109        "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel",
110        "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel",
111        "type": "application/vnd.sas.analytics.ml.pipeline.automation.project.champion.model"
112      },
113      {
114        "method": "GET",
115        "rel": "championModelReports",
116        "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel/reports",
117        "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel/reports",
118        "type": "application/vnd.sas.collection",
119        "itemType": "application/vnd.sas.analytics.report"
120      },
121      {
122        "method": "GET",
123        "rel": "championModelReportSummary",
124        "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel/reportSummary",
125        "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel/reportSummary",
126        "type": "application/vnd.sas.collection",
127        "itemType": "application/vnd.sas.summary"
128      },
129      {
130        "method": "PUT",
131        "rel": "registerChampionModel",
132        "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel?action=register",
133        "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel?action=register"
134      },
135      {
136        "method": "PUT",
137        "rel": "publishChampionModel",
138        "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel?action=publish",
139        "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel?action=publish"
140      },
141      {
142        "method": "POST",
143        "rel": "scoreData",
144        "href": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel/scoreData",
145        "uri": "/mlPipelineAutomation/projects/07d7b51f-6970-4225-8f03-eda03fcc810c/models/@championModel/scoreData",
146        "type": "application/vnd.sas.analytics.ml.pipeline.automation.score.data.input",
147        "responseType": "application/vnd.sas.analytics.ml.pipeline.automation.score.data.output"
148      }
149    ],
150    "publishDestinations": [
151      {
152        "name": "maslocal",
153        "description": "The default publishing destination for the Micro Analytic Score service.",
154        "destinationType": "microAnalyticService"
155      },
156      {
157        "name": "AACASDestination",
158        "destinationType": "cas",
159        "destinationTable": "aa_cas_model_table",
160        "casServerName": "cas-shared-default",
161        "casLibrary": "Public"
162      }
163    ]
164  },
165  "pipelineBuildMethod": "automatic"
166}

Path Parameters

Name	Type	Required	Description
projectId	string	true	projectId

Header Parameters

Name	Type	Required	Description
Accept-Language	string	true	Used to set the project locale
If-Match	string	true	If-Match

Request Body

project

This object contains metadata and information about an automation project.

Name	Type	Required	Description
analyticsProjectAttributes	Analytics Project Attributes	true	This object contains a list of analytics project attributes related to Model Studio project settings.
dataTableUri	string	true	Data table URI
description	string	false	Description of the automation project
name	string	true	Name of the automation project
revision	integer<int64>	false	Revision of the automation project instance
settings	Automation Project Settings	false	A collection of optional settings to configure an automation project after Model Studio project is created based on analyticsProjectAttributes.
state	string	false	Automation Project state. One of the enums [pending, preparing, waiting, ready, modeling, constructingPipeline, runningPipeline, quiescing, quiesced, completed, canceled, failed, oversampling, retraining]. Allowed values: pendingpreparingwaitingreadymodelingconstructingPipelinerunningPipelinequiescingquiescedcompletedcanceledfailedoversamplingretraining
type	string	true	Automation project type Allowed value: predictive
pipelineBuildMethod	string	false	The method used to generate the project pipeline Allowed values: automatictemplate
version	integer<int32>	false	Version of the resource
championModel	Champion Model	false	This object contains a summary of champion model.
customProperties	object	false	Custom properties expressed as a map of strings that are associated with the automation project. These properties are added to the ProviderSpecificProperties map of the generated analytics project (prefixed with 'customMLPA_').
links	array [Link]	false	The links that apply to this automation project

Responses

Status	Meaning	Description
200	OK	The automation project was updated.	Headers	Schema
400	Bad Request	One or more parameters were invalid.		Schema
404	Not Found	No automation project with the provided entity ID was found.		Schema
412	Precondition Failed	The value supplied in the If-Match header did not match the expected value.		Schema
428	Precondition Required	An If-Match header was not supplied on the update request.		Schema