packages/api-client/WorkbenchNodeFavoriteApiApi.md
All URIs are relative to http://backend/api/v1
| Method | HTTP request | Description |
|---|---|---|
| list5 | GET /node/favorite/list | Get favorite nodes |
| move1 | POST /node/favorite/move | Move favorite node |
| updateStatus | POST /node/favorite/updateStatus/{nodeId} | Change favorite status |
ResponseDataListFavoriteNodeInfo list5()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkbenchNodeFavoriteApiApi(configuration);
let body:.WorkbenchNodeFavoriteApiApiList5Request = {
// string | space id
xSpaceId: "spczJrh2i3tLW",
};
apiInstance.list5(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 |
ResponseDataListFavoriteNodeInfo
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 move1(markNodeMoveRo, )
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkbenchNodeFavoriteApiApi(configuration);
let body:.WorkbenchNodeFavoriteApiApiMove1Request = {
// MarkNodeMoveRo
markNodeMoveRo: {
nodeId: "nod10",
preNodeId: "nod10",
},
// string | space id
xSpaceId: "spczJrh2i3tLW",
};
apiInstance.move1(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| markNodeMoveRo | MarkNodeMoveRo | ||
| 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 updateStatus()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkbenchNodeFavoriteApiApi(configuration);
let body:.WorkbenchNodeFavoriteApiApiUpdateStatusRequest = {
// string | node id
nodeId: "fod8mXUeiXyVo",
// string | space id
xSpaceId: "spczJrh2i3tLW",
// string | user socket id (optional)
xSocketId: "QkKp9XJEl",
};
apiInstance.updateStatus(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 |
| xSocketId | [string] | user socket id | (optional) 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]