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": "move"
}
}
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": "irure est deserunt dolor officia",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 60761806,
"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": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer",
"missing": false,
"username": "occaecat",
"name": "sint in in proident",
"provenance": "Duis nostrud laborum in reprehenderit"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "owner",
"missing": false,
"username": "consequat laborum nostrud non enim",
"name": "dolor veniam mollit ut",
"provenance": "id non Lorem exercitation cupidatat"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "editor",
"missing": false,
"username": "Ut ad officia laborum",
"name": "magna adipisicing Ut culpa in",
"provenance": "deserunt veniam adipisicing dolore aliquip"
},
{
"type": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "viewer",
"missing": true,
"username": "laboris",
"name": "proident Lorem irure ex occaecat",
"provenance": "commodo amet reprehenderit nulla Lorem"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "operator",
"missing": true,
"username": "laborum pariatur occaecat",
"name": "adipisicing sed",
"provenance": "in"
}
],
"accessControl": {
"read": [
"in cillum",
"quis mollit elit",
"voluptate",
"in laborum eu",
"ipsum consequat"
],
"write": [
"voluptate consectetur ullamco veniam fugiat"
],
"execute": [
"culpa nisi",
"dolore",
"incididunt quis dolore Excepteur",
"magna dolor in minim labore",
"non quis Duis"
],
"manage": [
"qui et nisi",
"tempor nisi ad amet occaecat"
]
},
"componentIidIndex": 88464795,
"components": [
{
"iid": 52044394,
"type": "transformation",
"reference": "tempor proident ipsum laborum",
"folder": "/"
},
{
"iid": 97394771,
"type": "mopCommandTemplate",
"reference": "dolor elit",
"folder": "/"
},
{
"iid": 59757955,
"type": "template",
"reference": "nostrud exercitation incididunt id anim",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"username": "veniam dolor id cupidatat",
"provenance": "sed exercitation dolor",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": "esse reprehenderit adipisicing",
"provenance": "consequat irure reprehenderit",
"missing": false
},
"versionHistory": [
{
"versionNumber": 82686073,
"commitMessage": "dolore ea nisi",
"author": "id quis sit minim anim",
"branchName": "pariatur adipisicing"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "Excepteur adipisicing",
"branchName": "proident",
"projectPath": "sunt occaecat"
}
}
}
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"
}
}
}