diff --git a/Documentation/Report.rst b/Documentation/Report.rst index 1afbe12df648a807b3e18e7f72f500a11f59b047..0012410f4a369d75506638d1d977dd41734d365f 100644 --- a/Documentation/Report.rst +++ b/Documentation/Report.rst @@ -1697,7 +1697,10 @@ API Call QFQ Report (e.g. AJAX) * General use API call to fire a specific QFQ tt-content record. Useful for e.g. AJAX calls. No Typo3 is involved. *No FE-Group access control*. * This defines just a simple API endpoint. For defining a rest API see: :ref:`restApi`. * Custom response headers can be defined by setting the variable `apiResponseHeader` in the record store. - * Multiple headers should be separated by '\n' or '\r\n'. e.g.: 'Content-Type: application/json\ncustom-header: fooBar' + * Multiple headers should be separated by `\n` or `\r\n`. e.g.: `Content-Type: application/json\ncustom-header: fooBar` +* If the api call succeeds the rendered content of the report is returned as is. (no additional formatting, no JSON encoding) + * You can use MYSQL to create Json. See: +`MYSQL create Json <https://dev.mysql.com/doc/refman/8.0/en/json-creation-functions.html>`_ * If a QFQ error occurs then a http-status of 400 is returned together with a JSON encoded response of the form: `{"status":"error", "message":"..."}` Example QFQ record JS (with tt_content.uid=12345):: @@ -1728,6 +1731,10 @@ Example QFQ record called by above AJAX:: 10.sql = SELECT '{{arg1:S}} {{arg2:S}} {{arg3:C}} {{arg4:C}}', NOW() , 'Content-Type: application/json\ncustom-header: fooBar' AS _apiResponseHeader +Example text returned by the above AJAX call:: + + Hello World 456 5672020-09-22 18:09:47 + .. _rest_client: REST Client