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": 50963106,
"type": "mopCommandTemplate",
"reference": "velit proident Lorem",
"folder": "/"
},
{
"iid": 3344027,
"type": "jsonForm",
"reference": "quis",
"folder": "/"
}
],
"mode": "copy"
}
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": "velit",
"data": [
{
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 67256232,
"name": "Arista EOS Utilities",
"description": "This project is used at Acme Corp as the foundation of some major parts of our business process.",
"members": [
{
"type": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "viewer",
"missing": true,
"username": "occaecat laborum",
"name": "ut voluptate officia laborum",
"provenance": "dolor do ullamco"
}
],
"accessControl": {
"read": [
"ipsum",
"incididunt dolor anim minim Excepteur",
"id consectetur dolore Ut",
"ea dolore"
],
"write": [
"ad mollit velit",
"Lorem quis nulla",
"sint qui",
"minim fugiat labore",
"magna pariatur"
],
"execute": [
"do ullamco",
"sed nulla",
"ipsum aliqua consequat enim irure",
"deserunt id quis sit",
"adipisicing fugiat cillum tempor ut"
],
"manage": [
"laboris"
]
},
"componentIidIndex": 39990299,
"components": [
{
"iid": 90173345,
"type": "mopAnalyticTemplate",
"reference": "Ut",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "in",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "ipsum velit labore Duis incididunt",
"missing": true
},
"versionHistory": [
{
"versionNumber": -41740858,
"commitMessage": "ipsum",
"author": "Excepteur laborum",
"branchName": "laborum ullamco"
},
{
"versionNumber": 13671737,
"commitMessage": "labore dolore ipsum",
"author": "anim incididunt do",
"branchName": "dolor tempor Duis amet cillum"
},
{
"versionNumber": -42437270,
"commitMessage": "Ut",
"author": "proident officia ut enim minim",
"branchName": "in ipsum amet laboris"
},
{
"versionNumber": 20224986,
"commitMessage": "culpa in",
"author": "quis",
"branchName": "incididunt esse Lorem"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "eu sunt",
"branchName": "irure mollit",
"projectPath": "in dolor sunt"
}
}
],
"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"
}
]
]
}
}
}
}
}