AssetTypes

Asset types define models for assets in the system. Specifically, asset types define which properties are available on assets as well as how they are presented in the backoffice UI within tabs and sections.

Get all asset types

get

#Available from v.4.0.0

Authorizations

AuthorizationstringRequired

Responses

200

application/json

get

/v1/assettypes

GET /v1/assettypes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

[
  {
    "Uid": "3eff8f27-ac27-4d5d-a60b-1fc880dc94d9",
    "Alias": "AssetStructure",
    "Label": "Asset structure",
    "Configuration": {
      "Tabs": [
        {
          "Label": "General",
          "Sections": [
            {
              "Headline": "Basic information",
              "Description": "",
              "Properties": [
                {
                  "AttributeUid": "e563c3a6-8857-4fa9-8740-da68cad5fe33",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "c6aca584-4e25-4260-b5ab-79abcf384eb2",
                  "ViewPermission": "874530cc-3e8e-494d-bb70-1995e28ad592",
                  "SavePermission": "3e1e3ae1-6af9-4763-a7ae-4283c2b1e912",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "75b817a7-2be7-4915-8ed1-2ee4ad15d4ff",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "c80fa4d9-2793-4cd6-aede-870c81fd6eb8",
                  "ViewPermission": "fa92ef53-35b3-49e2-854d-aca36be0ddf4",
                  "SavePermission": "8e26ba9b-d287-4bbf-9419-4ede55363c54",
                  "Type": "AttributeSetup"
                },
                {
                  "AttributeUid": "001280b3-2104-49bc-b2c9-9772ce430590",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "f18798e6-140d-490e-b832-9fe4a02d95ea",
                  "ViewPermission": "376f32ce-845d-4818-b1d5-4798c1960045",
                  "SavePermission": "18e89ee5-70df-4901-916d-7c95f17c33a8",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "380308b9-d47a-4d13-8ae6-1ddf4e69b7c8",
              "ViewPermission": "c645cea2-7021-4252-b4ca-bf63c1278718",
              "SavePermission": "568ee1b9-3119-45b3-9f6c-bb3c9db285f7",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "f7258e0c-03bd-491e-9092-91ffbce00453",
          "ViewPermission": "d843833e-664e-4fae-9394-7b59e1d1e61d",
          "SavePermission": "5806dd98-a8e2-4667-b2fb-55ee6b9f4298",
          "Type": "DynamicTabSetup"
        }
      ]
    },
    "AllowedFileTypes": [],
    "SpecifiedExtensions": []
  },
  {
    "Uid": "5690a843-50fd-4dc7-b324-010788d903c7",
    "Alias": "AssetStructure2",
    "Label": "Asset structure 2",
    "Configuration": {
      "Tabs": [
        {
          "Label": "General",
          "Sections": [
            {
              "Headline": "Basic information",
              "Description": "",
              "Properties": [
                {
                  "AttributeUid": "e563c3a6-8857-4fa9-8740-da68cad5fe33",
                  "ReadOnly": false,
                  "Mandatory": false,
                  "Unchangeable": false,
                  "Inherits": false,
                  "Uid": "a4892d7d-392c-4b9f-915f-e7e635959f78",
                  "ViewPermission": "17f10fa4-c45c-46d2-9253-3a1a240fefb5",
                  "SavePermission": "7014ccbf-5cbb-4d20-8802-514d23ebb314",
                  "Type": "AttributeSetup"
                }
              ],
              "Uid": "b65970e2-a7c7-4055-8210-f65993a47ddc",
              "ViewPermission": "a3eca8c5-a7ff-4527-980a-1ccaed5edec3",
              "SavePermission": "39d60127-0147-44e7-84b4-098f98abfcf0",
              "Type": "DynamicSectionSetup"
            }
          ],
          "ShowSidebar": false,
          "Uid": "ad799ee5-1d33-47fa-912c-eb9a02f3b599",
          "ViewPermission": "318231cc-3b49-4013-8b75-1460e31031a5",
          "SavePermission": "12ec704b-a52f-4dd5-97af-07835473ee5b",
          "Type": "DynamicTabSetup"
        }
      ]
    },
    "AllowedFileTypes": [],
    "SpecifiedExtensions": []
  }
]

Create new asset type

post

#Available from v.4.0.0

Authorizations

AuthorizationstringRequired

Body

Represents an asset type in the PIM system

Uidstring · uuidOptional

Unique id of asset type

Aliasstring | nullableOptional

Unique human readable alias for the asset type

Labelstring | nullableOptional

Label of asset type displayed in the backoffice

SpecifiedExtensionsstring[] | nullableOptional

The file extensions that are allowed to be uploaded to the asset type (ex. jpg, png, pdf) Only available when AssetFileType is set to SpecifiedExtensions

Responses

200

400

Bad Request

application/json

post

/v1/assettypes

POST /v1/assettypes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1577

{
  "Uid": "8e7fbc5d-851a-46dd-aae3-9937f243a11e",
  "Alias": "AssetType",
  "Label": "Asset type",
  "Configuration": {
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "",
            "Properties": [
              {
                "AttributeUid": "62f7f7bd-8c35-4609-b7e0-6a7cbd1853df",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "4a83a4ba-7a99-4633-bbca-c53c1f2b870f",
                "ViewPermission": "0131b118-11a9-4607-b920-93e3d65fb504",
                "SavePermission": "7ac87899-1485-47f5-a2ce-6018b9619a5d",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "427da61c-5178-4df7-8eab-d14878c24e3e",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "575dd19e-4d36-4610-8995-7d9e48c94c39",
                "ViewPermission": "3d4baec1-36b3-4e9c-8f9c-e451ccb1f5b5",
                "SavePermission": "7fe9f42d-cb41-4da3-b63d-1b91cd02f198",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "90a6421c-bfcf-4853-a124-c790bdaf520b",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "d9e5ad76-ae12-458a-89b6-bc4839db9659",
                "ViewPermission": "be48d0cb-01e7-4b0a-bb81-5860da9be6d6",
                "SavePermission": "45387753-e792-4dd9-874b-67c7d3142838",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "b07072db-af72-4a9b-b6ae-dc983015179f",
            "ViewPermission": "378c1c82-82bb-4c69-8078-cc3d88bd9db9",
            "SavePermission": "a97e08d9-3709-4c2b-9a3b-5cf9684165b4",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "5af4751b-b933-404c-85ad-cc8df221fb4d",
        "ViewPermission": "ef52eede-59fa-4147-b342-bf16793750bb",
        "SavePermission": "1e7f2167-d29f-4a2e-9af8-4279293e6200",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "AllowedFileTypes": [],
  "SpecifiedExtensions": []
}

No content

Update an asset type

put

#Available from v.4.0.0

Authorizations

AuthorizationstringRequired

Body

Represents an asset type in the PIM system

Uidstring · uuidOptional

Unique id of asset type

Aliasstring | nullableOptional

Unique human readable alias for the asset type

Labelstring | nullableOptional

Label of asset type displayed in the backoffice

SpecifiedExtensionsstring[] | nullableOptional

The file extensions that are allowed to be uploaded to the asset type (ex. jpg, png, pdf) Only available when AssetFileType is set to SpecifiedExtensions

Responses

200

400

Bad Request

application/json

put

/v1/assettypes

PUT /v1/assettypes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1587

{
  "Uid": "defc6e3b-5805-4ef6-aed9-eca1e9dbd85f",
  "Alias": "AssetStructure",
  "Label": "Asset structure",
  "Configuration": {
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "",
            "Properties": [
              {
                "AttributeUid": "447fadde-e963-4a05-96a0-08e55d106f85",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "985d1cea-0d8a-4398-b234-37a9cf655041",
                "ViewPermission": "998d228e-6d09-408d-b1ae-19cc6be4923a",
                "SavePermission": "6adc8e65-5b52-4428-ba76-97fa0fe78bbd",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "40b1622b-8195-4aee-9487-61cafa7fea04",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "cb230fef-bea7-4054-abae-e74342b459dc",
                "ViewPermission": "4af8e3b7-63f3-4a6f-bddd-2067ee76e282",
                "SavePermission": "cf6ee825-bee2-4cc0-867f-363531f5af88",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "d87d7583-145b-4947-b384-9185b1db1c90",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "aea317b2-ac1e-4176-88b1-3d4dfeb1afbf",
                "ViewPermission": "da037fdd-fdc6-4a13-b86a-490879a8649c",
                "SavePermission": "2c3fc780-ec07-4c4f-a06e-df8085f4ca45",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "d0725a48-9940-4c2a-bce1-475846dd04fd",
            "ViewPermission": "58e5ed50-c051-4bbe-862f-d6207e2dfcc3",
            "SavePermission": "27c8b18f-7c15-4152-a8a7-a286eb364cca",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "2c009ab8-d83b-4641-a7cf-917ea391e47c",
        "ViewPermission": "9e8bcb28-16f5-4916-80fe-9b0fad5cf132",
        "SavePermission": "aae01dda-7f9b-47ee-bc72-3dd319ab0933",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "AllowedFileTypes": [],
  "SpecifiedExtensions": []
}

No content

Get an asset type

get

#Available from v.4.0.0

Authorizations

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of asset type

Responses

200

application/json

404

Not Found

application/json

get

/v1/assettypes/{uid}

GET /v1/assettypes/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "0f599a3a-934d-43b1-b85c-84fd588eecd0",
  "Alias": "AssetStructure",
  "Label": "Asset structure",
  "Configuration": {
    "Tabs": [
      {
        "Label": "General",
        "Sections": [
          {
            "Headline": "Basic information",
            "Description": "",
            "Properties": [
              {
                "AttributeUid": "6f4b946a-512e-4053-8f88-c7c83bcc1383",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "ba13a194-e81e-46c9-8013-6e2ce0d18006",
                "ViewPermission": "8c89cf79-eb25-4ad5-8754-18d11ea7a04a",
                "SavePermission": "bfba6dde-e914-4c4a-bc14-129bb401fc8c",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "7b330f22-f318-471d-bccd-c4e9b148ce19",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "989a1c39-4d00-4e16-85f0-4d0caee68b28",
                "ViewPermission": "0e23c9a8-da4e-41c0-b9b8-fe35e3118444",
                "SavePermission": "44860f86-aa8a-4567-942c-95e63aaa4350",
                "Type": "AttributeSetup"
              },
              {
                "AttributeUid": "1c19bf44-25e6-4dbe-8236-ff064476cc06",
                "ReadOnly": false,
                "Mandatory": false,
                "Unchangeable": false,
                "Inherits": false,
                "Uid": "22d2ddb9-1f64-4b37-8d4a-71753bf8ed5a",
                "ViewPermission": "a136cc9e-9303-4176-98f0-c5796a4ce5e7",
                "SavePermission": "b7f4fad7-3f2e-40fc-9a60-665ca3519197",
                "Type": "AttributeSetup"
              }
            ],
            "Uid": "577404cc-de87-4c07-ac99-6aa293688fff",
            "ViewPermission": "5270487e-f497-4058-a73c-b26c753c7d97",
            "SavePermission": "ae4e5ce0-025b-475c-a782-cfca41b3d3df",
            "Type": "DynamicSectionSetup"
          }
        ],
        "ShowSidebar": false,
        "Uid": "45769504-6a2e-40ba-80cd-723c8a7f3507",
        "ViewPermission": "27ea51fc-b932-4990-b2bf-ba9d2c66cea4",
        "SavePermission": "84667456-bd56-4265-94e6-41fd1b15e2f5",
        "Type": "DynamicTabSetup"
      }
    ]
  },
  "AllowedFileTypes": [],
  "SpecifiedExtensions": []
}

Delete an asset type

delete

#Available from v.4.0.0

Authorizations

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of asset type to delete

Responses

200

delete

/v1/assettypes/{uid}

DELETE /v1/assettypes/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

No content

PreviousAssets NextAttributeGroups

Last updated 1 month ago