...
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
| Connection Timeout (seconds) | Specifies the maximum time (in seconds) that the client will wait to establish a connection with the server. If the connection cannot be established within this time, an error will be thrown and logged. | ||||||
| Socket Timeout (seconds) | Specifies the maximum time (in seconds) that the client will wait for a server response after the connection is established. If no response is received within this time, an error will be thrown and logged. | ||||||
| Debug Mode | Show relevant debug entries in the server log for debugging purposes. | ||||||
| Response Type | Types of response format
| ||||||
| Format Response | Header. If Response Type is JSON, this section will be visible. | ||||||
| Enable Response Formatting | When checked, you can start writing a BeanShell script to format/post-process the JSON response. | ||||||
| Script | The "Enable Response Formatting" property must be enabled in order to write the BeanShell script here. Injected Variables:
Expected Return Object: It is expected to return a Map object that would later on be processed as configured to store to form and/or workflow variables. Example: Return the response only for the first item in a JSON array with the object name "apps".
| ||||||
| Store to Form | Header. If Response Type is JSON, this section will be visible. | ||||||
| Form | Select the target form to store data. | ||||||
| Base JSON Object Name for Multirow Data | Name of the object that contains an array to be based on. | ||||||
| Field Mapping | Mapping with JSON data with Form fields.
| ||||||
| Store to Workflow Variable | Header. If Response Type is JSON, this section will be visible. | ||||||
| Workflow Variable Mapping |
| ||||||
| Store Attachment | Header. If Response Type is File, this section will be visible. | ||||||
| Form | Recommended to use a child form with foreign key to main record as in a single JSON call, data may be returned successfully but fails in parsing to JSON format. | ||||||
| File Upload Field | Fill in to use as foreign key to main record. Leave it blank to save form record ID into column "ID". When it is blank and there are multiple logs, logs will be overwritten and only the last entry will be visible. | ||||||
| Store Response Status | Header. | ||||||
| Workflow Variable to Store Response Status | Workflow variable name to store response status value. | ||||||
| Form | Recommended to use a child form with foreign key to main record as in a single JSON call, data may be returned successfully but fails in parsing to JSON format. | ||||||
| Response Field ID | Fill in to use as foreign key to main record. Leave it blank to save form record ID into column "ID". When it is blank and there are multiple logs, logs will be overwritten and only the last entry will be visible. | ||||||
| Response Status Field * | Field to store response status. | ||||||
| Response Data Field | Field to store reponse data. | ||||||
| Base JSON Object Name for Multirow Data | Name of the object that contains an array to be based on. | ||||||
| Field Mapping |
| ||||||
| Field Mapping for Additional Attributes | To record additional attributes manually to provide clear insights on requests for audit purposes. For example, we set the table as: origin : appABC
|
...
- You can find the latest release at https://github.com/jogetoss/enhanced-json-api/releases Joget Marketplace.
- Upload the plugin to your Joget by navigating to Settings > Manage Plugins > Upload Plugin as admin.
...