Fetching Component and Template Definitions from the Conscia DX Engine

This blog post explains how you can fetch Component and Template definitions from the Conscia Digital Experience (DX) Engine using Conscia’s Webservice APIs. You can use this exported JSON to investigate Template and Component definitions offline, and you can store these definitions in a source code management system and even push them to other Conscia Environments using relevant Conscia Webservice APIs.

• DX Component Documentation: https://docs.conscia.ai/solutions/dx-engine/dx-engine-component-anatomy
• DX Template Documentation: https://docs.conscia.ai/solutions/dx-engine/templates

To invoke Conscia Webservice APIs, you must set the Authorization HTTP header to Bearer {Token}, replacing {Token} with a valid Conscia API token. You must also set the X-Customer-Code HTTP header to your Conscia customer identifier.

You always use GET to fetch template and component definitions.

Be sure to use the correct API endpoint:

• https://engine-staging.conscia.io/api – Conscia’s Staging DX Engine
• https://engine.conscia.io/api – Conscia’s Production DX Engine
• Docs: https://docs.conscia.ai/api/dx-engine#servers

To fetch all template definitions:

• GET https://engine-staging.conscia.io/api/experience/templates/
• Docs: https://docs.conscia.ai/api/dx-engine#get-/experience/templates

To fetch an individual template definition, replace {your-template-id} with your template’s identifier:

• GET https://docs.conscia.ai/api/dx-engine#get-/experience/templates/{your-template-id}
• Docs: https://docs.conscia.ai/api/dx-engine#get-/experience/templates/-templateCode-

To fetch all component definitions:

• GET https://engine-staging.conscia.io/api/experience/components
• Docs: https://docs.conscia.ai/api/dx-engine#get-/experience/components

To fetch an individual component definition, replace {your-component-id} with the component’s identifier:

• GET https://engine-staging.conscia.io/api/experience/components/{your-component-id}
• Docs: https://docs.conscia.ai/api/dx-engine#get-/experience/components/-componentCode-

You can use the following API to add or update Templates and Components in a Conscia Environment:

• https://docs.conscia.ai/api/dx-engine#post-/experience/templates
• https://docs.conscia.ai/api/dx-engine#post-/experience/templates/-templateCode-
• https://docs.conscia.ai/api/dx-engine#post-/experience/components
• https://docs.conscia.ai/api/dx-engine#put-/experience/components/-componentCode-
• DX Environment Documentation: https://docs.conscia.ai/solutions/dx-engine/environments

To specify an Environment for Conscia Webservice API calls, set the value of the X-Environment-Code HTTP header to the identifier associated with the Environment.

You can use the following API to export the configuration of an entire DX Engine Environment:

• GET /api/raw-engine-config

You can use the following API to import an entire DX Engine Environment:

• PUT /engine-config

With a JSON payload such as the following, where the engineConfig key holds a JSON value in the format returned by /api/raw-engine-config:

{
 "engineConfig": {}
}

You can pass the ?preserveSecrets=true query string parameter to preserve secrets in the target Environment. If preserveSecrets is false, as by default, then importing an environment will overwrite its secrets.

To invoke a Conscia DX Engine Orchestration Template, replace my-template-id with the Template’s identifier:

POST /api/experience/template/_query  
{  
  "templateCode": "my-template-id",  
  "context": { }
} 

To invoke one or more Conscia DX Engine Orchestration Components, replace my-component-code with the list of component identifiers:

POST /api/experience/components/_query  
{  
  "componentCodes": ["my-component-code"],  
  "context": { }
}

Title Image credit: ChatGPT