Wind River. Intelligent Device Platform XT EMS Profile EMS DEVICE MANAGEMENT USER'S GUIDE WIND RIVER 1.0

Transcription

1 Wind River Intelligent Device Platform XT EMS Profile WIND RIVER EMS DEVICE MANAGEMENT USER'S GUIDE 1.0

2 Copyright Notice Copyright 2014 Wind River Systems, Inc. All rights reserved. No part of this publication may be reproduced or transmitted in any form or by any means without the prior written permission of Wind River Systems, Inc. Wind River, Tornado, and VxWorks are registered trademarks of Wind River Systems, Inc. The Wind River logo is a trademark of Wind River Systems, Inc. Any third-party trademarks referenced are the property of their respective owners. For further information regarding Wind River trademarks, please see: This product may include software licensed to Wind River by third parties. Relevant notices (if any) are provided in your product installation at one of the following locations: installdir/product_name/3rd_party_licensor_notice.pdf installdir/legal-notices/ Wind River may refer to third-party documentation by listing publications or providing links to third-party Web sites for informational purposes. Wind River accepts no responsibility for the information provided in such third-party documentation. Corporate Headquarters Wind River 500 Wind River Way Alameda, CA U.S.A. Toll free (U.S.A.): WIND Telephone: Facsimile: For additional contact information, see the Wind River Web site: For information on how to contact Customer Support, see: 09 Dec 2014

3 Contents 1 EMS Device Management Overview... 5 About EMS Device Management Mashery API Reference... 7 About Mashery APIs... 8 Alarm Object APIs... 9 Alarm Examples Asset Object APIs Asset Examples Asset Configuration Object APIs Asset Group Object APIs Asset Group Examples Audit Object APIs Custom Object APIs Custom Object Examples Custom Object Group Object APIs Data Item Object APIs Data Item Examples Deployment Object APIs Expression Rule Object APIs Expression Rule Examples Extended Application Object APIs Extended List Object APIs Extended Map Object APIs Extended UI Module Object APIs External Credential Object APIs File Info Object APIs File Upload Session Object APIs Location Object APIs Machine Stream Object APIs Model Object APIs Organization Object APIs Region Object APIs Remote Server Object APIs Remote Session Object APIs iii

4 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Self Service Object APIs Software Package Object APIs Transport Configuration Object APIs Unit Of Measure Object APIs User Object APIs User Group Object APIs User Privilege Object APIs User Settings APIs Web Resource Object APIs iv

5 1 EMS Device Management Overview About EMS Device Management 5 About EMS Device Management The Wind River Edge Management System enables you to remotely manage devices running the EMS agent. The EMS Server is the cloud side of the Edge Management System. It receives data from the EMS agent on the devices connected to the server. When a device connects to the EMS server, it appears as an asset. The EMS Console provides an administrative interface to the server. You can also create your own application using the Mashery APIs to customize the administration and management of assets, and to export data to back end systems for further processing. The EMS Server stores data only for the previous 90 days. To maintain data history, you should export the data at regular intervals. 5

6

7 2 Mashery API Reference About Mashery APIs 8 Alarm Object APIs 9 Asset Object APIs 12 Asset Configuration Object APIs 14 Asset Group Object APIs 16 Audit Object APIs 19 Custom Object APIs 20 Custom Object Group Object APIs 22 Data Item Object APIs 24 Deployment Object APIs 27 Expression Rule Object APIs 28 Extended Application Object APIs 31 Extended List Object APIs 33 Extended Map Object APIs 34 Extended UI Module Object APIs 36 External Credential Object APIs 37 File Info Object APIs 39 File Upload Session Object APIs 40 Location Object APIs 41 Machine Stream Object APIs 42 Model Object APIs 44 Organization Object APIs 45 Region Object APIs 46 7

8 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Remote Server Object APIs 48 Remote Session Object APIs 48 Self Service Object APIs 50 Software Package Object APIs 51 Transport Configuration Object APIs 52 Unit Of Measure Object APIs 53 User Object APIs 55 User Group Object APIs 56 User Privilege Object APIs 58 User Settings APIs 59 Web Resource Object APIs 60 About Mashery APIs Mashery APIs enable you to write custom applications using REST API calls over HTTP to manage devices that run the EMS agent. The Mashery APIs are grouped into objects, each with a set of methods. The objects are based on those provided by the Axeda Platform Web Services, v2. The APIs enable you to programmatically perform many of the functions that are available from the EMS Console. Mashery APIs are available only to manage assets that run the EMS agent. Each Mashery API call requires a Mashery API key that controls the endpoints the application can access. You receive the key when you receive your Mashery account. Each user application must provide a unique API key in the HTTP query string for each REST API call. To use the APIs in your programming environment, retrieve the WADL definitions from the following URL: You can use the REST API calls directly in JSON or XML format, or you can convert the file into Java classes to use in a Java programming environment. For more information, see the following documents: Axeda Agent Web Services Guide, Axeda v2 API/Services Developer's Reference, 6.8 To test the API services using I/O Docs, log in to the following website with your Mashery username and password: On the Home page, click See APIs in Action with I/O Docs. 8

