REST mapping in PDS and its effects on the JSON payloads for ProDataSets

How the different ways to map DATASET or DATASET-HANDLE parameters in the Progress Developer Studio for OpenEdge REST Resource URI Editor affect the format of the JSON that must be passed to the REST service and the JSON that is returned from the REST service.

Mar 28, 2022
Knowledge

Title

URL Name

REST-mapping-in-PDSOE-and-its-effects-on-the-JSON-payloads-for-dataset-Handle

Article Number

000184504

Environment

Product: OpenEdge Version: 11.2 and later OS: Windows Other: WSA, PASOE

Question/Problem Description

In the Progress Developer Studio for OpenEdge REST Resource URI Editor, ABL interface parameters may be mapped to HTTP request or response messages as the message body itself, or as body parameters.

For input parameters, how does this choice affect the format of the JSON that must be passed to the REST service?

For output parameters, how does this choice affect the format of the JSON that is returned from the REST service?

Steps to Reproduce

Clarifying Information

Error Message

Table name '<name>' in JSON does not match '<name>'. (15376) Error attempting to run '<ABL routine>'. JSON value of ProDataset or temp-table parameter is invalid or empty. (16992) An incomplete client request. (8020) ERROR condition: An incomplete client request. (8020) (7211)

Defect Number

Enhancement Number

Cause

Resolution

When an OpenEdge REST service exposes an ABL routine with a ProDataSet parameter (defined as DATASET or DATASET-HANDLE), the JSON that is passed through the parameter must use a different format depending on whether it is passed in the body of the HTTP message, or as a body parameter.

If the format of the JSON is incorrect for the way the JSON is being passed, the ABL routine will raise error 15376, 16992 and 8020.

When a dataset parameter is mapped to the message body itself, the input JSON does not use the "request" wrapper nor the dataset name wrapper (i.e. the dataset name appears only once). The following screen captures show examples of how input and output parameters are defined to map to the message body, how the input JSON payload should be formatted, and how the resulting response is formatted:

REST call input parameter definition when passing via the message body:

User-added image

REST call output parameter definition when passing via the message body:

User-added image

Chrome Advanced REST Client Example for mapping to the message body:

User-added image

When mapping to a body parameter, the input JSON must use the "request" wrapper and the dataset name wrapper (i.e. the dataset name appears twice). The following screen captures show examples of how input and output parameters are defined to map to a body parameter, how the input JSON payload should be formatted, and how the resulting response is formatted:

REST call input parameter definition when passing via a body parameter

REST call output parameter definition when passing via a body parameter

Chrome Advanced REST Client Example for mapping to a body parameter

User-added image

Workaround

Notes

References to Other Documentation:

Possible causes when error (16992) is raised by REST operation

Keyword Phrase

Last Modified Date

3/28/2022 12:18 PM

REST mapping in PDS and its effects on the JSON payloads for ProDataSets

Files(0)

Was this article helpful?

Was this article helpful?

REST mapping in PDS and its effects on the JSON payloads for ProDataSets

Information

Related Articles