Back to Apitable

.WidgetUploadAPIApi

packages/api-client/WidgetUploadAPIApi.md

1.13.0-beta.13.1 KB
Original Source

.WidgetUploadAPIApi

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

MethodHTTP requestDescription
generateWidgetPreSignedUrlPOST /asset/widget/{packageId}/uploadPreSignedUrlGet widget file upload pre signed url
getWidgetUploadMetaPOST /asset/widget/uploadMetaget widget upload meta

generateWidgetPreSignedUrl

ResponseDataListWidgetUploadTokenVo generateWidgetPreSignedUrl(widgetAssetUploadCertificateRO, )

Example

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

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

let body:.WidgetUploadAPIApiGenerateWidgetPreSignedUrlRequest = {
  // WidgetAssetUploadCertificateRO
  widgetAssetUploadCertificateRO: {
    filenames: [
      "filenames_example",
    ],
    fileType: 1,
    count: 1,
    version: "version_example",
    fileExtName: [
      "fileExtName_example",
    ],
  },
  // string
  packageId: "packageId_example",
};

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

Parameters

NameTypeDescriptionNotes
widgetAssetUploadCertificateROWidgetAssetUploadCertificateRO
packageId[string]defaults to undefined

Return type

ResponseDataListWidgetUploadTokenVo

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]

getWidgetUploadMeta

ResponseDataWidgetUploadMetaVo getWidgetUploadMeta()

get widget upload meta

Example

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

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

let body:any = {};

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

ResponseDataWidgetUploadMetaVo

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]