9 2 Mashery API Reference Alarm Object APIs Alarm Object APIs Alarm object APIs enable you to create, read, and update alarms on an asset or group of assets. Alarms typically indicate an error condition in the software or hardware on an asset, such as the failure of a hardware component. The Mashery APIs enable you to specify the conditions that trigger an alarm, retrieve information about alarms on the system, and manage the alarm status. For more information about alarms and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: Alarms Axeda Platform Axeda v2 API/Services Developer s Reference: AlarmBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: AlarmBridge: REST Examples Counts the number of alarms based on criteria. Creates an alarm based on the alarm property values. Returns the state changes of an alarm. Finds an alarm based on the system identifier or alternate identifier. Finds alarms that match the specified search criteria. Finds alarms based on alarm identifiers in the request body. Returns a list of historical alarm values. rest/alarm/count rest/alarm rest/alarm/id/systemid/alarmstatechanges rest/alarm/id/identifier rest/alarm/find rest/alarm/findbyids rest/alarm/findinhistory 9

10 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Finds the first alarm that matches the specified criteria. Creates or updates an alarm. Sets the alarm state. properties of an existing alarm. Create one or more alarms. Creates or updates one or more alarms. properties of one or more alarms. rest/alarm/findone rest/alarm rest/alarm/setalarmstate?state=newalarmstate rest/alarm/id/systemid rest/alarm/bulk/create rest/alarm/bulk/save rest/alarm/bulk/update Related Links Alarm Examples on page 10 Alarm examples demonstrate selected methods in XML format. Alarm Examples Alarm examples demonstrate selected methods in XML format. The following examples show requests using the Linux curl command and show the request body in an XML file. create This example shows a request to create an alarm on an asset. The request body identifies the asset by the model and serial number id="default_testmodel default_testasset". $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X PUT \ " api_key=keyvalue" \ -d@alarm-create.xml \ tidy --show-warnings no -xml -i -q 10

11 2 Mashery API Reference Alarm Object APIs alarm-create.xml <?xml version="1.0" encoding="utf-8"?> <Alarm xmlns=" <name>testalarm_delete_me</name> <asset id="default_testmodel default_testasset"/> <severity>100</severity> </Alarm> findinhistory This example shows a request using the Linux curl command to find the historical value of all the alarms on the system, based on the wildcard in the request body. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ " api_key=keyvalue" \ -d@alarm-findinhistory.xml \ tidy --show-warnings no -xml -i -q alarm-findinhistory.xml <?xml version="1.0" encoding="utf-8"?> <HistoricalAlarmCriteria xmlns=" <name>*</name> </HistoricalAlarmCriteria> findone This example shows the request to find an alarm using the critiera asset model and serial number specified in the request body. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ " api_key=keyvalue" \ -d@alarm-findone.xml \ tidy --show-warnings no -xml -i -q alarm-findone.xml <?xml version="1.0" encoding="utf-8"?> <AlarmCriteria xmlns=" > <asset id="default_testmodel default_testasset"/> </AlarmCriteria> setalarmstate This example shows a request to set the state of the specified alarm to ACKNOWLEDGED. The request body specifies the alarm by model number, serial number, and alarm name using the id="default_testmodel default_testasset testalarm_delete_me". $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ " 11

12 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 state=acknowledged&?api_key=keyvalue" \ -d@alarm-setalarmstate.xml \ tidy --show-warnings no -xml -i -q alarm-setalarmstate.xml <?xml version="1.0" encoding="utf-8"?> <AlarmCollection xmlns=" <alarm xmlns:xsi=" xsi:type="alarm" id="default_testmodel default_testasset testalarm_delete_me"> </alarm> </AlarmCollection> Related Links Alarm Object APIs on page 9 Alarm object APIs enable you to create, read, and update alarms on an asset or group of assets. Asset Object APIs Asset object APIs enable you to create, read, update, and delete one or more assets. An asset is a piece of equipment that can be monitored and managed using either the Mashery APIs or the EMS console. When a device running the EMS agent starts, it automatically connects to the EMS server and an asset representing the device appears on the EMS Console. You can also create an asset using the Mashery APIs. For more information about assets and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference:Assets Axeda Platform Axeda v2 API/Services Developer s Reference:AssetBridge:Methods Axeda Platform Axeda v2 API/Services Developer s Reference:AssetBridge:REST Examples Counts the number of assets based on criteria. Creates an asset based on the asset property values. Deletes an asset. Finds an asset based on system identifier or alternate identifier. rest/asset/countassetsbycriteria rest/asset DELETE rest/asset/systemid rest/asset/id/identifier 12

