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": "4321abcdef694aa79dae47ad",
"role": "operator"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "editor"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer"
},
{
"type": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "editor"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator"
}
],
"version": {
"versionNumber": 54552524,
"commitMessage": "ullamco",
"author": "consectetur in ad sit aliquip",
"branchName": "consectetur aute non"
},
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "esse fugiat velit amet in",
"branchName": "laborum adipisicing",
"projectPath": "exercitation"
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Update result |
Copied to Clipboard
{
"message": "aliqua aute in",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 75917066,
"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": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "owner",
"missing": true,
"username": "culpa id",
"name": "et Excepteur culpa qui ut",
"provenance": "commodo deserunt sit"
},
{
"type": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "operator",
"missing": true,
"username": "dolore consequat sit nostrud",
"name": "Excepteur commodo",
"provenance": "nulla"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "owner",
"missing": false,
"username": "sit occaecat pariatur",
"name": "amet Duis commodo sit",
"provenance": "ea officia nulla nostrud"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer",
"missing": false,
"username": "adipisicing sed et",
"name": "ullamco sunt",
"provenance": "velit ad"
}
],
"accessControl": {
"read": [
"adipisicing dolore in quis",
"ex laboris sit qui adipisicing",
"incididunt nulla Excepteur"
],
"write": [
"aliquip incididunt fugiat proident",
"laborum laboris non in",
"eiusmod cupidatat"
],
"execute": [
"sunt nostrud",
"Lorem voluptate",
"qui tempor fugiat esse"
],
"manage": [
"dolore irure ut commodo do"
]
},
"componentIidIndex": 95414925,
"components": [
{
"iid": 10165651,
"type": "workflow",
"reference": "ullamco amet exercitation dolore ut",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": "sit nostrud consectetur culpa dolore",
"provenance": "nostrud dolore",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "magna",
"missing": true
},
"versionHistory": [
{
"versionNumber": 38816683,
"commitMessage": "nostrud",
"author": "sed id",
"branchName": "ipsum aute"
},
{
"versionNumber": -87169825,
"commitMessage": "voluptate dolor nostrud irure",
"author": "sint pariatur elit ut reprehenderit",
"branchName": "tempor dolor proident reprehenderit occaecat"
},
{
"versionNumber": 75926094,
"commitMessage": "incididunt cupidatat",
"author": "in dolor commodo",
"branchName": "ullamco aute consectetur voluptate sunt"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "pariatur nisi tempor sint",
"branchName": "id fugiat officia enim quis",
"projectPath": "consequat pariatur"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}