Summary
Remove a component from a project
Description
Remove a component from a project
Route
DELETE /automation-studio/projects/:projectId/components/:componentId
Roles
admin
apiwrite
designer
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
projectId |
string |
yes |
Project identifier |
componentId |
number |
yes |
Component identifier |
options |
object |
yes |
Options designating removal mode |
Copied to Clipboard
{
"options": {
"mode": "delete"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"title": "options",
"type": "object",
"description": "Options designating removal mode",
"properties": {
"mode": {
"type": "string",
"enum": [
"delete",
"move"
]
}
}
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Response object |
Copied to Clipboard
{
"message": "eiusmod",
"data": {
"_id": "5cb7b531d06cceb89fd21b1c",
"iid": 73155755,
"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": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "operator",
"missing": true,
"username": "occaecat ipsum sed",
"name": "magna id ex",
"provenance": "fugiat sit sunt consectetur"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "operator",
"missing": false,
"username": "officia in",
"name": "minim velit non nisi nulla",
"provenance": "irure in consequat eiusmod ut"
},
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "editor",
"missing": true,
"username": "minim",
"name": "pariatur fugiat ut velit in",
"provenance": "nostrud mollit sint"
}
],
"accessControl": {
"read": [
"velit ullamco sunt quis",
"reprehenderit magna sunt adipisicing ut"
],
"write": [
"elit quis",
"Duis commodo ipsum",
"tempor",
"cupidatat aute culpa anim labore",
"deserunt"
],
"execute": [
"esse ut cillum enim",
"dolore",
"elit"
],
"manage": [
"ipsum do dolore sed nostrud",
"dolore",
"aute mollit",
"nisi eiusmod"
]
},
"componentIidIndex": 73152154,
"components": [
{
"iid": 47621407,
"type": "mopAnalyticTemplate",
"reference": "anim laboris labore",
"folder": "/"
},
{
"iid": 10771909,
"type": "mopCommandTemplate",
"reference": "non qui deserunt",
"folder": "/"
},
{
"iid": 83058270,
"type": "transformation",
"reference": "pariatur reprehenderit cillum ut Ut",
"folder": "/"
},
{
"iid": 22433914,
"type": "mopCommandTemplate",
"reference": "aliquip",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": "minim aliquip eu esse amet",
"provenance": "occaecat",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": "commodo tempor",
"provenance": "esse magna occaecat eu voluptate",
"missing": false
},
"versionHistory": [
{
"versionNumber": -90465197,
"commitMessage": "occaecat enim",
"author": "ut",
"branchName": "incididunt exercitation"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "dolor ut ea do",
"branchName": "magna dolore",
"projectPath": "magna labore"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Message denoting the status of the delete operation"
},
"data": {
"$ref": "projects-http"
},
"metadata": {
"type": "object"
}
}
}