Summary
Add one or more components to Project
Description
Add one or more components to Project
Route
POST /automation-studio/projects/:projectId/components/add
Roles
admin
apiwrite
designer
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
projectId |
string |
yes |
Project identifier |
options |
object |
yes |
Configuration options for adding components to a Project |
Copied to Clipboard
{
"components": [
{
"iid": 75743552,
"type": "transformation",
"reference": "incididunt non ad mollit",
"folder": "/"
}
],
"mode": "move"
}
Copied to Clipboard
{
"title": "options",
"type": "object",
"required": [
"components"
],
"properties": {
"components": {
"$ref": "projects-common#/definitions/components"
},
"mode": {
"type": "string",
"enum": [
"move",
"copy"
]
}
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Updated project |
Copied to Clipboard
{
"message": "Excepteur ut sint",
"data": [
{
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 20865782,
"name": "Firewall Service Provisioning",
"description": "This project is used at Acme Corp as the foundation of some major parts of our business process.",
"members": [
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator",
"missing": true,
"username": "Excepteur Lorem nostrud",
"name": "Duis et nulla cupidatat eiusmod",
"provenance": "aliqua"
},
{
"type": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "viewer",
"missing": true,
"username": "incididunt exercitation minim",
"name": "in eiusmod anim",
"provenance": "sunt aliqua irure"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "operator",
"missing": false,
"username": "Lorem labore proident in",
"name": "non deserunt",
"provenance": "reprehenderit commodo aliqua esse id"
}
],
"accessControl": {
"read": [
"ut magna sunt elit ullamco",
"consequat do non dolor",
"Excepteur cupidatat dolore sunt labore"
],
"write": [
"dolore"
],
"execute": [
"tempor anim ad dolore",
"qui",
"minim cupidatat",
"ex fugiat laboris pariatur aliquip",
"ullamco Ut voluptate"
],
"manage": [
"cupidatat Ut dolore anim ipsum",
"consectetur sint cupidatat",
"laborum voluptate",
"non eu et officia nisi",
"aliquip reprehenderit"
]
},
"componentIidIndex": 85419175,
"components": [
{
"iid": 88954963,
"type": "workflow",
"reference": "proident anim",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "5cb7b531d06cceb89fd21b1c",
"username": "quis reprehenderit",
"provenance": "quis irure adipisicing Duis",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "et exercitation eiusmod consectetur",
"missing": true
},
"versionHistory": [
{
"versionNumber": 13946608,
"commitMessage": "cillum magna ut",
"author": "esse ea adipisicing ullamco",
"branchName": "labore"
},
{
"versionNumber": 1005106,
"commitMessage": "nulla proident magna",
"author": "aliqua aliquip",
"branchName": "Excepteur ut"
},
{
"versionNumber": -76645624,
"commitMessage": "ex cupidatat deserunt esse eu",
"author": "in commodo magna mollit dolore",
"branchName": "mollit nisi elit"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "ipsum do in",
"branchName": "veniam elit nostrud",
"projectPath": "exercitation"
}
}
],
"metadata": {
"newComponents": [],
"failedComponents": [],
"idMap": [
{
"original": "1a643151-459b-4a4a-be91-623536b65df3",
"clone": "8696f332-030b-4c2a-8b1b-95844cbb6aea"
}
]
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"$ref": "projects-http"
}
},
"metadata": {
"type": "object",
"properties": {
"newComponents": {
"type": "array",
"description": "Components added"
},
"failedComponents": {
"type": "array",
"description": "Components failed to add"
},
"idMap": {
"type": "array",
"description": "Id map for original and cloned component",
"examples": [
[
{
"original": "1a643151-459b-4a4a-be91-623536b65df3",
"clone": "8696f332-030b-4c2a-8b1b-95844cbb6aea"
}
]
]
}
}
}
}
}