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": "reprehenderit esse proident",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 15440402,
"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": "4321abcdef694aa79dae47ad",
"role": "viewer",
"missing": false,
"username": "quis",
"name": "ut cupidatat ex exercitation",
"provenance": "nisi laboris"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "editor",
"missing": false,
"username": "cillum et anim culpa",
"name": "eu adipisicing",
"provenance": "dolor deserunt et nostrud eiusmod"
}
],
"accessControl": {
"read": [
"reprehenderit nulla sint amet",
"cupidatat nulla adipisicing qui",
"veniam in id voluptate",
"officia ad commodo",
"tempor sed Duis"
],
"write": [
"in voluptate amet officia eiusmod",
"aute",
"ut proident sed ullamco dolor",
"ad sint",
"officia ad ex deserunt enim"
],
"execute": [
"sunt Ut consectetur",
"sed",
"Excepteur deserunt dolore non commodo",
"nostrud in Duis fugiat aliquip",
"Lorem dolore dolore consequat tempor"
],
"manage": [
"reprehenderit ad est laborum",
"incididunt sed labore irure ut",
"dolor culpa eu"
]
},
"componentIidIndex": 45262019,
"components": [
{
"iid": 47155768,
"type": "transformation",
"reference": "reprehenderit anim commodo qui",
"folder": "/"
},
{
"iid": 32098044,
"type": "jsonForm",
"reference": "proident laborum",
"folder": "/"
},
{
"iid": 69702578,
"type": "mopAnalyticTemplate",
"reference": "dolore Duis officia in ex",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "5cb7b531d06cceb89fd21b1c",
"username": null,
"provenance": "magna",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": "deserunt cillum mollit eiusmod",
"provenance": "Excepteur voluptate elit dolor laboris",
"missing": false
},
"versionHistory": [
{
"versionNumber": 84736972,
"commitMessage": "officia dolore consequat",
"author": "sunt in ut eu sed",
"branchName": "Lorem aliquip sit"
},
{
"versionNumber": 87457211,
"commitMessage": "sit",
"author": "cillum aliqua fugiat magna",
"branchName": "enim do eu labore"
},
{
"versionNumber": -74257881,
"commitMessage": "esse commodo",
"author": "fugiat quis in",
"branchName": "voluptate sit qui dolor"
},
{
"versionNumber": -50194274,
"commitMessage": "sed",
"author": "ut in dolore",
"branchName": "ut velit dolore"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "id dolor ipsum",
"branchName": "laborum pariatur Lorem",
"projectPath": "in veniam sunt"
}
}
}
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"
}
}
}