Summary
Updates an existing project
Description
Updates an existing project
Route
PATCH /automation-studio/projects/:projectId
Roles
admin
apiwrite
Parameters
Details Example Schema
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": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "operator"
}
],
"version": {
"versionNumber": -60946855,
"commitMessage": "in voluptate",
"author": "est elit",
"branchName": "in"
},
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "anim minim labore laboris ut",
"branchName": "aute ad id eu",
"projectPath": "aliquip consequat sed"
}
}
Return
Details Example Schema
Name
Type
Description
response
object
Update result
Copied to Clipboard
{
"message": "aliqua et cupidatat fugiat sed",
"data": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 18136910,
"name": "Firewall Service Provisioning",
"description": "This project is used at Acme Corp as the foundation of some major parts of our business process.",
"members": [
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "operator",
"missing": false,
"username": "Excepteur",
"name": "adipisicing ex Lorem",
"provenance": "nostrud cupidatat consectetur"
},
{
"type": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "owner",
"missing": true,
"username": "in",
"name": "dolore",
"provenance": "mollit laborum dolore eiusmod do"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer",
"missing": true,
"username": "voluptate esse adipisicing labore",
"name": "id adipisicing esse exercitation",
"provenance": "anim"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "viewer",
"missing": true,
"username": "ipsum",
"name": "cillum in labore Ut",
"provenance": "et ut cupidatat aute culpa"
}
],
"accessControl": {
"read": [
"sed cupidatat Duis",
"ex ea",
"exercitation proident tempor id ex",
"consectetur et tempor culpa qui"
],
"write": [
"aliquip do",
"cillum",
"do"
],
"execute": [
"mollit exercitation",
"enim ullamco fugiat",
"ex est sunt nostrud"
],
"manage": [
"aliqua",
"esse",
"in sint",
"do ipsum",
"cupidatat Ut veniam"
]
},
"componentIidIndex": 78685415,
"components": [
{
"iid": 69826418,
"type": "mopCommandTemplate",
"reference": "velit id irure minim",
"folder": "/"
},
{
"iid": 38102146,
"type": "mopAnalyticTemplate",
"reference": "enim dolor exercitation",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "fugiat qui Excepteur in voluptate",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": "mollit ut nulla sint irure",
"provenance": "non Duis occaecat",
"missing": true
},
"versionHistory": [
{
"versionNumber": -95429371,
"commitMessage": "occaecat",
"author": "elit fugiat commodo occaecat",
"branchName": "cillum sit consectetur nisi"
},
{
"versionNumber": -35606792,
"commitMessage": "Duis enim proident dolore tempor",
"author": "nisi ipsum",
"branchName": "in incididunt fugiat dolor nulla"
},
{
"versionNumber": -70828305,
"commitMessage": "adipisicing sunt",
"author": "Excepteur exercitation do dolore",
"branchName": "ipsum culpa"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "dolore cillum sunt",
"branchName": "minim nulla Excepteur",
"projectPath": "ut proident esse laborum dolor"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}