Check the status of PIMS

GET 
/pim/status

• No permissions are required for ApiKey.
• Example URI: https://instancename.piminto.com/api/en-us/pim/status

Provides the ability to check the status of PIMS (Product Information Management System).

Returns

---

• Information about the current state of PIM, as well as the date and time the current state was installed.
• PIM Counters: Includes information such as the total count of views, attributes defined in the PIM, size of assets (in bytes), and the total count of SKUs.
• PIM Limits: Presents details about the limits imposed on PIMS within the selected plan, covering aspects like the total count of views, attributes, asset size, and SKU count.

The PIMS status can take one of three possible values:

• Active: PIMS is currently available and operational.
• Inactive: PIMS is currently unavailable and inaccessible.
• Maintenance: PIMS is temporarily unavailable due to system updates or maintenance work.

Checking the PIMS status through this API endpoint can be useful for developers and users to ensure that PIMS is available before sending requests for product data.

Request

Responses

200

success

application/json

Schema

Schema

status stringrequired

The status of the API request. A value of "OK" indicates that the request was successfully sent and processed.

status_message stringrequired

A message about the status of the PIM system, as well as the date and time when the current status was established

pim_status stringrequired

Possible values: [Active, Inactive, Maintenance]

The current status of the PIM system.

pim_counters objectrequired
totalViews objectrequired
value integerrequired
description stringrequired
totalAttributes objectrequired
value integer
description string
totalStorageSize objectrequired
value integerrequired
description stringrequired
totalSKUs objectrequired
value integerrequired
description stringrequired
pim_limits objectrequired
maxViews objectrequired
value integerrequired
description stringrequired
maxAttributes objectrequired
value integerrequired
description stringrequired
maxStorageSize objectrequired
description stringrequired
value integerrequired
maxSKUs objectrequired
description stringrequired
value integerrequired

Example (from schema)

{
  "status": "OK",
  "status_message": "PIM is up and running since Wed Jan  4 11:04:56 2023",
  "pim_status": "Active",
  "pim_counters": {
    "totalViews": {
      "value": 0,
      "description": "Total count of views"
    },
    "totalAttributes": {
      "value": 0,
      "description": "Total count of attributes defined in the PIM"
    },
    "totalStorageSize": {
      "value": 0,
      "description": "Total size of assets (in bytes)"
    },
    "totalSKUs": {
      "value": 0,
      "description": "Total count of SKUs"
    }
  },
  "pim_limits": {
    "maxViews": {
      "value": 0,
      "description": "Maximum quantity of views in the PIM"
    },
    "maxAttributes": {
      "value": 0,
      "description": "Maximum quantity of attributes defined in the PIM"
    },
    "maxStorageSize": {
      "description": "Maximum total size of assets in bytes",
      "value": 0
    },
    "maxSKUs": {
      "description": "Maximum SKU allowed in the PIM",
      "value": 0
    }
  }
}

Loading...