Back to Apitable

.ContactOrganizationApiApi

packages/api-client/ContactOrganizationApiApi.md

1.13.0-beta.111.6 KB
Original Source

.ContactOrganizationApiApi

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

MethodHTTP requestDescription
getSubUnitListGET /org/getSubUnitListQuery the sub departments and members of department
loadOrSearchGET /org/loadOrSearchLoad/search departments and members
searchGET /org/searchUnitsearch organization resources
searchSubTeamAndMembersGET /org/search/unitSearch departments or members(it will be abandoned)
searchTeamInfoGET /org/searchGlobal search
searchUnitInfoVoPOST /org/searchUnitInfoVoaccurately query departments and members

getSubUnitList

ResponseDataSubUnitResultVo getSubUnitList()

Query the sub departments and members of department. if team id lack, default is 0

Example

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

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

let body:.ContactOrganizationApiApiGetSubUnitListRequest = {
  // string | team id (optional)
  teamId: "0",
  // string | link id: node share id | template id (optional)
  linkId: "shr8Txx",
  // string | space id (optional)
  xSpaceId: "spcyQkKp9XJEl",
};

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

Parameters

NameTypeDescriptionNotes
teamId[string]team id(optional) defaults to undefined
linkId[string]link id: node share idtemplate id
xSpaceId[string]space id(optional) defaults to undefined

Return type

ResponseDataSubUnitResultVo

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]

loadOrSearch

ResponseDataListUnitInfoVo loadOrSearch()

The most recently selected units are loaded by default when not keyword. The most recently added member of the same group are loaded when not selected. Load max 10

Example

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

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

let body:.ContactOrganizationApiApiLoadOrSearchRequest = {
  // LoadSearchDTO
  params: {
    keyword: "keyword_example",
    linkId: "linkId_example",
    unitIds: [
      1,
    ],
    filterIds: [
      1,
    ],
    all: true,
    searchEmail: true,
    userId: "userId_example",
  },
  // string | space id (optional)
  xSpaceId: "spczJrh2i3tLW",
  // string | link id: node share id | template id (optional)
  linkId: "shr8Tx",
  // string | keyword (optional)
  keyword: "Lili",
  // string | unitIds (optional)
  unitIds: "1271,1272",
  // string | specifies the organizational unit to filter (optional)
  filterIds: "123,124",
  // boolean | whether to load all departments and members (optional)
  all: true,
  // boolean | whether to search for emails (optional)
  searchEmail: true,
};

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

Parameters

NameTypeDescriptionNotes
paramsLoadSearchDTOdefaults to undefined
xSpaceId[string]space id(optional) defaults to undefined
linkId[string]link id: node share idtemplate id
keyword[string]keyword(optional) defaults to undefined
unitIds[string]unitIds(optional) defaults to undefined
filterIds[string]specifies the organizational unit to filter(optional) defaults to undefined
all[boolean]whether to load all departments and members(optional) defaults to undefined
searchEmail[boolean]whether to search for emails(optional) defaults to undefined

Return type

ResponseDataListUnitInfoVo

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]

search

ResponseDataUnitSearchResultVo search()

Provide input word fuzzy search organization resources

Example

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

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

let body:.ContactOrganizationApiApiSearchRequest = {
  // string | keyword
  keyword: "design",
  // string | link id: node share id | template id (optional)
  linkId: "shr8Tx",
  // string | the highlight style (optional)
  className: "highLight",
  // string | space id (optional)
  xSpaceId: "spcyQkKp9XJEl",
};

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

Parameters

NameTypeDescriptionNotes
keyword[string]keyworddefaults to undefined
linkId[string]link id: node share idtemplate id
className[string]the highlight style(optional) defaults to undefined
xSpaceId[string]space id(optional) defaults to undefined

Return type

ResponseDataUnitSearchResultVo

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]

searchSubTeamAndMembers

ResponseDataListOrganizationUnitVo searchSubTeamAndMembers()

fuzzy search unit

Example

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

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

let body:.ContactOrganizationApiApiSearchSubTeamAndMembersRequest = {
  // string | keyword
  keyword: "design",
  // string | space id
  xSpaceId: "spcyQkKp9XJEl",
  // string | the highlight style (optional)
  className: "highLight",
};

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

Parameters

NameTypeDescriptionNotes
keyword[string]keyworddefaults to undefined
xSpaceId[string]space iddefaults to undefined
className[string]the highlight style(optional) defaults to undefined

Return type

ResponseDataListOrganizationUnitVo

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]

searchTeamInfo

ResponseDataSearchResultVo searchTeamInfo()

fuzzy search department or members

Example

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

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

let body:.ContactOrganizationApiApiSearchTeamInfoRequest = {
  // string | keyword
  keyword: "design",
  // string | space id
  xSpaceId: "spcyQkKp9XJEl",
  // string | the highlight style (optional)
  className: "highLight",
};

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

Parameters

NameTypeDescriptionNotes
keyword[string]keyworddefaults to undefined
xSpaceId[string]space iddefaults to undefined
className[string]the highlight style(optional) defaults to undefined

Return type

ResponseDataSearchResultVo

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]

searchUnitInfoVo

ResponseDataListUnitInfoVo searchUnitInfoVo(searchUnitRo)

scenario field conversion(If the amount of data is large, the content requested by GET will exceed the limit.)

Example

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

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

let body:.ContactOrganizationApiApiSearchUnitInfoVoRequest = {
  // SearchUnitRo
  searchUnitRo: {
    names: "Zhang San, Li Si",
    linkId: "shr8T8vAfehg3yj3McmDG",
  },
  // string | space id (optional)
  xSpaceId: "spczJrh2i3tLW",
};

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

Parameters

NameTypeDescriptionNotes
searchUnitRoSearchUnitRo
xSpaceId[string]space id(optional) defaults to undefined

Return type

ResponseDataListUnitInfoVo

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]