Jump to

• Request
• Response

Get NF Supported product Categories

get

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

Use this (GET) method to display the Network Function (NF) categories provided by your product plug-in.

Request

Path Parameters

• versionId: string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : nfCategories

Type: object

Show Source

• nfCategories(optional): array nfCategory

{
    "properties":{
        "nfCategories":{
            "items":{
                "$ref":"#/definitions/RestNfCategory",
                "xml":{
                    "name":"nfCategory"
                }
            },
            "type":"array",
            "xml":{
                "name":"nfCategory"
            }
        }
    },
    "type":"object",
    "xml":{
        "name":"nfCategories"
    }
}

Nested Schema : nfCategory

Type: array

Show Source

• Array of: object nfCategory

{
    "items":{
        "$ref":"#/definitions/RestNfCategory",
        "xml":{
            "name":"nfCategory"
        }
    },
    "type":"array",
    "xml":{
        "name":"nfCategory"
    }
}

Nested Schema : nfCategory

Type: object

Show Source

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

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

Nested Schema : nfTypes

Type: array

Show Source

• Array of: object nfType

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

Nested Schema : nfType

Type: object

Show Source

• name(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        }
    },
    "type":"object",
    "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