Back to Apitable

.WorkbenchNodeFavoriteApiApi

packages/api-client/WorkbenchNodeFavoriteApiApi.md

1.13.0-beta.14.5 KB
Original Source

.WorkbenchNodeFavoriteApiApi

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

MethodHTTP requestDescription
list5GET /node/favorite/listGet favorite nodes
move1POST /node/favorite/moveMove favorite node
updateStatusPOST /node/favorite/updateStatus/{nodeId}Change favorite status

list5

ResponseDataListFavoriteNodeInfo list5()

Example

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

Parameters

NameTypeDescriptionNotes
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataListFavoriteNodeInfo

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]

move1

ResponseDataVoid move1(markNodeMoveRo, )

Example

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

Parameters

NameTypeDescriptionNotes
markNodeMoveRoMarkNodeMoveRo
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataVoid

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]

updateStatus

ResponseDataVoid updateStatus()

Example

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

Parameters

NameTypeDescriptionNotes
nodeId[string]node iddefaults to undefined
xSpaceId[string]space iddefaults to undefined
xSocketId[string]user socket id(optional) defaults 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]