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<
    DeleteDictionaryByIdResponses,
    DeleteDictionaryByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes a dictionary.

Deletes a dictionary identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteDictionaryByIdData, ThrowOnError>
Returns RequestResult<
    DeleteDictionaryByIdResponses,
    DeleteDictionaryByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:548

`Static`getDictionary

getDictionary<ThrowOnError extends boolean = true>(
    options?: Options<GetDictionaryData, ThrowOnError>,
): RequestResult<
    GetDictionaryResponses,
    GetDictionaryErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of dictionary items.

Gets a paginated collection of dictionary items with optional filtering by name.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetDictionaryData, ThrowOnError>
Returns RequestResult<
    GetDictionaryResponses,
    GetDictionaryErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:508

`Static`getDictionaryById

getDictionaryById<ThrowOnError extends boolean = true>(
    options: Options<GetDictionaryByIdData, ThrowOnError>,
): RequestResult<
    GetDictionaryByIdResponses,
    GetDictionaryByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a dictionary.

Gets a dictionary identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDictionaryByIdData, ThrowOnError>
Returns RequestResult<
    GetDictionaryByIdResponses,
    GetDictionaryByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:566

`Static`getDictionaryByIdExport

getDictionaryByIdExport<ThrowOnError extends boolean = true>(
    options: Options<GetDictionaryByIdExportData, ThrowOnError>,
): RequestResult<
    GetDictionaryByIdExportResponses,
    GetDictionaryByIdExportErrors,
    ThrowOnError,
    "fields",
>
Exports a dictionary.

Exports the dictionary identified by the provided Id to a downloadable format.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDictionaryByIdExportData, ThrowOnError>
Returns RequestResult<
    GetDictionaryByIdExportResponses,
    GetDictionaryByIdExportErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:606

`Static`getItemDictionary

getItemDictionary<ThrowOnError extends boolean = true>(
    options?: Options<GetItemDictionaryData, ThrowOnError>,
): RequestResult<
    GetItemDictionaryResponses,
    GetItemDictionaryErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of dictionary items.

Gets a collection of dictionary items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemDictionaryData, ThrowOnError>
Returns RequestResult<
    GetItemDictionaryResponses,
    GetItemDictionaryErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:668

`Static`getTreeDictionaryAncestors

getTreeDictionaryAncestors<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDictionaryAncestorsData, ThrowOnError>,
): RequestResult<
    GetTreeDictionaryAncestorsResponses,
    GetTreeDictionaryAncestorsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of ancestor dictionary items.

Gets a collection of dictionary items that are ancestors to the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDictionaryAncestorsData, ThrowOnError>
Returns RequestResult<
    GetTreeDictionaryAncestorsResponses,
    GetTreeDictionaryAncestorsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:686

`Static`getTreeDictionaryChildren

getTreeDictionaryChildren<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDictionaryChildrenData, ThrowOnError>,
): RequestResult<
    GetTreeDictionaryChildrenResponses,
    GetTreeDictionaryChildrenErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of dictionary tree child items.

Gets a paginated collection of dictionary tree items that are children of the provided parent Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDictionaryChildrenData, ThrowOnError>
Returns RequestResult<
    GetTreeDictionaryChildrenResponses,
    GetTreeDictionaryChildrenErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:704

`Static`getTreeDictionaryRoot

getTreeDictionaryRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDictionaryRootData, ThrowOnError>,
): RequestResult<
    GetTreeDictionaryRootResponses,
    GetTreeDictionaryRootErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of dictionary items from the root of the tree.

Gets a paginated collection of dictionary items from the root of the tree with optional filtering.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDictionaryRootData, ThrowOnError>
Returns RequestResult<
    GetTreeDictionaryRootResponses,
    GetTreeDictionaryRootErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:722

`Static`postDictionary

postDictionary<ThrowOnError extends boolean = true>(
    options?: Options<PostDictionaryData, ThrowOnError>,
): RequestResult<
    PostDictionaryResponses,
    PostDictionaryErrors,
    ThrowOnError,
    "fields",
>
Creates a new dictionary.

Creates a new dictionary with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostDictionaryData, ThrowOnError>
Returns RequestResult<
    PostDictionaryResponses,
    PostDictionaryErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:526

`Static`postDictionaryImport

postDictionaryImport<ThrowOnError extends boolean = true>(
    options?: Options<PostDictionaryImportData, ThrowOnError>,
): RequestResult<
    PostDictionaryImportResponses,
    PostDictionaryImportErrors,
    ThrowOnError,
    "fields",
>
Imports a dictionary.

Imports a dictionary from the provided file upload.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostDictionaryImportData, ThrowOnError>
Returns RequestResult<
    PostDictionaryImportResponses,
    PostDictionaryImportErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:646

`Static`putDictionaryById

putDictionaryById<ThrowOnError extends boolean = true>(
    options: Options<PutDictionaryByIdData, ThrowOnError>,
): RequestResult<
    PutDictionaryByIdResponses,
    PutDictionaryByIdErrors,
    ThrowOnError,
    "fields",
>
Updates a dictionary.

Updates a dictionary identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDictionaryByIdData, ThrowOnError>
Returns RequestResult<
    PutDictionaryByIdResponses,
    PutDictionaryByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:584