13 2 Mashery API Reference Asset Object APIs Finds assets that match the specified search criteria. Finds assets based on asset identifiers in the request body. Returns the asset configuration. Finds the first asset that matches the specified criteria. Creates or updates an asset. Marks the specified asset as recently viewed. Returns a list of recently viewed assets. properties of an existing asset. Creates one or more assets. Deletes one or more assets. Creates or updates one or more assets. properties of one or more assets. rest/asset/find rest/asset/findbyids rest/asset/id/systemid/config rest/asset/findone rest/asset rest/asset/recentlyviewed/id/systemid rest/asset/recentlyviewed rest/asset/id/systemid rest/asset/bulk/create rest/asset/bulk/delete rest/asset/bulk/save rest/asset/bulk/update Related Links Asset Examples on page 14 13

14 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Alarm examples demonstrate selected methods in XML format. Asset Examples Alarm examples demonstrate selected methods in XML format. The following examples show requests using the Linux curl command and show the request body in an XML file. Find (by criteria) This example shows a request to find assets using a wild card for the serial number (the criteria) in the request body. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ " api_key=apikey" \ -d@asset-findbycriteria.xml \ tidy --show-warnings no -xml -i -q asset-findbycriteria.xml <?xml version="1.0" encoding="utf-8"?> <AssetCriteria xmlns=" <serialnumber>default*</serialnumber> </AssetCriteria> Related Links Asset Object APIs on page 12 Asset object APIs enable you to create, read, update, and delete one or more assets. Asset Configuration Object APIs Asset Configuration APIs enable you to create, read, update, and delete asset configurations. Asset configuration APIs enable you to create and update asset configuration information for one or more asset configurations, such as organization information. For more information about asset configuration configuration and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: Asset Configuration Axeda Platform Axeda v2 API/Services Developer s Reference: AssetConfiguration: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: AssetConfiguration: REST Examples bridgeassetconfigurationbridge.html 14

15 2 Mashery API Reference Asset Configuration Object APIs Creates an asset configuration based on the asset configuration property values. Deletes an asset configuration. Finds an asset configuration based on an identifier. Finds asset configurations that match the specified search criteria. Finds asset configurations based on asset configuration identifiers in the request body. Returns the asset configuration. Finds the first asset configuration that matches the specified criteria. Creates or updates an asset configuration. properties of an existing asset configuration. Creates one or more asset configurations. Deletes one or more asset configurations. Creates or updates one or more asset configurations. rest/assetconfiguration DELETE rest/assetconfiguration/systemid rest/assetconfiguration/identifier rest/assetconfiguration/find rest/assetconfiguration/findbyids rest/assetconfiguration/id/systemid/config rest/assetconfiguration/findone rest/assetconfiguration rest/assetconfiguration/id/systemid rest/assetconfiguration/bulk/create rest/assetconfiguration/bulk/delete rest/assetconfiguration/bulk/save 15

16 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 properties of one or more asset configurations. rest/assetconfiguration/bulk/update Asset Group Object APIs Asset Group APIs enable you to create, read, delete, and update asset groups. An asset group contains one or more associated assets. Asset groups can also contain one other asset group. Assets can belong to multiple asset groups. For more information about asset groups and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: AssetGroupBridge Axeda Platform Axeda v2 API/Services Developer s Reference: AssetGroupBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: AssetGroupBridge: REST Examples Adds an asset to a group. Creates an asset group based on the asset group property values. Deletes an asset group. Finds an asset group based on an identifier. Finds asset groups that match the specified search criteria. Finds asset groups based on asset group identifiers in the request body. rest/assetgroup/id/systemid/assets rest/assetgroup DELETE rest/assetgroup/systemid rest/assetgroup/identifier rest/assetgroup/find rest/assetgroup/findbyids 16

