1WWW::GoodData(3) User Contributed Perl Documentation WWW::GoodData(3)
2
3
4
6 WWW::GoodData - Client library for GoodData REST-ful API
7
9 use WWW::GoodData;
10 my $gdc = new WWW::GoodData;
11 print $gdc->get_uri ('md', { title => 'My Project' });
12
14 WWW::GoodData is the client for GoodData JSON-based API built atop
15 WWW::GoodData::Agent client agent, with focus on usefullness and
16 correctness of implementation.
17
18 It provides code for navigating the REST-ful API structure as well as
19 wrapper funcitons for common actions.
20
22 new [PARAMS]
23 Create a new client instance.
24
25 You can optionally pass a hash reference with properties that would
26 be blessed, otherwise a new one is created. Possible properties
27 include:
28
29 agent A WWW::GoodData::Agent instance to use.
30
31 retries A number of retries to obtain results of asynchronous
32 tasks, such as report exports or data uploads. See poll.
33
34 Defaults to 3600 (delay of one hour).
35
36 links PATH
37 Traverse the links in resource hierarchy following given PATH,
38 starting from API root ("gdc" by default).
39
40 PATH is an array of dictionaries, where each key-value pair matches
41 properties of a link. If a plain string is specified, it is
42 considered to be a match against category property:
43
44 $gdc->links ('md', { 'category' => 'projects' });
45
46 The above call returns a list of all projects, with links to their
47 metadata resources.
48
49 get_uri PATH
50 Follows the same samentics as links() call, but returns an URI of
51 the first matching resource instead of complete link structure.
52
53 login EMAIL PASSWORD
54 Obtain a SST (login token).
55
56 logout
57 Make server invalidate the client session and drop credential
58 tokens.
59
60 Is called upon destruction of the GoodData client instance.
61
62 change_passwd OLD NEW
63 Change user password given the old and new password.
64
65 projects
66 Return array of links to project resources on metadata server.
67
68 delete_project IDENTIFIER
69 Delete a project given its identifier.
70
71 create_project TITLE SUMMARY TEMPLATE DRIVER TOKEN
72 Create a project given its title and optionally summary, project
73 template, db engine driver and authorization token return its
74 identifier.
75
76 The list of valid project templates is available from the template
77 server: <https://secure.gooddata.com/projectTemplates/>.
78
79 Valid db engine drivers are 'Pg' (default) and 'mysql'.
80
81 create_user DOMAIN EMAIL LOGIN PASSWORD FIRST_NAME LAST_NAME PHONE
82 COMPANY SSO_PROVIDER
83 Create a user given its email, login, password, first name,
84 surname, phone and optionally company, sso provider in domain.
85
86 Returns user identifier (URI).
87
88 get_roles PROJECT
89 Gets project roles.
90
91 Return array of project roles.
92
93 reports PROJECT
94 Return array of links to repoort resources on metadata server.
95
96 compute_report REPORT
97 Trigger a report computation and return the URI of the result
98 resource.
99
100 export_report REPORT FORMAT
101 Submit an exporter task for a computed report (see compute_report),
102 wait for completion and return raw data in desired format.
103
104 ldm_picture PROJECT
105 Return picture of Logical Data Model (LDM) in PNG format.
106
107 ldm_manage PROJECT MAQL
108 Execute MAQL statement for a project.
109
110 upload PROJECT MANIFEST
111 Upload and integrate a new data load via Single Loading Interface
112 (SLI).
113
114 poll BODY CONDITION
115 Should only be used internally.
116
117 Run BODY passing its return value to call to CONDITION until it
118 evaluates to true or retries (see properties) times out.
119
120 Returns value is of last iteration of BODY in case CONDITION
121 succeeds, otherwise undefined (in case of timeout).
122
123 create_object_with_expression PROJECT URI TYPE TITLE SUMMARY EXPRESSION
124 Create a new metadata object of type TYPE with EXPRESSION as the
125 only content.
126
127 create_report_definition PROJECT URI TITLE SUMMARY METRICS DIM FILTERS
128 Create a new reportDefinition in metadata.
129
130 DESTROY
131 Log out the session with logout unless not logged in.
132
134 · <http://developer.gooddata.com/api/> -- API documentation
135
136 · <https://secure.gooddata.com/gdc/> -- Browsable GoodData API
137
138 · WWW::GoodData::Agent -- GoodData API-aware user agent
139
141 Copyright 2011, 2012, 2013 Lubomir Rintel
142
143 Copyright 2012, 2013 Adam Stulpa, Jan Orel, Tomas Janousek
144
145 This program is free software; you can redistribute it and/or modify it
146 under the same terms as Perl itself.
147
149 Lubomir Rintel "lkundrak@v3.sk"
150
151 Adam Stulpa "adam.stulpa@gooddata.com"
152
153 Jan Orel "jan.orel@gooddata.com"
154
155 Tomas Janousek "tomi@nomi.cz"
156
157
158
159perl v5.28.1 2019-02-02 WWW::GoodData(3)