Back to Apitable

.TemplateCenterTemplateAlbumAPIApi

packages/api-client/TemplateCenterTemplateAlbumAPIApi.md

1.13.0-beta.13.3 KB
Original Source

.TemplateCenterTemplateAlbumAPIApi

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

MethodHTTP requestDescription
getAlbumContentGET /template/albums/{albumId}Get The Template Album Content
getRecommendedAlbumsGET /template/albums/recommendGet Recommended Template Albums

getAlbumContent

ResponseDataAlbumContentVo getAlbumContent()

Example

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

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

let body:.TemplateCenterTemplateAlbumAPIApiGetAlbumContentRequest = {
  // string | Template Album ID
  albumId: "albnafuwa2snc",
};

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

Parameters

NameTypeDescriptionNotes
albumId[string]Template Album IDdefaults to undefined

Return type

ResponseDataAlbumContentVo

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]

getRecommendedAlbums

ResponseDataListAlbumVo getRecommendedAlbums()

Example

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

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

let body:.TemplateCenterTemplateAlbumAPIApiGetRecommendedAlbumsRequest = {
  // string | Exclude Album (optional)
  excludeAlbumId: "albnafuwa2snc",
  // number | Max Count of Load.The number of response result may be smaller than it (optional)
  maxCount: 5,
};

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

Parameters

NameTypeDescriptionNotes
excludeAlbumId[string]Exclude Album(optional) defaults to undefined
maxCount[number]Max Count of Load.The number of response result may be smaller than it(optional) defaults to undefined

Return type

ResponseDataListAlbumVo

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]