NAME
WWW::GoodData - Client library for GoodData REST-ful API
SYNOPSIS
use WWW::GoodData;
my $gdc = new WWW::GoodData;
print $gdc->get_uri('md', { title => 'My Project' });
DESCRIPTION
WWW::GoodData is the client for GoodData JSON-based API built atop
WWW::GoodData::Agent client agent, with focus on usefullness and
correctness of implementation.
It provides code for navigating the REST-ful API structure as well as
wrapper funcitons for common actions.
METHODS
new [PARAMS]
Create a new client instance.
You can optionally pass a hash reference with properties that would
be blessed, otherwise a new one is created. Possible properties
include:
agent A WWW::GoodData::Agent instance to use.
auto_destroy
Sets automatic logout in destroying object.
Defaults to 1.
retries A number of retries to obtain results of asynchronous tasks,
such as report exports or data uploads. See poll.
Defaults to 3600 (delay of one hour).
verbose Adds handler for printing of request information to agent
When versbose mode is set. Password in 'postUserLogin'
parameter will be hidden.
Examples of verbose output: GET
https://secure.gooddata.com/gdc POST
https://secure.gooddata.com/gdc/account/login
{"postUserLogin":{"login":"bear@gooddata.com","verify_level"
:2,"remember":0,"password":"***"}}
Defaults to 0.
links PATH
Traverse the links in resource hierarchy following given PATH,
starting from API root ("gdc" by default).
PATH is an array of dictionaries, where each key-value pair matches
properties of a link. If a plain string is specified, it is
considered to be a match against category property:
$gdc->links('md', { 'category' => 'projects' });
The above call returns a list of all projects, with links to their
metadata resources.
get_uri PATH
Follows the same samentics as links() call, but returns an URI of
the first matching resource instead of complete link structure.
login EMAIL PASSWORD
Obtain a SST (login token).
logout
Make server invalidate the client session and drop credential
tokens.
Is called upon destruction of the GoodData client instance.
change_passwd OLD NEW
Change user password given the old and new password.
projects
Return array of links to project resources on metadata server.
delete_project IDENTIFIER
Delete a project given its identifier.
create_project TITLE SUMMARY TEMPLATE DRIVER TOKEN
Create a project given its title and optionally summary, project
template, db engine driver and authorization token return its
identifier.
The list of valid project templates is available from the template
server: <https://secure.gooddata.com/projectTemplates/>.
Valid db engine drivers are 'Pg' (default) and 'vertica'.
create_user DOMAIN EMAIL LOGIN PASSWORD FIRST_NAME LAST_NAME PHONE
COMPANY SSO_PROVIDER
Create a user given its email, login, password, first name, surname,
phone and optionally company, sso provider in domain.
Returns user identifier (URI).
get_roles PROJECT
Gets project roles.
Return array of project roles.
reports PROJECT
Return array of links to repoort resources on metadata server.
compute_report REPORT
Trigger a report computation and return the URI of the result
resource.
export_report REPORT FORMAT
Submit an exporter task for a computed report (see compute_report),
wait for completion and return raw data in desired format.
ldm_picture PROJECT
Return picture of Logical Data Model (LDM) in PNG format.
ldm_manage PROJECT MAQL
Execute MAQL statement for a project.
upload PROJECT MANIFEST
Upload and integrate a new data load via Single Loading Interface
(SLI).
uploads FILE_PATH FILE UPLOAD_PATH
Uploads to WebDAV service.
poll TASK_URL
Periodically checks status of task page and check
'wTaskStatus':'status' for 'RUNNING'.
Returns undef is status is OK.
create_object_with_expression PROJECT URI TYPE TITLE SUMMARY EXPRESSION
Create a new metadata object of type TYPE with EXPRESSION as the
only content.
create_report_definition PROJECT URI TITLE SUMMARY METRICS DIM FILTERS
Create a new reportDefinition in metadata.
DESTROY
Log out the session with logout unless not logged in.
dd_pull PROJECT ZIP_FILE DATASETS
Integrate a custom date dimension load via Single Loading Interface
(SLI).
SEE ALSO
* <http://developer.gooddata.com/api/> -- API documentation
* <https://secure.gooddata.com/gdc/> -- Browsable GoodData API
* WWW::GoodData::Agent -- GoodData API-aware user agent
CAVEATS
* uploads()
Don't check, when collection exists.
LICENSE AND COPYRIGHT
Copyright 2017 Michal Josef Spacek
Copyright 2011, 2012, 2013 Lubomir Rintel
Copyright 2012, 2013 Adam Stulpa, Jan Orel, Tomas Janousek
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
AUTHORS
Tomas Janousek "tomi@nomi.cz"
Jan Orel "jan.orel@gooddata.com"
Lubomir Rintel "lkundrak@v3.sk"
Michal Josef Spacek "michal.spacek@gooddata.com"
Adam Stulpa "adam.stulpa@gooddata.com"