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

Maintenance

PreviousLanguagesNextMiscellaneous

Maintenance is used to start maintenance tasks

Get task status

get
Authorizations
Path parameters
uidstring · uuidRequired

Task uid

Responses
200
OK
get
GET /v1/maintenance/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Created": "2025-05-09T12:21:43.349Z",
  "FinishedTimestamp": "2025-05-09T12:21:43.349Z",
  "StartTimestamp": "2025-05-09T12:21:43.349Z",
  "Status": 10,
  "PercentageDone": 1
}

Rebuild internal PIM references index

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildpimreferences HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild global list index

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildgloballistindex HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild category search index

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildcategoryindex HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild asset search index

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildassetindex HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild product search index

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildproductindex HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild variant search index

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildvariantindex HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild variant group search index

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildvariantgroupindex HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild product identifiers

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildproductidentifiers HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild variant identifiers

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildvariantidentifiers HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild variant group identifiers

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildvariantgroupidentifiers HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild category identifiers

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildcategoryidentifiers HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild product insights

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildproductenrichmentinsights HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild variant insights

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildvariantenrichmentinsights HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild variant group insights

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildvariantgroupenrichmentinsights HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000

Rebuild category insights

post
Authorizations
Responses
200
OK
Responsestring · uuid
post
POST /v1/maintenance/rebuildcategoryenrichmentinsights HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

123e4567-e89b-12d3-a456-426614174000
  • GETGet task status
  • POSTRebuild internal PIM references index
  • POSTRebuild global list index
  • POSTRebuild category search index
  • POSTRebuild asset search index
  • POSTRebuild product search index
  • POSTRebuild variant search index
  • POSTRebuild variant group search index
  • POSTRebuild product identifiers
  • POSTRebuild variant identifiers
  • POSTRebuild variant group identifiers
  • POSTRebuild category identifiers
  • POSTRebuild product insights
  • POSTRebuild variant insights
  • POSTRebuild variant group insights
  • POSTRebuild category insights