17 2 Mashery API Reference Asset Group Examples Finds the first asset group that matches the specified criteria. Creates or updates an asset group. Returns the child asset groups of the specified asset group. Removes an asset from an asset group. properties of an existing asset group. Creates one or more asset groups. Deletes one or more asset groups. Creates or updates one or more asset groups. properties of one or more asset groups. rest/assetgroup/findone rest/assetgroup rest/assetgroup/children?id=systemid DELETE rest/assetgroup/id/assetgroupsystemid/assets/id/assetsystemid rest/assetgroup/id/systemid rest/assetgroup/bulk/create rest/assetgroup/bulk/delete rest/assetgroup/bulk/save rest/assetgroup/bulk/update Related Links Asset Group Examples on page 17 Asset Group examples demonstrate selected methods in XML format. Asset Group Examples Asset Group examples demonstrate selected methods in XML format. The following examples show requests using the Linux curl command and show the request body in an XML file. addtogroup This example shows a request to add the asset with the model name default_testmodel and serial number default_testasset to an asset group that is specified by its system identifier. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ 17

18 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 -i -H "Accept: application/xml" \ -X PUT \ " assets?api_key=apikey" \ -d@assetgroup-addtogroup.xml \ tidy --show-warnings no -xml -i -q assetgroup-addtogroup.xml <Asset id="default_testmodel default_testasset" xmlns=" v2"> </Asset> create This example shows a request to create an asset group with the testassetgroup name. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X PUT \ " api_key=apikey" \ -d@assetgroup-create.xml > tmp cat tmp tidy --show-warnings no -xml -i -q cat tmp grep -m 1 -o "<v2:id>.*</v2:id>" assetgroup-create.xml v2:assetgroup xmlns:v2=" <v2:name>testassetgroup</v2:name> </v2:assetgroup> find (by criteria) This example shows a request to find asset groups using a wildcard for the serial number (the criteria) in the request body. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ " api_key=apikey" \ -d@assetgroup-findbycriteria.xml \ tidy --show-warnings no -xml -i -q assetgroup-findbycriteria.xml <?xml version="1.0" encoding="utf-8"?> <AssetGroupCriteria xmlns=" <serialnumber>default*</serialnumber> </AssetGroupCriteria> Related Links Asset Group Object APIs on page 16 18

19 2 Mashery API Reference Audit Object APIs Asset Group APIs enable you to create, read, delete, and update asset groups. Audit Object APIs The Audit APIs enable you to create and read entries in the EMS Server audit log. The audit log contains information about events that occur on the EMS Server. Audit APIs enable you to add and read entries in the log. They cannot be saved or deleted. For more information about audit entries and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: AuditBridge Axeda Platform Axeda v2 API/Services Developer s Reference: AuditBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: AuditBridge: REST Examples Creates an audit based on the audit property values. Finds an audit based on an identifier. Finds audits that match the specified search criteria. Finds audits based on audit identifiers in the request body. Finds the first audit that matches the specified criteria. Creates an audit. Creates one or more audits. Creates one or more audits. rest/audit rest/audit/id/systemid rest/audit/find rest/audit/findbyids rest/audit/findone rest/audit rest/audit/bulk/create rest/audit/bulk/save 19

20 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Custom Object APIs Custom object APIs enable you to create, read, update, and delete custom objects. Custom objects enable you to customize rules and actions on the EMS Server based on Groovy scripts or using the Scripto service. For more information about custom objects and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: CustomObjectBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: CustomObjectBridge: REST Examples CustomObjectBridge.html Verifies that a custom object compiles. Creates a custom object based on the custom object property values. Deletes a custom object. Finds a custom object based on an identifier. Finds custom objects that match the specified search criteria. Finds custom objects based on custom object identifiers in the request body. Returns the custom object with the specified system identifier. rest/customobject/compile rest/customobject DELETE rest/customobject/systemid rest/customobject/alternateid rest/customobject/find rest/customobject/findbyids rest/customobject/id/systemid 20

21 2 Mashery API Reference Custom Object Examples Finds the first custom object that matches the specified criteria. Creates or updates a custom object. properties of an existing custom object. Creates one or more custom objects. Deletes one or more custom objects. Creates or updates one or more custom objects. properties of one or more custom objects. rest/customobject/findone rest/customobject rest/customobject/id/systemid rest/customobject/bulk/create rest/customobject/bulk/delete rest/customobject/bulk/save rest/customobject/bulk/update Related Links Custom Object Examples on page 21 Custom Object examples demonstrate selected methods in XML format. Custom Object Examples Custom Object examples demonstrate selected methods in XML format. The following examples show requests using the Linux curl command and show the request body in an XML file. find (by criteria) This example shows a request to find custom objects using a wildcard for the name (the criteria) in the request body. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ " api_key=apikey" \ -d@customobject-findbycriteria.xml \ tidy --show-warnings no -xml -i -q 21

