Class TemplateService

Index

Constructors

Methods

deleteTemplateById getItemTemplate getItemTemplateAncestors getItemTemplateSearch getTemplateById getTemplateConfiguration getTemplateQuerySettings getTreeTemplateAncestors getTreeTemplateChildren getTreeTemplateRoot getTreeTemplateSiblings postTemplate postTemplateQueryExecute putTemplateById

Constructors

constructor

new TemplateService(): TemplateService
Returns TemplateService

Methods

`Static`deleteTemplateById

deleteTemplateById<ThrowOnError extends boolean = true>(
    options: Options<DeleteTemplateByIdData, ThrowOnError>,
): RequestResult<
    DeleteTemplateByIdResponses,
    DeleteTemplateByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes a template.

Deletes a template identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteTemplateByIdData, ThrowOnError>
Returns RequestResult<
    DeleteTemplateByIdResponses,
    DeleteTemplateByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7226

`Static`getItemTemplate

getItemTemplate<ThrowOnError extends boolean = true>(
    options?: Options<GetItemTemplateData, ThrowOnError>,
): RequestResult<
    GetItemTemplateResponses,
    GetItemTemplateErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of template items.

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

`Static`getItemTemplateAncestors

getItemTemplateAncestors<ThrowOnError extends boolean = true>(
    options?: Options<GetItemTemplateAncestorsData, ThrowOnError>,
): RequestResult<
    GetItemTemplateAncestorsResponses,
    GetItemTemplateAncestorsErrors,
    ThrowOnError,
    "fields",
>
Gets ancestors for a collection of template items.

Gets the ancestor chains for template items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemTemplateAncestorsData, ThrowOnError>
Returns RequestResult<
    GetItemTemplateAncestorsResponses,
    GetItemTemplateAncestorsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7168

`Static`getItemTemplateSearch

getItemTemplateSearch<ThrowOnError extends boolean = true>(
    options?: Options<GetItemTemplateSearchData, ThrowOnError>,
): RequestResult<
    GetItemTemplateSearchResponses,
    GetItemTemplateSearchErrors,
    ThrowOnError,
    "fields",
>
Searches template items.

Searches template items by the provided query with pagination support.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemTemplateSearchData, ThrowOnError>
Returns RequestResult<
    GetItemTemplateSearchResponses,
    GetItemTemplateSearchErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7186

`Static`getTemplateById

getTemplateById<ThrowOnError extends boolean = true>(
    options: Options<GetTemplateByIdData, ThrowOnError>,
): RequestResult<
    GetTemplateByIdResponses,
    GetTemplateByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a template.

Gets a template identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetTemplateByIdData, ThrowOnError>
Returns RequestResult<
    GetTemplateByIdResponses,
    GetTemplateByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7244

`Static`getTemplateConfiguration

getTemplateConfiguration<ThrowOnError extends boolean = true>(
    options?: Options<GetTemplateConfigurationData, ThrowOnError>,
): RequestResult<
    GetTemplateConfigurationResponses,
    GetTemplateConfigurationErrors,
    ThrowOnError,
    "fields",
>
Gets the template configuration.

Gets the configuration settings for templates.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTemplateConfigurationData, ThrowOnError>
Returns RequestResult<
    GetTemplateConfigurationResponses,
    GetTemplateConfigurationErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7284

`Static`getTemplateQuerySettings

getTemplateQuerySettings<ThrowOnError extends boolean = true>(
    options?: Options<GetTemplateQuerySettingsData, ThrowOnError>,
): RequestResult<
    GetTemplateQuerySettingsResponses,
    GetTemplateQuerySettingsErrors,
    ThrowOnError,
    "fields",
>
Gets template query settings.

Gets the available configuration settings for template queries including document type aliases, properties, and operators.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTemplateQuerySettingsData, ThrowOnError>
Returns RequestResult<
    GetTemplateQuerySettingsResponses,
    GetTemplateQuerySettingsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7324

`Static`getTreeTemplateAncestors

