Page 1 of 1

API manual DETAIL

Posted: Mon Jun 16, 2014 11:25 am
by davidw
In the API manual it talks about the fields that are being returned using the proplist. It then goes on to say that using the proplist is a good thing especially if the "=detail" argument is set.

How does the ="detaills" argument work?

/ip/hotspot/ip-bindings/getall
=details=true


see manual extract :-

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.

Re: API manual DETAIL

Posted: Mon Jun 16, 2014 12:45 pm
by janisk
it needs to be updated.

print (getall is now simply an alias to print) without detail where changed to not to include all the fields available. Now it returns what print in CLI would return in the same circumstance.

but still use of .proplist is highly encouraged to reduce the load on the router while returning data.

Re: API manual DETAIL

Posted: Mon Jun 16, 2014 3:02 pm
by davidw
Ok thanks for the clarification.

Am I right in thinking that not all fields are returned via get all command which under a normal terminal session would be ?

I have come across a few examples where this is the case

Re: API manual DETAIL

Posted: Mon Jun 16, 2014 4:28 pm
by janisk
print will return the same as print in CLI. for more stuff you have run monitor command or detail flag.