22 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 customobject-findbycriteria.xml <?xml version="1.0" encoding="utf-8"?> <CustomObjectCriteria xmlns=" <name>customobject*</name> </CustomObjectCriteria> save This example shows a request to save a custom object of language type Groovy script. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ " api_key=apikey" \ -d@customobject-save.xml \ tidy --show-warnings no -xml -i -q customobject-save.xml CustomObject xmlns=" <name>customobjectsave</name> <type>action</type> <params> <customobjectparam> <variablename>var </variablename> <displayname>displayname </displayname> </customobjectparam> <customobjectparam> <variablename>var </variablename> <displayname>displayname </displayname> </customobjectparam> </params> <description>description </description> <source>import com.axeda.*</source> <languagetype>groovy</languagetype> </CustomObject> Related Links Custom Object APIs on page 20 Custom object APIs enable you to create, read, update, and delete custom objects. Custom Object Group Object APIs Custom object group object APIs enable you to create, read, update, and delete custom object groups. A custom object group enables you to manage multiple custom objects as a group. For more information about custom object groups and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: CustomObjectGroupBridge Axeda Platform Axeda v2 API/Services Developer s Reference: CustomObjectGroupBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: CustomObjectGroupBridge: REST Examples CustomObjectGroupBridge.html 22

23 2 Mashery API Reference Custom Object Group Object APIs Creates a custom object group based on the custom object group property values. Deletes a custom object group. Finds a custom object group based on alternate identifier. Finds custom object groups that match the specified search criteria. Finds custom object groups based on identifiers in the request body. Returns the custom object group based on the specified system identifier. Finds the first custom object group that matches the specified criteria. Creates or updates a custom object group. properties of an existing custom object group. Creates one or more custom object groups. Deletes one or more custom object groups. rest/customobjectgroup DELETE rest/customobjectgroup/id/systemid rest/customobjectgroup/alternateid rest/customobjectgroup/find rest/customobjectgroup/findbyids rest/customobjectgroup/id/systemid rest/customobjectgroup/findone rest/customobjectgroup rest/customobjectgroup/id/systemid rest/customobjectgroup/bulk/create rest/customobjectgroup/bulk/delete 23

24 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Creates or updates one or more custom object groups. properties of one or more custom object groups. rest/customobjectgroup/bulk/save rest/customobjectgroup/bulk/update Data Item Object APIs Data item object APIs enable you to create, read, update, and delete data items on an asset or group of assets. Data items represent data sent between a device and the EMS server. Data items can be associated with an external data source, such as a sensor. The APIs operate on data items on the asset created using the Axeda Builder. For more information about data items and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: Data Items Axeda Platform Axeda v2 API/Services Developer s Reference: DataItemsBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: DataItemsBridge: REST Examples Creates a data item based on the data item property values. Deletes a data item. Finds a data item based on alternate identifier. Finds a data item based on system identifier. rest/dataitem DELETE rest/dataitem/id/systemid rest/dataitem/alternateid rest/dataitem/id/systemid 24

25 2 Mashery API Reference Data Item Object APIs Finds data items that match the specified search criteria. Finds data items based on data item identifiers in the request body. Returns the current data item values. Finds the first data item that matches the specified criteria. Creates or updates a data item. Returns the historical values of a data item. properties of an existing data item. Creates one or more data items. Deletes one or more data items. Creates or updates one or more data items. properties of one or more data items. rest/dataitem/find rest/dataitem/findbyids rest/dataitem/findcurrentvalues rest/dataitem/findone rest/dataitem rest/dataitem/findhistoricalvalues rest/dataitem/id/systemid rest/dataitem/bulk/create rest/dataitem/bulk/delete rest/dataitem/bulk/save rest/dataitem/bulk/update Related Links Data Item Examples on page 26 25

26 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Data Item examples demonstrate selected methods in XML format. Data Item Examples Data Item examples demonstrate selected methods in XML format. The following examples show requests using the Linux curl command and show the request body in an XML file. create This example shows a request to create a data item on an asset. The request body identifies the asset by the model id="windrivermodel". $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X PUT \ " api_key=apikey" \ -d@dataitem-create.xml \ tidy --show-warnings no -xml -i -q dataitem-create.xml <v2:dataitem xmlns:v2=" <v2:name>testdataitem_deleteme</v2:name> <ns85:model id="windrivermodel" xsi:type="ns85:modelreference" xmlns:ns85=" xmlns:xsi=" <v2:type>string</v2:type> </v2:dataitem> find (by identifier) This example shows a request to find a data item based on the system identifier specified in the REST call. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X GET \ " api_key=keyval" \ tidy --show-warnings no -xml -i -q findcurrentvalues This example shows a request to find current value of data items for the asset specified in the request body. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ " findcurrentvalues?api_key=apikey" \ -d@dataitem-findcurrentvalues.xml \ tidy --show-warnings no -xml -i -q 26

