System information

Manual:API
161
Tags
•• It is possible to run several commands simultaneously, without waiting for previous one to complete. If API client
is doing this and needs to differentiate command responses, it can use 'tag' API parameter in command sentences.
•• If you include 'tag' parameter with non-empty value in command sentence, then 'tag' parameter with exactly the
same value will be included in all responses generated by this command.
•• If you do not include 'tag' parameter or it's value is empty, then all responses for this command will not have 'tag'
parameter.
Command description
•• /cancel
• optional argument: =tag=tag of command to cancel, without it cancels all running commands
•• does not cancel itself
•• all canceled commands are interruped and in the usual case generate '!trap' and '!done' responses
• please note that /cancel is separate command and can have it's own unique '.tag' parameter, that is not
related to '=tag' argument of this command
•• listen
• listen command is avaliable where console print command is available, but it does not have expected effect
everywhere (i.e. may not work)
• !re sentences are generated as something changes in particular item list
•• when item is deleted or dissapears in any other way, the '!re' sentence includes value '=.dead=yes'
• This command does not terminate. To terminate it use /cancel command.
•• getall
• getall command is available where console print command is available. Since version 3.21 getall is an
alias for print.
• replies contain =.id=Item internal number property.
•• print
• API print command differs from the console counterpart in the following ways:
• where argument is not supported. Items can be filtered using query words (see below).
• .proplist argument is a comma separated list of property names that should be included for the returned
items.
•• returned items may have additional properties.
•• order of returned properties is not defined.
•• if list contains duplicate entries, handling of such entries is not defined.
• if propery is present in .proplist, but absent from the item, then that item does not have this property
value (?name will evaluate to false for that item).
• if .proplist is absent, all properties are included as requested by print command, even those that
have slow access time (such as file contents and perfomance counters). Thus use of .proplist is
encouraged. Omission of .proplist may have high perfomance penalty if =detail= argument is set.