Skip to content
/Asset Metadata

Apiera REST API (1.0.0)

The Apiera REST API provides programmatic access to the Apiera platform, enabling seamless integration with your existing systems and workflows.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.apiera.io/_mock/openapi/
http://localhost:5281/

Tags

Operations

Skus

Operations

Sku Dimensions

Operations

Sku Weights

Operations

Family Attributes

Operations

Family Categories

Operations

Families

Operations

Organization Members

Operations

Organizations

Operations

Organization Roles

Operations

Categories

Operations

Attributes

Operations

Attribute Terms

Operations

Assets

Operations

Asset Files

Operations

Asset Metadata

Operations

List metadata

Request

Retrieves a paginated list of metadata entries for an asset.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

Query
pageinteger(int32)
Default 1
sizeinteger(int32)
Default 20
curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/metadata?page=1&size=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved metadata.

Bodyapplication/json
itemsArray of objects(MetadataResponse)required
items[].​uuidstring(uuid)required

Unique identifier for this metadata entry.

items[].​assetUuidstring(uuid)required

Identifier of the asset this metadata belongs to.

items[].​createdAtstring(date-time)required

Timestamp when this metadata entry was created.

Example: "2025-11-23T14:15:22.123456Z"
items[].​updatedAtstring(date-time)required

Timestamp when this metadata entry was last modified.

Example: "2025-11-23T14:15:22.123456Z"
items[].​keystringrequired

Metadata key name.

items[].​valuestringrequired

Metadata value content.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json

List of custom key-value metadata pairs

[
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "key": "photographer",
    "value": "John Smith"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "key": "location",
    "value": "Swiss Alps"
  },
  {
    "uuid": "aaa11111-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-20T08:15:00.000000Z",
    "key": "copyright",
    "value": "© 2025 Outdoor Gear Co."
  }
]

Create metadata

Request

Creates a new metadata entry for an asset.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

Bodyapplication/jsonrequired
keystring[ 1 .. 255 ] charactersrequired

Metadata key name.

valuestring[ 1 .. 1000 ] charactersrequired

Metadata value content.

curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/metadata' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "key": "string",
    "value": "string"
  }'

Responses

Metadata created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this metadata entry.

assetUuidstring(uuid)required

Identifier of the asset this metadata belongs to.

createdAtstring(date-time)required

Timestamp when this metadata entry was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this metadata entry was last modified.

Example: "2025-11-23T14:15:22.123456Z"
keystringrequired

Metadata key name.

valuestringrequired

Metadata value content.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "key": "photographer",
  "value": "John Smith"
}

Get metadata

Request

Retrieves a single metadata entry.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

metadataUuidstring(uuid)required

Unique identifier of the metadata entry.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/metadata/{metadataUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved metadata.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this metadata entry.

assetUuidstring(uuid)required

Identifier of the asset this metadata belongs to.

createdAtstring(date-time)required

Timestamp when this metadata entry was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this metadata entry was last modified.

Example: "2025-11-23T14:15:22.123456Z"
keystringrequired

Metadata key name.

valuestringrequired

Metadata value content.

Response
application/json
{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-20T08:15:00.000000Z",
  "key": "photographer",
  "value": "John Smith"
}

Update metadata

Request

Updates an existing metadata entry. Only provided fields are updated.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

metadataUuidstring(uuid)required

Unique identifier of the metadata entry.

Bodyapplication/jsonrequired
keystring or null[ 1 .. 255 ] characters

Updated metadata key name.

valuestring or null[ 1 .. 1000 ] characters

Updated metadata value content.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/metadata/{metadataUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "key": "string",
    "value": "string"
  }'

Responses

Metadata updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this metadata entry.

assetUuidstring(uuid)required

Identifier of the asset this metadata belongs to.

createdAtstring(date-time)required

Timestamp when this metadata entry was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this metadata entry was last modified.

Example: "2025-11-23T14:15:22.123456Z"
keystringrequired

Metadata key name.

valuestringrequired

Metadata value content.

Response
application/json

Metadata with modified value

{
  "uuid": "aaa11111-e89b-12d3-a456-426614174001",
  "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "key": "photographer",
  "value": "Jane Doe"
}

Delete metadata

Request

Permanently deletes a metadata entry.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

metadataUuidstring(uuid)required

Unique identifier of the metadata entry.

curl -i -X DELETE \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/metadata/{metadataUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Metadata deleted successfully.

Response
No content
© 2025 Apiera AS