docs/sections/services/dfc/consumedapis.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 API
   5 ===
   6
   7 GET /events/unauthenticated.VES_NOTIFICATION_OUTPUT
   8 ---------------------------------------------------
   9
  10 Description
  11 ~~~~~~~~~~~
  12
  13 Reads fileReady events from DMaaP (Data Movement as a Platform)
  14
  15
  16 Responses
  17 ~~~~~~~~~
  18
  19 +-----------+---------------------+
  20 | HTTP Code | Description         |
  21 +===========+=====================+
  22 | **200**   | successful response |
  23 +-----------+---------------------+
  24
  25 GET /FEEDLOG_TOPIC/DEFAULT_FEED_ID?type=pub&filename=FILENAME
  26 -------------
  27
  28 Description
  29 ~~~~~~~~~~~
  30
  31 Querying the Data Router to check whether a file has been published previously.
  32
  33 Responses
  34 ~~~~~~~~~
  35
  36 +-----------+------------+-----------------------+
  37 | HTTP Code | Body       | Description           |
  38 +===========+============+=======================+
  39 | **400**   | NA         |   error in query      |
  40 +-----------+------------+-----------------------+
  41 | **200**   | []         |  Not published yet    |
  42 +-----------+------------+-----------------------+
  43 | **200**   | [$FILENAME]|  Already published    |
  44 +-----------+------------+-----------------------+
  45
  46 POST /publish
  47 -------------
  48
  49 Description
  50 ~~~~~~~~~~~
  51
  52 Publish the collected file/s as a stream to DataRouter
  53     - file as stream
  54     - compression
  55     - fileFormatType
  56     - fileFormatVersion
  57     - productName
  58     - vendorName
  59     - lastEpochMicrosec
  60     - sourceName
  61     - startEpochMicrosec
  62     - timeZoneOffset
  63
  64
  65 Responses
  66 ~~~~~~~~~
  67
  68 +-----------+---------------------+
  69 | HTTP Code | Description         |
  70 +===========+=====================+
  71 | **200**   | successful response |
  72 +-----------+---------------------+