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": "dolore",
"data": {
"_id": "5cb7b531d06cceb89fd21b1c",
"iid": 36145954,
"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": "62a1f3d2ebedfc54e6e0065c",
"role": "editor",
"missing": false,
"username": "aute amet",
"name": "et",
"provenance": "culpa ea cupidatat"
}
],
"accessControl": {
"read": [
"aliquip laboris"
],
"write": [
"dolor nulla",
"eiusmod proident occaecat",
"ut culpa fugiat id",
"irure consequat officia in eu",
"reprehenderit ipsum sint"
],
"execute": [
"nisi",
"labore sed ullamco Lorem non",
"sit"
],
"manage": [
"elit"
]
},
"componentIidIndex": 95924329,
"components": [
{
"iid": 96038893,
"type": "transformation",
"reference": "fugiat magna",
"folder": "/"
},
{
"iid": 99413652,
"type": "jsonForm",
"reference": "aute commodo laboris Ut",
"folder": "/"
},
{
"iid": 43016146,
"type": "mopCommandTemplate",
"reference": "consectetur Ut magna enim irure",
"folder": "/"
},
{
"iid": 47182384,
"type": "template",
"reference": "occaecat eu",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": "amet velit in fugiat ea",
"provenance": "aliqua veniam cupidatat Excepteur",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "5cb7b531d06cceb89fd21b1c",
"username": null,
"provenance": "sunt Duis",
"missing": false
},
"versionHistory": [
{
"versionNumber": 38538606,
"commitMessage": "aliquip laborum in quis adipisicing",
"author": "deserunt ipsum",
"branchName": "deserunt qui nulla sint"
},
{
"versionNumber": -19872162,
"commitMessage": "sed incididunt",
"author": "exercitation nostrud magna dolor",
"branchName": "magna"
},
{
"versionNumber": -71560294,
"commitMessage": "aliqua",
"author": "nostrud consectetur",
"branchName": "ut aute"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "ipsum sint adipisicing anim sunt",
"branchName": "dolor sed",
"projectPath": "ipsum in"
}
}
}
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"
}
}
}