packages/api-client/InternalServiceNodeInterfaceApi.md
All URIs are relative to http://backend/api/v1
| Method | HTTP request | Description |
|---|---|---|
| createDatasheet | POST /internal/spaces/{spaceId}/datasheets | create a table node |
| deleteNode | POST /internal/spaces/{spaceId}/nodes/{nodeId}/delete | delete node |
| filter | GET /internal/spaces/{spaceId}/nodes | Get filter nodes by type, permissions and node name. |
ResponseDataCreateDatasheetVo createDatasheet(createDatasheetRo, )
create a table node
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceNodeInterfaceApi(configuration);
let body:.InternalServiceNodeInterfaceApiCreateDatasheetRequest = {
// CreateDatasheetRo
createDatasheetRo: {
name: "This is a node",
folderId: "nod10",
preNodeId: "nod10",
description: "This is a table",
},
// string
spaceId: "spaceId_example",
};
apiInstance.createDatasheet(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| createDatasheetRo | CreateDatasheetRo | ||
| spaceId | [string] | defaults to undefined |
ResponseDataCreateDatasheetVo
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 deleteNode()
delete node
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceNodeInterfaceApi(configuration);
let body:.InternalServiceNodeInterfaceApiDeleteNodeRequest = {
// string
spaceId: "spaceId_example",
// string
nodeId: "nodeId_example",
};
apiInstance.deleteNode(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | defaults to undefined | |
| nodeId | [string] | 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]
ResponseDataListNodeInfo filter()
scenario: query an existing read-only dashboard
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .InternalServiceNodeInterfaceApi(configuration);
let body:.InternalServiceNodeInterfaceApiFilterRequest = {
// string
spaceId: "spaceId_example",
// number
type: 1,
// Array<number> (optional)
nodePermissions: [0,1,2,3],
// string (optional)
keyword: "",
};
apiInstance.filter(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | defaults to undefined | |
| type | [number] | defaults to undefined | |
| nodePermissions | Array<number> | (optional) defaults to undefined | |
| keyword | [string] | (optional) defaults to '' |
ResponseDataListNodeInfo
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]