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": "62a1f3d2ebedfc54e6e0065c",
"role": "viewer"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "editor"
}
],
"version": {
"versionNumber": -98645552,
"commitMessage": "qui sint",
"author": "sed ipsum tempor",
"branchName": "voluptate"
},
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "voluptate commodo eu do",
"branchName": "dolor quis incididunt elit qui",
"projectPath": "in"
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Update result |
Copied to Clipboard
{
"message": "consectetur",
"data": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 94053110,
"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": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "editor",
"missing": true,
"username": "irure cupidatat dolor sint",
"name": "mollit sit eiusmod",
"provenance": "dolore consectetur et"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "editor",
"missing": false,
"username": "voluptate nisi ad culpa magna",
"name": "fugiat anim ex veniam",
"provenance": "cillum reprehenderit eu pariatur dolor"
}
],
"accessControl": {
"read": [
"occaecat enim",
"quis culpa non veniam",
"nisi",
"proident non Duis ipsum laborum",
"officia occaecat anim culpa"
],
"write": [
"ipsum aliqua",
"ad Duis Excepteur",
"esse nulla elit"
],
"execute": [
"id eiusmod anim do",
"et Excepteur",
"dolore",
"exercitation"
],
"manage": [
"dolor nulla"
]
},
"componentIidIndex": 96038451,
"components": [
{
"iid": 93597090,
"type": "mopCommandTemplate",
"reference": "et dolore",
"folder": "/"
},
{
"iid": 269590,
"type": "transformation",
"reference": "sunt dolor officia in",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "cupidatat est culpa",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "5cb7b531d06cceb89fd21b1c",
"username": null,
"provenance": "cillum",
"missing": true
},
"versionHistory": [
{
"versionNumber": 50070530,
"commitMessage": "aliqua enim cillum",
"author": "labore Duis",
"branchName": "amet non dolor"
},
{
"versionNumber": -25670539,
"commitMessage": "ex",
"author": "dolore officia reprehenderit tempor",
"branchName": "eiusmod"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "ex mollit ad ipsum",
"branchName": "Excepteur laborum ad",
"projectPath": "ipsum enim reprehenderit Excepteur"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}