1. REST API for Sites Management
  2. Tasks
  3. Sites
  4. Content Cache

Site Cache Information

get

/sites/management/api/v1/sites/{id}/cache

RELATION

Get information about the site's content cache, including the last time the cache was successfully refreshed. The contents of the cache is typically served when the site is being crawled. Cache refresh occurs automatically, typically on an hourly basis.

Introduced in release 20.2.2.

Authorization

To invoke this operation, the authenticated user or client application must have been shared with the resource and have one of the following sharing roles:

  • Owner
  • Manager
  • Contributor
  • Downloader
  • Viewer

Refresh Content Cache

Site content cache can be forced to refresh now if the cache does not include recent site updates.

For more information, see Refresh Content Cache.

Path Alternative Identifiers

The default identifier for a Site resource is the Site Identifier. The Site resource supports alternative identifiers.

nameSite Name

Instead of the site identifier, the site name can be used to uniquely identify a site in the resource path. The default resource path parameter for a site is the site identifier, but when working with sites the human-readable site name is sometimes easier.

http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/cache

Introduced in release 19.4.1.

Successful Response Examples

This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

200OK

Request

GET https://api.example.com/sites/management/api/v1/sites/{id}/cache

Response Body

{
  "refreshedAt": "2018-05-21T12:01:15.123Z",
  "expiresAt": "2018-05-21T12:01:15.123Z",
  "trigger": "api"
}

Client Error Response Examples

This operation responds with following client error (4xx) responses with exception details in the response body. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

404Not Found - Site Not Found

The site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.

Error Code

OCE-SITEMGMT-009003

Resolution - Check Identifier

Check that the site identifier is valid.

Resolution - Check Membership

Check that the authenticated user is a member of the site or a site administrator.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
siteSite that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the SiteNotFoundExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Not Found",
  "status": "404",
  "detail": "Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
  "o:errorCode": "OCE-SITEMGMT-009003",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

This resource represents the relationship between a Site and Site Cache resource. If there is no Site Cache associated with the Site then the response status code will be 204 No Content.

Request

Path Parameters
Query Parameters

  • Comma-delimited string of field names that should not be included in the response.

  • Comma-separated list of link relation names to exclude from the response.

  • Comma-delimited string of field names that you want to expand. Use the value all to expand all relationships.

    The following field names can be specified in the expand query parameter:

    Field NameDescription
    statusThe status of most recent pre-render cache refresh job for the site.

  • Specify how errors in expansion are handled. If not specified, then the default is to include error details in the relationship field.

    Valid values are:

    • ignore - Ignore the error and do not expand the relationship. Relationship links are not included in the response
    • include - Include the error details instead of the expanded relationship. Relationship links are returned
    • fail - Fail the request with an expansion failure error response

  • Comma-delimited string of field names to include in the response. Nested fields can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist.

  • Resources that have been marked for deletion can be read, modified, and support extended operations as long this query parameter is set to true. When the includeDeleted query parameter is not sent then the response to read, modification, and extended operations will be identical to that which would be returned if the resource was permanently deleted.

  • Comma-separated list of link relation names to include in the response. By default, all links are returned.

    The following links are provided by this resource:

    Link RelationshipDescription
    parentDescribes where the parent resource can be read. Equivalent to an up link, this link provides the link to the parent resource, such as the collection resource that contains a singular resource.
    selfDescribes the current returned representation of the resource. Used for links that represent the resource itself. For example, if a resource is returned as part of a collection, the self link will provide the URL path for the individual resource.
    canonicalDescribes the preferred representation of the requested resource. Used for links that represent the canonical form of the resource. For example, if a resource is returned as part of a collection, the canonical link will provide the URL path for the canonical form of the individual resource.
    describedByDescribes the schema resource providing metadata information about the resource. Used on collection, singular and relation resources to indicate where the schema resource is that describes the resource.

  • Specify the resource representation that should be used to control the response fields and links. If no representation is specified, the client-defined representation is returned, based on the values of the fields, excludeFields, links, excludeLinks and expand query parameters.

    The following representations are supported with the return query parameter:

    RepresentationDescription
    representationFull resource representation includes all properties and links and expands most relationships.
    defaultDefault resource representation includes most properties and links.
    basicBasic resource representation includes some properties and some links.
    minimalMinimal resource representation, includes essential properties and no links.
Back to Top

Response

Supported Media Types

200 Response

OK
Headers
Body ()
Root Schema : schema
Match All
Show Source
  • SiteCache

    Information about the site's pre-rendered content cache.

    Introduced in release 20.2.2.
Nested Schema : SiteCache

Information about the site's pre-rendered content cache.

Introduced in release 20.2.2.
Match All
Show Source
  • SingularResource

    All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

  • SiteCache-allOf[1]
Nested Schema : SingularResource
Type: object

All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

Show Source
  • links
