Back to Apitable

.SpaceSubAdminApiApi

packages/api-client/SpaceSubAdminApiApi.md

1.13.0-beta.18.0 KB
Original Source

.SpaceSubAdminApiApi

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

MethodHTTP requestDescription
addRolePOST /space/addRoleCreate space role
deleteRoleDELETE /space/deleteRole/{memberId}delete admin
editRolePOST /space/editRoleEdite space role
getRoleDetailGET /space/getRoleDetailquery admin detail
listRoleGET /space/listRoleQuery admins

addRole

ResponseDataVoid addRole(addSpaceRoleRo, )

Example

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

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

let body:.SpaceSubAdminApiApiAddRoleRequest = {
  // AddSpaceRoleRo
  addSpaceRoleRo: {
    memberIds: [1,2],
    resourceCodes: ["MANAGE_TEAM","MANAGE_MEMBER"],
  },
  // string | space id
  xSpaceId: "spcyQkKp9XJEl",
};

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

Parameters

NameTypeDescriptionNotes
addSpaceRoleRoAddSpaceRoleRo
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]

deleteRole

ResponseData deleteRole()

delete admin

Example

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

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

let body:.SpaceSubAdminApiApiDeleteRoleRequest = {
  // number
  memberId: 1,
  // string | space id
  xSpaceId: "spcyQkKp9XJEl",
};

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

Parameters

NameTypeDescriptionNotes
memberId[number]defaults to undefined
xSpaceId[string]space iddefaults to undefined

Return type

ResponseData

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]

editRole

ResponseData editRole(updateSpaceRoleRo, )

Example

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

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

let body:.SpaceSubAdminApiApiEditRoleRequest = {
  // UpdateSpaceRoleRo
  updateSpaceRoleRo: {
    id: 1,
    memberId: 1,
    resourceCodes: ["MANAGE_TEAM","MANAGE_MEMBER"],
  },
  // string | space id
  xSpaceId: "spcyQkKp9XJEl",
};

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

Parameters

NameTypeDescriptionNotes
updateSpaceRoleRoUpdateSpaceRoleRo
xSpaceId[string]space iddefaults to undefined

Return type

ResponseData

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]

getRoleDetail

ResponseDataSpaceRoleDetailVo getRoleDetail()

Example

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

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

let body:.SpaceSubAdminApiApiGetRoleDetailRequest = {
  // number
  memberId: 1,
  // string | space id
  xSpaceId: "spcyQkKp9XJEl",
};

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

Parameters

NameTypeDescriptionNotes
memberId[number]defaults to undefined
xSpaceId[string]space iddefaults to undefined

Return type

ResponseDataSpaceRoleDetailVo

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]

listRole

ResponseDataPageInfoSpaceRoleVo listRole()

Page query sub admin.Description of Paging: pageNo: number of paging pageSize: size of paging。 order: order in current page。 sort: sorting in current page。 simple usage example:{"pageNo":1,"pageSize":20} complex usage example:{"pageNo":1,"pageSize":20,"order":"createTime,updateTime","sort":"asc,desc"}

Example

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

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

let body:.SpaceSubAdminApiApiListRoleRequest = {
  // Page
  page: {
    records: [
      {},
    ],
    total: 1,
    size: 1,
    current: 1,
    orders: [
      {
        column: "column_example",
        asc: true,
      },
    ],
    optimizeCountSql: true,
    searchCount: true,
    optimizeJoinOfCountSql: true,
    countId: "countId_example",
    maxLimit: 1,
    pages: 1,
  },
  // string | space id
  xSpaceId: "spcyQkKp9XJEl",
  // string | paging parameters
  pageObjectParams: "{"pageNo":1,"pageSize":20}",
};

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

Parameters

NameTypeDescriptionNotes
pagePagedefaults to undefined
xSpaceId[string]space iddefaults to undefined
pageObjectParams[string]paging parametersdefaults to undefined

Return type

ResponseDataPageInfoSpaceRoleVo

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]