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 ullamco ipsum",
"data": {
"_id": "5cb7b531d06cceb89fd21b1c",
"iid": 22867104,
"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": "62a1f3d2ebedfc54e6e0065c",
"role": "viewer",
"missing": true,
"username": "eu non",
"name": "est Ut consectetur pariatur",
"provenance": "id ullamco"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "owner",
"missing": true,
"username": "in veniam",
"name": "elit id dolore commodo",
"provenance": "ut in eiusmod laboris sit"
}
],
"accessControl": {
"read": [
"labore sunt ea",
"sint dolor"
],
"write": [
"adipisicing sed quis laboris"
],
"execute": [
"ut sed ad ut culpa"
],
"manage": [
"sit cupidatat id eiusmod"
]
},
"componentIidIndex": 17446444,
"components": [
{
"iid": 8251014,
"type": "jsonForm",
"reference": "eu ut",
"folder": "/"
},
{
"iid": 63702672,
"type": "jsonForm",
"reference": "cupidatat aute",
"folder": "/"
},
{
"iid": 57718103,
"type": "mopAnalyticTemplate",
"reference": "nisi elit",
"folder": "/"
},
{
"iid": 92840526,
"type": "mopAnalyticTemplate",
"reference": "tempor occaecat non ut",
"folder": "/"
},
{
"iid": 79262951,
"type": "mopAnalyticTemplate",
"reference": "minim veniam nisi est",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": "consequat velit labore Ut tempor",
"provenance": "dolor",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"username": "elit ex",
"provenance": "ipsum ad in in labore",
"missing": true
},
"versionHistory": [
{
"versionNumber": -54901891,
"commitMessage": "dolor minim mollit sunt proident",
"author": "in est fugiat aliqua magna",
"branchName": "velit cupidatat elit nostrud reprehenderit"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "quis adipisicing eiusmod cupidatat culpa",
"branchName": "laborum tempor aliqua occaecat est",
"projectPath": "in in"
}
}
}
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"
}
}
}