MindSphere CLI: mdsp events Command

Syntax:

mdsp events

Help:

mdsp events --help

Alternative form:

mc events

(The CLI was using mc as default command name in older versions)

Description

list, create or delete events *

Usage

Parameter list:

Usage: mc events|ev [options]

list, create or delete events *

Options:
  -m, --mode [list|create|delete|template|filtertemplate|info]  list | create | delete | template | filtertemplate | info (default: "list")
  -f, --file                                              .mdsp.json file with event definition
  -i, --assetid                                        mindsphere asset id
  -e, --eventid                                        event id
  -f, --filter [filter]                                         JSON file with filter (see:
                                                                https://developer.mindsphere.io/apis/advanced-eventmanagement/api-eventmanagement-best-practices.html)
  -n, --eventtype                                    the event type name
  -s, --size                                              max. number of events to list (default: "100")
  -c, --includeshared                                           include shared event types
  -g, --includeglobal                                           include global event types
  -k, --passkey                                        passkey
  -y, --retry                                           retry attempts before giving up (default: "3")
  -v, --verbose                                                 verbose output
  -h, --help                                                    display help for command

Examples

Here are some examples of how to use the mdsp events command:


  Examples:

    mdsp events --mode list 				 list last  events (default:100)
    mdsp events --mode list --eventtype PumpEvent		 list last  PumpEvents (default: 100)
    mdsp events --mode info --eventid 		 get info about event with specified id
    mdsp events --mode delete --eventid 		 delete event with specified id
    mdsp events --mode filtertemplate 			 create filter template for --mode list command
    mdsp events --mode template --eventtype PumpEvent 	 create a template file for event 
    mdsp events --mode create --file PumpEvent.eventtype.mdsp.json 	 create event

See MindSphere API documentation for more information about MindSphere APIs.

The content of the community tools and libraries documentation pages is licensed under the MIT License.
Siemens API Notice applies.
Back to top