getTreeTemplateAncestors<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeTemplateAncestorsData, ThrowOnError>,
): RequestResult<
    GetTreeTemplateAncestorsResponses,
    GetTreeTemplateAncestorsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of ancestor template items.

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

`Static`getTreeTemplateChildren

getTreeTemplateChildren<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeTemplateChildrenData, ThrowOnError>,
): RequestResult<
    GetTreeTemplateChildrenResponses,
    GetTreeTemplateChildrenErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of template tree child items.

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

`Static`getTreeTemplateRoot

getTreeTemplateRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeTemplateRootData, ThrowOnError>,
): RequestResult<
    GetTreeTemplateRootResponses,
    GetTreeTemplateRootErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of template items from the root of the tree.

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

`Static`getTreeTemplateSiblings

getTreeTemplateSiblings<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeTemplateSiblingsData, ThrowOnError>,
): RequestResult<
    GetTreeTemplateSiblingsResponses,
    GetTreeTemplateSiblingsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of template tree sibling items.

Gets a collection of template tree items that are siblings of the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeTemplateSiblingsData, ThrowOnError>
Returns RequestResult<
    GetTreeTemplateSiblingsResponses,
    GetTreeTemplateSiblingsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7396

`Static`postTemplate

postTemplate<ThrowOnError extends boolean = true>(
    options?: Options<PostTemplateData, ThrowOnError>,
): RequestResult<
    PostTemplateResponses,
    PostTemplateErrors,
    ThrowOnError,
    "fields",
>
Creates a new template.

Creates a new template with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostTemplateData, ThrowOnError>
Returns RequestResult<PostTemplateResponses, PostTemplateErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:7204

`Static`postTemplateQueryExecute

postTemplateQueryExecute<ThrowOnError extends boolean = true>(
    options?: Options<PostTemplateQueryExecuteData, ThrowOnError>,
): RequestResult<
    PostTemplateQueryExecuteResponses,
    PostTemplateQueryExecuteErrors,
    ThrowOnError,
    "fields",
>
Executes a template query.

Executes a template query with the provided parameters and returns the matching content results with execution metrics.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostTemplateQueryExecuteData, ThrowOnError>
Returns RequestResult<
    PostTemplateQueryExecuteResponses,
    PostTemplateQueryExecuteErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7302

`Static`putTemplateById

putTemplateById<ThrowOnError extends boolean = true>(
    options: Options<PutTemplateByIdData, ThrowOnError>,
): RequestResult<
    PutTemplateByIdResponses,
    PutTemplateByIdErrors,
    ThrowOnError,
    "fields",
>
Updates a template.

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

Class TemplateService

Index

Constructors

Methods

Constructors

constructor

Returns TemplateService

Methods

StaticdeleteTemplateById

Type Parameters

Parameters

Returns RequestResult< DeleteTemplateByIdResponses, DeleteTemplateByIdErrors, ThrowOnError, "fields",>

StaticgetItemTemplate

Type Parameters

Parameters

Returns RequestResult< GetItemTemplateResponses, GetItemTemplateErrors, ThrowOnError, "fields",>

StaticgetItemTemplateAncestors

Type Parameters

Parameters

Returns RequestResult< GetItemTemplateAncestorsResponses, GetItemTemplateAncestorsErrors, ThrowOnError, "fields",>

StaticgetItemTemplateSearch

Type Parameters

Parameters

Returns RequestResult< GetItemTemplateSearchResponses, GetItemTemplateSearchErrors, ThrowOnError, "fields",>

StaticgetTemplateById

Type Parameters

Parameters

Returns RequestResult< GetTemplateByIdResponses, GetTemplateByIdErrors, ThrowOnError, "fields",>

StaticgetTemplateConfiguration

Type Parameters

Parameters

Returns RequestResult< GetTemplateConfigurationResponses, GetTemplateConfigurationErrors, ThrowOnError, "fields",>

StaticgetTemplateQuerySettings

Type Parameters

