docs/cps-ncmp-message-status-codes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2023-2024 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _dataOperationMessageStatusCodes:
   7
   8
   9 CPS-NCMP Message Status Codes
  10 #############################
  11
  12     +-----------------+------------------------------------------------------+-----------------------------------+
  13     | Status Code     | Status Message                                       | Feature(s)                        |
  14     +=================+======================================================+===================================+
  15     | 0               | Successfully applied changes                         | Data Operation                    |
  16     +-----------------+------------------------------------------------------+-----------------------------------+
  17     | 1               | successfully applied subscription                    | CM Data Notification Subscription |
  18     +-----------------+------------------------------------------------------+-----------------------------------+
  19     | 100             | cm handle id(s) is(are) not found                    | Data Operation, Inventory         |
  20     +-----------------+------------------------------------------------------+-----------------------------------+
  21     | 101             | cm handle(s) not ready                               | Data Operation                    |
  22     +-----------------+------------------------------------------------------+-----------------------------------+
  23     | 102             | dmi plugin service is not responding                 | Data Operation                    |
  24     +-----------------+------------------------------------------------------+-----------------------------------+
  25     | 103             | dmi plugin service is not able to read resource data | Data Operation                    |
  26     +-----------------+------------------------------------------------------+-----------------------------------+
  27     | 104             | partially applied subscription                       | CM Data Notification Subscription |
  28     +-----------------+------------------------------------------------------+-----------------------------------+
  29     | 105             | subscription not applicable for all cm handles       | CM Data Notification Subscription |
  30     +-----------------+------------------------------------------------------+-----------------------------------+
  31     | 106             | subscription pending for all cm handles              | CM Data Notification Subscription |
  32     +-----------------+------------------------------------------------------+-----------------------------------+
  33     | 107             | southbound system is busy                            | Data Operation                    |
  34     +-----------------+------------------------------------------------------+-----------------------------------+
  35     | 108             | Unknown error                                        | Inventory                         |
  36     +-----------------+------------------------------------------------------+-----------------------------------+
  37     | 109             | cm-handle already exists                             | Inventory                         |
  38     +-----------------+------------------------------------------------------+-----------------------------------+
  39     | 110             | cm-handle has an invalid character(s) in id          | Inventory                         |
  40     +-----------------+------------------------------------------------------+-----------------------------------+
  41     | 111             | alternate id already associated                      | Inventory                         |
  42     +-----------------+------------------------------------------------------+-----------------------------------+
  43
  44 .. note::
  45
  46     - Single response format for all scenarios both positive and error, just using optional fields instead.
  47     - status-code 0-99 is reserved for any success response.
  48     - status-code from 100 to 199 is reserved for any failed response.
  49
  50
  51