Manage Template Placeholder Mappings

You can manage the mappings by retrieving the details using the Mappings API. You can get all the available mapping details using this API.

Here's how you can get the mapping details:
  • To get the mapping details, run the following cURL command or use a REST API client:

      curl -H Authorization: Bearer <accessToken> https://<hostName>/cx/industry/buying/configManagement/v1/mappings -X GET

How to Update Template Placeholder Mappings

You can configure placeholders for the template file using the available TmfSpecs and ReferenceFields list.

Here's how you can add new placeholder mappings:

  1. Create payload to create new mapping with the details described in the table

    Field Description
    name The unique placeholder name
    action

    The action to be performed on the placeholder. Accepted values are:

    • add
    • modify

    • delete
    referenceField
    • id

    The id of the reference field to be used for placeholder creation.

    The ID should be taken from the available list of reference fields.

  2. Call the Mapping API by running this cURL command or by using a REST API client:
    curl -H Authorization: Bearer <accessToken> https://<hostName>/cx/industry/buying/configManagement/v1/mappings -X PATCH -H "Content-Type: application/json" -d @sc-data.json
    
To get the supported TmfSpec list, call the TmfSpec API by running this cURL command or by using a REST API client:
  curl -H Authorization: Bearer <accessToken> 
  https://<hostName>/cx/industry/buying/configManagement/v1/tmfSpecs -X GET
To get the supported ReferenceField list, Call the TmfSpec API by running this cURL command or by using a REST API client:
  curl -H Authorization: Bearer <accessToken> 
  https://<hostName>/cx/industry/buying/configManagement/v1/referenceFields -X GET

Where:

  • <accessToken> is the OAuth access token for Contract Administrator Role.
  • <hostName> is the URL for the CX Industries Framework API Gateway.