Jump to

• Request
• Response

Get NF Device Groups

get

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

Use this (GET) method to display existing device groups in a Network Function (NF).

Request

Path Parameters

• nfId: string
• 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 : deviceGroups

Type: object

Show Source

• deviceGroups(optional): array deviceGroup

{
    "properties":{
        "deviceGroups":{
            "items":{
                "$ref":"#/definitions/RestDeviceGroup",
                "xml":{
                    "name":"deviceGroup"
                }
            },
            "type":"array",
            "xml":{
                "name":"deviceGroup"
            }
        }
    },
    "type":"object",
    "xml":{
        "name":"deviceGroups"
    }
}

Nested Schema : deviceGroup

Type: array

Show Source

• Array of: object deviceGroup

{
    "items":{
        "$ref":"#/definitions/RestDeviceGroup",
        "xml":{
            "name":"deviceGroup"
        }
    },
    "type":"array",
    "xml":{
        "name":"deviceGroup"
    }
}

Nested Schema : deviceGroup

Type: object

Show Source

• fullName(optional): string
• id(optional): string
• isHidden(optional): string
• name(optional): string
• parameters(optional): array parameters
• parentGroupFullName(optional): string
• parentGroupId(optional): string
• type(optional): string

{
    "properties":{
        "fullName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "isHidden":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "parameters":{
            "items":{
                "$ref":"#/definitions/RestParameter",
                "xml":{
                    "name":"parameter"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "parentGroupFullName":{
            "type":"string"
        },
        "parentGroupId":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"deviceGroup"
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object parameter

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

Nested Schema : parameter

Type: object

Show Source

• description(optional): string
• label(optional): string
• maxValue(optional): integer(int64)
• minValue(optional): integer(int64)
• name(optional): string
• readOnly(optional): boolean
• validValues(optional): array validValues
• value(optional): string
• valueList(optional): array validLists
• valueType(optional): string

{
    "properties":{
        "description":{
            "type":"string"
        },
        "label":{
            "type":"string"
        },
        "maxValue":{
            "format":"int64",
            "type":"integer"
        },
        "minValue":{
            "format":"int64",
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "readOnly":{
            "type":"boolean"
        },
        "validValues":{
            "items":{
                "type":"string",
                "xml":{
                    "name":"validValue"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "value":{
            "type":"string"
        },
        "valueList":{
            "items":{
                "type":"string",
                "xml":{
                    "name":"valueList"
                }
            },
            "type":"array",
            "xml":{
                "name":"validLists",
                "wrapped":true
            }
        },
        "valueType":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"parameter"
    }
}

Nested Schema : validValues

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string",
        "xml":{
            "name":"validValue"
        }
    },
    "type":"array",
    "xml":{
        "wrapped":true
    }
}

Nested Schema : validLists

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string",
        "xml":{
            "name":"valueList"
        }
    },
    "type":"array",
    "xml":{
        "name":"validLists",
        "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