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