{ "openapi":"3.0.1", "info":{ "title":"REST API for Oracle Session Delivery Management Cloud", "version":"2026.05.08", "description":"The Oracle Session Delivery Management Cloud (Oracle SDM Cloud) REST API documentation describes the supported REST endpoints and explains how to use the REST API interface. The REST API interface allows a northbound client application, such as a network service orchestrator (NSO), to interact with Oracle Session Delivery Management Cloud (Oracle SDM Cloud) and its supported Network Functions.", "x-summary":"The Oracle Session Delivery Management Cloud (Oracle SDM Cloud) REST API documentation describes the supported REST endpoints and explains how to use the REST API interface." }, "tags":[ { "name":"Network function APIs", "description":"The operations from the Network function APIs category." }, { "name":"User Management APIs", "description":"The operations from the User Management APIs category." }, { "name":"admin", "description":"administration APIs" }, { "name":"configuration/devices", "description":"device configuration APIs" }, { "name":"device configuration", "description":"Device configuration APIs" }, { "name":"inventory/device", "description":"device management APIs" }, { "name":"inventory/device-groups", "description":"Device group APIs." }, { "name":"inventory/sites", "description":"The operations from the inventory/sites category." }, { "name":"network function category", "description":"administration APIs" } ], "paths":{ "/rest/{versionId}/admin/permissions-cache":{ "delete":{ "tags":[ "admin" ], "summary":"Deletes user permissions cache", "description":"Use this (DELETE) method to delete user permissions cache on OSDMC server, ensuring recent permission changes are applied in subsequent requests. Note: The system also automatically clears the entire cache every hour.", "operationId":"logout", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Successfully processed the request with no content." }, "401":{ "description":"The request is not authorized." }, "404":{ "description":"The REST API version of your input request cannot be found." } }, "x-internal-id":"rest-{versionId}-admin-permissions-cache-delete", "x-filename-id":"rest-versionid-admin-permissions-cache-delete" } }, "/rest/{versionId}/security/audit-logs":{ "get":{ "tags":[ "User Management APIs" ], "summary":"Downloads Audit Logs", "description":"Use this (GET) Method to download the audit logs.", "operationId":"getAuditLogs", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Audit logs retrieved successfully.", "content":{ "text/csv":{ } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission." }, "404":{ "description":"The object (resource URI, IAM-info, etc) of your request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-security-audit-logs-get", "x-filename-id":"rest-versionid-security-audit-logs-get" } }, "/rest/{versionId}/inventory/device-mgmt/device-groups":{ "get":{ "tags":[ "inventory/device-groups" ], "summary":"Get Existing Device Groups", "description":"Use this (GET) method to retrieve all device groups created and maintained in Device Manager. Folder groups that are defined within Network Function (NF) device groups are not returned.", "operationId":"getHierarchicalGroups", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"parentGroupId", "in":"query", "schema":{ "type":"string" } }, { "name":"immediateChildren", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"All device groups retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GetDeviceGroupsResponse" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is not authorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-device-groups-get", "x-filename-id":"rest-versionid-inventory-device-mgmt-device-groups-get" }, "post":{ "tags":[ "inventory/device-groups" ], "summary":"Add a Device Group", "description":"Use this (POST) method to add a device group to Device Manager. A device group is a containment group that can contain other device groups or devices maintained in Network Functions (NFs).", "operationId":"createHierarchicalGroup", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CreateDeviceGroupRequest" } } } }, "responses":{ "201":{ "description":"Resource created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeviceGroupResponse" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is not authorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "409":{ "description":"The device group already exists." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-device-groups-post", "x-filename-id":"rest-versionid-inventory-device-mgmt-device-groups-post" } }, "/rest/{versionId}/inventory/device-mgmt/device-groups/{groupId}":{ "get":{ "tags":[ "inventory/device-groups" ], "summary":"Get Device Group Information", "description":"Use this (GET) method to retrieve information about a specific device group.", "operationId":"getHierarchicalGroup", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"groupId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Device group information retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeviceGroupResponse" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is not authorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-device-groups-{groupId}-get", "x-filename-id":"rest-versionid-inventory-device-mgmt-device-groups-groupid-get" }, "put":{ "tags":[ "inventory/device-groups" ], "summary":"Update a Device Group", "description":"This API can be used to rename a device group and/ormove a device group to another parent group within Device Manager.", "operationId":"updateHierarchicalGroup", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"groupId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UpdateDeviceGroupRequest" } } } }, "responses":{ "200":{ "description":"Successfully updated the device group.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeviceGroupResponse" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, device group, and so on) of your input request cannot be found." }, "409":{ "description":"Conflict. This occurs when renaming a device group to an existing name or moving it to its current parent group." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-device-groups-{groupId}-put", "x-filename-id":"rest-versionid-inventory-device-mgmt-device-groups-groupid-put" }, "delete":{ "tags":[ "inventory/device-groups" ], "summary":"Delete a Device Group", "description":"Use the (DELETE) method to delete device groups from Device Manager.", "operationId":"deleteHierarchicalGroup", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"groupId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Deleted successfully." }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, device group, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-device-groups-{groupId}-delete", "x-filename-id":"rest-versionid-inventory-device-mgmt-device-groups-groupid-delete" } }, "/rest/{versionId}/inventory/device-mgmt/devices/{deviceId}":{ "get":{ "tags":[ "inventory/device" ], "summary":"Get Device Information", "description":"Use this (GET) method to retrieve device credentials that where provided when the device was added for a targeted device as well as additional summary information as provided in Device Manager graphical user interface.", "operationId":"getDevice", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Device information retrieved successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestDevice" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-devices-{deviceId}-get", "x-filename-id":"rest-versionid-inventory-device-mgmt-devices-deviceid-get" } }, "/rest/{versionId}/inventory/device-mgmt/devices":{ "get":{ "tags":[ "inventory/device" ], "summary":"Get Device Management Summary Information", "description":"Use this (GET) method to retrieve the summary device information for all devices that the user has privileges to view in Device Manager. The user can filter the query request using the query parameters provided in the request.", "operationId":"getDevices", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"parentGroupId", "in":"query", "schema":{ "type":"string" } }, { "name":"immediateChildren", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Device management summary information retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestDeviceList" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-devices-get", "x-filename-id":"rest-versionid-inventory-device-mgmt-devices-get" } }, "/rest/{versionId}/inventory/device-mgmt/devices/{deviceId}/groups/{groupId}":{ "post":{ "tags":[ "inventory/device" ], "summary":"Overrides lock on device", "description":"Use this (POST) method to force unlock on the device. This method must be used once FSM operational lock is released, or overridden.", "operationId":"overrideLock", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"groupId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Successfully processed the request with no content." }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission." }, "404":{ "description":"The resource URI of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-devices-{deviceId}-groups-{groupId}-post", "x-filename-id":"rest-versionid-inventory-device-mgmt-devices-deviceid-groups-groupid-post" } }, "/rest/{versionId}/inventory/nf-mgmt/nf-categories":{ "get":{ "tags":[ "network function category" ], "summary":"Get NF Supported product Categories", "description":"Use this (GET) method to display the Network Function (NF) categories provided by your product plug-in.", "operationId":"getNfCategories", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieved NF Supported product Categories successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GetNfCategoriesResponse" } } } }, "401":{ "description":"The user is unauthorized." }, "404":{ "description":"The resource URI of your input request cannot be found" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nf-categories-get", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nf-categories-get" } }, "/rest/{versionId}/inventory/nf-mgmt/nf-categories/{nfCategoryId}":{ "get":{ "tags":[ "network function category" ], "summary":"Get a Targeted Category", "description":"Use this (GET) method to display the category for a Network Function (NF).", "operationId":"getNfCategory", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"nfCategoryId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieved targeted NF category successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestNfCategory" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "404":{ "description":"The resource URI of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nf-categories-{nfCategoryId}-get", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nf-categories-nfcategoryid-get" } }, "/rest/{versionId}/inventory/nf-mgmt/nf-categories/{nfCategoryId}/nf-types/{nfTypeName}":{ "get":{ "tags":[ "network function category" ], "summary":"Get Additional NF Metadata", "description":"Use this (GET) method to display Network Function (NF) type parameters. For example, an NF type can be a device or device cluster.", "operationId":"getNfConfigParameterInfoForNfType", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"nfCategoryId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"nfTypeName", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieved nf category metadata successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NfMetadataResponse" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "404":{ "description":"The resource URI of your input request cannot be found" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nf-categories-{nfCategoryId}-nf-types-{nfTypeName}-get", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nf-categories-nfcategoryid-nf-types-nftypename-get" } }, "/rest/{versionId}/inventory/nf-mgmt/nf-categories/{nfCategoryId}/nf-types":{ "get":{ "tags":[ "network function category" ], "summary":"Get Additional Category Metadata", "description":"Use this (GET) method to display the Network Function (NF) types for an NF category.", "operationId":"getNfTypes", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"nfCategoryId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieved nf types for an NF category successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GetNfTypesResponse" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "404":{ "description":"The resource URI of your input request cannot be found" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nf-categories-{nfCategoryId}-nf-types-get", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nf-categories-nfcategoryid-nf-types-get" } }, "/rest/{versionId}/inventory/nf-mgmt/nfs/action/{nfId}":{ "post":{ "tags":[ "Network function APIs" ], "summary":"Lock or unlock a Network Function", "description":"Use this (POST) method to lock or unlock all the devices within a network function", "operationId":"actionNetworkFunction", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"nfId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestNfAction" } } } }, "responses":{ "204":{ "description":"Action executed successfully." }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, network function, and so on) of your input request cannot be found." }, "409":{ "description":"The NF is already in same state as that of the targeted action." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nfs-action-{nfId}-post", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nfs-action-nfid-post" } }, "/rest/{versionId}/inventory/nf-mgmt/nfs":{ "get":{ "tags":[ "Network function APIs" ], "summary":"Get List of NFs in Device Management", "description":"Use this (GET) method to display existing Network Functions (NFs).", "operationId":"getNfs", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"parentGroupId", "in":"query", "schema":{ "type":"string" } }, { "name":"immediateChildren", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieved list of NFs successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GetNfsResponse" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The resource URI of your input request cannot be found" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nfs-get", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nfs-get" }, "post":{ "tags":[ "Network function APIs" ], "summary":"Add an NF", "description":"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 Session Delivery Manager Cloud plug-in is able to communicate with the devices in the NF.", "operationId":"addNf", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestNfParameterInfo" } } } }, "responses":{ "200":{ "description":"Added NF successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GetTargetedNfResponse" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission." }, "404":{ "description":"The resource URI of your input request cannot be found." }, "409":{ "description":"The NF is already added." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nfs-post", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nfs-post" } }, "/rest/{versionId}/inventory/nf-mgmt/nfs/{nfId}":{ "get":{ "tags":[ "Network function APIs" ], "summary":"Get a Targeted NF", "description":"Use this (GET) method to display a Network Function (NF).", "operationId":"getNf", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"nfId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieved NF details successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GetTargetedNfResponse" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, network function, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nfs-{nfId}-get", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nfs-nfid-get" }, "put":{ "tags":[ "Network function APIs" ], "summary":"Move an NF to Another Device Group Parent", "description":"Use this (PUT) method to move a Network Function (NF) to another group. You cannot move the NF if it is locked unless you are the owner of the lock or an administrator overrides the lock. An error message appears in both situations.", "operationId":"moveNf", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"nfId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestNfConfig" } } } }, "responses":{ "204":{ "description":"Moved NF successfully." }, "400":{ "description":"The user input is invalid (when user try to move locked device or when user try to move MCE)" }, "401":{ "description":"The user is unauthorized." }, "404":{ "description":"The resource URI of your input request cannot be found." }, "403":{ "description":"The user doesn't have the required permission." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nfs-{nfId}-put", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nfs-nfid-put" }, "delete":{ "tags":[ "Network function APIs" ], "summary":"Delete a Network Function", "description":"Use this (DELETE) method to delete a network function", "operationId":"deleteNetworkFunction", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"nfId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Deleted successfully." }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, network function, and so on) of your input request cannot be found." }, "409":{ "description":"The NF exists in locked state." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nfs-{nfId}-delete", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nfs-nfid-delete" } }, "/rest/{versionId}/inventory/nf-mgmt/nfs/{nfId}/groups/{groupId}":{ "put":{ "tags":[ "Network function APIs" ], "summary":"Updates the device group in a Network Function (NF)", "description":"Use this (PUT) method to edit the device group in a Network Function (NF), such as the user name, password used with the device, or SNMP parameters.", "operationId":"editNf", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"nfId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"groupId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestInputParameterList" } } } }, "responses":{ "200":{ "description":"Updated NF successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestDeviceGroup" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission." }, "404":{ "description":"The resource URI of your input request cannot be found." }, "409":{ "description":"No change in request parameter values." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nfs-{nfId}-groups-{groupId}-put", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nfs-nfid-groups-groupid-put" } }, "/rest/{versionId}/inventory/nf-mgmt/nfs/{nfId}/groups":{ "get":{ "tags":[ "Network function APIs" ], "summary":"Get NF Device Groups", "description":"Use this (GET) method to display existing device groups in a Network Function (NF).", "operationId":"getGroupsInNf", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"nfId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieved NFs Group based on NfId successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestDeviceGroupList" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-nf-mgmt-nfs-{nfId}-groups-get", "x-filename-id":"rest-versionid-inventory-nf-mgmt-nfs-nfid-groups-get" } }, "/rest/{versionId}/inventory/device-mgmt/sites":{ "get":{ "tags":[ "inventory/sites" ], "summary":"Retrieves all Sites", "description":"Use this (GET) method to retrieve the list of all sites. A site is used to group Network Functions (NFs) and devices based on their physical location.", "operationId":"getSites", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"All site retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SitesList" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The resource URI of your input request cannot be found" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-sites-get", "x-filename-id":"rest-versionid-inventory-device-mgmt-sites-get" }, "put":{ "tags":[ "inventory/sites" ], "summary":"Update Site details by Site Id", "description":"Use this (PUT) method to update the details of site by sites id ", "operationId":"updateSiteDetailsBySiteId", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UpdateSiteRequest" } } } }, "responses":{ "200":{ "description":"Updated site successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Sites" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The resource URI of your input request cannot be found" }, "409":{ "description":"The site with site desc already exists" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-sites-put", "x-filename-id":"rest-versionid-inventory-device-mgmt-sites-put" }, "post":{ "tags":[ "inventory/sites" ], "summary":"Adds a site", "description":"Use this (POST) method to add a site to Device Manager. A site is used to group Network Functions (NFs) and devices based on their physical location.", "operationId":"addSites", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AddSiteRequest" } } } }, "responses":{ "201":{ "description":"Site created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Sites" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The resource URI of your input request cannot be found" }, "409":{ "description":"The site with site name already exists" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-sites-post", "x-filename-id":"rest-versionid-inventory-device-mgmt-sites-post" } }, "/rest/{versionId}/inventory/device-mgmt/sites/{managingSiteId}/assign":{ "get":{ "tags":[ "inventory/sites" ], "summary":"Retrieve assigned Sites detail for a Managing Site.", "description":"Use this (GET) method to get assigned sites details for a managing site. A site is used to group Network Functions (NFs) and devices based on their physical location.", "operationId":"getAssignedSites", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"managingSiteId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieved assigned sites details successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestSiteAssignmentInfo" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The resource URI of your input request cannot be found" }, "409":{ "description":"No managed sites found for the given site Id" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-sites-{managingSiteId}-assign-get", "x-filename-id":"rest-versionid-inventory-device-mgmt-sites-managingsiteid-assign-get" }, "post":{ "tags":[ "inventory/sites" ], "summary":"Assign sites", "description":"Use this (POST) method to assign sites to managing site. A site is used to group Network Functions (NFs) and devices based on their physical location.", "operationId":"assignSites", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"managingSiteId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestSiteAssignmentRequest" } } } }, "responses":{ "200":{ "description":"Assigned sites successfully.", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/RestSiteAssignmentInfo" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The resource URI of your input request cannot be found" }, "409":{ "description":"The assign sites are already managed by managing site" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-sites-{managingSiteId}-assign-post", "x-filename-id":"rest-versionid-inventory-device-mgmt-sites-managingsiteid-assign-post" } }, "/rest/{versionId}/inventory/device-mgmt/sites/{siteId}":{ "delete":{ "tags":[ "inventory/sites" ], "summary":"Delete a Site", "description":"Use the (DELETE) method to delete a specific sitein Device Manager.", "operationId":"deleteSite", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"siteId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Deleted successfully." }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, site and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-sites-{siteId}-delete", "x-filename-id":"rest-versionid-inventory-device-mgmt-sites-siteid-delete" } }, "/rest/{versionId}/inventory/device-mgmt/sites/{siteName}":{ "get":{ "tags":[ "inventory/sites" ], "summary":"Retrieve Site details by Site name", "description":"Use this (GET) method to retrieve the details of site by sites name A site is used to group Network Functions (NFs) and devices based on their physical location.", "operationId":"getSiteDetailsBySiteName", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"siteName", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieve site details successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Sites" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The resource URI of your input request cannot be found" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-inventory-device-mgmt-sites-{siteName}-get", "x-filename-id":"rest-versionid-inventory-device-mgmt-sites-sitename-get" } }, "/rest/{versionId}/configuration/devices/{deviceId}/action":{ "post":{ "tags":[ "configuration/devices" ], "summary":"Update the Configuration on a Device", "description":"Use this (POST) method to push a device configuration stored on the OSDMC database to the device and ensure that it is properly activated and used as the running configuration for the device. Only SaveAndActivate action is supported.", "operationId":"actionOnDevice", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestDeviceAction" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestDeviceConfigActionResult" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-devices-{deviceId}-action-post", "x-filename-id":"rest-versionid-configuration-devices-deviceid-action-post" } }, "/rest/{versionId}/configuration/devices":{ "get":{ "tags":[ "configuration/devices" ], "summary":"Get a List of Devices Associated with Config Manager", "description":"Use this (GET) method to retrieve a list of device names that are currently being managed by Configuration Manager. A device can be added to Device Manager (refer to Add an NF), but does not show up in the managed list until it is assigned to Config Manager (refer to Associate a Device with a Configuration Service).", "operationId":"getManagedDevices", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"parentGroupId", "in":"query", "schema":{ "type":"string" } }, { "name":"immediateChildren", "in":"query", "schema":{ "type":"string" } }, { "name":"nfName", "in":"query", "schema":{ "type":"string" } }, { "name":"deviceName", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieve list of device from Config Manager successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestManagedDeviceList" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The resource URI of your input request cannot be found" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-devices-get", "x-filename-id":"rest-versionid-configuration-devices-get" }, "post":{ "tags":[ "configuration/devices" ], "summary":"Assign a Device to Element Manager for FCAPS Management", "description":"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.", "operationId":"associateDeviceToConfigMgr", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestDeviceAssociation" } } } }, "responses":{ "200":{ "description":"Assigned a device to config manager successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ManagedDeviceDetailResponse" } } } }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The resource URI of your input request cannot be found" }, "409":{ "description":"The device is already associated with configuration manager" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-devices-post", "x-filename-id":"rest-versionid-configuration-devices-post" } }, "/rest/{versionId}/configuration/devices/{deviceId}":{ "get":{ "tags":[ "configuration/devices" ], "summary":"Get Device Configuration Management Summary Information", "description":"Use this (GET) method to retrieve a summary of the targeted device information such as software version, platform, provisioning status, management IP address, if there are any configuration modifications pending, and so on.", "operationId":"getManagedDevice", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieved device configuration summary successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestManagedDevice" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have required permission" }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-devices-{deviceId}-get", "x-filename-id":"rest-versionid-configuration-devices-deviceid-get" }, "delete":{ "tags":[ "configuration/devices" ], "summary":"Unassign a Device from Element Manager to Stop FCAPS Management", "description":"Use this (DELETE) method to unassign a device from being managed by Session Element Manager. Device status and health statistics are stopped, device provisioning is disabled, and any alarms originating from a device are not processed by the fault management system.", "operationId":"disassociateDevice", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"removed device from config manager successfully." }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, device Id) of your input request cannot be found." }, "409":{ "description":"The device is not manageable. It cannot be associated/disassociated with configuration manager." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-devices-{deviceId}-delete", "x-filename-id":"rest-versionid-configuration-devices-deviceid-delete" } }, "/rest/{versionId}/configuration/devices/{deviceId}/load-config":{ "get":{ "tags":[ "configuration/devices" ], "summary":"Load a Configuration for a Targeted Device", "description":"Use this (GET) method to start a provisioning (configuration modification) session. This method ensures that the targeted device configuration in the OSDMC database is synchronized with the configuration on the device. A new targeted device must be provisioned before any work begins to prevent any configuration with a create, read, update, destroy (CRUD) operation from failing to load.", "operationId":"loadConfig", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Loaded the device successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestManagedDevice" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "409":{ "description":"The device is of ME Product Type. It cannot be loaded." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-devices-{deviceId}-load-config-get", "x-filename-id":"rest-versionid-configuration-devices-deviceid-load-config-get" } }, "/rest/{versionId}/configuration/device-configs/{deviceId}/config-elements/add":{ "post":{ "tags":[ "device configuration" ], "summary":"Add a Configuration Element", "description":"Use this (POST) method to add a configuration element to a targeted device configuration. The element is added to the SDM database and is not pushed to the device until a device action is initiated. Refer to the Perform a Device Action (POST) method for more information.", "operationId":"addConfigElement", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestConfigElement" } } } }, "responses":{ "200":{ "description":"Config instance for the given element type added successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestConfigElement" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The object (resource URI, config, and so on) of your input request cannot be found." }, "409":{ "description":"The object (resource, config, and so on) of your input request already exists." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-{deviceId}-config-elements-add-post", "x-filename-id":"rest-versionid-configuration-device-configs-deviceid-config-elements-add-post" } }, "/rest/{versionId}/configuration/device-configs/{deviceId}/config-elements/create":{ "post":{ "tags":[ "device configuration" ], "summary":"Create a Configuration Element", "description":"Use this (POST) method to create a configuration element object with default values. All configurations that a device supports are modeled as a Type-Of configuration element which has configuration attributes. For example, if a configuration element of the type NetworkInterface is requested, a configuration object is returned with default populated attributes that can be used to configure/add the network-interface element instance. Similarly, when a configuration element of type RealmConfig is requested, it returns a configuration object with default populated attributes that can be used to configure/add the realm-config element instance and so on. This is a convenience method that allows a user to ask the server to construct any type of configuration element that is based on the current model and release that the targeted device is running. The create method returns a configuration element object but does not persist this to the OSDMC database. The user can modify the configuration element, and then use the add API/method to add this object to the targeted device configuration. Refer to the Add an Element Type (POST) API for more information.", "operationId":"createConfigElementByType", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestElementTypeRequest" } } } }, "responses":{ "200":{ "description":"Config element for the given element type retrieved successfully, with default values.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestConfigElement" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The object (resource URI, config, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-{deviceId}-config-elements-create-post", "x-filename-id":"rest-versionid-configuration-device-configs-deviceid-config-elements-create-post" } }, "/rest/{versionId}/configuration/device-configs/{deviceId}/config-elements/delete":{ "post":{ "tags":[ "device configuration" ], "summary":"Delete a Configuration Element", "description":"Use this (POST) method to delete the complete targeted configuration element instance. If the configuration element instance has sub-element children, they are also deleted from the targeted device configuration. This deletion is only done on the SDMC database and is not pushed to the device. The deletion is not applied to the device until an action method is initiated. Refer to the Perform a Device Action (POST) method for more information.", "operationId":"deleteConfigElement", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestConfigElement" } } } }, "responses":{ "204":{ "description":"Successfully processed the request with no content." }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "409":{ "description":"Target configuration element must have one instance" }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-{deviceId}-config-elements-delete-post", "x-filename-id":"rest-versionid-configuration-device-configs-deviceid-config-elements-delete-post" } }, "/rest/{versionId}/configuration/device-configs/{deviceId}/configuration-changes":{ "get":{ "tags":[ "device configuration" ], "summary":"Get Pending Configuration Modifications", "description":"Use this (GET) method to retrieve all configuration modifications in the OSDMC database that the user made on a targeted device. All users are assigned their own configuration modification staging area to allow concurrent users to make modifications to their respective staging area so that they do not interfere with each other. No configuration modification is pushed to a device until the appropriate push action method is invoked. If this action completes successfully, the staging area is cleared and is ready for the next provisioning session. If a call made using this method after a successful push action, an empty set is returned because all modifications were applied to the device.", "operationId":"getUserChangedConfigElements", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Retrieved pending configuration modifications on a targeted device successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestChangedConfigElementList" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have required permission" }, "404":{ "description":"The resource object of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-{deviceId}-configuration-changes-get", "x-filename-id":"rest-versionid-configuration-device-configs-deviceid-configuration-changes-get" }, "delete":{ "tags":[ "device configuration" ], "summary":"Delete Pending Configuration Modifications", "description":"Use this (DELETE) method to remove all configuration modifications in the OSDMC database that the user made on a targeted device. All users are assigned their own configuration modification staging area. This allows concurrent users to make modifications to their own staging area and not interfere with each other. No configuration modification is pushed to a device until the appropriate push action method is invoked. This method allows a user to clear any modifications made during previous sessions that the user does not intend to push to the device and start with a clean staging area. If you initiate a push action to a device, the users current modification in the staging area is completed and cleared automatically and is ready for next provisioning session.", "operationId":"deleteUserChangedConfigElements", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Pending config element changes deleted successfully." }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object of your input request cannot be found." }, "409":{ "description":"Configuration of device loaded in this host is stale." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-{deviceId}-configuration-changes-delete", "x-filename-id":"rest-versionid-configuration-device-configs-deviceid-configuration-changes-delete" } }, "/rest/{versionId}/configuration/device-configs/util/encrypt-password":{ "post":{ "tags":[ "device configuration" ], "summary":"Update a Configuration Password", "description":"Use this (POST) method to provide specific configuration required passwords. Devices may require additional passwords for some configuration elements so they can be modified. Refer to the device product documentation for more information about these additional passwords.", "operationId":"encryptPassword", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestEncryptPasswordRequest" } } } }, "responses":{ "200":{ "description":"Ok.", "content":{ "application/json":{ "schema":{ "type":"string" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-util-encrypt-password-post", "x-filename-id":"rest-versionid-configuration-device-configs-util-encrypt-password-post" } }, "/rest/{versionId}/configuration/device-configs/{deviceId}/element-types/attribute-metadata":{ "post":{ "tags":[ "device configuration" ], "summary":"Get Additional Attribute Metadata", "description":"Use this (POST) method to retrieve additional meta-data information about a targeted attribute for a targeted configuration element. OSDMC configuration support is model driven to allow a user to query any attribute supported by a release, and get additional information on that attribute such as what type of summary it supports, the range of summaries, if it is a required attribute, if the attribute is part of a primary or foreign key relationship, and so on. A client can be configured use this metadata to describe the characteristics of all attributes supported by a device release.", "operationId":"getAttributeMetadata", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestAttrMetadataRequest" } } } }, "responses":{ "200":{ "description":"Retrieved attribute metadata for device configuration with deviceId successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestAttributeMetadata" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-{deviceId}-element-types-attribute-metadata-post", "x-filename-id":"rest-versionid-configuration-device-configs-deviceid-element-types-attribute-metadata-post" } }, "/rest/{versionId}/configuration/device-configs/{deviceId}/config-elements/retrieve":{ "post":{ "tags":[ "device configuration" ], "summary":"Get a Configuration Element Instance", "description":"Use this (POST) method to target and retrieve a specific configuration element instance to modify and submit them. Refer to the Update an Element method for more information about updating this element that you modified and submitted.", "operationId":"getConfigElement", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestConfigElement" } } } }, "responses":{ "200":{ "description":"Configuration of the element instance is retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestConfigElement" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "409":{ "description":"The device is of type MCE/ME . The Configuration instance of it cannot be listed/seen." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-{deviceId}-config-elements-retrieve-post", "x-filename-id":"rest-versionid-configuration-device-configs-deviceid-config-elements-retrieve-post" } }, "/rest/{versionId}/configuration/device-configs/{deviceId}/config-elements":{ "get":{ "tags":[ "device configuration" ], "summary":"Get a List of Configuration Element Instances", "description":"Use this (GET) method to retrieve a list of configuration element instances for a specific element type (refer to Get an Element by Its Type). For example, requesting configuration element instances for NetworkInterface returns all the network-interface instances currently existing in the targeted device configuration.", "operationId":"getConfigInstancesByType", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"elementTypePath", "in":"query", "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "schema":{ "type":"string" } }, { "name":"limitation", "in":"query", "schema":{ "type":"string" } }, { "name":"sort", "in":"query", "schema":{ "type":"string" } }, { "name":"ascending", "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"List of configuration element instances retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestConfigElementList" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "409":{ "description":"The Device is of ME Product type.The Configuration Element Instances cannot be listed/seen." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-{deviceId}-config-elements-get", "x-filename-id":"rest-versionid-configuration-device-configs-deviceid-config-elements-get" } }, "/rest/{versionId}/configuration/device-configs/{deviceId}/element-types/element-metadata":{ "post":{ "tags":[ "device configuration" ], "summary":"Get Additional Element Metadata", "description":"Use this (POST) method to retrieve additional meta-data information about a targeted configuration element. OSDMC configuration support is model driven to allow a user to query any attribute supported by a release, and get additional information such as if it contains additional sub-element children, what are its inter-dependencies between other elements, and so on. A client can be configured to use this metadata for self-describing the characteristics of all elements supported by a given device release to develop an understanding of configuration element dependencies and the flow for which elements need to configured first, second, and so on.", "operationId":"getElementMetadata", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestElementTypeRequest" } } } }, "responses":{ "200":{ "description":"Retrieved element metadata for device configuration with deviceId successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestElementMetadata" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-{deviceId}-element-types-element-metadata-post", "x-filename-id":"rest-versionid-configuration-device-configs-deviceid-element-types-element-metadata-post" } }, "/rest/{versionId}/configuration/device-configs/{deviceId}/element-types":{ "get":{ "tags":[ "device configuration" ], "summary":"Get a List of Top-level Configuration Element Types", "description":"Use this (GET) method to retrieve a list of top-level configuration element types that the targeted device release supports. A top-level element can contain several layers of sub-element children but has no parent configuration element. The top level element types can then be used to construct any configuration element that the targeted device release supports by invoking the Add an Element Type (POST) method.", "operationId":"getElementTypes", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestElementTypes" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user does not have permission for the attempted action." }, "404":{ "description":"The object (resource URI, device, and so on) of your input request cannot be found." }, "409":{ "description":"The Device is of ME Product type.The Top Level Config Elements Types cannot be listed/seen." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-{deviceId}-element-types-get", "x-filename-id":"rest-versionid-configuration-device-configs-deviceid-element-types-get" } }, "/rest/{versionId}/configuration/device-configs/{deviceId}/config-elements/update":{ "post":{ "tags":[ "device configuration" ], "summary":"Update a Configuration Element", "description":"Use this (POST) method to update all top-level element and sub-element configuration instances on the OSDMC database. Changes are made only to your staging area. No changes are pushed to the device until you use the Perform a Device Action (POST) method.", "operationId":"updateConfigElement", "parameters":[ { "name":"versionId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"deviceId", "in":"path", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestConfigElement" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/RestConfigElement" } } } }, "400":{ "description":"The user input is invalid." }, "401":{ "description":"The user is unauthorized." }, "403":{ "description":"The user doesn't have the required permission" }, "404":{ "description":"The object (resource URI, device, config, and so on) of your input request cannot be found." }, "409":{ "description":"The Device type (MCE, ME) cannot be updated." }, "500":{ "description":"An internal server error has occurred while processing the request." } }, "x-internal-id":"rest-{versionId}-configuration-device-configs-{deviceId}-config-elements-update-post", "x-filename-id":"rest-versionid-configuration-device-configs-deviceid-config-elements-update-post" } } }, "components":{ "schemas":{ "CreateDeviceGroupRequest":{ "type":"object", "properties":{ "name":{ "type":"string" }, "parentGroupFullName":{ "type":"string" } } }, "DeviceGroupResponse":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "fullName":{ "type":"string" }, "parentGroupId":{ "type":"string" }, "parentGroupFullName":{ "type":"string" } } }, "RestDeviceGroup":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "fullName":{ "type":"string" }, "type":{ "type":"string" }, "parentGroupId":{ "type":"string" }, "parentGroupFullName":{ "type":"string" }, "parameters":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestParameter" } } } }, "RestParameter":{ "type":"object", "properties":{ "name":{ "type":"string" }, "valueType":{ "type":"string", "readOnly":true }, "value":{ "type":"string" }, "valueList":{ "type":"array", "readOnly":true, "items":{ "type":"string", "readOnly":true } }, "validValues":{ "type":"array", "readOnly":true, "items":{ "type":"string", "readOnly":true } }, "label":{ "type":"string", "readOnly":true }, "description":{ "type":"string", "readOnly":true }, "minValue":{ "type":"integer", "format":"int64", "readOnly":true }, "maxValue":{ "type":"integer", "format":"int64", "readOnly":true }, "readOnly":{ "type":"boolean", "readOnly":true } } }, "GetDeviceGroupsResponse":{ "type":"object", "properties":{ "deviceGroups":{ "type":"array", "items":{ "$ref":"#/components/schemas/DeviceGroupResponse" } } } }, "UpdateDeviceGroupRequest":{ "type":"object", "properties":{ "name":{ "type":"string" }, "parentGroupFullName":{ "type":"string" } } }, "RestDevice":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "key":{ "type":"string" }, "ip":{ "type":"string" }, "parentGroupId":{ "type":"string" }, "nfId":{ "type":"string" }, "nfName":{ "type":"string" }, "siteId":{ "type":"string" }, "connectivityStatus":{ "type":"boolean" }, "bootstrapState":{ "type":"string" }, "softwareInfo":{ "$ref":"#/components/schemas/RestDeviceSoftwareInfo" }, "platformInfo":{ "$ref":"#/components/schemas/RestDevicePlatformInfo" }, "groupParameters":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestParameter" } }, "manageable":{ "type":"boolean" } } }, "RestDevicePlatformInfo":{ "type":"object", "properties":{ "platform":{ "type":"string" }, "timeZoneInfo":{ "type":"string" } }, "xml":{ "name":"platformInfo" } }, "RestDeviceSoftwareInfo":{ "type":"object", "properties":{ "version":{ "type":"string" }, "configVersion":{ "type":"string" } }, "xml":{ "name":"softwareInfo" } }, "RestDeviceList":{ "type":"object", "properties":{ "devices":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestManagedDeviceResponse" } } } }, "RestManagedDeviceResponse":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "key":{ "type":"string" }, "ip":{ "type":"string" }, "parentGroupId":{ "type":"string" }, "nfId":{ "type":"string" }, "nfName":{ "type":"string" }, "siteId":{ "type":"string" }, "connectivityStatus":{ "type":"boolean" }, "bootstrapState":{ "type":"string" }, "softwareInfo":{ "$ref":"#/components/schemas/RestDeviceSoftwareInfo" }, "platformInfo":{ "$ref":"#/components/schemas/RestDevicePlatformInfo" }, "manageable":{ "type":"boolean" } } }, "GetNfCategoriesResponse":{ "type":"object", "properties":{ "nfCategories":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestNfCategoryWithoutTypes" } } } }, "RestNfCategoryWithoutTypes":{ "type":"object", "properties":{ "name":{ "type":"string" }, "product":{ "type":"string" }, "vendor":{ "type":"string" } } }, "RestNfCategory":{ "type":"object", "properties":{ "name":{ "type":"string" }, "product":{ "type":"string" }, "vendor":{ "type":"string" }, "nfTypes":{ "type":"array", "readOnly":true, "items":{ "$ref":"#/components/schemas/RestNfType" } }, "id":{ "type":"string", "readOnly":true } } }, "RestNfType":{ "type":"object", "properties":{ "name":{ "type":"string" } } }, "NfMetadataResponse":{ "type":"object", "properties":{ "parentGroupFullName":{ "type":"string" }, "name":{ "type":"string" }, "nfCategory":{ "$ref":"#/components/schemas/RestNfCategoryWithoutTypes" }, "nfType":{ "$ref":"#/components/schemas/RestNfType" }, "parameters":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestParameter" } }, "associatedSiteName":{ "type":"string" } } }, "GetNfTypesResponse":{ "type":"object", "properties":{ "nfTypes":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestNfType" } } } }, "RestNfAction":{ "type":"object", "properties":{ "type":{ "type":"string" } } }, "GetTargetedNfChildResponse":{ "type":"object", "properties":{ "id":{ "type":"string" }, "ipAddress":{ "type":"string" }, "name":{ "type":"string" }, "parentGroupFullName":{ "type":"string" }, "parentGroupId":{ "type":"string" } } }, "GetTargetedNfResponse":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "parentGroupId":{ "type":"string" }, "parentGroupFullName":{ "type":"string" }, "groupType":{ "type":"string" }, "nfCategory":{ "$ref":"#/components/schemas/RestNfCategorySummary" }, "nfType":{ "$ref":"#/components/schemas/RestNfType" }, "children":{ "type":"array", "items":{ "$ref":"#/components/schemas/GetTargetedNfChildResponse" } } } }, "RestNfCategorySummary":{ "type":"object", "properties":{ "name":{ "type":"string" }, "product":{ "type":"string" }, "vendor":{ "type":"string" }, "id":{ "type":"string" } } }, "RestDeviceParameterInfo":{ "type":"object", "properties":{ "type":{ "type":"string" }, "parameters":{ "type":"array", "xml":{ "wrapped":true }, "items":{ "$ref":"#/components/schemas/RestParameter" } } }, "xml":{ "name":"deviceConfig" } }, "RestNfParameterInfo":{ "type":"object", "properties":{ "parentGroupId":{ "type":"string" }, "parentGroupFullName":{ "type":"string" }, "id":{ "type":"string", "readOnly":true }, "name":{ "type":"string" }, "nfCategory":{ "$ref":"#/components/schemas/RestNfCategory" }, "nfType":{ "$ref":"#/components/schemas/RestNfType" }, "numDevices":{ "type":"string", "readOnly":true }, "parameters":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestParameter" } }, "associatedSiteName":{ "type":"string" }, "addDeviceToConfigMgr":{ "type":"boolean" }, "nfcParameterInfos":{ "type":"array", "readOnly":true, "items":{ "$ref":"#/components/schemas/RestNfcParameterInfo" } } } }, "RestNfcParameterInfo":{ "type":"object", "properties":{ "componentType":{ "type":"string" }, "parameters":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestParameter" } }, "deviceParameterInfos":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestDeviceParameterInfo" } } }, "readOnly":true }, "RestInputParameterList":{ "type":"object", "properties":{ "parameters":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestParameter" } } } }, "RestDeviceGroupList":{ "type":"object", "properties":{ "deviceGroups":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestDeviceGroup" } } } }, "GetNfResponse":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "parentGroupId":{ "type":"string" }, "parentGroupFullName":{ "type":"string" }, "groupType":{ "type":"string" } } }, "GetNfsResponse":{ "type":"object", "properties":{ "nfList":{ "type":"array", "items":{ "$ref":"#/components/schemas/GetNfResponse" } } } }, "RestNfConfig":{ "type":"object", "properties":{ "parentGroupFullName":{ "type":"string" } } }, "AddSiteRequest":{ "type":"object", "properties":{ "siteName":{ "type":"string" }, "siteDescription":{ "type":"string" } } }, "Sites":{ "type":"object", "properties":{ "isMgmtEnabled":{ "type":"boolean" }, "noOfMCE":{ "type":"string" }, "noOfNetworkFunctions":{ "type":"string" }, "siteRegistrationId":{ "type":"string" }, "siteDescription":{ "type":"string" }, "siteId":{ "type":"string" }, "siteName":{ "type":"string" } } }, "RestSiteAssignmentInfo":{ "type":"object", "properties":{ "managingSite":{ "$ref":"#/components/schemas/Sites" }, "assignedSites":{ "type":"array", "items":{ "$ref":"#/components/schemas/Sites" } } } }, "RestSiteAssignmentRequest":{ "type":"object", "properties":{ "assignSiteIds":{ "type":"array", "items":{ "type":"string" } } } }, "SitesList":{ "type":"object", "properties":{ "sites":{ "type":"array", "items":{ "$ref":"#/components/schemas/Sites" } } } }, "UpdateSiteRequest":{ "type":"object", "properties":{ "siteDescription":{ "type":"string" }, "siteId":{ "type":"string" } } }, "RestDeviceConfigActionResult":{ "type":"object", "properties":{ "taskId":{ "type":"string" }, "action":{ "type":"string" }, "status":{ "type":"string" }, "errorMessage":{ "type":"string" }, "validationErrorMessage":{ "type":"string" }, "isValidationSuccess":{ "type":"string" }, "isDeviceFirmwareChangedFailure":{ "type":"string" }, "isLockSuccess":{ "type":"string" }, "isEraseCacheSuccess":{ "type":"string" }, "isCreateSuccess":{ "type":"string" }, "isIntegrityCheckSuccess":{ "type":"string" }, "isRestoreConfigSuccess":{ "type":"string" }, "isSaveConfigSuccess":{ "type":"string" }, "isActivateConfigSuccess":{ "type":"string" }, "isUnlockSuccess":{ "type":"string" } } }, "RestDeviceAction":{ "type":"object", "properties":{ "type":{ "type":"string" } }, "xml":{ "name":"deviceAction" } }, "ManagedDeviceDetailResponse":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "key":{ "type":"string" }, "ip":{ "type":"string" }, "parentGroupId":{ "type":"string" }, "nfId":{ "type":"string" }, "nfName":{ "type":"string" }, "siteId":{ "type":"string" }, "connectivityStatus":{ "type":"boolean" }, "manageable":{ "type":"boolean" }, "bootstrapState":{ "type":"string" }, "softwareInfo":{ "$ref":"#/components/schemas/RestDeviceSoftwareInfo" }, "platformInfo":{ "$ref":"#/components/schemas/RestDevicePlatformInfo" }, "pendingChanges":{ "type":"string" } } }, "RestDeviceAssociation":{ "type":"object", "properties":{ "nfName":{ "type":"string" }, "deviceName":{ "type":"string" } }, "xml":{ "name":"deviceAssociation" } }, "RestManagedDevice":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "key":{ "type":"string" }, "ip":{ "type":"string" }, "parentGroupId":{ "type":"string" }, "nfId":{ "type":"string" }, "nfName":{ "type":"string" }, "siteId":{ "type":"string" }, "connectivityStatus":{ "type":"boolean" }, "bootstrapState":{ "type":"string" }, "softwareInfo":{ "$ref":"#/components/schemas/RestDeviceSoftwareInfo" }, "platformInfo":{ "$ref":"#/components/schemas/RestDevicePlatformInfo" }, "lastOperation":{ "type":"string" }, "status":{ "type":"string" }, "statusChangeTime":{ "type":"string" }, "pendingChanges":{ "type":"string" }, "manageable":{ "type":"boolean" } } }, "RestManagedDeviceList":{ "type":"object", "properties":{ "devices":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestManagedDevice" } } } }, "RestConfigAttribute":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" } }, "xml":{ "name":"attribute" } }, "RestConfigElement":{ "type":"object", "properties":{ "elementTypePath":{ "type":"string" }, "parentElement":{ "$ref":"#/components/schemas/RestConfigElement" }, "attributes":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestConfigAttribute" } }, "childrenElements":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestConfigElement" } } } }, "RestElementTypeRequest":{ "type":"object", "properties":{ "elementTypePath":{ "type":"string" } }, "xml":{ "name":"elementTypeRequest" } }, "RestEncryptPasswordRequest":{ "type":"object", "properties":{ "configPassword":{ "type":"string" }, "inputPassword":{ "type":"string" } }, "xml":{ "name":"encryptPassword" } }, "RestAttributeMetadata":{ "type":"object", "properties":{ "name":{ "type":"string" }, "cliName":{ "type":"string" }, "valueType":{ "type":"string" }, "delimiter":{ "type":"string" }, "defaultValue":{ "type":"string" }, "referredElementType":{ "type":"string" }, "suggestedValues":{ "type":"array", "items":{ "type":"string" } }, "validNumericRange":{ "type":"array", "items":{ "type":"string" } }, "enumeratedValues":{ "type":"array", "items":{ "type":"string" } }, "regExpPattern":{ "type":"array", "items":{ "type":"string" } }, "referredValues":{ "type":"array", "items":{ "type":"string" } }, "key":{ "type":"boolean" }, "required":{ "type":"boolean" } } }, "RestAttrMetadataRequest":{ "type":"object", "properties":{ "elementTypePath":{ "type":"string" }, "attributeName":{ "type":"string" } }, "xml":{ "name":"attributeTypeRequest" } }, "PageInfo":{ "type":"object", "properties":{ "offset":{ "type":"integer", "format":"int32" }, "limitation":{ "type":"integer", "format":"int32" }, "numberOfElements":{ "type":"integer", "format":"int64" } } }, "RestConfigElementList":{ "type":"object", "properties":{ "pageInfo":{ "$ref":"#/components/schemas/PageInfo" }, "configElement":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestConfigElement" } } } }, "RestElementMetadata":{ "type":"object", "properties":{ "type":{ "type":"string" }, "elementTypePath":{ "type":"string" }, "subElements":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestSubElement" } }, "attributeMetadatas":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestAttributeMetadata" } }, "readOnly":{ "type":"boolean" }, "singleInstance":{ "type":"boolean" } } }, "RestSubElement":{ "type":"object", "properties":{ "required":{ "type":"boolean" }, "elementTypePath":{ "type":"string" } }, "xml":{ "name":"subElement" } }, "RestElementType":{ "type":"object", "properties":{ "cliName":{ "type":"string" }, "name":{ "type":"string" } } }, "RestElementTypes":{ "type":"object", "properties":{ "elementTypes":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestElementType" } } } }, "RestChangedConfigElement":{ "type":"object", "properties":{ "type":{ "type":"string" }, "name":{ "type":"string" }, "user":{ "type":"string" }, "operation":{ "type":"string" }, "timestamp":{ "type":"string" } } }, "RestChangedConfigElementList":{ "type":"object", "properties":{ "changedConfigElements":{ "type":"array", "items":{ "$ref":"#/components/schemas/RestChangedConfigElement" } } } } } }, "swagger":"2.0" }