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 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": "5cb7b531d06cceb89fd21b1c",
"role": "owner"
}
],
"version": {
"versionNumber": -2599630,
"commitMessage": "qui dolor sunt officia irure",
"author": "occaecat cillum in sint",
"branchName": "voluptate sunt Lorem do Ut"
},
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "consectetur nostrud culpa consequat",
"branchName": "sed sit sint",
"projectPath": "et do sint ea"
}
}
Return
Details Example Schema
Name
Type
Description
response
object
Update result
Copied to Clipboard
{
"message": "dolor consectetur",
"data": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 51504035,
"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": "operator",
"missing": true,
"username": "dolore enim ex",
"name": "ullamco ipsum",
"provenance": "Duis"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "viewer",
"missing": false,
"username": "eiusmod in Lorem",
"name": "proident aliquip eu",
"provenance": "sunt dolor reprehenderit"
}
],
"accessControl": {
"read": [
"dolor sed in Duis aliqua",
"quis anim fugiat non ex",
"fugiat et occaecat officia non",
"Lorem culpa consectetur",
"amet eiusmod sunt minim"
],
"write": [
"ad nulla Lorem reprehenderit",
"ad est dolore",
"minim veniam pariatur Excepteur nulla",
"consequat"
],
"execute": [
"quis",
"ullamco ea incididunt in adipisicing"
],
"manage": [
"aute aliquip nulla",
"cillum nulla",
"incididunt enim reprehenderit",
"cupidatat minim",
"ullamco id ad labore voluptate"
]
},
"componentIidIndex": 49728606,
"components": [
{
"iid": 93909975,
"type": "jsonForm",
"reference": "sit veniam aliquip adipisicing",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "consequat",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": "deserunt",
"provenance": "anim",
"missing": true
},
"versionHistory": [
{
"versionNumber": 37147387,
"commitMessage": "voluptate",
"author": "dolor consequat ipsum",
"branchName": "aliquip nisi reprehenderit quis"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "mollit cillum",
"branchName": "tempor anim dolore fugiat",
"projectPath": "magna ut consequat incididunt veniam"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}