dataFormat
Type: Integer
The dataFormat property of the JadeRestRequest class contains the format to use for serialized objects. The value can be one of the following JadeRestRequest class constants.
JadeRestRequest Class Constant | Value | Description |
---|---|---|
DataFormat_FormUrlEncoding | 5 | Corresponds to the application/x‑www‑form‑urlencoded HTTP content‑type. When using this format, use the addFormUrlData method to add object properties. |
DataFormat_JSON | 3 | Corresponds to the application/json HTTP content‑type. When using this format, use the addObjectParam method to add an object encoded in Microsoft JSON format. |
DataFormat_JSONN | 4 | Corresponds to the application/json HTTP content‑type. When using this format, use the addObjectParam method to add an object encoded in NewtonSoft JSON format. |
DataFormat_JSON_Any | 8 | Corresponds to the application/*+json HTTP content‑type. When using this format, set the body property as required by the REST API specification. |
DataFormat_JSON_PATCH | 11 | Corresponds to the application/json‑patch+json HTTP content‑type. When using this format, set the body property as required by the REST API specification. |
DataFormat_MultipartFormData | 6 | Corresponds to the multipart/form‑data HTTP content‑type. When using this format, use the addMultipartFormData method to add form data. |
DataFormat_OctetStream | 7 | Corresponds to the application/octet‑stream HTTP content‑type. When using this format, set the body parameter as required by the REST API specification. |
DataFormat_PDF | 27 | Corresponds to the application/PDF HTTP content‑type. When using this format, set the body parameter as required by the REST API specification. |
DataFormat_Text_JSON | 10 | Corresponds to the text/json HTTP content‑type. When using this format, use the addObjectParam method to add an object encoded in Microsoft JSON format. |
DataFormat_Text_Plain | 9 | Corresponds to the text/plain HTTP content‑type. When using this format, set the body property as required by the REST API. |
DataFormat_Unknown | -1 | This value is used only by the OpenAPI import wizard, and it signifies that the REST API specification is expecting a data format not supported by JADE. |
DataFormat_XML | 1 | Corresponds to the application/xml HTTP content‑type. When using this format, use addObjectParam method the add an object using the to encode the object in XML. |
If the property is unset or set to any other value, data is serialized in the JSON data format by default.
2020.0.01 and higher