This document will cover the APICallCache feature for JSON. The following areas will be covered:
- Call Cache
Below is the standard definition of API:
An application programming interface (API) is a computing interface that defines interactions between multiple software intermediaries. It defines the kinds of calls or requests that can be made, how to make them, the data formats that should be used, the conventions to follow, etc. It can also provide extension mechanisms so that users can extend existing functionality in various ways and to varying degrees. An API can be entirely custom, specific to a component, or designed based on an industry-standard to ensure interoperability.
Below is the standard definition of Cache:
In computing, a cache is a hardware or software component that stores data so that future requests for that data can be served faster; the data stored in a cache might be the result of an earlier computation or a copy of data stored elsewhere. A cache hit occurs when the requested data can be found in a cache, while a cache miss occurs when it cannot. Cache hits are served by reading data from the cache, which is faster than re-computing a result or reading from a slower data store; thus, the more requests that can be served from the cache, the faster the system performs.
For OASIS, it is a queuing method that submits, monitors, and returns the results of job(s) running on the OASIS server
Basic PO Listing (without Call Cache)
Without Call Cache, the request could potentially receive a "500-Internal Server Error".
The 500 (Internal Server Error) status code indicates the server encountered an unexpected condition that prevented it from fulfilling the request. Pretty much timed out.
Basic PO Listing (with Call Cache)
With Call Cache, the job will not time out and will return the results quickly.
Call Cache Modifiers
Keep in mind if you use an "APICallCache=1" modifier, the call will be cached on the server. The "APICallCache=1" is used to improve response times for calls that are not expected to change regularly.
If you are going to be running multiple calls at once, be sure to include APICallCache = (with unique numbers for each call).
Call Cache Status
Shows every job that has been cached and its status.
The cache is cleared out and reset every two hours.
Below is the URL to check the Cache status: