Jump to

• Request
• Response

Assign a Device to Element Manager for FCAPS Management

post

/rest/{versionId}/configuration/devices

Use this (POST) method to assign a device to be managed by Session Element Manager. Once a device is assigned, Session Element Manager starts managing the device by periodically polling for health statistics and processing alarms sent from the device. To provision the device configuration, the device must be assigned to Session Element Manager.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• versionId: string

Body ()

Root Schema : deviceAssociation

Type: object

Show Source

• deviceName(optional): string
• nfName(optional): string

{
    "properties":{
        "deviceName":{
            "type":"string"
        },
        "nfName":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"deviceAssociation"
    }
}

Back to Top

Response

200 Response

successful operation

Body ()

Root Schema : device

Type: object

Show Source

• bootstrapState(optional): string
• connectivityStatus(optional): boolean
• description(optional): string
• groupParameters(optional): array groupParameters
• id(optional): string
• ip(optional): string
• key(optional): string
• lastOperation(optional): string
• loadedConfigVersion(optional): string
• manageable(optional): boolean
• name(optional): string
• nfId(optional): string
• nfName(optional): string
• parameters(optional): array parameters
  parameters
• parentGroupId(optional): string
• pendingChanges(optional): string
• platformInfo(optional): object platformInfo
• softwareInfo(optional): object softwareInfo
• status(optional): string
• statusChangeTime(optional): string

{
    "properties":{
        "bootstrapState":{
            "type":"string"
        },
        "connectivityStatus":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        },
        "groupParameters":{
            "items":{
                "$ref":"#/definitions/RestParameter",
                "xml":{
                    "name":"groupParameter"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "id":{
            "type":"string"
        },
        "ip":{
            "type":"string"
        },
        "key":{
            "type":"string"
        },
        "lastOperation":{
            "type":"string"
        },
        "loadedConfigVersion":{
            "type":"string"
        },
        "manageable":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "nfId":{
            "type":"string"
        },
        "nfName":{
            "type":"string"
        },
        "parameters":{
            "description":"parameters",
            "items":{
                "$ref":"#/definitions/RestParameter",
                "xml":{
                    "name":"parameter"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "parentGroupId":{
            "type":"string"
        },
        "pendingChanges":{
            "type":"string"
        },
        "platformInfo":{
            "$ref":"#/definitions/RestDevicePlatformInfo"
        },
        "softwareInfo":{
            "$ref":"#/definitions/RestDeviceSoftwareInfo"
        },
        "status":{
            "type":"string"
        },
        "statusChangeTime":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"device"
    }
}

Nested Schema : groupParameters

Type: array

Show Source

• Array of: object parameter

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

Nested Schema : parameters

Type: array

parameters

Show Source

• Array of: object parameter

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

Nested Schema : platformInfo

Type: object

Show Source

• platform(optional): string
• serialNumber(optional): string
• timeZoneInfo(optional): object timeZoneInfo

{
    "properties":{
        "platform":{
            "type":"string"
        },
        "serialNumber":{
            "type":"string"
        },
        "timeZoneInfo":{
            "$ref":"#/definitions/RestDeviceTimeZoneInfo"
        }
    },
    "type":"object",
    "xml":{
        "name":"platformInfo"
    }
}

Nested Schema : softwareInfo

Type: object

Show Source

• configVersion(optional): string
• version(optional): string

{
    "properties":{
        "configVersion":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"softwareInfo"
    }
}

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

Nested Schema : timeZoneInfo

Type: object

Show Source

• daySaveTimeEnd(optional): string
• daySaveTimeStart(optional): string
• minFromUTC(optional): string

{
    "properties":{
        "daySaveTimeEnd":{
            "type":"string"
        },
        "daySaveTimeStart":{
            "type":"string"
        },
        "minFromUTC":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"timeZoneInfo"
    }
}

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