v1

latestSwagger 2.02026-07-13137761.0 MB
Asset family

Get list of asset families

This endpoint allows you to get a list of asset families. Asset families are paginated.

get/api/rest/v1/asset-families

Query parameters

search_afterstring

Cursor when using the search_after pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html">Pagination</a> section

Response

Return asset families paginated

Example response

{
  "_embedded": {
    "items": [
      {
        "code": "model_pictures",
        "labels": {
          "en_US": "Model pictures",
          "fr_FR": "Photographies en pied"
        },
        "attribute_as_main_media": "main_image",
        "naming_convention": {
          "source": {
            "property": "code",
            "channel": null,
            "locale": null
          },
          "pattern": "/(?P<product_ref>.*)-.*/",
          "abort_asset_creation_on_error": true
        },
        "product_link_rules": [
          {
            "product_selections": [
              {
                "field": "sku",
                "operator": "EQUALS",
                "value": "{{product_ref}}"
              }
            ],
            "assign_assets_to": [
              {
                "attribute": "model_pictures",
                "mode": "replace"
              }
            ]
          }
        ],
        "transformations": [
          {
            "label": "Thumbnail plus black and white transformation",
            "filename_suffix": "_thumbnailBW",
            "source": {
              "attribute": "main_image",
              "channel": null,
              "locale": null
            },
            "target": {
              "attribute": "thumbnail",
              "channel": null,
              "locale": null
            },
            "operations": [
              {
                "type": "thumbnail",
                "parameters": {
                  "width": 150,
                  "height": 150
                }
              },
              {
                "type": "colorspace",
                "parameters": {
                  "colorspace": "grey"
                }
              }
            ]
          }
        ],
        "sharing_enabled": true
      }
    ]
  }
}