Class EntityApi

EntityApi - object-oriented interface

Export

EntityApi

Hierarchy

BaseAPI
- EntityApi

Index

Constructors

Properties

axios basePath configuration

Methods

entityControllerFindOne entityControllerSearch

Constructors

constructor

new EntityApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): EntityApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns EntityApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

entityControllerFindOne

entityControllerFindOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EntityOutputDTOAPI, any>>
Required permissions: READ_ENTITIES
OperationId: EntityControllerFindOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EntityOutputDTOAPI, any>>
Throws
Memberof
EntityApi
- Defined in packages/lib-apiclient/src/generated/api.ts:17985

entityControllerSearch

entityControllerSearch(
entitySearchInputDTO?: EntitySearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EntityOutputArrayDTOAPI, any>>
Required permissions: READ_ENTITIES
OperationId: EntityControllerSearch
Parameters
- OptionalentitySearchInputDTO: EntitySearchInputDTO
  EntitySearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EntityOutputArrayDTOAPI, any>>
Throws
Memberof
EntityApi
- Defined in packages/lib-apiclient/src/generated/api.ts:17999