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
    • Welcome to Struct PIM 4
    • 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
    • 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

Dimensions

PreviousCategoriesNextExports

Delete a dimension in the system

delete
Authorizations
Query parameters
uidstring · uuidOptional

Uid of dimension

Responses
200
OK
delete
DELETE /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content

Get a specific dimension in the system

get
Authorizations
Path parameters
uidstring · uuidRequired

Uid of dimension

Responses
200
OK
404
Not Found
get
GET /v1/Dimensions/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Segments": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Identifier": "text",
      "Name": "text"
    }
  ]
}
  • GETGet all dimensions added to the system
  • POSTAdd dimension to system
  • PUTUpdate a dimension in the system
  • DELETEDelete a dimension in the system
  • GETGet a specific dimension in the system

Get all dimensions added to the system

get
Authorizations
Responses
200
OK
get
GET /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Alias": "text",
    "Segments": [
      {
        "Uid": "123e4567-e89b-12d3-a456-426614174000",
        "Identifier": "text",
        "Name": "text"
      }
    ]
  }
]

Add dimension to system

post
Authorizations
Body

Representation of a dimension to be used to segment attribute value data

Uidstring · uuidOptional

Unique id of dimension

Aliasstring | nullableOptional

Unique alias of dimension

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

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Segments": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Identifier": "text",
      "Name": "text"
    }
  ]
}
{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Segments": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Identifier": "text",
      "Name": "text"
    }
  ]
}

Update a dimension in the system

put
Authorizations
Body

Representation of a dimension to be used to segment attribute value data

Uidstring · uuidOptional

Unique id of dimension

Aliasstring | nullableOptional

Unique alias of dimension

Responses
200
OK
put
PUT /v1/Dimensions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 155

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Segments": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Identifier": "text",
      "Name": "text"
    }
  ]
}
200

OK

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "Segments": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "Identifier": "text",
      "Name": "text"
    }
  ]
}