Update NSD information

Use this API to update NSD resource information. The PATCH method modifies the operational state or user-defined data of an individual NS descriptor resource.

The following elements of the request, example, and responses are described:

Request

Table 1. Request
Aspect Value
Endpoint URL /api/etsi/nsd/v2/ns_descriptors/<nsd-id>
HTTP Method PATCH

Request headers

Table 2. Request headers
Header Value
Content-Type application/json
Version 2.1.0

Request data

Table 3. Request data
Parameter Type Description Required
nsdoperationalState String To set the operational state of an onboarded NSD from one state to another.
Possible Values:
  • ENABLED
  • DISABLED
 No
userDefinedData object Key-Value map of user-defined values to either add new entries or update existing values. No

Request data example

{
             "nsdOperationalState": "DISABLED",
             "userDefinedData": {
             "key1": "value1",
             "key2": "value2"
        }
}

Response codes

Table 4. Response codes
HTTP status code Description
200 When the NSD Info was successfully updated.
400 The response body contains details about the error.
404 Displays when no NS descriptor for supplied ID is found.
409 Displayed when attempting to Disable an NSD package resource of which the operational state is not "ENABLED" or attempting to Enable an NSD package resource of which the operational state is not "DISABLED".
500 Internal Server Error
4xx/5xx In addition to the response codes defined in this table, any common error response codes.

Response headers

Table 5. Response headers
Header Description
Content-Type application/json

Response data

The response body contains details of the NSD package information modifications.

{
                  "nsdOperationalState": "DISABLED",
                  "userDefinedData": {
                       "key1": "value1",
                       "key2": "value2"
                  }
}