summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis/pmmapper.rst
blob: 5da8bf1651b5d85b118adfc985006631be03d540 (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
.. This work is licensed under a
   Creative Commons Attribution 4.0 International License.

========================
3GPP PM Mapper
========================

.. contents::
    :depth: 3

Overview
========

Component description can be found under `3GPP PM Mapper`_.

.. _3GPP PM Mapper: ../../sections/services/pm-mapper/index.html

Paths
=====

PUT ``/delivery``
---------------------------------------------------

Description
~~~~~~~~~~~
Publish the PM Measurment file to PM Mapper.

Responses
~~~~~~~~~

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

GET ``/healthcheck``
--------------------

Description
~~~~~~~~~~~
This is the health check endpoint. If this returns a 200, the server is alive.
If anything other than a 200, the server is either dead or no connection to
pm mapper.

Responses
~~~~~~~~~

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

GET ``/reconfigure``
--------------------

Description
~~~~~~~~~~~
This is the reconfigure endpoint to fetch updated config information using
config binding service.

Responses
~~~~~~~~~

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