`Static`putDictionaryByIdMove

putDictionaryByIdMove<ThrowOnError extends boolean = true>(
    options: Options<PutDictionaryByIdMoveData, ThrowOnError>,
): RequestResult<
    PutDictionaryByIdMoveResponses,
    PutDictionaryByIdMoveErrors,
    ThrowOnError,
    "fields",
>
Moves a dictionary.

Moves a dictionary identified by the provided Id to a different location.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDictionaryByIdMoveData, ThrowOnError>
Returns RequestResult<
    PutDictionaryByIdMoveResponses,
    PutDictionaryByIdMoveErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:624

Class DictionaryService

Index

Constructors

Methods

Constructors

constructor

Returns DictionaryService

Methods

StaticdeleteDictionaryById

Type Parameters

Parameters

Returns RequestResult< DeleteDictionaryByIdResponses, DeleteDictionaryByIdErrors, ThrowOnError, "fields",>

StaticgetDictionary

Type Parameters

Parameters

Returns RequestResult< GetDictionaryResponses, GetDictionaryErrors, ThrowOnError, "fields",>

StaticgetDictionaryById

Type Parameters

Parameters

Returns RequestResult< GetDictionaryByIdResponses, GetDictionaryByIdErrors, ThrowOnError, "fields",>

StaticgetDictionaryByIdExport

Type Parameters

Parameters

Returns RequestResult< GetDictionaryByIdExportResponses, GetDictionaryByIdExportErrors, ThrowOnError, "fields",>

StaticgetItemDictionary

Type Parameters

Parameters

Returns RequestResult< GetItemDictionaryResponses, GetItemDictionaryErrors, ThrowOnError, "fields",>

StaticgetTreeDictionaryAncestors

Type Parameters

Parameters

Returns RequestResult< GetTreeDictionaryAncestorsResponses, GetTreeDictionaryAncestorsErrors, ThrowOnError, "fields",>

StaticgetTreeDictionaryChildren

Type Parameters

Parameters

Returns RequestResult< GetTreeDictionaryChildrenResponses, GetTreeDictionaryChildrenErrors, ThrowOnError, "fields",>

StaticgetTreeDictionaryRoot

Type Parameters

Parameters

Returns RequestResult< GetTreeDictionaryRootResponses, GetTreeDictionaryRootErrors, ThrowOnError, "fields",>

StaticpostDictionary

Type Parameters

Parameters

Returns RequestResult< PostDictionaryResponses, PostDictionaryErrors, ThrowOnError, "fields",>

StaticpostDictionaryImport

Type Parameters

Parameters

Returns RequestResult< PostDictionaryImportResponses, PostDictionaryImportErrors, ThrowOnError, "fields",>

StaticputDictionaryById

Type Parameters

Parameters

Returns RequestResult< PutDictionaryByIdResponses, PutDictionaryByIdErrors, ThrowOnError, "fields",>

StaticputDictionaryByIdMove

Type Parameters

Parameters

Returns RequestResult< PutDictionaryByIdMoveResponses, PutDictionaryByIdMoveErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deleteDictionaryById

Returns RequestResult<
DeleteDictionaryByIdResponses,
DeleteDictionaryByIdErrors,
ThrowOnError,
"fields",
>

`Static`getDictionary

Returns RequestResult<
GetDictionaryResponses,
GetDictionaryErrors,
ThrowOnError,
"fields",
>

`Static`getDictionaryById

Returns RequestResult<
GetDictionaryByIdResponses,
GetDictionaryByIdErrors,
ThrowOnError,
"fields",
>

`Static`getDictionaryByIdExport

Returns RequestResult<
GetDictionaryByIdExportResponses,
GetDictionaryByIdExportErrors,
ThrowOnError,
"fields",
>

`Static`getItemDictionary

Returns RequestResult<
GetItemDictionaryResponses,
GetItemDictionaryErrors,
ThrowOnError,
"fields",
>

`Static`getTreeDictionaryAncestors

Returns RequestResult<
GetTreeDictionaryAncestorsResponses,
GetTreeDictionaryAncestorsErrors,
ThrowOnError,
"fields",
>

`Static`getTreeDictionaryChildren

Returns RequestResult<
GetTreeDictionaryChildrenResponses,
GetTreeDictionaryChildrenErrors,
ThrowOnError,
"fields",
>

`Static`getTreeDictionaryRoot

Returns RequestResult<
GetTreeDictionaryRootResponses,
GetTreeDictionaryRootErrors,
ThrowOnError,
"fields",
>

`Static`postDictionary

Returns RequestResult<
PostDictionaryResponses,
PostDictionaryErrors,
ThrowOnError,
"fields",
>

`Static`postDictionaryImport

Returns RequestResult<
PostDictionaryImportResponses,
PostDictionaryImportErrors,
ThrowOnError,
"fields",
>

`Static`putDictionaryById

Returns RequestResult<
PutDictionaryByIdResponses,
PutDictionaryByIdErrors,
ThrowOnError,
"fields",
>

`Static`putDictionaryByIdMove

Returns RequestResult<
PutDictionaryByIdMoveResponses,
PutDictionaryByIdMoveErrors,
ThrowOnError,
"fields",
>