Class DictionaryService

Index

Constructors

Methods

deleteDictionaryById getDictionary getDictionaryById getDictionaryByIdExport getItemDictionary getTreeDictionaryAncestors getTreeDictionaryChildren getTreeDictionaryRoot postDictionary postDictionaryImport putDictionaryById putDictionaryByIdMove

Constructors

constructor

new DictionaryService(): DictionaryService
Returns DictionaryService

Methods

`Static`deleteDictionaryById

deleteDictionaryById<ThrowOnError extends boolean = true>(
options: Options<DeleteDictionaryByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteDictionaryByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:358

`Static`getDictionary

getDictionary<ThrowOnError extends boolean = true>(
    options?: Options<GetDictionaryData, ThrowOnError>,
): RequestResult<
    PagedDictionaryOverviewResponseModel,
    unknown,
    ThrowOnError,
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetDictionaryData, ThrowOnError>
Returns RequestResult<PagedDictionaryOverviewResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:328

`Static`getDictionaryById

getDictionaryById<ThrowOnError extends boolean = true>(
options: Options<GetDictionaryByIdData, ThrowOnError>,
): RequestResult<DictionaryItemResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDictionaryByIdData, ThrowOnError>
Returns RequestResult<DictionaryItemResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:371

`Static`getDictionaryByIdExport

getDictionaryByIdExport<ThrowOnError extends boolean = true>(
options: Options<GetDictionaryByIdExportData, ThrowOnError>,
): RequestResult<File | Blob, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDictionaryByIdExportData, ThrowOnError>
Returns RequestResult<File | Blob, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:401

`Static`getItemDictionary

getItemDictionary<ThrowOnError extends boolean = true>(
options?: Options<GetItemDictionaryData, ThrowOnError>,
): RequestResult<DictionaryItemItemResponseModel[], unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemDictionaryData, ThrowOnError>
Returns RequestResult<DictionaryItemItemResponseModel[], unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:448

`Static`getTreeDictionaryAncestors

getTreeDictionaryAncestors<ThrowOnError extends boolean = true>(
options?: Options<GetTreeDictionaryAncestorsData, ThrowOnError>,
): RequestResult<NamedEntityTreeItemResponseModel[], unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDictionaryAncestorsData, ThrowOnError>
Returns RequestResult<NamedEntityTreeItemResponseModel[], unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:461

`Static`getTreeDictionaryChildren

getTreeDictionaryChildren<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDictionaryChildrenData, ThrowOnError>,
): RequestResult<
    PagedNamedEntityTreeItemResponseModel,
    unknown,
    ThrowOnError,
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDictionaryChildrenData, ThrowOnError>
Returns RequestResult<PagedNamedEntityTreeItemResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:474

`Static`getTreeDictionaryRoot

getTreeDictionaryRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDictionaryRootData, ThrowOnError>,
): RequestResult<
    PagedNamedEntityTreeItemResponseModel,
    unknown,
    ThrowOnError,
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDictionaryRootData, ThrowOnError>
Returns RequestResult<PagedNamedEntityTreeItemResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:487

`Static`postDictionary

postDictionary<ThrowOnError extends boolean = true>(
options?: Options<PostDictionaryData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostDictionaryData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:341

`Static`postDictionaryImport

postDictionaryImport<ThrowOnError extends boolean = true>(
options?: Options<PostDictionaryImportData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostDictionaryImportData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:431

`Static`putDictionaryById

putDictionaryById<ThrowOnError extends boolean = true>(
options: Options<PutDictionaryByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDictionaryByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:384

`Static`putDictionaryByIdMove

putDictionaryByIdMove<ThrowOnError extends boolean = true>(
options: Options<PutDictionaryByIdMoveData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDictionaryByIdMoveData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:414

Class DictionaryService

Index

Constructors

Methods

Constructors

constructor

Returns DictionaryService

Methods

StaticdeleteDictionaryById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticgetDictionary

Type Parameters

Parameters

Returns RequestResult<PagedDictionaryOverviewResponseModel, unknown, ThrowOnError>

StaticgetDictionaryById

Type Parameters

Parameters

Returns RequestResult<DictionaryItemResponseModel, unknown, ThrowOnError>

StaticgetDictionaryByIdExport

Type Parameters

Parameters

Returns RequestResult<File | Blob, unknown, ThrowOnError>

StaticgetItemDictionary

Type Parameters

Parameters

Returns RequestResult<DictionaryItemItemResponseModel[], unknown, ThrowOnError>

StaticgetTreeDictionaryAncestors

Type Parameters

Parameters

Returns RequestResult<NamedEntityTreeItemResponseModel[], unknown, ThrowOnError>

StaticgetTreeDictionaryChildren

Type Parameters

Parameters

Returns RequestResult<PagedNamedEntityTreeItemResponseModel, unknown, ThrowOnError>

StaticgetTreeDictionaryRoot

Type Parameters

Parameters

Returns RequestResult<PagedNamedEntityTreeItemResponseModel, unknown, ThrowOnError>

StaticpostDictionary

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticpostDictionaryImport

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticputDictionaryById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticputDictionaryByIdMove

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

Settings

On This Page

`Static`deleteDictionaryById

`Static`getDictionary

`Static`getDictionaryById

`Static`getDictionaryByIdExport

`Static`getItemDictionary

`Static`getTreeDictionaryAncestors

`Static`getTreeDictionaryChildren

`Static`getTreeDictionaryRoot

`Static`postDictionary

`Static`postDictionaryImport

`Static`putDictionaryById

`Static`putDictionaryByIdMove