Parameters

Returns RequestResult< GetTemplateQuerySettingsResponses, GetTemplateQuerySettingsErrors, ThrowOnError, "fields",>

StaticgetTreeTemplateAncestors

Type Parameters

Parameters

Returns RequestResult< GetTreeTemplateAncestorsResponses, GetTreeTemplateAncestorsErrors, ThrowOnError, "fields",>

StaticgetTreeTemplateChildren

Type Parameters

Parameters

Returns RequestResult< GetTreeTemplateChildrenResponses, GetTreeTemplateChildrenErrors, ThrowOnError, "fields",>

StaticgetTreeTemplateRoot

Type Parameters

Parameters

Returns RequestResult< GetTreeTemplateRootResponses, GetTreeTemplateRootErrors, ThrowOnError, "fields",>

StaticgetTreeTemplateSiblings

Type Parameters

Parameters

Returns RequestResult< GetTreeTemplateSiblingsResponses, GetTreeTemplateSiblingsErrors, ThrowOnError, "fields",>

StaticpostTemplate

Type Parameters

Parameters

Returns RequestResult<PostTemplateResponses, PostTemplateErrors, ThrowOnError, "fields">

StaticpostTemplateQueryExecute

Type Parameters

Parameters

Returns RequestResult< PostTemplateQueryExecuteResponses, PostTemplateQueryExecuteErrors, ThrowOnError, "fields",>

StaticputTemplateById

Type Parameters

Parameters

Returns RequestResult< PutTemplateByIdResponses, PutTemplateByIdErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deleteTemplateById

Returns RequestResult<
DeleteTemplateByIdResponses,
DeleteTemplateByIdErrors,
ThrowOnError,
"fields",
>

`Static`getItemTemplate

Returns RequestResult<
GetItemTemplateResponses,
GetItemTemplateErrors,
ThrowOnError,
"fields",
>

`Static`getItemTemplateAncestors

Returns RequestResult<
GetItemTemplateAncestorsResponses,
GetItemTemplateAncestorsErrors,
ThrowOnError,
"fields",
>

`Static`getItemTemplateSearch

Returns RequestResult<
GetItemTemplateSearchResponses,
GetItemTemplateSearchErrors,
ThrowOnError,
"fields",
>

`Static`getTemplateById

Returns RequestResult<
GetTemplateByIdResponses,
GetTemplateByIdErrors,
ThrowOnError,
"fields",
>

`Static`getTemplateConfiguration

Returns RequestResult<
GetTemplateConfigurationResponses,
GetTemplateConfigurationErrors,
ThrowOnError,
"fields",
>

`Static`getTemplateQuerySettings

Returns RequestResult<
GetTemplateQuerySettingsResponses,
GetTemplateQuerySettingsErrors,
ThrowOnError,
"fields",
>

`Static`getTreeTemplateAncestors

Returns RequestResult<
GetTreeTemplateAncestorsResponses,
GetTreeTemplateAncestorsErrors,
ThrowOnError,
"fields",
>

`Static`getTreeTemplateChildren

Returns RequestResult<
GetTreeTemplateChildrenResponses,
GetTreeTemplateChildrenErrors,
ThrowOnError,
"fields",
>

`Static`getTreeTemplateRoot

Returns RequestResult<
GetTreeTemplateRootResponses,
GetTreeTemplateRootErrors,
ThrowOnError,
"fields",
>

`Static`getTreeTemplateSiblings

Returns RequestResult<
GetTreeTemplateSiblingsResponses,
GetTreeTemplateSiblingsErrors,
ThrowOnError,
"fields",
>

`Static`postTemplate

`Static`postTemplateQueryExecute

Returns RequestResult<
PostTemplateQueryExecuteResponses,
PostTemplateQueryExecuteErrors,
ThrowOnError,
"fields",
>

`Static`putTemplateById

Returns RequestResult<
PutTemplateByIdResponses,
PutTemplateByIdErrors,
ThrowOnError,
"fields",
>