Category commands and pipelines

Current version: 10.2

The following table describes the category commands and pipelines:

Command/Pipeline

Description

CreateCategoryCommand

CreateCategoryPipeline

Creates a new category inside an existing catalog.

Parameters:

  • catalogId: identifier for the catalog to which the category is being added

  • name: internal name for the category

  • displayName: display name for the category

  • description: description for the category

  • isSearchable: indicates whether the category is searchable

DeleteCategoryCommand

DeleteCategoryPipeline

Deletes an existing category from the specified catalog.

Parameters:

  • catalogFriendlyId: identifier for the catalog from which the category is being removed

  • categoryId: identifier for the category

EditCategoryCommand

EditCategoryPipeline

Makes changes to an existing category.

Parameters:

  • category: internal name for the category

  • displayName: display name for the category

  • desciption: description for the category

  • isSearchable: indicates whether the category is searchable

GetCategoriesCommand

GetCategoriesPipeline

Retrieves all categories defined in the environment.

Parameters:

  • catalogName: name of the catalog

    Note

    Although the catalogName parameter is present in the code, it is not currently supported.

GetCategoryCommand

GetCategoryPipeline

Retrieves a specific category in a catalog.

Parameters:

  • categoryID: identifier for the category to be retrieved

Do you have some feedback for us?

If you have suggestions for improving this article,