SAP Knowledge Base Article - Public

3251165 - How to download the template to enable DWB API calls

Symptom

When using DWB API Call For Registered Product using Complete Business Object Module, it is able to import the required data with template by using Data Workbench tool, but not able to import via DWB API calls.

Environment

SAP Cloud for Customer

Cause

The wrong template is downloaded.

Resolution

To work with DWB API, user has to download the template using the endpoint: <HostName>/api/v1/template?token=<token>&serviceName=<service_name>&entityName=<rootEntityName>&isCustom=false&type=1&operation=1

Take Register Product object as an example: <HostName>/api/v1/template?serviceName=registeredproduct&entityName=RegisteredProduct&isCustom=false&type=1&operation=1&token=<Single use token>

Which specified in the documentation: Consuming SAP Cloud for Customer Data Workbench REST API from Java Applications

The template is not fully consistent. Usually if any new fields are added to the Odata service (or) if any metadata changes to the service then need to download a new template and do the import. Mostly there is no change in the standard fields of relevant Odata service. But if you add any extension fields(KUT, PDI ) to Odata service then templates should not match in PROD and STG tenants.

If user wants to do a data import in a particular tenant, it is always recommended to download the template from that tenant and use it for import.

See Also

Data Workbench APIs

Keywords

Data Workbench, DWB, API, DWB API, API calls, Import, template, Java Code , KBA , LOD-CRM-INT-DWB , Data Workbench , How To

Product

SAP Cloud for Customer core applications 2208