Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Deletes either all device types, or, when device types are specified in the Body, it deletes the specified device types. Before any device types are deleted, delete performs the following checks:
If device types are specified in the the body, delete checks whether any specified device types are being used by any device. If a specified device type is being used, then no device types are deleted, and an error is returned. The delete is only performed when none of the specified device types are being used by any device.
If no device types are specified in the the body, delete checks whether any device types are being used by any device. If any device type is being used, then no device types are deleted, and an error is returned. The delete is only performed when no device types are being used by any device.
Parameter
Include in request body a collection of Device Type IDs to be deleted.
Return Codes
204
Success.
422
Error. Includes an error message if any device types, or selected device types, are being used and cannot be deleted.
Success Response
Response code 200 in case of success or some error code otherwise.
Examples
https://localhost/iap/devTypes/delete
Request Body
[473]
Response
Response code 200
/iap/devTypes/export
Exports specified device types with all related resources. Device types are specified in the REST body.
export builds DTD files containing all information about the specified device types, and DTP archive containing DTD and all related resources (XIF, icon, application and system image files) if requested.
If packaged format is specified (in the query parameter), then one DTD file is built for all specified device types, all related resource files are found, packed with the DTD file into one DTP archive, and sent in response.
If packaged format is not specified (in the query parameter), then one DTD file is built for each specified device type, all related resource files are found, links to download all the DTD files, and resources are collected and sent in response.
Query Parameters
You can specify a query parameter appended to the end of your URI, preceded with a "?" character.
Parameter
Type
Description
packaged
Boolean
(Optional) Specifies export format.
Possible values: True/False.
Default is True.
Return Codes
200
Success.
Request Body Parameters
Include in request body a collection of Device Type IDs to be exported.
Success Response
Collection of device type resources that can be exported.
Exports all device types with all related resource files in a single DTP archive. This archive contains one DTD file containing all device types and all related resource files.
export builds DTD files containing all information about the specified device types, and DTP archive containing DTD and all related resources (XIF, icon, application and system image files) if requested.
If packaged format is specified (in the query parameter), then one DTD file is built for all specified device types, all related resource files are found, packed with the DTD file into one DTP archive, and sent in response.
If packaged format is not specified (in the query parameter), then one DTD file is built for each specified device type, all related resource files are found, links to download all the DTD files, and resources are collected and sent in response.
If no Device Type IDs specified, all DTDs and all related resource files will be packaged to resulting DTP file.
Parameters
Include in request body a collection of Device Type IDs to be exported.
Return Codes
200
Success.
Success Response
DTP package
Examples
Request Body
[125,126]
Response
DTP package with specified device types
/iap/metafile/{file_type}
Imports specific files to the CMS.
Path Parameters
The following list describes the possible values for file_type. file_type is optional.
Parameter
Description
app
Files to import are Neuron application image files (.apb, .ndl, .nxe).
icon
Files to import are device icon files.
sys
Files to import are Neuron system image files (.ndl, .nx).
File: 6kEvbMultiSensor.XIF generated by LONNCC32 Version 6.39.02, XIF Version 4.501 Copyright (c) Echelon Corporation 1989-2018 All Rights Reserved. Run on Fri Aug 24 18:36:06 2018 : : : NVVAL \x01 \x00 \x28 \x0D \xAC \x00 \x00 \x00 \x00 \x00 \x00 \x00 \x00 \x00 \x00 \x68 \x00 \x02 \x00 \x02 \xFF \xFE \x00 \x00 -----------------------------11130049656327408512700814640--
Return Codes
204
Success. This only means the request was correctly formatted. It doesn't mean that the payload is correct or that that the SmartServer can process the data.
415
Content-Type header needs to be multipart/form-data.
428
For zip files with multiple files, means that the zip file or included files may have been already downloaded.
You need to send another POST request with the confirmation Id, which is included in HTTP 428 response, to import this zip file