Created dateUpdated dateAffects versionFix version

 

 

Management Console - All versions
Blancco Cloud - All versions
N/A

Description

How to retrieve custom fields from Blancco Management Console API to include in a CSV export, or use as a search field in an export.

Step by step instructions

To access the custom fields via the Blancco Management Console report export API you will need to specify the path to the custom field "user_data.fields.fieldName" within your request xml file. For example, for a field entitled “Client”, the path would be "user_data.fields.Client".

For use as a search path you need to use the full path entry in the search path.  <search path="user_data.fields.fieldName" value="fieldValue" operator="eq" datatype="string" conjunction="true" />. For example if you were searching for a particular client name "Blancco" the search path would be <search path="user_data.fields.Client" value="Blancco" operator="eq" datatype="string" conjunction="true" />

Search Path Example - using the custom field as a search criteria:

<?xml version="1.0" encoding="UTF-8"?>
<request>
<export-report>
<report mode="original"/>
<search path="user_data.fields.Client" value="Blancco" operator="eq" datatype="string" conjunction="true" />
</export-report>
</request>

CSV Example - exporting the custom field value as a column in CSV:

<?xml version="1.0" encoding="UTF-8"?> <request>
<export-report>
<report mode="original"/>
<search path="user_data.fields.Client" value="Blancco" operator="eq" datatype="string" conjunction="true" />
<reportColumns>
<columnPath>user_data.fields.Client</columnPath>-->
</reportColumns>
<csv-options csvLanguage="en_US" delimiter="," subDelimiter=":"/>
</export-report>
</request>