Document Properties
Kbid
29401V
Last Modified
09-Jun-2020
Added to KB
08-May-2020
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • IOM 3.0
  • IOM 3.1
  • IOM 3.2
  • IOM 3.3
  • IOM 3.4
  • IOM 3.5
  • IOM 3.6
  • IOM 3.7
  • IOM 4.0
  • IOM 4.1
  • IOM 4.2
  • IOM 4.3
  • IOM 4.4
  • IOM 4.5
  • IOM 4.6
  • IOM 4.7
  • IOM 5.0
Reference - IOM REST API - Cache 1.0
Document View


This API specification is available for download as an Open API 3.0 YAML file: 

Authentication

Basic Authentication

Please configure your clients to use this authentication method to submit user name and password.

Authorization

The permission "View return requests" is required to use the GET endpoints and must be assigned at the requested shop_name organization. The permission "Manage return requests" is required to use the POST endpoints and must be assigned at the requested shop_name organization.

References

Limitations

Note

Supported caches 
Currently only the cache named bakery-cache-config is supported.

API Specification

Introduction
OpenAPI Version: 3.0.1
IOM Cache Management REST API Version: 1.0

Cache operations to manage application caches.

Cache Management API
/caches
GET: Returns the statuses for all cache for all server nodes.

Description

Returns the statuses for all cache for all server nodes.

Request Body

--

Request Parameters

--

Response

200 - OK The request has succeeded.

Object application/json

401 - Unauthorized or Forbidden.

500 - Internal Server Error .

/caches/{cacheName}
GET: Returns the statuses of the given cache name for all server nodes.

Description

Returns the statuses of the given cache name for all server nodes.

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathcacheNamestringRequired | Name of the cache the action should be processed for.

Response

200 - OK The request has succeeded.

Object application/json

401 - Unauthorized or Forbidden.

500 - Internal Server Error .

DELETE: Requests to clear a given cache on all server nodes.

Description

Requests to clear a given cache on all server nodes. The cache clear will be processed asynchronously from all server nodes.

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathcacheNamestringRequired | Name of the cache the action should be processed for.

Response

200 - OK The request has succeeded.

401 - Unauthorized or Forbidden

500 - Internal Server Error .

Request and Response Object Schemata
Object application/json{
  • "data":
    array
    An array of CacheStateDO objects.
    [
    CacheStateDO: Represents the current status of a cache on a server.
    {
    • "id":
      integer
      Format: int64
    • "cacheName":
      string
      Name of the cache | Example: bakery-cache-config
    • "clearDate":
      string
      Timestamp of the last cache clear for the cache and the server | Format: date-time
    • "action":
      string
      Specifies under which circumstances the cache was cleared. A server startup as a clean cache after server startup or requested as the cache was cleared by a request | Example: server startup | Possible Values: server startuprequested
    • "serverId":
      string
      Unique identifier for a server | Example: BACKEND_0.0.0.0
    }
    ]
  • "statusCode":
    integer
    Format: int32
  • "errors":
    array
    An array of FieldError objects.
    [
    FieldError
    {
    • "message":
      string
    • "sourceField":
      string
    }
    ]
  • "exceptions":
    array
    An array of CodedException objects.
    [
    CodedException
    {
    • "message":
      string
    • "code":
      string
    }
    ]
}
Disclaimer
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.