Preview Provider

This endpoint generates a rendered HTML fragment from a BCM document fragment. The timeout for this request should be 10 seconds.

post/lc.preview.updatesegment

Request

  • Base URL
    https://example.com
  • URL
    https://example.com/lc.preview.updatesegment
  • 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 referencing the session associated with this request.

scope'source' | 'target' required

Indicates if the content generated is the source or the target content.

Response

OK

previewSessionIdstring required

Unique ID for this preview session

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