Jump to

• Request
• Response
• Examples

Get a Targeted Category

get

/rest/{versionId}/inventory/nfMgmt/nfCategories/{nfCategoryId}

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

Request

Path Parameters

• nfCategoryId: string
• versionId: string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root 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: array

Show Source

• Array of: object nfType

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

Nested Schema : nfType

Type: object

Show Source

• name(optional): string

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

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 product category 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/nfCategories/ID6

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"?>
<nfCategory>
  <id>ID6</id>
  <name>SD</name>
  <nfTypes>
    <nfType>
      <name>Device</name>
    </nfType>
    <nfType>
      <name>Device Cluster</name>
    </nfType>
  </nfTypes>
  <product>Session Delivery</product>
  <vendor>Oracle</vendor>
</nfCategory>

Back to Top