#Miscellaneous

The Miscellaneous endpoints allows you to get general information about the status of the API and the PIM installation as well as the ability to manage objects which are shared between entities in Struct PIM.

GET /Heartbeat Get an indication if the API is alive

Returns "Is alive", if API is runnint correctly

Response status OK (200)

string

GET /misc/archivereasons Get all archive reasons

#Available from v.3.3.0

Response status OK (200)

array : ArchiveReason
ArchiveReason
Property name Data type Description
Uid string

Unique id of archive reason

Name string

Presented name of archive reason


PUT /misc/archivereasons Update archive reason

#Available from v.3.3.0

Request parameters

Property name Parameter type Data type Description
model body object : ArchiveReason
ArchiveReason
Property name Data type Description
Uid string

Unique id of archive reason

Name string

Presented name of archive reason

Response status OK (200)

No body message is returned

POST /misc/archivereasons Create new archive reason

#Available from v.3.3.0

Request parameters

Property name Parameter type Data type Description
model body object : ArchiveReason
ArchiveReason
Property name Data type Description
Uid string

Unique id of archive reason

Name string

Presented name of archive reason

Response status OK (200)

No body message is returned

GET /misc/archivereasons/{uid} Get an archive reason

#Available from v.3.3.0

Request parameters

Property name Parameter type Data type Description
uid path string

Id of archive reason

Response status OK (200)

object : ArchiveReason
ArchiveReason
Property name Data type Description
Uid string

Unique id of archive reason

Name string

Presented name of archive reason


DELETE /misc/archivereasons/{uid} Delete an archive reason

#Available from v.3.3.0

Request parameters

Property name Parameter type Data type Description
uid path string

Id of archive reason

Response status OK (200)

No body message is returned

GET /misc/models Get model definitions for products, variants, categories and global lists

#Available from v.3.2.0 Get complete the model descriptions for products, variants and categories, usable for migration tools, Model classes scaffolding etc.

Response status OK (200)

object : ModelStructure
ModelStructure
Property name Data type Description
ProductModels array : ProductModelSetup
VariantModels array : VariantModelSetup
CategoryModels array : CategoryModelSetup
GlobalListModels array : AttributeModel
CategoryAttributeModels array : AttributeModel
ProductModelSetup
Property name Data type Description
Alias string
Properties array : AttributeModel
AttributeModel
Property name Data type Description
Alias string
DataType string
Localized boolean
IsMultiValue boolean
DimensionSpecific boolean
ReferencedAttribute string
Properties array : AttributeModel
Name string
Description string
VariantModelSetup
Property name Data type Description
Alias string
Properties array : AttributeModel
CategoryModelSetup
Property name Data type Description
Alias string
Properties array : AttributeModel

GET /Version Get currently running PIM Version

Response status OK (200)

string