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": "occaecat cupidatat",
"data": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 18863357,
"name": "Arista EOS Utilities",
"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": "62a1f3d2ebedfc54e6e0065c",
"role": "editor",
"missing": false,
"username": "magna esse consequat amet",
"name": "eiusmod",
"provenance": "dolore nostrud laborum"
}
],
"accessControl": {
"read": [
"occaecat velit deserunt proident ea",
"elit voluptate occaecat"
],
"write": [
"Ut Lorem cupidatat magna",
"pariatur minim magna deserunt"
],
"execute": [
"irure ea in"
],
"manage": [
"sit adipisicing consectetur",
"sint sit in",
"dolor do eiusmod ut",
"qui elit mollit sit sunt"
]
},
"componentIidIndex": 58260000,
"components": [
{
"iid": 63441805,
"type": "template",
"reference": "reprehenderit in ut",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "ex",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"username": "non incididunt nulla mollit",
"provenance": "Duis et",
"missing": false
},
"versionHistory": [
{
"versionNumber": -58823027,
"commitMessage": "eu",
"author": "sit",
"branchName": "cupidatat veniam laborum anim sunt"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "eiusmod voluptate",
"branchName": "voluptate",
"projectPath": "eiusmod anim veniam nostrud proident"
}
}
}
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"
}
}
}