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": "proident commodo ea",
"data": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 48503777,
"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": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "viewer",
"missing": true,
"username": "Ut irure",
"name": "proident aliquip Duis",
"provenance": "esse do sunt"
}
],
"accessControl": {
"read": [
"Excepteur",
"occaecat dolore Ut cupidatat tempor",
"aliqua adipisicing Duis"
],
"write": [
"aliqua ex ea",
"sed"
],
"execute": [
"qui proident in ad",
"mollit aliqua do dolore et"
],
"manage": [
"id sit Excepteur",
"sit",
"ad dolore Lorem aliquip",
"sit incididunt sed proident qui",
"dolor laborum esse Lorem dolore"
]
},
"componentIidIndex": 38358155,
"components": [
{
"iid": 85447477,
"type": "jsonForm",
"reference": "eiusmod aliquip occaecat qui anim",
"folder": "/"
},
{
"iid": 62812455,
"type": "workflow",
"reference": "dolor labore eu ipsum nisi",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": "voluptate dolor dolore sed",
"provenance": "culpa",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "nulla do",
"missing": false
},
"versionHistory": [
{
"versionNumber": -56852738,
"commitMessage": "aliqua non quis consequat",
"author": "nisi cillum labore nulla esse",
"branchName": "esse nulla"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "quis ullamco enim ipsum",
"branchName": "nulla sunt do minim dolore",
"projectPath": "fugiat ullamco"
}
}
}
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"
}
}
}