# 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 running correctly
Response status OK (200)
GET /misc/archivereasons Get all archive reasons
#Available from v.3.3.0
[
{
"Uid": "467d2c30-3309-419e-9b04-6f61b261e269",
"Name": "Outdated"
},
{
"Uid": "f73833e4-3300-4518-905e-ff90dd45b268",
"Name": "Irrellevant"
}
]
Response status OK (200)
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
{
"Uid": "037703f7-71ad-44b9-b434-2e02f412645d",
"Name": "Outdated"
}
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
model | body | object : ArchiveReason |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of archive reason |
Name | string |
Presented name of archive reason |
Response status OK (200)
POST /misc/archivereasons Create new archive reason
#Available from v.3.3.0
{
"Uid": "d860986a-a08e-48af-aa39-938661644271",
"Name": "Outdated"
}
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
model | body | object : ArchiveReason |
Property name | Data type | Description |
---|---|---|
Uid | string |
Unique id of archive reason |
Name | string |
Presented name of archive reason |
Response status OK (200)
GET /misc/archivereasons/{uid} Get an archive reason
#Available from v.3.3.0
{
"Uid": "fee05b37-93ec-4506-962c-e86078b05818",
"Name": "Outdated"
}
Request parameters
Property name | Parameter type | Data type | Description |
---|---|---|---|
uid | path | string |
Id of archive reason |
Response status OK (200)
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)
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)
Property name | Data type | Description |
---|---|---|
ProductModels | array : ProductModelSetup | |
VariantModels | array : VariantModelSetup | |
CategoryModels | array : CategoryModelSetup | |
VariantGroupModels | array : VariantGroupModelSetup | |
GlobalListModels | array : AttributeModel | |
CategoryAttributeModels | array : AttributeModel |
Property name | Data type | Description |
---|---|---|
Alias | string | |
Properties | array : 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 |
Property name | Data type | Description |
---|---|---|
Alias | string | |
Properties | array : AttributeModel |
Property name | Data type | Description |
---|---|---|
Alias | string | |
Properties | array : AttributeModel |
Property name | Data type | Description |
---|---|---|
Alias | string | |
Properties | array : AttributeModel |