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": "nostrud sint veniam est ex",
"data": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 33169659,
"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": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer",
"missing": true,
"username": "sint labore et reprehenderit ea",
"name": "consectetur in Lorem dolore",
"provenance": "dolore magna"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "editor",
"missing": false,
"username": "cupidatat laboris est adipisicing",
"name": "in ea",
"provenance": "veniam sit eu Ut cupidatat"
}
],
"accessControl": {
"read": [
"irure officia Duis veniam ea",
"consequat",
"in ut mollit culpa",
"non",
"ullamco dolor commodo"
],
"write": [
"cupidatat exercitation culpa",
"consequat dolore sint dolor",
"tempor non enim pariatur magna",
"non id ad",
"sunt cupidatat"
],
"execute": [
"pariatur"
],
"manage": [
"ea"
]
},
"componentIidIndex": 77398853,
"components": [
{
"iid": 89613314,
"type": "template",
"reference": "mollit dolore deserunt aute in",
"folder": "/"
},
{
"iid": 99395601,
"type": "transformation",
"reference": "irure sint ex",
"folder": "/"
},
{
"iid": 4180961,
"type": "jsonForm",
"reference": "officia do laboris ullamco",
"folder": "/"
},
{
"iid": 67106584,
"type": "mopCommandTemplate",
"reference": "in mollit nulla laboris",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": "exercitation",
"provenance": "aute in",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": "nulla dolore id Excepteur mollit",
"provenance": "nisi nostrud nulla do",
"missing": true
},
"versionHistory": [
{
"versionNumber": -50290299,
"commitMessage": "qui aliqua cillum veniam",
"author": "deserunt",
"branchName": "officia"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "ut",
"branchName": "deserunt ad ex",
"projectPath": "magna voluptate"
}
}
}
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"
}
}
}