XOMNI: Experience Omni-Channel

Category API Set

Creating a new category

HTTP POST /private/catalog/category

The APIs can be used to create new categories. Using this API, you can create a new category.

Updating an existing category

HTTP PUT /private/catalog/category

The category management systems provides APIs to update a particular category in backend. Using this API, you can update category name, description fields and parent category of a particular category.

Removing a relationship between a video and a category

HTTP DELETE /private/catalog/categories/{categoryId}/video?assetId={assetId}

The APIs can be used to remove relationships between assets and categories. Using this API, you can remove a relationship between a video and a category.

Fetching documents of a particular category

HTTP GET /private/catalog/categories/{categoryId}/document

The APIs can be used to create relationships between assets and categories. Using this API, you can get a list of documents assigned to a particular category.

Removing a category

HTTP DELETE /private/catalog/category?categoryId={categoryId}

The category management systems provides APIs to delete a category and related metadata ın backend. Using this method, you can remove an existing category by giving the unique ID of a particular category.

Removing a relationship between a document and a category

HTTP DELETE /private/catalog/categories/{categoryId}/document?assetId={assetId}

The APIs can be used to remove relationships between assets and categories. Using this API, you can remove a relationship between a document and a category.

Removing a relationship between an image and a category

HTTP DELETE /private/catalog/categories/{categoryId}/image? assetId={assetId}

The APIs can be used to remove relationships between assets and categories. Using this API, you can remove a relationship between an image and a category.

Fetching images of a particular category

HTTP GET /private/catalog/categories/{categoryId}/image

The APIs can be used to create relationships between assets and categories. Using this API, you can get a list of images assigned to a particular category.

Getting a single category and related metadata.

HTTP GET /private/catalog/category?categoryId={categoryId}

The category management systems provides APIs to get a single category and related metadata from the backend. Using this API, you can get a particular category and related metadata.

Partially updating an existing category

HTTP PATCH /private/catalog/category

The API provides to partially update an existing category.

Fetching full category tree

HTTP GET /private/catalog/categories

The API returns a full list of categories with nested tree relationship.

Fetching videos of a particular category

HTTP GET /private/catalog/categories/{categoryId}/video

The APIs can be used to create relationships between assets and categories. Using this API, you can get a list of videos assigned to a particular category.

Updating a relationship between an image and a category

HTTP PUT /private/catalog/categories/{categoryId}/image

The API can be used to update relationships between assets and categories. Using this API, you can change default image of the category.

Updating a relationship between a video and a category

HTTP PUT /private/catalog/categories/{categoryId}/video

The API can be used to update relationships between assets and categories. Using this API, you can change default video of the category.

Updating a relationship between a document and a category

HTTP PUT /private/catalog/categories/{categoryId}/document

The API can be used to update relationships between assets and categories. Using this API, you can change default document of the category.

Adding a particular video to a category

HTTP POST /private/catalog/categories/{categoryId}/video

The APIs can be used to create relationships between assets and categories. Using this API, you can assign a video to a category.

Adding a particular video to a category

HTTP POST /private/catalog/categories/{categoryId}/video

The APIs can be used to create relationships between assets and categories. Using this API, you can assign a video to a category.

Adding a particular document to a category

HTTP POST /private/catalog/categories/{categoryId}/document?assetId={assetId}&isDefault={isDefault}

The APIs can be used to create relationships between assets and categories. Using this API, you can assign a document to a category.

Adding a particular image to a category

HTTP POST /private/catalog/categories/{categoryId}/image

The APIs can be used to create relationships between assets and categories. Using this API, you can assign an image to a category.

Adding a particular image to a category

HTTP POST /private/catalog/categories/{categoryId}/image?assetId={assetId}&isDefault={isDefault}

The APIs can be used to create relationships between assets and categories. Using this API, you can assign an image to a category.

Adding a particular document to a category

HTTP POST /private/catalog/categories/{categoryId}/document

The APIs can be used to create relationships between assets and categories. Using this API, you can assign a document to a category.