List NS descriptors

Use this API to query and list information for all available NS descriptors in the system. The GET method lists all NSDs.

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
HTTP Method GET

Request headers

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

Request data

None

Request data example

None

Response codes

Table 3. Response codes
HTTP status code Description
200 Returned when the list of NS descriptors was successfully retrieved (or is an empty list, if none are available).
400 The response body contains details about the error.
500 Internal Server Error
4xx/5xx In addition to the response codes defined in this table, any common error response codes.

Response headers

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

Response data

The response body contains an array with details of all NSD package information that is stored or an empty array, if there are none.

[
   {
        "id": "assembly::ns-test::1.0",
        "nsdName": "TBC",
        "nsdVersion": "1.0",
        "nsdDesigner": "IBM",
        "nsdInvariantId": "TBC",
        "artifacts": [
              {
              "artifactPath": "Files/Tests/Runtime Scenarios/Test2.json",
              "checksum": {
              "algorithm": "SHA-256",
              "hash":
       "56945701c081a844e156115d913012d5832ca9cb1cb1938e92db9a55a16ec0e4" 
             }
       } , 
       ...{ <output truncated for brevity>}...
	],
       "nsdOnboardingState": "ONBOARDED",
       "nsdOperationalState": "ENABLED",
       "nsdUsageState": "IN_USE",
       "userDefinedData": {
            "tnco-package-id": "assembly::ns-test::1.0"
       },
       "_links": {
       "self": {
            "href":
       "https://<ishtar_route>/api/etsi/nsd/v2/ns_descriptors/assembly::
       ns-test::1.0"
       },
       "nsd_content": {
           "href":
       "https://<ishtar_route>/api/etsi/nsd/v2/ns_descriptors/assembly::
       ns-test::1.0/nsd_content"
            }
       }
}
]