Wind River Intelligent Device Platform XT EMS Profile · Mashery APIs enable you to write custom...
Transcript of Wind River Intelligent Device Platform XT EMS Profile · Mashery APIs enable you to write custom...
Wind River® Intelligent Device Platform XTEMS Profile
WIND RIVER® EMS DEVICE MANAGEMENT USER'S GUIDE
1.0
Copyright Notice
Copyright © 2014 Wind River Systems, Inc.
All rights reserved. No part of this publication may be reproduced or transmitted in any form orby 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. TheWind River logo is a trademark of Wind River Systems, Inc. Any third-party trademarksreferenced are the property of their respective owners. For further information regarding WindRiver trademarks, please see:
www.windriver.com/company/terms/trademark.html
This product may include software licensed to Wind River by third parties. Relevant notices (ifany) are provided in your product installation at one of the following locations:
installDir/product_name/3rd_party_licensor_notice.pdfinstallDir/legal-notices/
Wind River may refer to third-party documentation by listing publications or providing links tothird-party Web sites for informational purposes. Wind River accepts no responsibility for theinformation provided in such third-party documentation.
Corporate Headquarters
Wind River500 Wind River WayAlameda, CA 94501-1153U.S.A.Toll free (U.S.A.): 800-545-WINDTelephone: 510-748-4100Facsimile: 510-749-2010
For additional contact information, see the Wind River Web site:
www.windriver.com
For information on how to contact Customer Support, see:
www.windriver.com/support
09 Dec 2014
Contents
1 EMS Device Management Overview ...................................................................... 5About EMS Device Management ....................................................................................... 5
2 Mashery API Reference .......................................................................................... 7About Mashery APIs ........................................................................................................... 8
Alarm Object APIs .............................................................................................................. 9
Alarm Examples .................................................................................................. 10
Asset Object APIs .............................................................................................................. 12
Asset Examples .................................................................................................. 14
Asset Configuration Object APIs ........................................................................................ 14
Asset Group Object APIs ................................................................................................... 16
Asset Group Examples ........................................................................................ 17
Audit Object APIs ............................................................................................................... 19
Custom Object APIs ........................................................................................................... 20
Custom Object Examples .................................................................................... 21
Custom Object Group Object APIs ..................................................................................... 22
Data Item Object APIs ........................................................................................................ 24
Data Item Examples ............................................................................................ 26
Deployment Object APIs .................................................................................................... 27
Expression Rule Object APIs ............................................................................................. 28
Expression Rule Examples ................................................................................. 30
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
Remote Server Object APIs ............................................................................................... 48
Remote Session Object APIs ............................................................................................. 48
iii
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
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
iv
1EMS 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 theEMS agent. The EMS Server is the cloud side of the Edge Management System. It receives datafrom 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 anadministrative interface to the server. You can also create your own application using theMashery APIs to customize the administration and management of assets, and to export data toback end systems for further processing.
The EMS Server stores data only for the previous 90 days. To maintain data history, you shouldexport the data at regular intervals.
5
2Mashery 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
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 tomanage devices that run the EMS agent.
The Mashery APIs are grouped into objects, each with a set of methods. The objects are based onthose provided by the Axeda Platform Web Services, v2. The APIs enable you toprogrammatically 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 applicationcan access. You receive the key when you receive your Mashery account. Each user applicationmust 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 thefollowing URL:
https://serverName/services/v2/rest?_wadl
You can use the REST API calls directly in JSON or XML format, or you can convert the file intoJava classes to use in a Java programming environment.
For more information, see the following documents:
• Axeda Agent Web Services Guide, 6.8.0• 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 Masheryusername and password:
http://windriver.mashery.com
On the Home page, click See APIs in Action with I/O Docs.
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
8
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 thefailure of a hardware component. The Mashery APIs enable you to specify the conditions thattrigger 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/AlarmBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Counts the number ofalarms based oncriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/count
Creates an alarmbased on the alarmproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/alarm
Returns the statechanges of an alarm.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/id/systemId/alarmStateChanges
Finds an alarm basedon the systemidentifier or alternateidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/id/identifier
Finds alarms thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/find
Finds alarms based onalarm identifiers inthe request body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/findByIds
Returns a list ofhistorical alarmvalues.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/findInHistory
2 Mashery API ReferenceAlarm Object APIs
9
Description Endpoint
Finds the first alarmthat matches thespecified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/findOne
Creates or updates analarm.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/alarm
Sets the alarm state. POST https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/setAlarmState?state=newAlarmState
Updates theproperties of anexisting alarm.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/id/systemId
Create one or morealarms.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/bulk/create
Creates or updatesone or more alarms.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/bulk/save
Updates theproperties of one ormore alarms.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/bulk/update
Related LinksAlarm Examples on page 10Alarm 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 requestbody in an XML file.
create
This example shows a request to create an alarm on an asset. The request body identifies the assetby 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 \ "https://windriver.api.mashery.com/serverName/services/v1/rest/alarm?api_key=keyValue" \ [email protected] \ | tidy --show-warnings no -xml -i -q
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
10
alarm-create.xml
<?xml version="1.0" encoding="UTF-8"?><Alarm xmlns="http://www.axeda.com/services/v2"><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 thealarms 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 \ "https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/findInHistory?api_key=keyValue" \ [email protected] \ | tidy --show-warnings no -xml -i -q
alarm-findInHistory.xml
<?xml version="1.0" encoding="UTF-8"?><HistoricalAlarmCriteria xmlns="http://www.axeda.com/services/v2"><name>*</name></HistoricalAlarmCriteria>
findOne
This example shows the request to find an alarm using the critiera asset model and serial numberspecified in the request body.
$ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ "https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/findOne?api_key=keyValue" \ [email protected] \ | tidy --show-warnings no -xml -i -q
alarm-findOne.xml
<?xml version="1.0" encoding="UTF-8"?><AlarmCriteria xmlns="http://www.axeda.com/services/v2" ><asset id="default_testmodel||default_testasset"/></AlarmCriteria>
setAlarmState
This example shows a request to set the state of the specified alarm to ACKNOWLEDGED. Therequest body specifies the alarm by model number, serial number, and alarm name using theid="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 \ "https://windriver.api.mashery.com/serverName/services/v1/rest/alarm/setAlarmState?
2 Mashery API ReferenceAlarm Object APIs
11
state=ACKNOWLEDGED&?api_key=keyValue" \ [email protected] \ | tidy --show-warnings no -xml -i -q
alarm-setAlarmState.xml
<?xml version="1.0" encoding="UTF-8"?><AlarmCollection xmlns="http://www.axeda.com/services/v2"><alarm xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Alarm" id="default_testmodel||default_testasset||testalarm_delete_me"></alarm></AlarmCollection>
Related LinksAlarm Object APIs on page 9Alarm 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 MasheryAPIs or the EMS console. When a device running the EMS agent starts, it automatically connectsto the EMS server and an asset representing the device appears on the EMS Console. You can alsocreate 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/AssetBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Counts the number ofassets based oncriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/asset/countAssetsByCriteria
Creates an asset basedon the asset propertyvalues.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/asset
Deletes an asset. DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/asset/systemId
Finds an asset basedon system identifier oralternate identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/asset/id/identifier
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
12
Description Endpoint
Finds assets thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/asset/find
Finds assets based onasset identifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/asset/findByIds
Returns the assetconfiguration.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/asset/id/systemId/config
Finds the first assetthat matches thespecified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/asset/findOne
Creates or updates anasset.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/asset
Marks the specifiedasset as recentlyviewed.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/asset/recentlyViewed/id/systemId
Returns a list ofrecently viewedassets.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/asset/recentlyViewed
Updates theproperties of anexisting asset.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/asset/id/systemId
Creates one or moreassets.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/asset/bulk/create
Deletes one or moreassets.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/asset/bulk/delete
Creates or updatesone or more assets.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/asset/bulk/save
Updates theproperties of one ormore assets.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/asset/bulk/update
Related LinksAsset Examples on page 14
2 Mashery API ReferenceAsset Object APIs
13
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 requestbody 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 \ "https://windriver.api.mashery.com/serverName/services/v1/rest/asset/find?api_key=apiKey" \ [email protected] \ | tidy --show-warnings no -xml -i -q
asset-findByCriteria.xml
<?xml version="1.0" encoding="UTF-8"?><AssetCriteria xmlns="http://www.axeda.com/services/v2"><serialNumber>default*</serialNumber></AssetCriteria>
Related LinksAsset Object APIs on page 12Asset 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 oneor more asset configurations, such as organization information.
For more information about asset configuration configuration and the available APIs, see thefollowing:
• 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/
bridgeAssetConfigurationBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
14
Description Endpoint
Creates an assetconfiguration basedon the assetconfigurationproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration
Deletes an assetconfiguration.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration/systemId
Finds an assetconfiguration basedon an identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration/identifier
Finds assetconfigurations thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration/find
Finds assetconfigurations basedon asset configurationidentifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration/findByIds
Returns the assetconfiguration.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration/id/systemId/config
Finds the first assetconfiguration thatmatches the specifiedcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration/findOne
Creates or updates anasset configuration.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration
Updates theproperties of anexisting assetconfiguration.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration/id/systemId
Creates one or moreasset configurations.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration/bulk/create
Deletes one or moreasset configurations.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration/bulk/delete
Creates or updatesone or more assetconfigurations.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetConfiguration/bulk/save
2 Mashery API ReferenceAsset Configuration Object APIs
15
Description Endpoint
Updates theproperties of one ormore assetconfigurations.
POST https://windriver.api.mashery.com/serverName/services/v1/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 otherasset 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/AssetGroupBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Adds an asset to agroup.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/id/systemId/assets
Creates an asset groupbased on the assetgroup propertyvalues.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup
Deletes an assetgroup.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/systemId
Finds an asset groupbased on an identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/identifier
Finds asset groupsthat match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/find
Finds asset groupsbased on asset groupidentifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/findByIds
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
16
Description Endpoint
Finds the first assetgroup that matchesthe specified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/findOne
Creates or updates anasset group.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup
Returns the child assetgroups of thespecified asset group.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/children?id=systemId
Removes an assetfrom an asset group.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/id/assetGroupSystemId/assets/id/assetSystemId
Updates theproperties of anexisting asset group.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/id/systemId
Creates one or moreasset groups.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/bulk/create
Deletes one or moreasset groups.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/bulk/delete
Creates or updatesone or more assetgroups.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/bulk/save
Updates theproperties of one ormore asset groups.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/bulk/update
Related LinksAsset Group Examples on page 17Asset 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 requestbody in an XML file.
addToGroup
This example shows a request to add the asset with the model name default_testmodel and serialnumber default_testasset to an asset group that is specified by its system identifier.
$ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \
2 Mashery API ReferenceAsset Group Examples
17
-i -H "Accept: application/xml" \ -X PUT \ "https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/id/746/assets?api_key=apiKey" \ [email protected] \ | tidy --show-warnings no -xml -i -q
assetGroup-addToGroup.xml
<Asset id="default_testmodel||default_testasset" xmlns="http://www.axeda.com/services/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 \ "https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup?api_key=apiKey" \ [email protected] > tmpcat tmp | tidy --show-warnings no -xml -i -qcat tmp | grep -m 1 -o "<v2:id>.*</v2:id>"
assetGroup-create.xml
v2:AssetGroup xmlns:v2="http://www.axeda.com/services/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 (thecriteria) in the request body.
$ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ "https://windriver.api.mashery.com/serverName/services/v1/rest/assetGroup/find?api_key=apiKey" \ [email protected] \ | tidy --show-warnings no -xml -i -q
assetGroup-findByCriteria.xml
<?xml version="1.0" encoding="UTF-8"?><AssetGroupCriteria xmlns="http://www.axeda.com/services/v2"><serialNumber>default*</serialNumber></AssetGroupCriteria>
Related LinksAsset Group Object APIs on page 16
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
18
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 enableyou 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/AuditBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates an auditbased on the auditproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/audit
Finds an audit basedon an identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/audit/id/systemId
Finds audits thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/audit/find
Finds audits based onaudit identifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/audit/findByIds
Finds the first auditthat matches thespecified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/audit/findOne
Creates an audit. POST https://windriver.api.mashery.com/serverName/services/v1/rest/audit
Creates one or moreaudits.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/audit/bulk/create
Creates one or moreaudits.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/audit/bulk/save
2 Mashery API ReferenceAudit Object APIs
19
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 Groovyscripts 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
CustomObjectBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Verifies that a customobject compiles.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/compile
Creates a customobject based on thecustom objectproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/customObject
Deletes a customobject.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/systemId
Finds a custom objectbased on an identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/alternateId
Finds custom objectsthat match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/find
Finds custom objectsbased on customobject identifiers inthe request body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/findByIds
Returns the customobject with thespecified systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/id/systemId
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
20
Description Endpoint
Finds the first customobject that matchesthe specified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/findOne
Creates or updates acustom object.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObject
Updates theproperties of anexisting customobject.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/id/systemId
Creates one or morecustom objects.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/bulk/create
Deletes one or morecustom objects.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/bulk/delete
Creates or updatesone or more customobjects.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/bulk/save
Updates theproperties of one ormore custom objects.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/bulk/update
Related LinksCustom Object Examples on page 21Custom 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 requestbody 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 \ "https://windriver.api.mashery.com/serverName/services/v1/rest/customObject/find?api_key=apiKey" \ [email protected] \ | tidy --show-warnings no -xml -i -q
2 Mashery API ReferenceCustom Object Examples
21
customObject-findByCriteria.xml
<?xml version="1.0" encoding="UTF-8"?><CustomObjectCriteria xmlns="http://www.axeda.com/services/v2"><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 \ "https://windriver.api.mashery.com/sandbox1/services/v1/rest/customObject?api_key=apiKey" \ [email protected] \ | tidy --show-warnings no -xml -i -q
customObject-save.xml
CustomObject xmlns="http://www.axeda.com/services/v2"><name>customObjectSave</name><type>ACTION</type><params><customObjectParam><variableName>var11367590998148</variableName><displayName>displayName11367590998148</displayName></customObjectParam><customObjectParam><variableName>var21367590998148</variableName><displayName>displayName21367590998148</displayName></customObjectParam></params><description>description1367590998148</description><source>import com.axeda.*</source><languageType>GROOVY</languageType></CustomObject>
Related LinksCustom Object APIs on page 20Custom 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 objectgroups.
A custom object group enables you to manage multiple custom objects as a group. For moreinformation 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
CustomObjectGroupBridge.html
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
22
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a customobject group based onthe custom objectgroup propertyvalues.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup
Deletes a customobject group.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup/id/systemId
Finds a custom objectgroup based onalternate identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup/alternateId
Finds custom objectgroups that match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup/find
Finds custom objectgroups based onidentifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup/findByIds
Returns the customobject group based onthe specified systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup/id/systemId
Finds the first customobject group thatmatches the specifiedcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup/findOne
Creates or updates acustom object group.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup
Updates theproperties of anexisting custom objectgroup.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup/id/systemId
Creates one or morecustom object groups.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup/bulk/create
Deletes one or morecustom object groups.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup/bulk/delete
2 Mashery API ReferenceCustom Object Group Object APIs
23
Description Endpoint
Creates or updatesone or more customobject groups.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/customObjectGroup/bulk/save
Updates theproperties of one ormore custom objectgroups.
POST https://windriver.api.mashery.com/serverName/services/v1/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 orgroup of assets.
Data items represent data sent between a device and the EMS server. Data items can beassociated with an external data source, such as a sensor. The APIs operate on data items on theasset created using the Axeda Builder. For more information about data items and the availableAPIs, 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/DataItemsBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a data itembased on the data itemproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem
Deletes a data item. DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/id/systemId
Finds a data itembased on alternateidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/alternateId
Finds a data itembased on systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/id/systemId
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
24
Description Endpoint
Finds data items thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/find
Finds data itemsbased on data itemidentifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/findByIds
Returns the currentdata item values.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/findCurrentValues
Finds the first dataitem that matches thespecified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/findOne
Creates or updates adata item.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem
Returns the historicalvalues of a data item.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/findHistoricalValues
Updates theproperties of anexisting data item.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/id/systemId
Creates one or moredata items.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/bulk/create
Deletes one or moredata items.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/bulk/delete
Creates or updatesone or more dataitems.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/bulk/save
Updates theproperties of one ormore data items.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/bulk/update
Related LinksData Item Examples on page 26
2 Mashery API ReferenceData Item Object APIs
25
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 requestbody in an XML file.
create
This example shows a request to create a data item on an asset. The request body identifies theasset by the model id="WindRiverModel".
$ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X PUT \ "https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem?api_key=apiKey" \ [email protected] \ | tidy --show-warnings no -xml -i -q
dataItem-create.xml
<v2:DataItem xmlns:v2="http://www.axeda.com/services/v2"><v2:name>testdataItem_deleteme</v2:name><ns85:model id="WindRiverModel" xsi:type="ns85:ModelReference" xmlns:ns85="http://www.axeda.com/services/v2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/><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 theREST call.
$ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X GET \ "https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/id/52?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 therequest body.
$ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ "https://windriver.api.mashery.com/serverName/services/v1/rest/dataItem/findCurrentValues?api_key=apiKey" \ [email protected] \ | tidy --show-warnings no -xml -i -q
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
26
dataItem-findCurrentValues.xml
<v2:CurrentDataItemValueCriteria sortAscending="true" sortPropertyName="name" xmlns:v2="http://www.axeda.com/services/v2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><v2:assetId>42</v2:assetId></v2:CurrentDataItemValueCriteria>
Related LinksData Item Object APIs on page 24Data item object APIs enable you to create, read, update, and delete data items on an asset orgroup of assets.
Deployment Object APIs
Deployment object APIs enable you to create, read, update, and delete the objects that controlsoftware packages that are delivered to an EMS agent.
Deployment objects control the deployment of software packages to an EMS agent running on anasset. 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/DeploymentBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Cancels adeployment.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/deployment/id/systemId/cancel
Creates a deploymentbased on thedeployment propertyvalues.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/deployment
Deletes a deployment. DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/deployment/id/systemId
Finds deploymentsthat match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/deployment/find
2 Mashery API ReferenceDeployment Object APIs
27
Description Endpoint
Finds deploymentsbased on deploymentidentifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/deployment/findByIds
Returns a deploymentwith the specifiedsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/deployment/id/systemId
Finds the firstdeployment thatmatches the specifiedcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/deployment/findOne
Redeploys adeployment.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/deployment/id/systemId/redeploy
Creates or updates adeployment.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/deployment
Updates theproperties of anexisting deployment.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/deployment/id/systemId
Creates one or moredeployments.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/deployment/bulk/create
Deletes one or moredeployments.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/deployment/bulk/delete
Creates or updatesone or moredeployments.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/deployment/bulk/save
Updates theproperties of one ormore deployments.
POST https://windriver.api.mashery.com/serverName/services/v1/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 andthe available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: Expression Rules
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
28
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: ExpressionRuleBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: ExpressionRuleBridge: REST
Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
ExpressionRuleBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates an expressionrule based on theexpression ruleproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule
Deletes an expressionrule.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/id/systemId
Finds an expressionrule based onalternate identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/alternateId
Finds expression rulesthat match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/find
Finds expression rulesbased on expressionrule identifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/findByIds
Returns theexpression rule withthe specified systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/id/systemId
Finds the firstexpression rule thatmatches the specifiedcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/findOne
Creates or updates anexpression rule.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule
Updates theproperties of anexisting expressionrule.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/id/systemId
2 Mashery API ReferenceExpression Rule Object APIs
29
Description Endpoint
Validates the syntaxof the expression rule.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/validate
Creates one or moreexpression rules.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/bulk/create
Deletes one or moreexpression rules.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/bulk/delete
Creates or updatesone or moreexpression rules.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/bulk/save
Updates theproperties of one ormore expression rules.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/bulk/update
Related LinksExpression Rule Examples on page 30Expression 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 requestbody 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 \ "https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule?api_key=keyVal" \ [email protected] \ | tidy --show-warnings no -xml -i -q
expressionRule-create.xml
<?xml version="1.0" encoding="UTF-8"?><ExpressionRule xmlns="http://www.axeda.com/services/v2"><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>
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
30
<standalone>true</standalone></ExpressionRule>
find (by criteria)
This example shows a request to find an expression rule based on the rule name in the requestbody.
$ curl -k --stderr /dev/null \ -i -H "Content-type: application/xml" \ -i -H "Accept: application/xml" \ -X POST \ "https://windriver.api.mashery.com/serverName/services/v1/rest/expressionRule/find?api_key=keyVal" \ [email protected] \ | tidy --show-warnings no -xml -i -q
expressionRule-findByCriteria.xml
<?xml version="1.0" encoding="UTF-8"?><ExpressionRuleCriteria xmlns="http://www.axeda.com/services/v2"><name>testexpressionRule</name></ExpressionRuleCriteria>
Related LinksExpression Rule Object APIs on page 28Expression 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 InternetApplication objects.
Extended Applications are Rich Internet Applications (RIA) hosted on the EMS Server, and canbe 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
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates an extendedapplication based onthe extendedapplication propertyvalues.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication
2 Mashery API ReferenceExtended Application Object APIs
31
Description Endpoint
Deletes an extendedapplication.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication/id/systemId
Finds an extendedapplication based onan alternate identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication/alternateId
Finds extendedapplications thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication/find
Finds extendedapplications based onsystem identifiers inthe request body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication/findByIds
Returns the extendedapplication based onthe specified systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication/id/systemId
Finds the firstextended applicationthat matches thespecified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication/findOne
Creates or updates anextended application.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication
Updates theproperties of anexisting extendedapplication.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication/id/systemId
Creates one or moreextended applications.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication/bulk/create
Deletes one or moreextended applications.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication/bulk/delete
Creates or updatesone or more extendedapplications.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication/bulk/save
Updates theproperties of one ormore extendedapplications.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedApplication/bulk/update
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
32
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 aboutextended 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
ExtendedListBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Adds a value to anexisting extendedlist.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/alternateId
Creates anextended list basedon the extendedlist propertyvalues.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList
Deletes anextended list.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/id/systemId
Finds an extendedlist based on thealternate identifier,which is the sameas the systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/systemId
Finds extendedlists that match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/find
Finds extendedlists based onextended listidentifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/findByIds
2 Mashery API ReferenceExtended List Object APIs
33
Description Endpoint
Returns theextended list basedon the specifiedsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/id/systemId
Finds the firstextended list thatmatches thespecified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/findOne
Removes a valuefrom an extendedlist.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/id/systemId
Creates or updatesan extended list.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList
Updates theproperties of anexisting extendedlist.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/id/systemId
Creates one ormore extendedlists.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/bulk/create
Deletes one ormore extendedlists.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/bulk/delete
Creates or updatesone or moreextended lists.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedList/bulk/save
Updates theproperties of oneor more extendedlists.
POST https://windriver.api.mashery.com/serverName/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 moreinformation about extended maps and the available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: ExtendedMapBridge: Methods
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
34
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: ExtendedMapBridge: REST Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
ExtendedMapBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Adds a value to anexisting extendedmap.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap/systemId/key
Creates an extendedmap based on theextended mapproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap
Deletes the contents ofan extended map.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap/id/systemId
Finds an extendedmap based on thealternate or systemidentifier, which arethe same value.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap/systemId
GET https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap/id/systemId
Finds extended mapsthat match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap/find
Finds extended listsbased on extendedmap identifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap/findByIds
Finds the firstextended map thatmatches the specifiedcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap/findOne
Creates one or moreextended maps.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap/bulk/create
Deletes the contents ofone or more extendedmaps.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap/bulk/delete
Creates or updatesone or more extendedmaps.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap/bulk/save
2 Mashery API ReferenceExtended Map Object APIs
35
Description Endpoint
Updates theproperties of one ormore extended maps.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedMap/bulk/update
Extended UI Module Object APIs
Extended UI Model object APIs enable you to create, read, update and delete extended UImodules.
You use extended UI modules to create custom applications in the EMS Console using eithercustom objects or extended applications. For more information about Extended UI Modules andthe 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
ExtendedUIModuleBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates an extendedUI module based onthe extended UImodule propertyvalues.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule
Deletes an extendedUI module.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule/id/systemId
Finds extended UImodules that matchthe specified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule/find
Finds extended UImodules based onextended UI moduleidentifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule/findByIds
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
36
Description Endpoint
Returns the extendedUI module based onthe specified systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule/id/systemId
Finds the firstextended UI Modulethat matches thespecified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule/findOne
Creates or updates anextended UI module.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule
Updates theproperties of anexisting extended UIModule.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule/id/systemId
Creates one or moreextended UI modules.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule/bulk/create
Deletes one or moreextended UI modules.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule/bulk/delete
Creates or updatesone or more extendedUI modules.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule/bulk/save
Updates theproperties of one ormore extended UImodules.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/extendedUIModule/bulk/update
External Credential Object APIs
External credential object APIs enable you to create, read, update and delete external credentialsthat determine access to the EMS Server.
External credentials are name-value pairs, and can be applied to user groups. For moreinformation 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/DataItemsBridge.html
2 Mashery API ReferenceExternal Credential Object APIs
37
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates an externalcredential based onthe external credentialproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/externalCredential
Deletes an externalcredential.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/externalCredential/id/systemId
Finds externalcredentials that matchthe specified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/externalCredential/find
Finds externalcredentials based onexternal credentialidentifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/externalCredential/findByIds
Returns the externalcredential based onsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/externalCredential/id/systemId
Finds the first externalcredential thatmatches the specifiedcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/externalCredential/findOne
Creates or updates anexternal credential.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/externalCredential
Updates theproperties of anexisting externalcredential.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/externalCredential/id/systemId
Creates one or moreexternal credentials.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/externalCredential/bulk/create
Deletes one or moreexternal credentials.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/externalCredential/bulk/delete
Creates or updatesone or more externalcredentials.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/externalCredential/bulk/save
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
38
Description Endpoint
Updates theproperties of one ormore externalcredentials.
POST https://windriver.api.mashery.com/serverName/services/v1/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 servermust have an associated file info object. For more information about file info and the availableAPIs, 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/FileInfoBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a file infobased on the file infoproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/file
Deletes a file info. DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/file/systemId
Finds file infos thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/file/find
Retrieves file contentsas a stream of bytes
GET https://windriver.api.mashery.com/serverName/services/v1/rest/file/systemId/download
Returns the fileupload progress.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/file/systemId/progress
Lists the file info bycriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/file/list
Creates or updates afile info.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/file/save
2 Mashery API ReferenceFile Info Object APIs
39
Description Endpoint
Creates or updates afile info and uploadsits contents to theEMS Server.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/file
Updates theproperties of a fileinfo.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/file/systemId
Uploads file contents. PUT https://windriver.api.mashery.com/serverName/services/v1/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 fileuploads.
File sessions are used to manage file uploads, which must be associated with a file uploadsessions. You cannot delete or updated a file upload session. For more information about fileupload 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• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
FileUploadSessionBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a file uploadsession based on thefile upload sessionproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/file/session
Finds a file uploadsession based on thesystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/file/session/systemId
Finds file uploadsessions that matchthe specified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/file/session/list
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
40
Description Endpoint
Creates or updates afile upload session.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/file/session/save
Location Object APIs
Location object APIs enable you to create, read, update, and delete location information for anasset.
Organizations, locations, and regions organize assets. A location must be associated with anorganization. For more information about locations and the available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: LocationBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: LocationBridge: REST Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/LocationBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a locationbased on the locationproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/location
Deletes a location. DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/location/id/systemId
Finds locations thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/location/find
Finds location basedon location identifiersin the request body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/location/findByIds
Returns the locationbased on systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/location/id/systemId
Finds the first locationthat matches thespecified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/location/findOne
Creates or updates alocation.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/location
2 Mashery API ReferenceLocation Object APIs
41
Description Endpoint
Updates theproperties of anexisting location.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/location/id/systemId
Creates one or morelocations.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/location/bulk/create
Deletes one or morelocations.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/location/bulk/delete
Creates or updatesone or more locations.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/location/bulk/save
Updates theproperties of one ormore locations.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/location/bulk/update
Machine Stream Object APIs
Machine stream object APIs enable you to create, read, update, and delete access to raw streamsof data from assets connected to the EMS Server.
Machine streams can contain data items, alarms, registration, and location information fromassets. Transport configuration are used to specify the transport and status of the stream. Formore information about machine streams and the available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: MachineStreamBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: MachineStreamBridge: REST
Examples
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a machinestream based on themachine streamproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream
Deletes a machinestream.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream/id/systemId
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
42
Description Endpoint
Finds machinestreams that matchthe specified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream/find
Returns the assetstatus for each asset inthe specified machinestream.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream/id/systemId/associatedAssets
Returns the machinestream based onsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream/id/systemId
Finds the firstmachine stream thatmatches the specifiedcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream/findOne
Creates or updates amachine stream.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream
Updates theproperties of anexisting machinestream.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream/id/systemId
Creates one or moremachine streams.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream/bulk/create
Deletes one or moremachine streams.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream/bulk/delete
Creates or updatesone or more machinestreams.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream/bulk/save
Updates theproperties of one ormore machinestreams.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/machineStream/bulk/update
2 Mashery API ReferenceMachine Stream Object APIs
43
Model Object APIs
Model object APIs enable you to create, read, update, and delete asset models.
A model represents assets of the same type with the same properties. You can specify the modelname when you build the rootfs. If a device running the EMS agent starts the first time without amodel name, one is automatically generated.
For more information about models and the available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: ModelBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: ModelBridge: REST Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/ModelBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a model basedon the model propertyvalues.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/model
Deletes a model. DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/model/id/systemId
Finds models thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/model/find
Returns the modelbased on the systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/model/id/systemId
Finds the first modelthat matches thespecified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/model/findOne
Creates or updates amodel.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/model
Updates theproperties of anexisting model.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/model/id/systemId
Creates one or moremodels.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/model/bulk/create
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
44
Description Endpoint
Deletes one or moremodels.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/model/bulk/delete
Creates or updatesone or more models.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/model/bulk/save
Updates theproperties of one ormore models.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/model/bulk/update
Organization Object APIs
Organization object APIs enable you to create, read, update, and delete asset organizationinformation.
Organizations, locations, and regions organize assets. An organization must be associated with alocation. For more information about organizations and the available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: OrganizationBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: OrganizationBridge: REST Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
OrganizationBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a organizationbased on theorganization propertyvalues.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/organization
Deletes aorganization.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/organization/id/systemId
Finds organizationsthat match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/organization/find
Finds organizationsbased on organizationidentifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/organization/findByIds
2 Mashery API ReferenceOrganization Object APIs
45
Description Endpoint
Returns theorganization based onsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/organization/id/systemId
Finds the firstorganization thatmatches the specifiedcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/organization/findOne
Creates or updates aorganization.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/organization
Updates theproperties of anexisting organization.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/organization/id/systemId
Creates one or moreorganizations.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/organization/bulk/create
Deletes one or moreorganizations.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/organization/bulk/delete
Creates or updatesone or moreorganizations.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/organization/bulk/save
Updates theproperties of one ormore organizations.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/organization/bulk/update
Region Object APIs
Region object APIs enable you to create, read, update, and delete asset region information.
You can use regions, locations, and organizations to organize assets. A location must beassociated with an organization before it can be associated with a region. For more informationabout regions and the available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: RegionBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: RegionBridge: REST Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/RegionBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
46
Description Endpoint
Creates a region basedon the regionproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/region
Deletes a region. DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/region/id/systemId
Finds regions thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/region/find
Finds regions basedon region identifiersin the request body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/region/findByIds
Returns the regionbased on systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/region/id/systemId
Finds the first regionthat matches thespecified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/region/findOne
Creates or updates aregion.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/region
Updates theproperties of anexisting region.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/region/id/systemId
Creates one or moreregions.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/region/bulk/create
Deletes one or moreregions.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/region/bulk/delete
Creates or updatesone or more regions.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/region/bulk/save
Updates theproperties of one ormore regions.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/region/bulk/update
2 Mashery API ReferenceRegion Object APIs
47
Remote Server Object APIs
Remove server object APIs enable you to read information about remote access servers.
Remote servers enable you to access an asset through a remote session. For more informationabout remote servers and the available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: RemoteServerBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: RemoteServerBrdige: REST Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
RemoteServerBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Finds remote serversthat match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/remoteServer/find
Returns the remoteserver based onsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/remoteServer/id/systemId
Finds the first remoteserver that matchesthe specified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/remoteServer/findOne
Finds remote serverbest able to handle thesession with thespecified systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/remoteServer/find
Remote Session Object APIs
Remote session object APIs enable you to create, read, update, and delete remote sessions tocommunicate with remote assets.
Remote sessions enable communication with assets that do not have a graphical user interfaceand are behind a firewall. For more information about remote sessions and the available APIs,see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: RemoteSessionBridge: Methods
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
48
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: RemoteSessionBridge: RESTExamples
• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/RemoteSessionBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a remotesession based inputparameters.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession
Deletes the history ofa remote session.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/id/systemId
Ends a remote session POST https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/id/systemId/end
Finds an activeremote interface byasset alternate orsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/interfaces/asset/alternateId
GET https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/interfaces/asset/id/systemId
Finds a remoteinterface by systemidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/interface/id/systemId
Finds remote sessionsthat match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/find
Finds remote sessionsbased on remotesession identifiers inthe request body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/findByIds
Returns the remotesession based onsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/id/systemId
Finds the first remotesession that matchesthe specified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/findOne
2 Mashery API ReferenceRemote Session Object APIs
49
Description Endpoint
Returns the remoteclient information forthe specified remoteinterface based onsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/clientInfo/interface/id/systemId
Returns the status ofthe remote session.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/id/systemId/status
Joins a remote session. POST https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/id/systemId/join
Leaves a remotesession
POST https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/id/systemId/leave
Merges a remotesession with anexisting remotesession specified bythe system identifier.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/id/systemId/merge
Validates a user for aremote session.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/id/systemId/isUserValid
Deletes one or moreremote sessions.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/remoteSession/bulk/delete
Self Service Object APIs
Self service object APIs enable users to manage their passwords.
For more information about self services and the available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: SelfServiceBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: SelfServiceBrdige: REST Examples
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Changes the user'spassword.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/self/password
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
50
Description Endpoint
Provides the user withthe passwordvalidation policy.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/self/password/validationPolicy
Validates the user'spassword against thepassword validationpolicy.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/self/password/validate
Software Package Object APIs
Software package object APIs enable you to create, read, update, and delete software packages.
Software pacakges contain instructions and other information about delivering software to EMSagents. For more information about software packages 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: SoftwarePackageBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: SoftwarePackageBridge: REST
Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
SoftwarePackageBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a softwarepackage based on thesoftware packageproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/softwarePackage
Deletes a softwarepackage.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/softwarePackage/id/systemId
Finds softwarepackages that matchthe specified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/softwarePackage/find
Returns the softwarepackage based on thesystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/softwarePackage/id/systemId
2 Mashery API ReferenceSoftware Package Object APIs
51
Description Endpoint
Finds the firstsoftware package thatmatches the specifiedcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/softwarePackage/findOne
Creates or updates asoftware package.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/softwarePackage
Updates theproperties of anexisting softwarepackage.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/softwarePackage/id/systemId
Creates one or moresoftware packages.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/softwarePackage/bulk/create
Deletes one or moresoftware packages.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/softwarePackage/bulk/delete
Creates or updatesone or more softwarepackages.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/softwarePackage/bulk/save
Updates theproperties of one ormore softwarepackages.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/softwarePackage/bulk/update
Transport Configuration Object APIs
Transport configuration object APIs enable you to create, read, update and delete transportobjects.
Transport configurations are used by machine streams. Only Adminstrators on the EMS Servercan use transport configuration. For more information about Data Items and the available APIs,see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: TransportConfigurationBridge:Methods
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: TransportConfigurationBridge: RESTExamples
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
52
Description Endpoint
Creates a transportconfiguration basedon the transportconfigurationproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/transportConfiguration
Deletes a transportconfiguration.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/transportConfiguration/id/systemId
Finds transportconfigurations thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/transportConfiguration/find
Returns the transportconfiguration basedon system identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/transportConfiguration/id/systemId
Creates or updates atransportconfiguration.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/transportConfiguration
Updates theproperties of anexisting transportconfiguration.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/transportConfiguration/id/systemId
Unit Of Measure Object APIs
Unit of measure object APIs enable you to create, read, update, and delete units of measure fordata item values.
For more information about units of measure and the available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: UnitOfMeasureBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: UnitOfMeasureBridge: REST
Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
UnitOfMeasureBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
2 Mashery API ReferenceUnit Of Measure Object APIs
53
Description Endpoint
Creates a unit ofmeasure based on theunit of measureproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/unitOfMeasure
Deletes a unit ofmeasure.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/unitOfMeasure/id/systemId
Finds unit ofmeasures that matchthe specified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/unitOfMeasure/find
Returns the unit ofmeasure based onsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/unitOfMeasure/id/systemId
Finds the first unit ofmeasure that matchesthe specified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/unitOfMeasure/findOne
Creates or updates aunit of measure.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/unitOfMeasure
Updates theproperties of anexisting unit ofmeasure.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/unitOfMeasure/id/systemId
Creates one or moreunit of measures.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/unitOfMeasure/bulk/create
Deletes one or moreunit of measures.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/unitOfMeasure/bulk/delete
Creates or updatesone or more unit ofmeasures.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/unitOfMeasure/bulk/save
Updates theproperties of one ormore unit ofmeasures.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/unitOfMeasure/bulk/update
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
54
User Object APIs
User object APIs enable you to create, read, update, and delete user accounts on the EMS Server.
Users define thc properties of a user on the EMS Server. Users belong to user groups and haveprivileges defined in the user privileges object. For more information about users and theavailable APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: Users• Axeda® Platform Axeda v2 API/Services Developer’s Reference: UserBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: UserBridge: REST Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/UserBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a user basedon the user propertyvalues.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/user
Deletes a user. DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/user
Sets a user's passwordstate to expired.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/user/alternateId/password/expire
Finds a user based onthe alternateidentifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/user/alternateId
Finds a user based onthe system identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/user/id/systemId
Finds users thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/user/find
Finds users based onuser identifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/user/findByIds
Returnes thevalidation policy of auser's password.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/user/password/validationPolicy
2 Mashery API ReferenceUser Object APIs
55
Description Endpoint
Finds the first userthat matches thespecified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/user/findOne
Creates or updates auser.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/user
Resets a user'spassword
POST https://windriver.api.mashery.com/serverName/services/v1/rest/user/alternateId/password/resetRequest
Updates theproperties of anexisting user.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/user/id/systemId
Unlocks a user. PUT https://windriver.api.mashery.com/serverName/services/v1/rest/user/alternateId/unlock
Create one or moreusers.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/user/bulk/create
Deletes one or moreusers.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/user/bulk/delete
Creates or updatesone or more users.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/user/bulk/save
Updates theproperties of one ormore users.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/user/bulk/update
User Group Object APIs
User group object APIs enable you to create, read, update, and delete user group information.
A user group is a pool of users with common access privileges on the EMS Server. For moreinformation about user groups and the available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: UserGroupBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: UserGroupBridge: REST Examples
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
56
Description Endpoint
Creates a user groupbased on the usergroup propertyvalues.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup
Deletes a user group. DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup/id/systemId
Finds user groups thatmatch the specifiedsearch criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup/find
Finds user groupsbased on user groupidentifiers in therequest body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup/findByIds
Returns the usergroup based onsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup/id/systemId
Finds the first usergroup that matchesthe specified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup/findOne
Creates or updates auser group.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup
Updates theproperties of anexisting user group.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup/id/systemId
Creates one or moreuser groups.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup/bulk/create
Deletes one or moreuser groups.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup/bulk/delete
Creates or updatesone or more usergroups.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup/bulk/save
Updates theproperties of one ormore user groups.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userGroup/bulk/update
2 Mashery API ReferenceUser Group Object APIs
57
User Privilege Object APIs
User privilege object APIs enable you to create, read, update, and delete user privilegeinformation.
A user privilege object enables a user on the EMS Server to assign custom privileges to usergroups on the EMS Server. For more information about user privileges and the available APIs,see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: UserPrivilegeBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: UserPrivilegeBridge: REST Examples
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a userprivilege based on theuser privilegeproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege
Deletes a userprivilege.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege/id/systemId
Finds user privilegesthat match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege/find
Finds user privilegesbased on userprivilege identifiers inthe request body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege/findByIds
Returns the userprivilege based onsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege/id/systemId
Finds the first userprivilege that matchesthe specified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege/findOne
Checks if a user hasthe specifiedprivilege.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege/privilegeName/hasPrivilege
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
58
Description Endpoint
Creates or updates auser privilege.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege
Updates theproperties of anexisting userprivilege.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege/id/systemId
Creates one or moreuser privileges.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege/bulk/create
Deletes one or moreuser privileges.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege/bulk/delete
Creates or updatesone or more userprivileges.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege/bulk/save
Updates theproperties of one ormore user privileges.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/userPrivilege/bulk/update
User Settings APIs
User settings object APIs enable you to create, read, update, and delete settings in the user layerof the EMS server.
The user layer contains the settings for each user. For more information about user settings andthe available APIs, see the following:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: Platform Settings• Axeda® Platform Axeda v2 API/Services Developer’s Reference: UserSettingsBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: UserSettingsBridge: REST Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
UserSettingsBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
DeletesPlatformSettings.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/settings/user
Finds a setting. GET https://windriver.api.mashery.com/serverName/services/v1/rest/settings/user
2 Mashery API ReferenceUser Settings APIs
59
Description Endpoint
FindsPlatformSettings thatmatch all settings inthe specified path.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/settings/user
Creates or updatesPlatformSettings.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/settings/user/save
Web Resource Object APIs
Web resource object APIs enable you to automatically generate client classes from web servicesWSDLs.
You can use web resources to upload Groovy scripts to the EMS Server and configure them ascustom objects. For more information about web resources and the available APIs, see thefollowing:
• Axeda® Platform Axeda v2 API/Services Developer’s Reference: WebResourcesBridge: Methods• Axeda® Platform Axeda v2 API/Services Developer’s Reference: WebResourcesBridge: REST Examples• https://mentor.axeda.com/javadoc/6_6-SDK_Javadoc/com/axeda/sdk/v2/bridge/
WebResourceBridge.html
The following table shows the endpoint mapping of Mashery APIs to Axeda methods. TheserverName corresponds to the name of the EMS Server, for example, sandbox1.
Description Endpoint
Creates a webresource based on theweb resourceproperty values.
PUT https://windriver.api.mashery.com/serverName/services/v1/rest/webResource
Deletes a webresource.
DELETE https://windriver.api.mashery.com/serverName/services/v1/rest/webResource/id/systemId
Finds web resourcesthat match thespecified searchcriteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/webResource/find
Finds web resourcesbased on webresource identifiers inthe request body.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/webResource/findByIds
Wind River® Intelligent Device Platform XT EMS ProfileWind River® EMS Device Management User's Guide, 1.0
60
Description Endpoint
Returns the webresource based onsystem identifier.
GET https://windriver.api.mashery.com/serverName/services/v1/rest/webResource/id/identifier
Finds the first webresource that matchesthe specified criteria.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/webResource/findOne
Creates or updates aweb resource.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/webResource
Updates theproperties of anexisting web resource.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/webResource/id/systemId
Creates one or moreweb resources.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/webResource/bulk/create
Deletes one or moreweb resources.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/webResource/bulk/delete
Creates or updatesone or more webresources.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/webResource/bulk/save
Updates theproperties of one ormore web resources.
POST https://windriver.api.mashery.com/serverName/services/v1/rest/webResource/bulk/update
2 Mashery API ReferenceWeb Resource Object APIs
61