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": "Arista EOS Utilities",
"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": "5cb7b531d06cceb89fd21b1c",
"role": "operator"
}
],
"version": {
"versionNumber": 31568074,
"commitMessage": "voluptate ut cupidatat tempor",
"author": "nulla non cillum",
"branchName": "culpa"
},
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "ex magna adipisicing dolor",
"branchName": "ut do cillum non ipsum",
"projectPath": "et est ut fugiat"
}
}
Return
Details Example Schema
Name
Type
Description
response
object
Update result
Copied to Clipboard
{
"message": "dolore",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 52211758,
"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": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "operator",
"missing": true,
"username": "exercitation consequat",
"name": "cupidatat anim elit dolor",
"provenance": "elit Excepteur"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer",
"missing": true,
"username": "reprehenderit incididunt",
"name": "qui minim sunt nisi",
"provenance": "Excepteur dolore velit aliquip dolor"
}
],
"accessControl": {
"read": [
"deserunt",
"labore",
"minim",
"eiusmod commodo consequat"
],
"write": [
"sint voluptate cupidatat",
"ad aliquip",
"minim non adipisicing"
],
"execute": [
"Duis pariatur sunt id Lorem",
"do consequat nulla reprehenderit",
"dolor",
"eu qui dolor consequat"
],
"manage": [
"veniam quis"
]
},
"componentIidIndex": 74449051,
"components": [
{
"iid": 28838819,
"type": "transformation",
"reference": "reprehenderit labore tempor pariatur eiusmod",
"folder": "/"
},
{
"iid": 85760042,
"type": "workflow",
"reference": "exercitation Excepteur",
"folder": "/"
},
{
"iid": 4169834,
"type": "jsonForm",
"reference": "deserunt exercitation voluptate ut tempor",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "labore sed sit",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "magna irure",
"missing": false
},
"versionHistory": [
{
"versionNumber": 43918608,
"commitMessage": "anim Lorem elit",
"author": "non laborum",
"branchName": "officia Ut id elit nostrud"
},
{
"versionNumber": 88952521,
"commitMessage": "aute laborum ut",
"author": "Lorem aute proident",
"branchName": "in amet sunt"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "incididunt esse",
"branchName": "est esse Excepteur",
"projectPath": "ad ea aliqua nostrud"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}