- Menu
- Sitemap
Reference - IOM REST API - Cache 1.0
Download Specification
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
Currently only the cache named bakery-cache-config is supported.
API Specification
Introduction
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
Object application/json
401 - Unauthorized
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
| Location | Name | Format | Description |
|---|---|---|---|
| in path | cacheName | string | Required | Name of the cache the action should be processed for. |
Response
200 - OK
Object application/json
401 - Unauthorized
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
| Location | Name | Format | Description |
|---|---|---|---|
| in path | cacheName | string | Required | Name of the cache the action should be processed for. |
Response
200 - OK
401 - Unauthorized
500 - Internal Server Error
Request and Response Object Schemata
Object application/json
{- "data":arrayAn array of
CacheStateDOobjects.[]CacheStateDO: Represents the current status of a cache on a server.
{- "id":integerFormat:
int64 - "cacheName":stringName of the cache | Example:
bakery-cache-config - "clearDate":stringTimestamp of the last cache clear for the cache and the server | Format:
date-time - "action":stringSpecifies 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":stringUnique identifier for a server | Example:
BACKEND_0.0.0.0
- "statusCode":integerFormat:
int32 - "errors":arrayAn array of
FieldErrorobjects.[]FieldError:
{- "message":string
- "sourceField":string
- "exceptions":arrayAn array of
CodedExceptionobjects.[]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.