Jump to

• Request
• Response

Drop Cache

post

/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_dropCache

Use this endpoint to eliminate the cache created through REST web services. Drop Cache can improve site performance by removing cached objects that would otherwise remain in memory for the duration of the timeout specified in administration.

Request

Supported Media Types

• application/json

Path Parameters

• MainDocVarName(required): string
  The variable name of the main document, note the first letter must be capitalized.
• ProcessVarName(required): string
  The variable name of the commerce process, note the first letter must be capitalized.
• id(required): integer
  Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.

Body ()

Root Schema : Transaction-_dropCacheRequest

Type: object

Show Source

• cacheInstanceId: string
  Title: Cache Instance Id

  The unique identifier for the entry of transaction data stored in the cache.This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify / Interact action to avoid reload transaction data from db.

{
    "type":"object",
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of transaction data stored in the cache.This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify / Interact action to avoid reload transaction data from db.",
            "title":"Cache Instance Id"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Transaction-_dropCacheResponse

Type: object

Show Source

• cacheInstanceId: string
  Title: Cache Instance Id

  The unique identifier for the entry of transaction data stored in the cache.This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify / Interact action to avoid reload transaction data from db.

{
    "type":"object",
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of transaction data stored in the cache.This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify / Interact action to avoid reload transaction data from db.",
            "title":"Cache Instance Id"
        }
    }
}

Back to Top