File: reference.rst

package info (click to toggle)
tryton-modules-document-incoming 7.0.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 540 kB
  • sloc: python: 791; xml: 290; makefile: 11; sh: 3
file content (27 lines) | stat: -rw-r--r-- 891 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
*************
API Reference
*************

.. _Post incoming document:

Post incoming document
======================

The *Incoming Document Module* defines some routes for user applications:

   - ``POST`` ``/<database_name>/document_incoming``:
     Create an `Incoming Document <model-document.incoming>` using:

      - the `JSON <https://en.wikipedia.org/wiki/JSON>`_ Object with at least
        ``data`` key containing the document encoded in `Base64
        <https://en.wikipedia.org/wiki/Base64>`_.
        Other keys are treated as values for the fields of the record.

      - an octet-stream of the ``data``.
        The parameters of the request are treated as values for the fields of
        the record.

     Some request parameters change the behavior of the request:

      - ``process``: a boolean (``1`` or ``0``) to launch the processing on the
        created record.