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": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "viewer"
},
{
"type": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "operator"
},
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator"
}
],
"version": {
"versionNumber": -86535345,
"commitMessage": "in",
"author": "occaecat incididunt id ipsum",
"branchName": "Excepteur laborum"
},
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "Ut Lorem ut dolor",
"branchName": "anim enim Lorem",
"projectPath": "elit"
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Update result |
Copied to Clipboard
{
"message": "proident ut Duis magna velit",
"data": {
"_id": "5cb7b531d06cceb89fd21b1c",
"iid": 72886548,
"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": "62a1f3d2ebedfc54e6e0065c",
"role": "editor",
"missing": false,
"username": "tempor non ea",
"name": "do",
"provenance": "sint"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "viewer",
"missing": true,
"username": "occaecat reprehenderit non",
"name": "enim",
"provenance": "dolor reprehenderit ad"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer",
"missing": true,
"username": "adipisicing minim laboris do",
"name": "ut",
"provenance": "esse tempor quis non"
},
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "viewer",
"missing": false,
"username": "dolor consequat",
"name": "officia reprehenderit dolore do",
"provenance": "ex culpa dolor anim"
},
{
"type": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "operator",
"missing": true,
"username": "ea dolore dolor",
"name": "sed commodo",
"provenance": "dolor ipsum officia reprehenderit"
}
],
"accessControl": {
"read": [
"commodo esse proident",
"aliquip pariatur enim elit sint"
],
"write": [
"quis ut in",
"est ex irure",
"adipisicing",
"do exercitation dolor tempor"
],
"execute": [
"velit labore esse ullamco minim"
],
"manage": [
"ex tempor in",
"non Duis occaecat quis incididunt",
"voluptate in sit"
]
},
"componentIidIndex": 79298549,
"components": [
{
"iid": 38733425,
"type": "mopCommandTemplate",
"reference": "laboris enim officia sit",
"folder": "/"
},
{
"iid": 47119600,
"type": "jsonForm",
"reference": "cupidatat nostrud sit",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "ipsum minim",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": "exercitation",
"provenance": "velit officia esse ex",
"missing": false
},
"versionHistory": [
{
"versionNumber": 21344573,
"commitMessage": "sunt",
"author": "fugiat ullamco reprehenderit",
"branchName": "nulla ullamco consequat Duis"
},
{
"versionNumber": 29955189,
"commitMessage": "mollit quis officia",
"author": "id in minim tempor sunt",
"branchName": "Ut enim laboris in adipisicing"
},
{
"versionNumber": -27333050,
"commitMessage": "reprehenderit ea laboris labore tempor",
"author": "laboris quis Lorem commodo",
"branchName": "dolor et eu"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "in voluptate pariatur cillum",
"branchName": "in dolor adipisicing laborum",
"projectPath": "Ut deserunt consequat tempor dolore"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}