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 comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally",
"thumbnailBackgroundColor": "#FFFFFF",
"members": [
{
"type": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "operator"
},
{
"type": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "editor"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "operator"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator"
}
],
"version": {
"versionNumber": 16434010,
"commitMessage": "exercitation esse reprehenderit",
"author": "sed ullamco nulla",
"branchName": "eu"
},
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "est laboris",
"branchName": "dolore magna proident",
"projectPath": "deserunt exercitation nulla consectetur"
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Update result |
Copied to Clipboard
{
"message": "in sit consequat Ut",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 56537770,
"name": "Arista EOS Utilities",
"description": "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally",
"members": [
{
"type": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "owner",
"missing": true,
"username": "exercitation dolore dolor",
"name": "aute nisi laborum sint Ut",
"provenance": "esse dolore non"
},
{
"type": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "operator",
"missing": false,
"username": "ullamco",
"name": "pariatur sit velit",
"provenance": "proident"
},
{
"type": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "operator",
"missing": false,
"username": "ad ullamco id occaecat anim",
"name": "laboris nulla",
"provenance": "quis dolore"
},
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "owner",
"missing": false,
"username": "sed sunt et occaecat anim",
"name": "quis ea cillum",
"provenance": "eiusmod reprehenderit cupidatat exercitation laborum"
}
],
"accessControl": {
"read": [
"magna",
"aute minim Duis",
"Lorem"
],
"write": [
"ut",
"ullamco enim deserunt",
"aute non labore proident qui",
"esse velit dolore sed magna"
],
"execute": [
"consequat deserunt",
"nisi occaecat Ut est",
"id pariatur irure",
"ex ut eiusmod tempor sint"
],
"manage": [
"elit eu",
"amet magna",
"occaecat in esse"
]
},
"componentIidIndex": 53601010,
"components": [
{
"iid": 17920194,
"type": "workflow",
"reference": "fugiat",
"folder": "/"
},
{
"iid": 47954609,
"type": "mopAnalyticTemplate",
"reference": "Lorem esse anim",
"folder": "/"
},
{
"iid": 15812366,
"type": "workflow",
"reference": "ullamco",
"folder": "/"
},
{
"iid": 60980444,
"type": "template",
"reference": "deserunt veniam",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "et labore dolor ea in",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"username": "proident dolor est",
"provenance": "minim sit id eiusmod",
"missing": false
},
"versionHistory": [
{
"versionNumber": 46708831,
"commitMessage": "minim aliquip",
"author": "eiusmod reprehenderit",
"branchName": "ipsum"
},
{
"versionNumber": -51950978,
"commitMessage": "eu",
"author": "nisi sed voluptate sit esse",
"branchName": "laborum"
},
{
"versionNumber": 30424682,
"commitMessage": "qui sunt commodo aute",
"author": "in pariatur",
"branchName": "magna"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "irure Duis consequat",
"branchName": "exercitation est ut",
"projectPath": "ex laborum velit do in"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}