Nested Schema : SiteCache-allOf[1]
Type: object
Show Source

  • Date and time when the cache expires. Will be null if the site cache is being refreshed for the first time and has not completed. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

    Introduced in release 20.2.2.

  • Date and time of the last successful site content cache refresh. Will be null if the site cache is being refreshed for the first time and has not completed. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

    Introduced in release 20.2.2.
  • status

    The status of most recent pre-render cache refresh job for the site. This job may still be in progress, or have failed. The refreshedAt field will contain when the last successful refresh occurred, if there is one.

    Introduced in release 20.2.2.

  • Mechanism that triggered the last successful site content cache refresh. Will be null if the site cache is being refreshed for the first time and has not completed.

    Valid values are:

    • preCaching - Cache was updated by pre-caching process of internal nightly crawlers
    • internalScheduler - Cache was updated by internal hourly crawlers
    • api - Cache was updated by a call to the update api
    • customRequest - Cache was updated by direct manual update of a page

    Introduced in release 20.2.2.
Nested Schema : status

The status of most recent pre-render cache refresh job for the site. This job may still be in progress, or have failed. The refreshedAt field will contain when the last successful refresh occurred, if there is one.

Introduced in release 20.2.2.
Match All
Show Source
Nested Schema : RefreshSiteJobStatus

Background job details for refreshing a site.

Introduced in release 20.2.2.
Match All
Show Source
Nested Schema : SiteJobStatus
Discriminator: action

Background job details for site jobs.

Match All
Show Source
  • SingularResource

    All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

  • SiteJobStatus-allOf[1]
Nested Schema : SiteJobStatus-allOf[1]
Type: object
Show Source

  • Type of Site Job Status. Valid values are: , translate, copy, publish, importTranslations, hardDelete, copyTheme, copyComponent, refresh, publishTheme.

  • Whether the asynchronous job is completed or not.

  • A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.

  • Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.

  • Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

  • error

    Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.

  • A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.

  • Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.

  • The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: succeeded, failed, aborted. The value blocked means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: pending, processing, paused.

    Valid values are:

    • pending - Request is waiting to run
    • processing - Request is running
    • succeeded - Request has completed successfully
    • failed - Request has failed
    A processing request failed before it was completed.
    • aborted - Request was aborted
    A processing request was aborted before it was completed.
    • paused - Request was running, but is now paused
    • blocked - Request is blocked
    Request requires action, such as waiting for a human to approve something.

  • HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.

  • result

    It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the requestStatus property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.

  • Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

Nested Schema : RefreshSiteJobStatus-allOf[1]
Type: object
Show Source
Nested Schema : error
Type: object

Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.

Nested Schema : result

It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the requestStatus property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.

Match All
Show Source
  • HttpResponse

    Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.

Nested Schema : HttpResponse
Type: object

Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.

Show Source
Nested Schema : headers
Type: array

HTTP response headers.

Show Source
Nested Schema : status
Type: object

HTTP status code response value and reason.

Show Source

  • The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of 404.

  • Short, human-readable summary of the status code.

Nested Schema : items
Type: object
Show Source
Nested Schema : pages
Type: object

List of all pages that are included in the site refresh job. Each page contains its individual refresh status, and any error details if the page failed to refresh.

Introduced in release 20.2.2.
Show Source
  • items

    Collection of Site Page Refresh Item elements.

    Introduced in release 20.2.2.
Match All
Show Source
  • CollectionResource

    All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Nested Schema : items
Type: array

Collection of Site Page Refresh Item elements.

Introduced in release 20.2.2.
Show Source
Nested Schema : CollectionResource

All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Match All
Show Source
Nested Schema : CollectionResource-allOf[1]
Type: object
Show Source

  • Total number of resources in the response.

  • Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.

  • Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.

  • Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.

  • Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the totalResults parameter is supported and is set to true by the client.

Nested Schema : items
Match All
Show Source
Nested Schema : SitePageRefreshItem

Status details for an individual page in a site refresh job.

Introduced in release 20.2.2.
Match All
Show Source
Nested Schema : SitePageRefreshItem-allOf[1]
Type: object
Show Source
  • error

    Error details for an individual page that has failed to refresh in a site refresh job.

    Introduced in release 20.2.2.

  • The page URL of an individual page in a site refresh job.

    Introduced in release 20.2.2.

  • The current status of an individual page in a site refresh job.

    Valid values are:

    • pending - Job has been queued
    • processing - Job is processing
    • complete - Job has completed
    • failed - Job has failed

    Introduced in release 20.2.2.
Nested Schema : error
Type: object

Error details for an individual page that has failed to refresh in a site refresh job.

Introduced in release 20.2.2.
Example Response ()
{
    "refreshedAt":"2018-05-21T12:01:15.123Z",
    "expiresAt":"2018-05-21T12:01:15.123Z",
    "trigger":"api"
}

204 Response

No Content
Headers

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SiteNotFoundExceptionDetail
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : SiteNotFoundExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Site Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Not Found",
    "status":"404",
    "detail":"Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
    "o:errorCode":"OCE-SITEMGMT-009003",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

406 Response

Not Acceptable

416 Response

Range Not Satisfiable

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout
Back to Top