Jump to

• Request
• Response
• Examples

Get Additional NF Metadata

get

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

Use this (GET) method to display Network Function (NF) type parameters. For example, an NF type can be a device or device cluster.

Request

Path Parameters

• nfCategoryId: string
• nfTypeName: string
• versionId: string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : nfConfig

Type: object

Show Source

• id(optional): string
• name(optional): string
• nfCategory(optional): object nfCategory
• nfcParameterInfos(optional): array nfcConfig
• nfType(optional): object nfType
• numDevices(optional): string
• parameters(optional): array parameter
• parentGroupFullName(optional): string
• parentGroupId(optional): string

{
    "type":"object",
    "properties":{
        "parentGroupId":{
            "type":"string"
        },
        "parentGroupFullName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "nfCategory":{
            "$ref":"#/definitions/RestNfCategory"
        },
        "nfType":{
            "$ref":"#/definitions/RestNfType"
        },
        "numDevices":{
            "type":"string"
        },
        "parameters":{
            "type":"array",
            "xml":{
                "name":"parameter",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestParameter"
            }
        },
        "nfcParameterInfos":{
            "type":"array",
            "xml":{
                "name":"nfcConfig",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestNfcParameterInfo"
            }
        }
    },
    "xml":{
        "name":"nfConfig"
    }
}

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

Type: array

Show Source

• Array of: object nfcConfig

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

Nested Schema : nfType

Type: object

Show Source

• name(optional): string

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

Nested Schema : parameter

Type: array

Show Source

• Array of: object parameter

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

Nested Schema : nfType

Type: array

Show Source

• Array of: object nfType

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

Nested Schema : nfcConfig

Type: object

Show Source

• componentType(optional): string
• deviceParameterInfos(optional): array deviceConfig
• parameters(optional): array parameter

{
    "type":"object",
    "properties":{
        "componentType":{
            "type":"string"
        },
        "parameters":{
            "type":"array",
            "xml":{
                "name":"parameter",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestParameter"
            }
        },
        "deviceParameterInfos":{
            "type":"array",
            "xml":{
                "name":"deviceConfig",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestDeviceParameterInfo"
            }
        }
    },
    "xml":{
        "name":"nfcConfig"
    }
}

Nested Schema : deviceConfig

Type: array

Show Source

• Array of: object deviceConfig

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

Nested Schema : parameter

Type: array

Show Source

• Array of: object parameter

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

Nested Schema : deviceConfig

Type: object

Show Source

• parameters(optional): array parameter
• type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "parameters":{
            "type":"array",
            "xml":{
                "name":"parameter",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestParameter"
            }
        }
    },
    "xml":{
        "name":"deviceConfig"
    }
}

Nested Schema : parameter

Type: array

Show Source

• Array of: object parameter

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

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
  Default Value: false
• validValues(optional): array validValue
• value(optional): string
• valueList(optional): array validLists
• valueType(optional): string

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

Nested Schema : validValue

Type: array

Show Source

• Array of: string

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

Nested Schema : validLists

Type: array

Show Source

• Array of: string

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

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 NF configuration parameter information for the specified NF type 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/nfTypes/Device%20Cluster

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"?>
<nfConfig>
  <name/>
  <nfCategory>
    <name>SD</name>
    <product>Session Delivery</product>
    <vendor>Oracle</vendor>
  </nfCategory>
  <nfType>
    <name>Device Cluster</name>
  </nfType>
  <parameters>
    <parameter>
      <description>The description for this network function</description>
      <name>description</name>
      <readOnly>false</readOnly>
      <valueType>String</valueType>
    </parameter>
    <parameter>
      <description>The component type for devices in this device cluster</description>
      <name>sg.component.type</name>
      <readOnly>false</readOnly>
      <validValues>
        <validValue>SBC</validValue>
        <validValue>SR</validValue>
        <validValue>SLB</validValue>
        <validValue>CSM</validValue>
        <validValue>SLRM</validValue>
        <validValue>MSG</validValue>
      </validValues>
      <valueType>SingleSelection</valueType>
    </parameter>
    <parameter>
      <description>The name of the device cluster group</description>
      <name>sg.device.cluster.name</name>
      <readOnly>false</readOnly>
      <valueType>String</valueType>
    </parameter>
    <parameter>
      <description>The Redundancy Type for all devices belonging to this cluster</description>
      <name>sg.redundancy.type</name>
      <readOnly>false</readOnly>
      <validValues>
        <validValue>HA</validValue>
        <validValue>STANDALONE</validValue>
      </validValues>
      <valueType>SingleSelection</valueType>
    </parameter>
  </parameters>
  <parentGroupFullName/>
</nfConfig>

Back to Top