Summary
Updates an existing project
Description
Updates an existing project
Route
PATCH /automation-studio/projects/:projectId
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
projectId |
string |
yes |
Project identifier, either an ObjectId or an IID |
updateData |
object |
yes |
Project update data |
Copied to Clipboard
{
"name": "Arista EOS Utilities",
"description": "This project is used at Acme Corp as the foundation of some major parts of our business process.",
"thumbnailBackgroundColor": "#FFFFFF",
"members": [
{
"type": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "operator"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer"
}
],
"version": {
"versionNumber": 71281587,
"commitMessage": "et aliqua laboris fugiat non",
"author": "esse",
"branchName": "consectetur proident culpa aliquip"
},
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "incididunt",
"branchName": "eu",
"projectPath": "ipsum"
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Update result |
Copied to Clipboard
{
"message": "sit deserunt do",
"data": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 50788824,
"name": "Arista EOS Utilities",
"description": "This project is used at Acme Corp as the foundation of some major parts of our business process.",
"members": [
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "owner",
"missing": false,
"username": "pariatur occaecat",
"name": "Ut dolor Excepteur fugiat",
"provenance": "aliqua dolore in"
}
],
"accessControl": {
"read": [
"occaecat nostrud",
"irure ipsum deserunt in"
],
"write": [
"laboris culpa aliquip minim",
"et veniam ullamco",
"occaecat nostrud consequat",
"dolor officia Excepteur in sint"
],
"execute": [
"aliquip",
"consectetur commodo labore",
"commodo occaecat in",
"sed aliquip",
"officia consequat laboris"
],
"manage": [
"occaecat sit laboris elit in"
]
},
"componentIidIndex": 12550811,
"components": [
{
"iid": 17676162,
"type": "mopAnalyticTemplate",
"reference": "fugiat in commodo pariatur ullamco",
"folder": "/"
},
{
"iid": 48870387,
"type": "template",
"reference": "esse dolore eiusmod ullamco fugiat",
"folder": "/"
},
{
"iid": 69622613,
"type": "mopAnalyticTemplate",
"reference": "magna",
"folder": "/"
},
{
"iid": 99583327,
"type": "jsonForm",
"reference": "velit anim enim",
"folder": "/"
},
{
"iid": 75465806,
"type": "template",
"reference": "fugiat ut anim reprehenderit commodo",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "in Ut",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "dolor ut",
"missing": true
},
"versionHistory": [
{
"versionNumber": -8773620,
"commitMessage": "officia dolore exercitation consequat enim",
"author": "esse sint ipsum ea",
"branchName": "esse et consectetur velit"
},
{
"versionNumber": 90083759,
"commitMessage": "nisi reprehenderit",
"author": "eiusmod non nisi",
"branchName": "dolor eu"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "laboris dolor magna",
"branchName": "aliqua cillum elit dolor",
"projectPath": "voluptate dolor incididunt"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}