Function EntityApiFactory

EntityApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    entityControllerFindOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EntityOutputDTOAPI>;
    entityControllerSearch(
        entitySearchInputDTO?: EntitySearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EntityOutputArrayDTOAPI>;
}
EntityApi - factory interface
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    entityControllerFindOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EntityOutputDTOAPI>;
    entityControllerSearch(
        entitySearchInputDTO?: EntitySearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EntityOutputArrayDTOAPI>;
}
- entityControllerFindOne: function
  - entityControllerFindOne(
    id: string,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<EntityOutputDTOAPI>
    Required permissions: READ_ENTITIES
    OperationId: EntityControllerFindOne
    
    Parameters
    id: string
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns AxiosPromise<EntityOutputDTOAPI>
    Throws
    Defined in packages/lib-apiclient/src/generated/api.ts:17949
- entityControllerSearch: function
  - entityControllerSearch(
    entitySearchInputDTO?: EntitySearchInputDTO,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<EntityOutputArrayDTOAPI>
    Required permissions: READ_ENTITIES
    OperationId: EntityControllerSearch
    
    Parameters
    OptionalentitySearchInputDTO: EntitySearchInputDTO
    EntitySearchInputDTO
    
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns AxiosPromise<EntityOutputArrayDTOAPI>
    Throws
    Defined in packages/lib-apiclient/src/generated/api.ts:17959
Export
- Defined in packages/lib-apiclient/src/generated/api.ts:17939

Function EntityApiFactory

Parameters

Returns { entityControllerFindOne( id: string, options?: RawAxiosRequestConfig, ): AxiosPromise<EntityOutputDTOAPI>; entityControllerSearch( entitySearchInputDTO?: EntitySearchInputDTO, options?: RawAxiosRequestConfig, ): AxiosPromise<EntityOutputArrayDTOAPI>;}

entityControllerFindOne: function

Parameters

Returns AxiosPromise<EntityOutputDTOAPI>

Throws

entityControllerSearch: function

Parameters

Returns AxiosPromise<EntityOutputArrayDTOAPI>

Throws

Export

Settings

Returns {
entityControllerFindOne(
id: string,
options?: RawAxiosRequestConfig,
): AxiosPromise<EntityOutputDTOAPI>;
entityControllerSearch(
entitySearchInputDTO?: EntitySearchInputDTO,
options?: RawAxiosRequestConfig,
): AxiosPromise<EntityOutputArrayDTOAPI>;
}