API docs by Redocly

Asset Management Api (1)

Download OpenAPI specification:Download

asset

Get asset by id

get an asset by id

Authorizations:
Bearer
path Parameters
assetId
required
string
query Parameters
disable-triggers
string
Default: "0"
Enum: "0" "1"

If set to 1, the Matrix trigger manager is disabled for any operations in this request. Otherwise, triggers are active as normal.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "external_id": "string",
  • "status": "archived",
  • "type": "design_area_menu_normal",
  • "version": "string",
  • "created": {
    },
  • "updated": {
    },
  • "status_changed": {
    },
  • "published": {
    },
  • "attributes": {
    },
  • "metadata_schemas": [
    ],
  • "metadata_values": {
    },
  • "paint_layouts": {
    },
  • "web_paths": [
    ],
  • "urls": [
    ]
}

Delete asset by id

Delete an asset by id. You can only delete an asset if it does not orphan any other assets

Authorizations:
Bearer
path Parameters
assetId
required
string
query Parameters
disable-triggers
string
Default: "0"
Enum: "0" "1"

If set to 1, the Matrix trigger manager is disabled for any operations in this request. Otherwise, triggers are active as normal.

Responses

Update an asset

update an asset

Authorizations:
Bearer
path Parameters
assetId
required
string
query Parameters
contextid
integer >= 0

The context id to perform the request in. When updating an asset, the contextualised data for the updated metadata or attributes will be created if needed. Must be an existing context defined in the system.

disable-triggers
string
Default: "0"
Enum: "0" "1"

If set to 1, the Matrix trigger manager is disabled for any operations in this request. Otherwise, triggers are active as normal.

Request Body schema: application/json
Any of
external_id
string
type
string
object
Array of objects or null
object or null
object
web_paths
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "external_id": "string",
  • "type": "string",
  • "attributes": {
    },
  • "metadata_schemas": [
    ],
  • "metadata_values": {
    },
  • "paint_layouts": {
    },
  • "web_paths": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "external_id": "string",
  • "status": "archived",
  • "type": "design_area_menu_normal",
  • "version": "string",
  • "created": {
    },
  • "updated": {
    },
  • "status_changed": {
    },
  • "published": {
    },
  • "attributes": {
    },
  • "metadata_schemas": [
    ],
  • "metadata_values": {
    },
  • "paint_layouts": {
    },
  • "web_paths": [
    ],
  • "urls": [
    ]
}

Create Asset

Authorizations:
Bearer
query Parameters
disable-triggers
string
Default: "0"
Enum: "0" "1"

If set to 1, the Matrix trigger manager is disabled for any operations in this request. Otherwise, triggers are active as normal.

Request Body schema: application/json
required
object
required
object (AssetCreateParentLink)

Responses

Request samples

Content type
application/json
{
  • "asset": {
    },
  • "parent": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "external_id": "string",
  • "status": "archived",
  • "type": "design_area_menu_normal",
  • "version": "string",
  • "created": {
    },
  • "updated": {
    },
  • "status_changed": {
    },
  • "published": {
    },
  • "attributes": {
    },
  • "metadata_schemas": [
    ],
  • "metadata_values": {
    },
  • "paint_layouts": {
    },
  • "web_paths": [
    ],
  • "urls": [
    ]
}

Set the asset status

This operation changes the asset status

Authorizations:
Bearer
path Parameters
assetId
required
string
query Parameters
disable-triggers
string
Default: "0"
Enum: "0" "1"

If set to 1, the Matrix trigger manager is disabled for any operations in this request. Otherwise, triggers are active as normal.

Request Body schema: application/json
status
required
string
Enum: "archived" "under_construction" "pending_approval" "approved_to_go_live" "live" "up_for_review" "safe_editing" "safe_editing_pending_approval" "safe_edit_approved_to_go_live"
published_date_time_unix
integer

Set the asset published date. Only applicable with 'live' status.

Responses

Request samples

Content type
application/json
{
  • "status": "archived",
  • "published_date_time_unix": 0
}

design

Process the Design asset's parse file

Process Design asset's parse file and regenerate the design content file

Authorizations:
Bearer
path Parameters
assetId
required
string
query Parameters
disable-triggers
string
Default: "0"
Enum: "0" "1"

If set to 1, the Matrix trigger manager is disabled for any operations in this request. Otherwise, triggers are active as normal.

Responses