summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/dfc/consumedapis.rst
blob: 258164a753537327302f9f067ea219186ead1133 (plain)
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0

API
===

GET /events/unauthenticated.VES_NOTIFICATION_OUTPUT
---------------------------------------------------

Description
~~~~~~~~~~~

Reads fileReady events from DMaaP (Data Movement as a Platform)


Responses
~~~~~~~~~

+-----------+---------------------+
| HTTP Code | Description         |
+===========+=====================+
| **200**   | successful response |
+-----------+---------------------+

GET /FEEDLOG_TOPIC/DEFAULT_FEED_ID?type=pub&filename=FILENAME
-------------------------------------------------------------

Description
~~~~~~~~~~~

Querying the Data Router to check whether a file has been published previously.

Responses
~~~~~~~~~

+-----------+------------+-----------------------+
| HTTP Code | Body       | Description           |
+===========+============+=======================+
| **400**   | NA         |   error in query      |
+-----------+------------+-----------------------+
| **200**   | []         |  Not published yet    |
+-----------+------------+-----------------------+
| **200**   | [$FILENAME]|  Already published    |
+-----------+------------+-----------------------+

POST /publish
-------------

Description
~~~~~~~~~~~

Publish the collected file/s as a stream to DataRouter
    - file as stream
    - compression
    - fileFormatType
    - fileFormatVersion
    - productName
    - vendorName
    - lastEpochMicrosec
    - sourceName
    - startEpochMicrosec
    - timeZoneOffset


Responses
~~~~~~~~~

+-----------+---------------------+
| HTTP Code | Description         |
+===========+=====================+
| **200**   | successful response |
+-----------+---------------------+