27 2 Mashery API Reference Deployment Object APIs dataitem-findcurrentvalues.xml <v2:currentdataitemvaluecriteria sortascending="true" sortpropertyname="name" xmlns:v2=" xmlns:xsi=" XMLSchema-instance"> <v2:assetid>42</v2:assetid> </v2:currentdataitemvaluecriteria> Related Links Data Item Object APIs on page 24 Data item object APIs enable you to create, read, update, and delete data items on an asset or group of assets. Deployment Object APIs Deployment object APIs enable you to create, read, update, and delete the objects that control software packages that are delivered to an EMS agent. Deployment objects control the deployment of software packages to an EMS agent running on an asset. Deployments must reference a software package. For more information about deployments and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: Files and Packages Axeda Platform Axeda v2 API/Services Developer s Reference: DeploymentBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: DeploymentBridge: REST Examples Cancels a deployment. Creates a deployment based on the deployment property values. Deletes a deployment. Finds deployments that match the specified search criteria. rest/deployment/id/systemid/cancel rest/deployment DELETE rest/deployment/id/systemid rest/deployment/find 27

28 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Finds deployments based on deployment identifiers in the request body. Returns a deployment with the specified system identifier. Finds the first deployment that matches the specified criteria. Redeploys a deployment. Creates or updates a deployment. properties of an existing deployment. Creates one or more deployments. Deletes one or more deployments. Creates or updates one or more deployments. properties of one or more deployments. rest/deployment/findbyids rest/deployment/id/systemid rest/deployment/findone rest/deployment/id/systemid/redeploy rest/deployment rest/deployment/id/systemid rest/deployment/bulk/create rest/deployment/bulk/delete rest/deployment/bulk/save rest/deployment/bulk/update Expression Rule Object APIs Expression rule object APIs enable you to create, read, update and delete expression rules. You use expression rules to evaluate a condition and take a specified action based on the value. The format of an expression rule is if-then-else. For more information about expression rules and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: Expression Rules 28

29 2 Mashery API Reference Expression Rule Object APIs Axeda Platform Axeda v2 API/Services Developer s Reference: ExpressionRuleBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: ExpressionRuleBridge: REST Examples ExpressionRuleBridge.html Creates an expression rule based on the expression rule property values. Deletes an expression rule. Finds an expression rule based on alternate identifier. Finds expression rules that match the specified search criteria. Finds expression rules based on expression rule identifiers in the request body. Returns the expression rule with the specified system identifier. Finds the first expression rule that matches the specified criteria. Creates or updates an expression rule. properties of an existing expression rule. rest/expressionrule DELETE rest/expressionrule/id/systemid rest/expressionrule/alternateid rest/expressionrule/find rest/expressionrule/findbyids rest/expressionrule/id/systemid rest/expressionrule/findone rest/expressionrule rest/expressionrule/id/systemid 29

30 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Validates the syntax of the expression rule. Creates one or more expression rules. Deletes one or more expression rules. Creates or updates one or more expression rules. properties of one or more expression rules. rest/expressionrule/validate rest/expressionrule/bulk/create rest/expressionrule/bulk/delete rest/expressionrule/bulk/save rest/expressionrule/bulk/update Related Links Expression Rule Examples on page 30 Expression Rule examples demonstrate selected methods in XML format. Expression Rule Examples Expression Rule examples demonstrate selected methods in XML format. The following examples show requests using the Linux curl command and show the request body in an XML file. create This example shows a request to create an expression rule with a DATA trigger. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X PUT \ " api_key=keyval" \ -d@expressionrule-create.xml \ tidy --show-warnings no -xml -i -q expressionrule-create.xml <?xml version="1.0" encoding="utf-8"?> <ExpressionRule xmlns=" <name>testexpressionrule</name> <type>data</type> <description>description</description> <ifexpression>true</ifexpression> <thenexpression>abs(1)</thenexpression> <elseexpression>now()</elseexpression> <consecutive>true</consecutive> <applytoall>false</applytoall> <enabled>false</enabled> 30

