Jump to

• Request
• Response

Add an NF

post

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

Use this (POST) method to add a Network Function (NF) with devices to a group that you created. Once the NF is added successfully, the Oracle Communications Session Element Manager plug-in is able to communicate with the devices in the NF.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• versionId: string

Body ()

Root Schema : nfConfig

Type: object

Show Source

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

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

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

Type: array

Show Source

• Array of: object nfcConfig

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

Nested Schema : nfType

Type: object

Show Source

• name(optional): string

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

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

Type: array

Show Source

• Array of: object nfType

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

Nested Schema : nfcConfig

Type: object

Show Source

• componentType(optional): string
• deviceParameterInfos(optional): array deviceConfigs
• parameters(optional): array parameters

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

Nested Schema : deviceConfigs

Type: array

Show Source

• Array of: object deviceConfig

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

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

Type: object

Show Source

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

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

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
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root 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