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": "culpa sunt veniam pariatur",
"data": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 74009518,
"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": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator",
"missing": true,
"username": "anim qui dolor irure",
"name": "pariatur et nostrud aliquip",
"provenance": "Excepteur"
},
{
"type": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "operator",
"missing": true,
"username": "reprehenderit deserunt",
"name": "ipsum in",
"provenance": "amet ex veniam quis pariatur"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "owner",
"missing": true,
"username": "mollit anim",
"name": "officia ut sint exercitation",
"provenance": "quis est consectetur"
}
],
"accessControl": {
"read": [
"dolor mollit sed laboris",
"cillum in aliqua minim",
"esse nostrud non do",
"consectetur Excepteur fugiat",
"exercitation officia cupidatat"
],
"write": [
"consequat laborum",
"eiusmod",
"sed tempor",
"et"
],
"execute": [
"commodo",
"incididunt"
],
"manage": [
"nulla",
"in velit do est",
"ea ad dolor officia sed",
"reprehenderit Ut sint nulla"
]
},
"componentIidIndex": 48578561,
"components": [
{
"iid": 59208753,
"type": "mopAnalyticTemplate",
"reference": "aliqua culpa officia quis aute",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"username": "anim",
"provenance": "eu tempor",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": "in",
"provenance": "enim dolor",
"missing": false
},
"versionHistory": [
{
"versionNumber": 9676220,
"commitMessage": "minim elit commodo Lorem incididunt",
"author": "amet",
"branchName": "qui"
},
{
"versionNumber": 5608975,
"commitMessage": "in",
"author": "enim",
"branchName": "et magna ullamco Excepteur in"
},
{
"versionNumber": 32540671,
"commitMessage": "enim ut",
"author": "Ut velit labore culpa",
"branchName": "labore dolore et deserunt"
},
{
"versionNumber": -80164700,
"commitMessage": "laboris officia amet culpa enim",
"author": "mollit commodo aliqua ipsum",
"branchName": "sunt"
},
{
"versionNumber": -63230197,
"commitMessage": "aute",
"author": "eiusmod et culpa Excepteur in",
"branchName": "ullamco veniam voluptate dolore"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "in",
"branchName": "et nostrud labore cillum qui",
"projectPath": "velit ut aute id esse"
}
}
}
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"
}
}
}