Struct Docs
Struct.PIM 4
Struct.PIM 4
  • Struct PIM Documentation
  • API Reference
  • Latest updates from Struct HQ
  • Latest updates in Documentation
  • Fundamental concepts
    • Get familiar with Struct PIM
    • Catalogues & categories
    • Products & variants
    • Attributes
    • Product structures
    • Identifiers
    • Global lists
    • Localization & segmentation
    • Revisions & changelog
    • Publications
    • Supplier onboarding portal
  • Tutorials
    • Helpful guides
      • How to search efficiently
      • How to use Import
        • How to import products
        • How to import data into a list property on entities
        • How to import categories
        • How to import with media
        • How to use File templates
    • Example projects
      • Working with the API
  • Integration
    • Integrate with Struct PIM
    • Web API
    • Webhooks
  • Media format
  • API Reference
    • Introduction
    • Endpoints
      • AssetFolders
      • Assets
      • AssetTypes
      • AttributeGroups
      • Attributes
      • AttributeScopes
      • Browse
      • BusinessUnits
      • Catalogues
      • Categories
      • Dimensions
      • Exports
      • EnrichmentInsightSetups
      • GlobalLists
      • Languages
      • Maintenance
      • Miscellaneous
      • Messaging
      • Permissions
      • Products
      • ProductStructures
      • Publications
      • Transactions
      • UserGroup
      • UserRoles
      • Users
      • VariantGroups
      • UserTasks
      • Variants
      • Webhooks
      • Workflows
      • Models
Powered by GitBook
On this page
  1. API Reference
  2. Endpoints

AssetTypes

PreviousAssetsNextAttributeGroups

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 an asset type

get

#Available from v.4.0.0

Authorizations
Path parameters
uidstring · uuidRequired

Unique id of asset type

Responses
200
OK
404
Not Found
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"
      }
    ]
  }
}

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
delete
DELETE /v1/assettypes/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content
  • GETGet all asset types
  • POSTCreate new asset type
  • PUTUpdate an asset type
  • GETGet an asset type
  • DELETEDelete an asset type

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"
        }
      ]
    }
  }
]

Create new asset type

post

#Available from v.4.0.0

Authorizations
Body

Represents a 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

Responses
200
OK
400
Bad Request
post
POST /v1/assettypes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 262

{
  "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"
      }
    ]
  }
}
No content

Update an asset type

put

#Available from v.4.0.0

Authorizations
Body

Represents a 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

Responses
200
OK
400
Bad Request
put
PUT /v1/assettypes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 262

{
  "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"
      }
    ]
  }
}
No content