Back to Apitable

.BasicModuleAccessoryCallbackInterfaceApi

packages/api-client/BasicModuleAccessoryCallbackInterfaceApi.md

1.13.0-beta.13.2 KB
Original Source

.BasicModuleAccessoryCallbackInterfaceApi

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

MethodHTTP requestDescription
notifyCallbackPOST /asset/upload/callbackResource upload completion notification callback
widgetCallbackPOST /asset/widget/uploadCallbackwidget upload callback

notifyCallback

ResponseDataListAssetUploadResult notifyCallback(assetUploadNotifyRO)

After S3 completes the client upload, it actively reaches the notification server

Example

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

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

let body:.BasicModuleAccessoryCallbackInterfaceApiNotifyCallbackRequest = {
  // AssetUploadNotifyRO
  assetUploadNotifyRO: {
    type: 0,
    resourceKeys: ["spc10/2019/12/10/159","spc10/2019/12/10/168"],
  },
};

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

Parameters

NameTypeDescriptionNotes
assetUploadNotifyROAssetUploadNotifyRO

Return type

ResponseDataListAssetUploadResult

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]

widgetCallback

ResponseDataVoid widgetCallback(widgetUploadNotifyRO)

Example

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

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

let body:.BasicModuleAccessoryCallbackInterfaceApiWidgetCallbackRequest = {
  // WidgetUploadNotifyRO
  widgetUploadNotifyRO: {
    resourceKeys: ["widget/asset/adflkajadfj"],
  },
};

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

Parameters

NameTypeDescriptionNotes
widgetUploadNotifyROWidgetUploadNotifyRO

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]