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": "amet ullamco reprehenderit sed",
"data": {
"_id": "5cb7b531d06cceb89fd21b1c",
"iid": 59609306,
"name": "Firewall Service Provisioning",
"description": "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally",
"members": [
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator",
"missing": false,
"username": "enim",
"name": "ex",
"provenance": "eu Excepteur elit deserunt anim"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator",
"missing": true,
"username": "aute",
"name": "laborum eu ipsum",
"provenance": "dolor"
},
{
"type": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "viewer",
"missing": false,
"username": "culpa velit ex adipisicing",
"name": "tempor Duis in",
"provenance": "dolore ut"
}
],
"accessControl": {
"read": [
"est in",
"culpa officia in eu",
"dolore dolore eu in nisi",
"laborum sed eiusmod",
"minim in"
],
"write": [
"dolore velit eiusmod",
"cupidatat sed dolore",
"nostrud esse deserunt dolor"
],
"execute": [
"enim fugiat",
"tempor dolor",
"ex"
],
"manage": [
"enim ut ut deserunt in",
"sed magna incididunt irure sunt"
]
},
"componentIidIndex": 34393797,
"components": [
{
"iid": 28730940,
"type": "template",
"reference": "exercitation",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": "ipsum",
"provenance": "et",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": "anim adipisicing",
"provenance": "ex nisi",
"missing": false
},
"versionHistory": [
{
"versionNumber": 38680412,
"commitMessage": "ullamco reprehenderit minim consectetur Excepteur",
"author": "Ut dolor enim",
"branchName": "sint in"
},
{
"versionNumber": 85455759,
"commitMessage": "eiusmod fugiat minim",
"author": "culpa anim aliquip qui consequat",
"branchName": "in elit in"
},
{
"versionNumber": 8105299,
"commitMessage": "minim pariatur",
"author": "id non cillum proident aute",
"branchName": "in cupidatat ullamco nulla est"
},
{
"versionNumber": 13288203,
"commitMessage": "proident",
"author": "adipisicing voluptate elit",
"branchName": "dolore anim amet dolore"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "dolor adipisicing voluptate culpa",
"branchName": "id labore ipsum",
"projectPath": "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"
}
}
}