RWrws
Preview Provider

Refresh Preview

Changed on

This endpoint refreshes the preview. This initiates an asynchronous background job to generate the preview. The timeout for this request which initiates the background job should be 10 seconds - the background job might run longer than this. The Response will be sent on the callbackUrl and not from this request. Callback Response

put/lc.preview.refreshpreview

Request

  • Base URL
    https://example.com
  • URL
    https://example.com/lc.preview.refreshpreview
  • Auth
    none declared

Headers

X-LC-ExtensionPointVersionstring

The extension point version

X-LC-ExtensionIdstring

The extension identifier

X-LC-AppVersionstring

The app version

TR_IDstring

A trace id, to help track problems. If it's not received, an auto-generated value will be used for logging. TR_ID header should also be set on the response.

x-lc-signaturestring

JWS token containing the signature and additional claims.

Request body

previewSessionIdstring required

Unique identifier for the given Preview Session.

scope'source' | 'target'

It indicates whether the source or the target is being generated.

previewResultFileUrlstring

Defines the one time upload URL to upload either a generated previewPackage or a previewHtmlFile.

callbackUrlstring required

This is the URL detailing endpoint to call when the asynchronous job has completed.

Response

Accepted

Changes

  • v19d9d8922a0ceRevision changes
    • info

      the endpoint scheme security LanguageCloudJWSToken was removed from the API

    • info

      added the new optional header request parameter TR_ID

    • info

      added the new optional header request parameter x-lc-signature