Jump to

• Request
• Response
• Examples

Get List of NFs in Device Management

get

/rest/{versionId}/inventory/nfMgmt/nfs

Use this (GET) method to display existing Network Functions (NFs).

Request

Path Parameters

• versionId: string

Query Parameters

• immediateChildren(optional): string
• parentGroupId(optional): string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : nfs

Type: object

Show Source

• nfList(optional): array nf

{
    "type":"object",
    "properties":{
        "nfList":{
            "type":"array",
            "xml":{
                "name":"nf"
            },
            "items":{
                "$ref":"#/definitions/RestNetworkFunction"
            }
        }
    },
    "xml":{
        "name":"nfs"
    }
}

Nested Schema : nf

Type: array

Show Source

• Array of: object nf

{
    "type":"array",
    "xml":{
        "name":"nf"
    },
    "items":{
        "$ref":"#/definitions/RestNetworkFunction"
    }
}

Nested Schema : nf

Type: object

Show Source

• children(optional): array group
• groupType(optional): string
• hidden(optional): string
• id(optional): string
• ipAddress(optional): string
• name(optional): string
• nfCategory(optional): object nfCategory
• nfType(optional): object nfType
• parentGroupFullName(optional): string
• parentGroupId(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "parentGroupId":{
            "type":"string"
        },
        "parentGroupFullName":{
            "type":"string"
        },
        "hidden":{
            "type":"string"
        },
        "groupType":{
            "type":"string"
        },
        "nfCategory":{
            "$ref":"#/definitions/RestNfCategory"
        },
        "nfType":{
            "$ref":"#/definitions/RestNfType"
        },
        "ipAddress":{
            "type":"string"
        },
        "children":{
            "type":"array",
            "xml":{
                "name":"group",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestNetworkFunction"
            }
        }
    },
    "xml":{
        "name":"nf"
    }
}

Nested Schema : group

Type: array

Show Source

• Array of: object nf

{
    "type":"array",
    "xml":{
        "name":"group",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/RestNetworkFunction"
    }
}

Nested Schema : nfCategory

Type: object

Show Source

• id(optional): string
• name(optional): string
• nfTypes(optional): array nfType
• product(optional): string
• vendor(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "product":{
            "type":"string"
        },
        "vendor":{
            "type":"string"
        },
        "nfTypes":{
            "type":"array",
            "xml":{
                "name":"nfType",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestNfType"
            }
        }
    },
    "xml":{
        "name":"nfCategory"
    }
}

Nested Schema : nfType

Type: object

Show Source

• name(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        }
    },
    "xml":{
        "name":"nfType"
    }
}

Nested Schema : nfType

Type: array

Show Source

• Array of: object nfType

{
    "type":"array",
    "xml":{
        "name":"nfType",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/RestNfType"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

Back to Top

Examples

The following example shows how to display the existing NFs by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

Example of cURL Data

The following shows an example of cURL data sent with the request.

curl -v -b sessionid.txt -X GET -H"Content-Type: application/xml" -H"Accept: application/xml" http://localhost:8080/rest/v1.1/inventory/nfMgmt/nfs

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Wed, 06 Sep 2017 19:52:54 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
Content-Length: 416
Vary: Accept-Encoding
Content-Type: application/xml

Example of Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<nfs>
  <nf>
    <groupType>NETWORKFUNCTION</groupType>
    <hidden>false</hidden>
    <id>ID7</id>
    <name>NF1</name>
    <parentGroupFullName>HG1/HG2</parentGroupFullName>
    <parentGroupId>ID4</parentGroupId>
  </nf>
  <nf>
    <groupType>DEVICE</groupType>
    <hidden>false</hidden>
    <id>ID16</id>
    <name>NF2</name>
    <parentGroupFullName>HG1</parentGroupFullName>
    <parentGroupId>ID3</parentGroupId>
  </nf>
</nfs>

Back to Top