JSON Generation

Version

Application Scenario

To write API data into a specified interface using the API Output operator, you may need to transform database data or other forms of data into JSON data to facilitate data interaction.

Function Description

You can use the JSON Generation operator of FineDataLink to generate JSON data.

• You can configure three-level (at most) nested subobjects and one-level nested subarrays in the JSON configuration area. Only one subarray is allowed at a level.

• A field can only be selected once in the JSON Generation operator. The selected fields are grayed out.

• If the field value is numeric, the generated value will be a numeric value without double quotation marks (""). If the field value is a Boolean value (true/false), the generated value will be true/false without double quotation marks (""). In other cases, the generated value will be a string.

• If you select String, the generated value will be a string enclosed in double quotation marks ("").

• For subarrays, you can add only one field or subobject in the front.

• Same names are not allowed for keys at the same level but are allowed for keys across levels.

You can download the sample data: dw_comment.xlsx

Transform user data in a table format into JSON data and then use the API Output operator to write it into an API of the business system to trigger business processes, thus achieving data interaction.

This document details how to use the JSON Generation operator.

Data Fetching

Drag a Data Transformation node to the design page and click it. Drag a DB Table Input operator to the configuration page and use the SQL statement shown in the following figure to fetch the data that needs to be output to an API.

Click Data Preview, as shown in the following figure.

JSON Setting

The data to be written into the API should be JSON data, so you need to transform the original data in the database table format into JSON data.

The following is an example of JSON data:

{
	"fields": {
		"summary": "The document is excellent.",
		"components": {
			"name": [
				"FDL"
			]
		},
		"customfield_14904": "https://help.fanruan.com/finedatalink-en/doc-view-51.html",
		"description": "FDL Deployment Environment Preparation"
	}
}

Drag a JSON Generation operator to the design page, and configure Output Field and JSON Setting.

Click the + button in JSON Setting, as shown in the following figure.

Enter the first key fields and configure its subobject, as shown in the following figure.

Enter the key summary in the subobject and select the comment field as its value, as shown in the following figure.

You can modify the value type to String, Value, and Boolean, as shown in the following figure.

The final effect is shown in the following figure.

If you click Automatic Generation, an object without nesting is automatically generated for fields in the data flow entering the JSON Generation operator, where each field is represented as a key-value pair with the field name as the key and the field value as the value, as shown in the following figure.

Data Preview

Click Data Preview to view the generated JSON data.

Click a piece of JSON data, and you can view and copy the detailed content on the right side, as shown in the following figure.

For details about subsequent operations, see API Output.