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": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "editor"
}
],
"version": {
"versionNumber": 88444114,
"commitMessage": "aliqua mollit",
"author": "sed ullamco sit non aute",
"branchName": "et in"
},
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "pariatur cillum nostrud sit",
"branchName": "ea irure id labore exercitation",
"projectPath": "eiusmod velit sunt ullamco ut"
}
}
Return
Details Example Schema
Name
Type
Description
response
object
Update result
Copied to Clipboard
{
"message": "dolor dolore sint",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 57543867,
"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": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "editor",
"missing": false,
"username": "aute eu Ut enim Lorem",
"name": "et est",
"provenance": "do"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "owner",
"missing": true,
"username": "cillum velit magna",
"name": "ea deserunt in nulla",
"provenance": "laborum irure"
},
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "owner",
"missing": true,
"username": "nulla fugiat",
"name": "mollit est in qui",
"provenance": "cupidatat"
}
],
"accessControl": {
"read": [
"dolor quis mollit",
"dolor",
"quis",
"sed"
],
"write": [
"nulla sunt",
"proident cillum in nostrud veniam",
"in pariatur consectetur in",
"sed reprehenderit et",
"in magna occaecat ex sint"
],
"execute": [
"sint esse officia",
"nostrud",
"consequat",
"velit elit mollit veniam",
"consectetur velit"
],
"manage": [
"ex labore"
]
},
"componentIidIndex": 50752474,
"components": [
{
"iid": 86974297,
"type": "mopCommandTemplate",
"reference": "esse incididunt",
"folder": "/"
},
{
"iid": 82347247,
"type": "mopCommandTemplate",
"reference": "adipisicing ad occaecat mollit Ut",
"folder": "/"
},
{
"iid": 32866133,
"type": "transformation",
"reference": "qui tempor",
"folder": "/"
},
{
"iid": 69924470,
"type": "jsonForm",
"reference": "elit Lorem",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": "elit Lorem magna qui",
"provenance": "commodo enim adipisicing",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": "labore cillum",
"provenance": "nisi cillum",
"missing": false
},
"versionHistory": [
{
"versionNumber": -3145270,
"commitMessage": "dolor occaecat exercitation",
"author": "dolor ullamco dolore cupidatat",
"branchName": "cupidatat irure et"
},
{
"versionNumber": -54987725,
"commitMessage": "eu",
"author": "officia sed",
"branchName": "ad adipisicing Lorem enim consectetur"
},
{
"versionNumber": -92218813,
"commitMessage": "enim",
"author": "esse cillum culpa labore id",
"branchName": "deserunt proident Lorem in pariatur"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "esse id quis incididunt",
"branchName": "ipsum nisi",
"projectPath": "aliqua"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}