31 2 Mashery API Reference Extended Application Object APIs <standalone>true</standalone> </ExpressionRule> find (by criteria) This example shows a request to find an expression rule based on the rule name in the request body. $ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ " api_key=keyval" \ -d@expressionrule-findbycriteria.xml \ tidy --show-warnings no -xml -i -q expressionrule-findbycriteria.xml <?xml version="1.0" encoding="utf-8"?> <ExpressionRuleCriteria xmlns=" <name>testexpressionrule</name> </ExpressionRuleCriteria> Related Links Expression Rule Object APIs on page 28 Expression rule object APIs enable you to create, read, update and delete expression rules. Extended Application Object APIs Extended Applications APIs enable you to create, read, update and delete Rich Internet Application objects. Extended Applications are Rich Internet Applications (RIA) hosted on the EMS Server, and can be uploaded from the EMS Console. The contents can be displayed using extended UI modules. For more information about extended applications and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: ExtendedApplicationBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: ExtendedApplicationBridge: REST Examples Creates an extended application based on the extended application property values. rest/extendedapplication 31

32 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Deletes an extended application. Finds an extended application based on an alternate identifier. Finds extended applications that match the specified search criteria. Finds extended applications based on system identifiers in the request body. Returns the extended application based on the specified system identifier. Finds the first extended application that matches the specified criteria. Creates or updates an extended application. properties of an existing extended application. Creates one or more extended applications. Deletes one or more extended applications. Creates or updates one or more extended applications. properties of one or more extended applications. DELETE rest/extendedapplication/id/systemid rest/extendedapplication/alternateid rest/extendedapplication/find rest/extendedapplication/findbyids rest/extendedapplication/id/systemid rest/extendedapplication/findone rest/extendedapplication rest/extendedapplication/id/systemid rest/extendedapplication/bulk/create rest/extendedapplication/bulk/delete rest/extendedapplication/bulk/save rest/extendedapplication/bulk/update 32

33 2 Mashery API Reference Extended List Object APIs Extended List Object APIs Extended list object APIs enable you to create, read, update, and delete extended lists.. An extended list is an ordered list of up to 1000 unique string entries. For more information about extended lists and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: ExtendedListBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: ExtendedListBridge: REST Examples ExtendedListBridge.html Adds a value to an existing extended list. Creates an extended list based on the extended list property values. Deletes an extended list. Finds an extended list based on the alternate identifier, which is the same as the system identifier. Finds extended lists that match the specified search criteria. Finds extended lists based on extended list identifiers in the request body. PUT services/v1/rest/extendedlist/alternateid PUT services/v1/rest/extendedlist DELETE services/v1/rest/extendedlist/id/systemid GET services/v1/rest/extendedlist/systemid POST services/v1/rest/extendedlist/find POST services/v1/rest/extendedlist/findbyids 33

34 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Returns the extended list based on the specified system identifier. Finds the first extended list that matches the specified criteria. Removes a value from an extended list. Creates or updates an extended list. properties of an existing extended list. Creates one or more extended lists. Deletes one or more extended lists. Creates or updates one or more extended lists. properties of one or more extended lists. GET services/v1/rest/extendedlist/id/systemid POST services/v1/rest/extendedlist/findone DELETE services/v1/rest/extendedlist/id/systemid POST services/v1/rest/extendedlist POST services/v1/rest/extendedlist/id/systemid POST services/v1/rest/extendedlist/bulk/create POST services/v1/rest/extendedlist/bulk/delete POST services/v1/rest/extendedlist/bulk/save POST services/v1/rest/extendedlist/bulk/update Extended Map Object APIs Extended map object APIs enable you to create, read, update and delete extended maps. An extended map is an ordered list of up to 1000 unique string name-value pairs. For more information about extended maps and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: ExtendedMapBridge: Methods 34

35 2 Mashery API Reference Extended Map Object APIs Axeda Platform Axeda v2 API/Services Developer s Reference: ExtendedMapBridge: REST Examples ExtendedMapBridge.html Adds a value to an existing extended map. Creates an extended map based on the extended map property values. Deletes the contents of an extended map. Finds an extended map based on the alternate or system identifier, which are the same value. Finds extended maps that match the specified search criteria. Finds extended lists based on extended map identifiers in the request body. Finds the first extended map that matches the specified criteria. Creates one or more extended maps. Deletes the contents of one or more extended maps. Creates or updates one or more extended maps. rest/extendedmap/systemid/key rest/extendedmap DELETE rest/extendedmap/id/systemid rest/extendedmap/systemid rest/extendedmap/id/systemid rest/extendedmap/find rest/extendedmap/findbyids rest/extendedmap/findone rest/extendedmap/bulk/create rest/extendedmap/bulk/delete rest/extendedmap/bulk/save 35

