Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
qfq
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
typo3
qfq
Commits
da31882e
Commit
da31882e
authored
4 years ago
by
Marc Egger
Browse files
Options
Downloads
Patches
Plain Diff
Report.rst: fix dataReport doku
parent
e7a58c8a
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!293
Develop
Pipeline
#3835
passed
4 years ago
Stage: before
Stage: build
Stage: selenium
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
Documentation/Report.rst
+8
-1
8 additions, 1 deletion
Documentation/Report.rst
with
8 additions
and
1 deletion
Documentation/Report.rst
+
8
−
1
View file @
da31882e
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment