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 used at Acme Corp as the foundation of some major parts of our business process.",
"thumbnailBackgroundColor": "#FFFFFF",
"members": [
{
"type": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "editor"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "editor"
},
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "owner"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "viewer"
}
],
"version": {
"versionNumber": -90308453,
"commitMessage": "veniam aute",
"author": "laborum ut",
"branchName": "laboris"
},
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "non ut incididunt",
"branchName": "minim cillum cupidatat eiusmod aliqua",
"projectPath": "tempor laborum"
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Update result |
Copied to Clipboard
{
"message": "consequat incididunt",
"data": {
"_id": "5cb7b531d06cceb89fd21b1c",
"iid": 73412157,
"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": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator",
"missing": false,
"username": "eiusmod ipsum qui",
"name": "eiusmod dolore aliquip in minim",
"provenance": "magna commodo aliquip incididunt consectetur"
},
{
"type": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "viewer",
"missing": true,
"username": "et ut",
"name": "commodo",
"provenance": "est"
}
],
"accessControl": {
"read": [
"Lorem dolor ut Duis",
"esse"
],
"write": [
"cupidatat",
"deserunt nostrud sit non",
"aute incididunt do occaecat",
"cupidatat aliqua Duis"
],
"execute": [
"laboris ut labore",
"enim in Excepteur incididunt",
"sunt in ut",
"velit sint ex voluptate non"
],
"manage": [
"aliqua et",
"deserunt",
"nulla aliquip",
"cupidatat enim commodo dolor"
]
},
"componentIidIndex": 52430037,
"components": [
{
"iid": 3523687,
"type": "mopCommandTemplate",
"reference": "amet minim laborum consectetur",
"folder": "/"
},
{
"iid": 57551420,
"type": "workflow",
"reference": "reprehenderit qui",
"folder": "/"
},
{
"iid": 48201333,
"type": "mopAnalyticTemplate",
"reference": "quis Duis eiusmod commodo",
"folder": "/"
},
{
"iid": 40843125,
"type": "mopAnalyticTemplate",
"reference": "deserunt sunt",
"folder": "/"
},
{
"iid": 58938142,
"type": "transformation",
"reference": "voluptate ullamco eiusmod ut",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": "consequat",
"provenance": "Ut in anim ut",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "occaecat ipsum veniam Ut",
"missing": true
},
"versionHistory": [
{
"versionNumber": 7038733,
"commitMessage": "enim nisi esse Ut",
"author": "Excepteur cillum laborum",
"branchName": "dolore cillum consectetur labore ea"
},
{
"versionNumber": 15127106,
"commitMessage": "fugiat",
"author": "sit dolore nulla cillum",
"branchName": "commodo culpa occaecat"
},
{
"versionNumber": 23301576,
"commitMessage": "consectetur dolore amet ex Duis",
"author": "magna in",
"branchName": "exercitation enim sint"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "nostrud cupidatat mollit",
"branchName": "qui nostrud adipisicing eiusmod deserunt",
"projectPath": "quis"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}