Skip to main content

Assets and Items

  • Updated

This document provides documentation for managing Assets and Items in Brizy Cloud.

API Explorer: https://[your-white-label-dashboard-domain]/api/doc/v2 (to access the correct link please replace [your-white-label-dashboard-domain] with the domain you gave us in the on-boarding process for your White Label setup)

Asset API

The Asset API allows you to manage assets within your projects. An asset represents a structure that can contain multiple items.

Get a List of Assets

Retrieves a paginated list of all assets associated with a specific project.

Endpoint: GET /api/{version}/projects/{project}/assets

get-a-list-of-assets.jpg

Get an Asset by ID

Retrieves a specific asset by its ID.

Endpoint: GET /api/{version}/projects/{project}/assets/{asset}

get-an-asset-by-id.png

Create an Asset

Creates a new asset within a project.

Endpoint: POST /api/{version}/projects/{project}/assets

create-an-asset.png

Delete an Asset

Deletes an asset by its ID.

Endpoint: DELETE /api/{version}/projects/{project}/assets/{asset}

delete-an-asset.png

Get Asset Fields

Retrieves a paginated list of fields for a specific asset.

Endpoint: GET /api/{version}/projects/{project}/assets/{asset}/fields

get-asset-fields.png

Create an Asset Field

Creates a new field for an asset.

Endpoint: POST /api/{version}/projects/{project}/assets/{asset}/fields

create-an-asset-field.png

Update an Asset Field

Updates an existing field for an asset.

Endpoint: PATCH /api/{version}/projects/{project}/assets/{asset}/fields/{field}

update-an-asset-field.png

Delete an Asset Field

Deletes a field from an asset.

Endpoint: DELETE /api/{version}/projects/{project}/assets/{asset}/fields/{field}

delete-an-asset-field.png

Get Asset Items

Retrieves a paginated list of items for a specific asset.

Endpoint: GET /api/{version}/projects/{project}/assets/{asset}/items

get-asset-items.png
 

Item API

The Item API allows you to manage individual items within assets. Items represent the actual content entries.

Create an Item

Creates a new item within a specific asset.

Endpoint: POST /api/{version}/projects/{project}/items

create-an-item.png

Get an Item

Retrieves a specific item by its ID.

Endpoint: GET /api/{version}/projects/{project}/items/{item}

get-an-item.png

Update an Item

Updates an existing item.

Endpoint: PATCH /api/{version}/projects/{project}/items/{item}

update-an-item.png

Delete an Item

Deletes an item by its ID.

Endpoint: DELETE /api/{version}/projects/{project}/items/{item}

delete-an-item.png

Get Item Fields

Retrieves a paginated list of fields for a specific item.

Endpoint: GET /api/{version}/projects/{project}/items/{item}/fields

get-item-fields.png

Related articles