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
Responses
200

OK

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

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Alias": "text",
    "Label": "text",
    "Configuration": {
      "Tabs": [
        {
          "Uid": "123e4567-e89b-12d3-a456-426614174000",
          "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
          "SavePermission": "123e4567-e89b-12d3-a456-426614174000",
          "Type": "text"
        }
      ]
    },
    "AllowedFileTypes": [
      0
    ],
    "SpecifiedExtensions": [
      "text"
    ]
  }
]

Create new asset type

post

#Available from v.4.0.0

Authorizations
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

OK

No content
post
POST /v1/assettypes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 316

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "Configuration": {
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "AllowedFileTypes": [
    0
  ],
  "SpecifiedExtensions": [
    "text"
  ]
}
No content

Update an asset type

put

#Available from v.4.0.0

Authorizations
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

OK

No content
put
PUT /v1/assettypes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 316

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "Configuration": {
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "AllowedFileTypes": [
    0
  ],
  "SpecifiedExtensions": [
    "text"
  ]
}
No content

Get an asset type

get

#Available from v.4.0.0

Authorizations
Path parameters
uidstring · uuidRequired

Unique id of asset type

Responses
200

OK

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

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Label": "text",
  "Configuration": {
    "Tabs": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "ViewPermission": "123e4567-e89b-12d3-a456-426614174000",
        "SavePermission": "123e4567-e89b-12d3-a456-426614174000",
        "Type": "text"
      }
    ]
  },
  "AllowedFileTypes": [
    0
  ],
  "SpecifiedExtensions": [
    "text"
  ]
}

Delete an asset type

delete

#Available from v.4.0.0

Authorizations
Path parameters
uidstring · uuidRequired

Unique id of asset type to delete

Responses
200

OK

No content
delete
DELETE /v1/assettypes/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content
PreviousAssetsNextAttributeGroups