Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Tip
titleCreating JSON payloads

Note the following when you define a JSON payload: The object name specified in the payload must be in the following format: "_<HTTP_METHOD><RESOURCE_PATH>" where RESOURCE_PATH represents the path value specified in the data service resource. For example, if the RESOURCE_PATH is "employee", the payload object name should be as follows:

  • For HTTP POST requests: _postemployee
  • For HTTP PUT requests: _putemployee

However, if the The child name/values of the child fields in the payload should be the names and values of the input parameters in the target query.

Handling a resource path with the "/" symbol

If the RESOURCE_PATH specified in the data service contains the "/" symbol, be sure to replace the "/" symbol with the underscore symbol ("_") in the payload object name. For example, if the RESOURCE_PATH

Note

Important! In this scenario, the RESOURCE_PATH value should only contain simple letters. For example, the value can be "/employee/add" but not "/Employee/Add".

For example, if the RESOURCE_PATH is "/employee/add", the payload object name should be as follows:

  • For HTTP POST requests: _post_employee_add
  • For HTTP PUT requests: _put_employee_add

The child name/values of the child fields in the payload should be the names and values of the input parameters in the target query.If you are sending a batch request to the "/employee/add" resource, the payload object name should be as follows:

Code Block
{
    "_post_employee_add_batch_req": {
        "_post_employee_add": [
            {
               ..........
            },
            {
               ..........
            }
        ]
    }
}