docs/sections/apis/pmmapper.rst

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