Back to Apitable

.WorkbenchNodeRubbishApiApi

packages/api-client/WorkbenchNodeRubbishApiApi.md

1.13.0-beta.16.6 KB
Original Source

.WorkbenchNodeRubbishApiApi

All URIs are relative to http://backend/api/v1

MethodHTTP requestDescription
_deletePOST /node/rubbish/delete/{nodeId}Delete node in rubbish
delete1DELETE /node/rubbish/delete/{nodeId}Delete node in rubbish
list3GET /node/rubbish/listGet node in rubbish
recoverPOST /node/rubbish/recoverRecover node

_delete

ResponseDataVoid _delete()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
nodeId[string]node iddefaults to undefined
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete1

ResponseDataVoid delete1()

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
nodeId[string]node iddefaults to undefined
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list3

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.

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
xSpaceId[string]space iddefaults 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

Return type

ResponseDataListRubbishNodeVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

recover

ResponseDataNodeInfoVo recover(nodeRecoverRo, )

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
nodeRecoverRoNodeRecoverRo
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataNodeInfoVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]