| Eric Debeau | 1af3053 | 2019-05-14 17:45:22 +0000 | [diff] [blame] | 1 | .. This work is licensed under a |
| 2 | Creative Commons Attribution 4.0 International License. |
| 3 | |
| rajendrajaiswal | fdd14ec | 2019-02-18 17:20:26 +0000 | [diff] [blame] | 4 | ======================== |
| 5 | 3GPP PM Mapper |
| 6 | ======================== |
| 7 | |
| 8 | .. contents:: |
| 9 | :depth: 3 |
| rajendrajaiswal | fdd14ec | 2019-02-18 17:20:26 +0000 | [diff] [blame] | 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 | |
| rajendrajaiswal | fdd14ec | 2019-02-18 17:20:26 +0000 | [diff] [blame] | 18 | Paths |
| 19 | ===== |
| 20 | |
| 21 | PUT ``/delivery`` |
| 22 | --------------------------------------------------- |
| 23 | |
| 24 | Description |
| 25 | ~~~~~~~~~~~ |
| 26 | Publish the PM Measurment file to PM Mapper. |
| 27 | |
| rajendrajaiswal | fdd14ec | 2019-02-18 17:20:26 +0000 | [diff] [blame] | 28 | Responses |
| 29 | ~~~~~~~~~ |
| 30 | |
| 31 | +-----------+---------------------+ |
| 32 | | HTTP Code | Description | |
| 33 | +===========+=====================+ |
| 34 | | **200** | successful response | |
| 35 | +-----------+---------------------+ |
| 36 | |
| rajendrajaiswal | fdd14ec | 2019-02-18 17:20:26 +0000 | [diff] [blame] | 37 | GET ``/healthcheck`` |
| 38 | -------------------- |
| 39 | |
| rajendrajaiswal | fdd14ec | 2019-02-18 17:20:26 +0000 | [diff] [blame] | 40 | Description |
| 41 | ~~~~~~~~~~~ |
| Eric Debeau | 1af3053 | 2019-05-14 17:45:22 +0000 | [diff] [blame] | 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. |
| rajendrajaiswal | 3a71509 | 2019-03-12 14:09:23 +0000 | [diff] [blame] | 45 | |
| 46 | Responses |
| 47 | ~~~~~~~~~ |
| 48 | |
| 49 | +-----------+---------------------+ |
| 50 | | HTTP Code | Description | |
| 51 | +===========+=====================+ |
| 52 | | **200** | successful response | |
| 53 | +-----------+---------------------+ |
| 54 | |
| rajendrajaiswal | 3a71509 | 2019-03-12 14:09:23 +0000 | [diff] [blame] | 55 | GET ``/reconfigure`` |
| 56 | -------------------- |
| 57 | |
| rajendrajaiswal | 3a71509 | 2019-03-12 14:09:23 +0000 | [diff] [blame] | 58 | Description |
| 59 | ~~~~~~~~~~~ |
| Eric Debeau | 1af3053 | 2019-05-14 17:45:22 +0000 | [diff] [blame] | 60 | This is the reconfigure endpoint to fetch updated config information using |
| 61 | config binding service. |
| rajendrajaiswal | fdd14ec | 2019-02-18 17:20:26 +0000 | [diff] [blame] | 62 | |
| 63 | Responses |
| 64 | ~~~~~~~~~ |
| 65 | |
| 66 | +-----------+---------------------+ |
| 67 | | HTTP Code | Description | |
| 68 | +===========+=====================+ |
| 69 | | **200** | successful response | |
| 70 | +-----------+---------------------+ |