packages/api-client/WorkbenchNodeRubbishApiApi.md
All URIs are relative to http://backend/api/v1
| Method | HTTP request | Description |
|---|---|---|
| _delete | POST /node/rubbish/delete/{nodeId} | Delete node in rubbish |
| delete1 | DELETE /node/rubbish/delete/{nodeId} | Delete node in rubbish |
| list3 | GET /node/rubbish/list | Get node in rubbish |
| recover | POST /node/rubbish/recover | Recover node |
ResponseDataVoid _delete()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkbenchNodeRubbishApiApi(configuration);
let body:.WorkbenchNodeRubbishApiApiDeleteRequest = {
// string | node id
nodeId: "fod8mXUeiXyVo",
// string | space id
xSpaceId: "spczJrh2i3tLW",
};
apiInstance._delete(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| nodeId | [string] | node id | defaults to undefined |
| xSpaceId | [string] | space id | defaults to undefined |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid delete1()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkbenchNodeRubbishApiApi(configuration);
let body:.WorkbenchNodeRubbishApiApiDelete1Request = {
// string | node id
nodeId: "fod8mXUeiXyVo",
// string | space id
xSpaceId: "spczJrh2i3tLW",
};
apiInstance.delete1(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| nodeId | [string] | node id | defaults to undefined |
| xSpaceId | [string] | space id | defaults to undefined |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataListRubbishNodeVo list3()
If the last node id is passed in, the service status code 422 is returned.It means that the node is no longer in the recovery compartment, the positioning fails, and the last node can be requested again.
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkbenchNodeRubbishApiApi(configuration);
let body:.WorkbenchNodeRubbishApiApiList3Request = {
// string | space id
xSpaceId: "spczJrh2i3tLW",
// number | expected load quantity(May be because the total number or permissions are not enough) (optional)
size: 15,
// boolean | whether to request an overrun node(default FALSE) (optional)
isOverLimit: true,
// string | id of the last node in the loaded list (optional)
lastNodeId: "dstM5qG7",
};
apiInstance.list3(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| xSpaceId | [string] | space id | defaults to undefined |
| size | [number] | expected load quantity(May be because the total number or permissions are not enough) | (optional) defaults to undefined |
| isOverLimit | [boolean] | whether to request an overrun node(default FALSE) | (optional) defaults to undefined |
| lastNodeId | [string] | id of the last node in the loaded list | (optional) defaults to undefined |
ResponseDataListRubbishNodeVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataNodeInfoVo recover(nodeRecoverRo, )
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkbenchNodeRubbishApiApi(configuration);
let body:.WorkbenchNodeRubbishApiApiRecoverRequest = {
// NodeRecoverRo
nodeRecoverRo: {
nodeId: "nod10",
parentId: "nod10",
},
// string | space id
xSpaceId: "spczJrh2i3tLW",
};
apiInstance.recover(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| nodeRecoverRo | NodeRecoverRo | ||
| xSpaceId | [string] | space id | defaults to undefined |
ResponseDataNodeInfoVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]