Back to Apitable

.WidgetSDKWidgetApiApi

packages/api-client/WidgetSDKWidgetApiApi.md

1.13.0-beta.112.3 KB
Original Source

.WidgetSDKWidgetApiApi

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

MethodHTTP requestDescription
copyWidgetPOST /widget/copyCopy widget
createWidget1POST /widget/createCreate widget
findTemplatePackageListGET /widget/template/package/listGet package teamplates
findWidgetInfoByNodeIdGET /node/{nodeId}/widgetget the widget information of the node
findWidgetInfoBySpaceIdGET /space/{spaceId}/widgetGet the space widgets
findWidgetPackByNodeIdGET /node/{nodeId}/widgetPackGet the node widget package
findWidgetPackByWidgetIdsGET /widget/getGet widget info
widgetStoreListPOST /widget/package/store/listGet widget store

copyWidget

ResponseDataListWidgetPack copyWidget(widgetCopyRo)

Scenario: 1、dashboard import widget2:the widget panel sends applets to the dashboard; 3:copy widget

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .WidgetSDKWidgetApiApi(configuration);

let body:.WidgetSDKWidgetApiApiCopyWidgetRequest = {
  // WidgetCopyRo
  widgetCopyRo: {
    nodeId: "dst11/dsb11",
    widgetIds: ["wdtiJjVmNFcFmNtQFA","wdtSbp8TkH7gTGAYR1"],
  },
};

apiInstance.copyWidget(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
widgetCopyRoWidgetCopyRo

Return type

ResponseDataListWidgetPack

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]

createWidget1

ResponseDataWidgetPack createWidget1(widgetCreateRo)

Scenario:1、dashboard new applet 2、datasheet widget panel new widget

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .WidgetSDKWidgetApiApi(configuration);

let body:.WidgetSDKWidgetApiApiCreateWidget1Request = {
  // WidgetCreateRo
  widgetCreateRo: {
    nodeId: "dstAAA/dsbBBB",
    widgetPackageId: "wpkBBB",
    name: "This is a widget",
  },
};

apiInstance.createWidget1(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
widgetCreateRoWidgetCreateRo

Return type

ResponseDataWidgetPack

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]

findTemplatePackageList

ResponseDataListWidgetTemplatePackageInfo findTemplatePackageList()

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .WidgetSDKWidgetApiApi(configuration);

let body:any = {};

apiInstance.findTemplatePackageList(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

ResponseDataListWidgetTemplatePackageInfo

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]

findWidgetInfoByNodeId

ResponseDataListWidgetInfo findWidgetInfoByNodeId()

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .WidgetSDKWidgetApiApi(configuration);

let body:.WidgetSDKWidgetApiApiFindWidgetInfoByNodeIdRequest = {
  // string | node id
  nodeId: "dstJ2oRZxsh2yld4MA",
};

apiInstance.findWidgetInfoByNodeId(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

Return type

ResponseDataListWidgetInfo

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]

findWidgetInfoBySpaceId

ResponseDataListWidgetInfo findWidgetInfoBySpaceId()

get the widgets under the entire space

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .WidgetSDKWidgetApiApi(configuration);

let body:.WidgetSDKWidgetApiApiFindWidgetInfoBySpaceIdRequest = {
  // string | space id
  spaceId: "spczJrh2i3tLW",
  // number | load quantity (optional)
  count: 10,
};

apiInstance.findWidgetInfoBySpaceId(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
spaceId[string]space iddefaults to undefined
count[number]load quantity(optional) defaults to undefined

Return type

ResponseDataListWidgetInfo

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]

findWidgetPackByNodeId

ResponseDataListWidgetPack findWidgetPackByNodeId()

Node types are limited to dashboards and datasheet

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .WidgetSDKWidgetApiApi(configuration);

let body:.WidgetSDKWidgetApiApiFindWidgetPackByNodeIdRequest = {
  // string | node id
  nodeId: "dstJ2oRZxsh2yld4MA",
  // string | association id:node share id、template id (optional)
  linkId: "shr8T8vAfehg3yj3McmDG",
  // string | space id (optional)
  xSpaceId: "spczJrh2i3tLW",
};

apiInstance.findWidgetPackByNodeId(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
linkId[string]association id:node share id、template id(optional) defaults to undefined
xSpaceId[string]space id(optional) defaults to undefined

Return type

ResponseDataListWidgetPack

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]

findWidgetPackByWidgetIds

ResponseDataListWidgetPack findWidgetPackByWidgetIds()

get widget info by widget id

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .WidgetSDKWidgetApiApi(configuration);

let body:.WidgetSDKWidgetApiApiFindWidgetPackByWidgetIdsRequest = {
  // string | widget ids
  widgetIds: "wdtlMDweJzTsbSJAFY,wdt923ZpvvRhD8kVLs",
  // string | Association ID: node sharing ID and template ID (optional)
  linkId: "shr8T8vAfehg3yj3McmDG",
};

apiInstance.findWidgetPackByWidgetIds(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
widgetIds[string]widget idsdefaults to undefined
linkId[string]Association ID: node sharing ID and template ID(optional) defaults to undefined

Return type

ResponseDataListWidgetPack

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]

widgetStoreList

ResponseDataListWidgetStoreListInfo widgetStoreList(widgetStoreListRo, )

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .WidgetSDKWidgetApiApi(configuration);

let body:.WidgetSDKWidgetApiApiWidgetStoreListRequest = {
  // WidgetStoreListRo
  widgetStoreListRo: {
    filter: false,
    type: 1,
    previewSearchKeyword: "previewSearchKeyword_example",
  },
  // string | space id
  xSpaceId: "spczJrh2i3tLW",
};

apiInstance.widgetStoreList(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
widgetStoreListRoWidgetStoreListRo
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataListWidgetStoreListInfo

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]