Jump to

• Request
• Response

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

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

Nested Schema : nf

Type: array

Show Source

• Array of: object nf

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

Nested Schema : nf

Type: object

Show Source

• children(optional): array groups
• 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

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

Nested Schema : groups

Type: array

Show Source

• Array of: object nf

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

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 : nfType

Type: object

Show Source

• name(optional): string

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

Nested Schema : nfTypes

Type: array

Show Source

• Array of: object nfType

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

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