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": "velit consectetur mollit",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 58341843,
"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": "5cb7b531d06cceb89fd21b1c",
"role": "operator",
"missing": true,
"username": "nulla aliqua",
"name": "ut amet voluptate",
"provenance": "occaecat"
}
],
"accessControl": {
"read": [
"culpa Duis quis laboris",
"est ut proident officia consectetur",
"in Lorem sint mollit et",
"proident nisi aliquip sit"
],
"write": [
"sunt dolor",
"magna incididunt anim"
],
"execute": [
"labore incididunt nulla in"
],
"manage": [
"ut reprehenderit ad ex nostrud",
"ex anim culpa eu"
]
},
"componentIidIndex": 99199156,
"components": [
{
"iid": 64074779,
"type": "mopCommandTemplate",
"reference": "aliqua dolore veniam ut",
"folder": "/"
},
{
"iid": 98847115,
"type": "jsonForm",
"reference": "tempor",
"folder": "/"
},
{
"iid": 83546972,
"type": "transformation",
"reference": "non pariatur voluptate",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "magna",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": "esse Lorem eiusmod sit",
"provenance": "deserunt aliquip incididunt id do",
"missing": true
},
"versionHistory": [
{
"versionNumber": -65394054,
"commitMessage": "aliquip in ullamco Ut eiusmod",
"author": "ipsum incididunt Duis",
"branchName": "amet minim"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "ea nulla",
"branchName": "nisi adipisicing",
"projectPath": "dolore fugiat"
}
}
}
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"
}
}
}