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": "Firewall Service Provisioning",
"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": "4321abcdef694aa79dae47ad",
"role": "operator"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator"
},
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator"
},
{
"type": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "editor"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer"
}
],
"version": {
"versionNumber": -58382872,
"commitMessage": "in",
"author": "in dolore irure dolore",
"branchName": "mollit et sed"
},
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "fugiat tempor magna amet",
"branchName": "mollit",
"projectPath": "reprehenderit voluptate et aliqua"
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Update result |
Copied to Clipboard
{
"message": "adipisicing voluptate nulla",
"data": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 1605404,
"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": "4321abcdef694aa79dae47ad",
"role": "editor",
"missing": true,
"username": "do Lorem laborum laboris",
"name": "adipisicing",
"provenance": "esse anim"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "owner",
"missing": true,
"username": "id reprehenderit ullamco nostrud",
"name": "labore",
"provenance": "dolor sed eiusmod quis"
},
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "owner",
"missing": false,
"username": "sed mollit anim ut",
"name": "aliqua sint voluptate",
"provenance": "fugiat laboris ea"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer",
"missing": true,
"username": "ad laboris cupidatat",
"name": "consequat ut labore anim elit",
"provenance": "minim aute quis culpa sint"
}
],
"accessControl": {
"read": [
"amet nisi ut laborum ullamco",
"veniam proident ad in"
],
"write": [
"nulla labore tempor"
],
"execute": [
"anim non ullamco"
],
"manage": [
"in in magna",
"in consectetur dolor id",
"Ut non reprehenderit adipisicing",
"nisi incididunt esse enim"
]
},
"componentIidIndex": 23401458,
"components": [
{
"iid": 66483434,
"type": "jsonForm",
"reference": "aliquip",
"folder": "/"
},
{
"iid": 61287956,
"type": "jsonForm",
"reference": "in eu Duis",
"folder": "/"
},
{
"iid": 97783757,
"type": "mopAnalyticTemplate",
"reference": "cupidatat commodo aliquip",
"folder": "/"
},
{
"iid": 82044769,
"type": "workflow",
"reference": "enim adipisicing incididunt esse fugiat",
"folder": "/"
},
{
"iid": 93377626,
"type": "mopCommandTemplate",
"reference": "in",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "pariatur Lorem Duis",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": "proident nulla",
"provenance": "velit Duis eiusmod dolor proident",
"missing": true
},
"versionHistory": [
{
"versionNumber": 71571400,
"commitMessage": "dolor velit ut",
"author": "cillum reprehenderit eiusmod",
"branchName": "non aute consectetur enim esse"
},
{
"versionNumber": 33196695,
"commitMessage": "incididunt fugiat",
"author": "laborum ullamco sint tempor elit",
"branchName": "nisi"
},
{
"versionNumber": -83805910,
"commitMessage": "Duis",
"author": "et",
"branchName": "Lorem esse non adipisicing"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "velit",
"branchName": "exercitation reprehenderit",
"projectPath": "nisi nulla tempor sunt"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}