Skip to content

Commit

Permalink
Information about __export_name
Browse files Browse the repository at this point in the history
  • Loading branch information
mickenordin authored Mar 31, 2017
1 parent ea9af76 commit d24e843
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion SU/API/Icinga2.pod
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,10 @@ Returns the result in a perl reference.
=item export (FULL, API_ONLY)

Returns a Perl Data structure without unneccessary meta data. $icinga->export can
only be called after do_request.
only be called after do_request. The name of the object is stored in
$object->{attrs}{vars}{__export_name} so that you can access if you need it, please
note that you can't use this variable name for other things if you whis to use this library
as it will be overwritten in the exported object.

"FULL" is optional and if it is true, write once attributes will be included in
the export. Objects exported with FULL set to true can be converted to json and be
Expand Down

0 comments on commit d24e843

Please sign in to comment.