docs/sections/apis/pmmapper.rst

   1 .. This work is licensed under a
   2    Creative Commons Attribution 4.0 International License.
   3    http://creativecommons.org/licenses/by/4.0
   4
   5 ========================
   6 3GPP PM Mapper
   7 ========================
   8
   9 .. contents::
  10     :depth: 3
  11
  12 Overview
  13 ========
  14
  15 Component description can be found under `3GPP PM Mapper`_.
  16
  17 .. _3GPP PM Mapper: ../../sections/services/pm-mapper/index.rst
  18
  19 Paths
  20 =====
  21
  22 PUT ``/delivery``
  23 ---------------------------------------------------
  24
  25 Description
  26 ~~~~~~~~~~~
  27 Publish the PM Measurment file to PM Mapper.
  28
  29 Responses
  30 ~~~~~~~~~
  31
  32 +-----------+---------------------+
  33 | HTTP Code | Description         |
  34 +===========+=====================+
  35 | **200**   | successful response |
  36 +-----------+---------------------+
  37
  38 GET ``/healthcheck``
  39 --------------------
  40
  41 Description
  42 ~~~~~~~~~~~
  43 This is the health check endpoint. If this returns a 200, the server is alive.
  44 If anything other than a 200, the server is either dead or no connection to
  45 pm mapper.
  46
  47 Responses
  48 ~~~~~~~~~
  49
  50 +-----------+---------------------+
  51 | HTTP Code | Description         |
  52 +===========+=====================+
  53 | **200**   | successful response |
  54 +-----------+---------------------+
  55
  56 GET ``/reconfigure``
  57 --------------------
  58
  59 Description
  60 ~~~~~~~~~~~
  61 This is the reconfigure endpoint to fetch updated config information using
  62 config binding service.
  63
  64 Responses
  65 ~~~~~~~~~
  66
  67 +-----------+---------------------+
  68 | HTTP Code | Description         |
  69 +===========+=====================+
  70 | **200**   | successful response |
  71 +-----------+---------------------+