36 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 properties of one or more extended maps. rest/extendedmap/bulk/update Extended UI Module Object APIs Extended UI Model object APIs enable you to create, read, update and delete extended UI modules. You use extended UI modules to create custom applications in the EMS Console using either custom objects or extended applications. For more information about Extended UI Modules and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: ExtendedUIModuleBridge Axeda Platform Axeda v2 API/Services Developer s Reference: ExtendedUIModuleBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: ExtendedUIModuleBridge: REST Examples ExtendedUIModuleBridge.html Creates an extended UI module based on the extended UI module property values. Deletes an extended UI module. Finds extended UI modules that match the specified search criteria. Finds extended UI modules based on extended UI module identifiers in the request body. rest/extendeduimodule DELETE rest/extendeduimodule/id/systemid rest/extendeduimodule/find rest/extendeduimodule/findbyids 36

37 2 Mashery API Reference External Credential Object APIs Returns the extended UI module based on the specified system identifier. Finds the first extended UI Module that matches the specified criteria. Creates or updates an extended UI module. properties of an existing extended UI Module. Creates one or more extended UI modules. Deletes one or more extended UI modules. Creates or updates one or more extended UI modules. properties of one or more extended UI modules. rest/extendeduimodule/id/systemid rest/extendeduimodule/findone rest/extendeduimodule rest/extendeduimodule/id/systemid rest/extendeduimodule/bulk/create rest/extendeduimodule/bulk/delete rest/extendeduimodule/bulk/save rest/extendeduimodule/bulk/update External Credential Object APIs External credential object APIs enable you to create, read, update and delete external credentials that determine access to the EMS Server. External credentials are name-value pairs, and can be applied to user groups. For more information about External Credentials and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: ExternalCredentialBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: ExternalCredentialBridge: REST Examples 37

38 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Creates an external credential based on the external credential property values. Deletes an external credential. Finds external credentials that match the specified search criteria. Finds external credentials based on external credential identifiers in the request body. Returns the external credential based on system identifier. Finds the first external credential that matches the specified criteria. Creates or updates an external credential. properties of an existing external credential. Creates one or more external credentials. Deletes one or more external credentials. Creates or updates one or more external credentials. rest/externalcredential DELETE rest/externalcredential/id/systemid rest/externalcredential/find rest/externalcredential/findbyids rest/externalcredential/id/systemid rest/externalcredential/findone rest/externalcredential rest/externalcredential/id/systemid rest/externalcredential/bulk/create rest/externalcredential/bulk/delete rest/externalcredential/bulk/save 38

39 2 Mashery API Reference File Info Object APIs properties of one or more external credentials. rest/externalcredential/bulk/update File Info Object APIs File info object APIs enable you to create, read, update and delete information about a file. File info objects contain information about a specific file. All files uploaded to the EMS server must have an associated file info object. For more information about file info and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: Files and Packages Axeda Platform Axeda v2 API/Services Developer s Reference: FileInfoBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: FileInfoBridge: REST Examples Creates a file info based on the file info property values. Deletes a file info. Finds file infos that match the specified search criteria. Retrieves file contents as a stream of bytes Returns the file upload progress. Lists the file info by criteria. Creates or updates a file info. rest/file DELETE rest/file/systemid rest/file/find rest/file/systemid/download rest/file/systemid/progress rest/file/list rest/file/save 39

40 Wind River Intelligent Device Platform XT EMS Profile Wind River EMS Device Management User's Guide, 1.0 Creates or updates a file info and uploads its contents to the EMS Server. properties of a file info. Uploads file contents. rest/file rest/file/systemid rest/file/systemid/content File Upload Session Object APIs File upload session object APIs enable you to create and read file uploads sessions to manage file uploads. File sessions are used to manage file uploads, which must be associated with a file upload sessions. You cannot delete or updated a file upload session. For more information about file upload sessions and the available APIs, see the following: Axeda Platform Axeda v2 API/Services Developer s Reference: Files and Packages Axeda Platform Axeda v2 API/Services Developer s Reference: FileUploadSessionBridge: Methods Axeda Platform Axeda v2 API/Services Developer s Reference: FileUploadSessionBridge: REST Examples FileUploadSessionBridge.html Creates a file upload session based on the file upload session property values. Finds a file upload session based on the system identifier. Finds file upload sessions that match the specified search criteria. rest/file/session rest/file/session/systemid rest/file/session/list 40