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