Jump to

• Request
• Response
• Examples

Get a Targeted NF

get

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

Use this (GET) method to display a Network Function (NF).

Request

Path Parameters

• nfId: string
• versionId: string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root 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 retrieve the specified NF by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

<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/ID16

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Wed, 06 Sep 2017 20:08:15 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
Content-Length: 717
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"?>
<nf>
  <groups>
    <group>
      <id>ID5</id>
      <ipAddress>10.196.120.79</ipAddress>
      <name>sd79</name>
      <parentGroupFullName>HG1/NF2</parentGroupFullName>
      <parentGroupId>ID16</parentGroupId>
    </group>
    <group>
      <id>ID6</id>
      <ipAddress>10.196.120.78</ipAddress>
      <name>sd78</name>
      <parentGroupFullName>HG1/NF2</parentGroupFullName>
      <parentGroupId>ID16</parentGroupId>
    </group>
  </groups>
  <groupType>DEVICE</groupType>
  <hidden>false</hidden>
  <id>ID16</id>
  <name>NF2</name>
  <nfCategory>
    <id>ID2</id>
    <name>SD</name>
    <product>Session Delivery</product>
    <vendor>Oracle</vendor>
  </nfCategory>
  <nfType>
    <name>Device</name>
  </nfType>
  <parentGroupFullName>HG1</parentGroupFullName>
  <parentGroupId>ID3</parentGroupId>
</nf>

Back to Top