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": "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": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "editor"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "operator"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "owner"
},
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "owner"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "editor"
}
],
"version": {
"versionNumber": 75173002,
"commitMessage": "esse eu",
"author": "sunt commodo non",
"branchName": "aliquip cillum Lorem in ipsum"
},
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "eu",
"branchName": "Lorem occaecat veniam dolor",
"projectPath": "laborum nulla laboris voluptate"
}
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
Update result |
Copied to Clipboard
{
"message": "sed commodo dolore magna dolore",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 89635657,
"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": "62a1f3d2ebedfc54e6e0065c",
"role": "editor",
"missing": true,
"username": "elit",
"name": "anim nostrud eu laborum velit",
"provenance": "consectetur cupidatat Duis dolore aliquip"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "owner",
"missing": true,
"username": "ut laborum est do",
"name": "do commodo ad",
"provenance": "voluptate occaecat qui consectetur sint"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer",
"missing": false,
"username": "dolor deserunt",
"name": "minim cillum",
"provenance": "tempor ullamco ut"
}
],
"accessControl": {
"read": [
"incididunt Ut nisi in",
"Excepteur sit amet anim",
"eiusmod enim ipsum ullamco",
"do"
],
"write": [
"mollit veniam fugiat ipsum",
"ad",
"occaecat irure voluptate esse",
"laborum ipsum nostrud incididunt"
],
"execute": [
"in adipisicing commodo proident",
"Lorem dolor",
"laboris"
],
"manage": [
"Excepteur eu sit proident",
"dolore est",
"ea occaecat dolore",
"eu nisi id nostrud in",
"occaecat ipsum dolor Excepteur"
]
},
"componentIidIndex": 47057799,
"components": [
{
"iid": 47548829,
"type": "jsonForm",
"reference": "eu id",
"folder": "/"
},
{
"iid": 48688189,
"type": "jsonForm",
"reference": "et Excepteur",
"folder": "/"
},
{
"iid": 55101623,
"type": "transformation",
"reference": "aute dolore eiusmod",
"folder": "/"
},
{
"iid": 23684673,
"type": "template",
"reference": "esse irure",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": "adipisicing",
"provenance": "sunt amet laboris laborum Excepteur",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "velit",
"missing": false
},
"versionHistory": [
{
"versionNumber": 78441146,
"commitMessage": "ex nostrud",
"author": "amet eu in irure",
"branchName": "Ut consequat aliqua"
},
{
"versionNumber": -79885404,
"commitMessage": "occaecat",
"author": "elit",
"branchName": "ut labore minim enim"
},
{
"versionNumber": 92033400,
"commitMessage": "nulla quis voluptate eu in",
"author": "quis id do incididunt officia",
"branchName": "adipisicing velit commodo irure"
},
{
"versionNumber": 58892980,
"commitMessage": "ex do mollit irure",
"author": "minim amet commodo laborum",
"branchName": "do minim id Lorem enim"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "culpa",
"branchName": "dolore",
"projectPath": "aliquip id incididunt"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}