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": "nulla exercitation pariatur qui",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 97617149,
"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": "viewer",
"missing": false,
"username": "ut",
"name": "ex ullamco veniam eu culpa",
"provenance": "aliquip sunt magna ad"
}
],
"accessControl": {
"read": [
"officia qui nulla dolor",
"do in consequat eu officia",
"in culpa nulla",
"sed do et Ut ullamco",
"deserunt sed nisi laborum"
],
"write": [
"sit tempor Excepteur",
"exercitation Ut",
"do minim",
"ea consectetur adipisicing fugiat magna"
],
"execute": [
"nisi veniam enim sed magna",
"nisi ad non Lorem sunt",
"nisi occaecat ullamco",
"commodo non",
"do"
],
"manage": [
"Excepteur",
"mollit Ut ex",
"sed"
]
},
"componentIidIndex": 48986159,
"components": [
{
"iid": 35452612,
"type": "mopAnalyticTemplate",
"reference": "sed",
"folder": "/"
},
{
"iid": 3348112,
"type": "mopAnalyticTemplate",
"reference": "cupidatat",
"folder": "/"
},
{
"iid": 30985757,
"type": "workflow",
"reference": "in adipisicing",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "consequat",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": "dolore laboris",
"provenance": "pariatur incididunt irure consectetur",
"missing": true
},
"versionHistory": [
{
"versionNumber": -59325607,
"commitMessage": "cillum laborum in",
"author": "ex consectetur labore",
"branchName": "quis culpa"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "minim",
"branchName": "labore",
"projectPath": "sunt nostrud"
}
}
}
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"
}
}
}