WWW::SmartSheet - Interface to SmartSheet API v2.
version 0.06
returns a hash of info on the current user
optional parameters default to $pagesize=100 and $page=1 sample returned info:
{ "pageNumber": 1, "pageSize": 100, "totalPages": 1, "totalCount": 2, "data": [ { "accessLevel": "OWNER", "id": 4583173393803140, "name": "sheet 1", "permalink": "https://app.smartsheet.com/b/home?lx=xUefSOIYmn07iJJesvSHCQ", "createdAt": "2015-06-05T20:05:29Z", "modifiedAt": "2015-06-05T20:05:43Z" }, { "accessLevel": "OWNER", "id": 2331373580117892, "name": "sheet 2", "permalink": "https://app.smartsheet.com/b/home?lx=xUefSOIYmn07iJJrthEFTG", "createdAt": "2015-06-05T20:05:29Z", "modifiedAt": "2015-06-05T20:05:43Z" } ] }
http://smartsheet-platform.github.io/api-docs/#get-all-columns Takes a sheetid and returns "IndexResult Object containing an array of Column Objects"
Example Response: { "pageNumber": 1, "pageSize": 100, "totalPages": 1, "totalCount": 3, "data": [ { "id": 7960873114331012, "index": 0, "symbol": "STAR", "title": "Favorite", "type": "CHECKBOX", "validation": false }, { "id": 642523719853956, "index": 1, "primary": true, "title": "Primary Column", "type": "TEXT_NUMBER", "validation": false }, { "id": 5146123347224452, "index": 2, "title": "Status", "type": "PICKLIST", "validation": false } ] }
sheet_id email => 'foo@examples.com', access_level => one of the following strings: VIEWER EDITOR EDITOR_SHARE ADMIN
Note: This only creates a new share and will not update or delete an exising one
Sample returned data:
{ "resultCode": 0, "result": [ { "id": "AAAFeF82FOeE", "type": "USER", "userId": 1539725208119172, "email": "jane.doe@smartsheet.com", "name": "Jane Doe", "accessLevel": "EDITOR", "scope": "ITEM" } ], "message": "SUCCESS" }
Uses "Create Sheet in 'Sheets' folder" (http://smartsheet-platform.github.io/api-docs/#create-sheet-in-quot-sheets-quot-folder)
Requires, name of sheet, columns (title, primary, type)
$w->create_sheet( name => 'Name of the sheet', columns => [ { title => "Baked Good", type => 'TEXT_NUMBER', primary => 1 }, { title => 'Baker', type => 'CONTACT_LIST' }, { title => 'Price Per Item', type => 'TEXT_NUMBER' }, { title => "Gluten Free?", "type" => "CHECKBOX", "symbol" => "FLAG"}, { title => 'Status', type => 'PICKLIST', options => ['Started', 'Finished' , 'Delivered'] } ] );
Returns:
{ 'resultCode' => 0, 'result' => { 'id' => '2331373580117892', 'permalink' => 'https://app.smartsheet.com/b/home?lx=0HHzeGnfHik-N13ZT8pU7g', 'name' => 'Name of the sheet', 'accessLevel' => 'OWNER', 'columns' => [ { 'index' => 0, 'primary' => bless( do{\(my $o = 1)}, 'JSON::PP::Boolean' ), 'width' => 150, 'type' => 'TEXT_NUMBER', 'validation' => bless( do{\(my $o = 0)}, 'JSON::PP::Boolean' ), 'title' => 'Baked Good', 'id' => '7960873114331012' }, { 'id' => '6430209165167777', 'validation' => $VAR1->{'result'}{'columns'}[0]{'validation'}, 'title' => 'Baker', 'type' => 'CONTACT_LIST', 'width' => 150, 'index' => 1 }, { 'validation' => $VAR1->{'result'}{'columns'}[0]{'validation'}, 'title' => 'Price Per Item', 'id' => '3580578411771296', 'type' => 'TEXT_NUMBER', 'width' => 150, 'index' => 2 }, { 'id' => '7306226134567921', 'validation' => $VAR1->{'result'}{'columns'}[0]{'validation'}, 'title' => 'Gluten Free?', 'symbol' => 'FLAG', 'type' => 'CHECKBOX', 'width' => 150, 'index' => 3 }, { 'validation' => $VAR1->{'result'}{'columns'}[0]{'validation'}, 'title' => 'Status', 'id' => '1425783243468763', 'type' => 'PICKLIST', 'options' => [ 'Started', 'Finished', 'Delivered' ], 'width' => 150, 'index' => 4 } ] }, 'message' => 'SUCCESS' };
Given sheetid, deletes the sheet.
multiple columns can be added at one time
$w->add_column( $sheet_id, [ { title => 'Delivered', type => 'DATE', index => 5}, { title => 'AnotherCol', type => 'TEXT_NUMBER', index => 5} ] );
returns
{ "resultCode": 0, "result": [ { "id": 4503594425063547, "index": 4, "title": "New Date Column", "type": "DATE", "validation": true, "width": 150 }, { "id": 9007194052434043, "index": 4, "title": "New Picklist Column 1", "type": "TEST_NUMBER", "width": 150 } ], "message": "SUCCESS" }
curl https://api.smartsheet.com/2.0/sheets/{sheetId}/rows \ -H "Authorization: Bearer ll352u9jujauoqz4gstvsae05" \ -H "Content-Type: application/json" \ -X POST \ -d '[{"toTop":true, "cells": [ {"columnId": 7960873114331012, "value": true}, {"columnId": 642523719853956, "value": "New status", "strict": false} ] }, {"toTop":true, "cells": [ {"columnId": 7960873114331012, "value": true}, {"columnId": 642523719853956, "value": "New status", "strict": false} ] }]'
$location can be: toTop, toBottom, parentId=<rowid>, or "siblingId=<rowid>,above" (or leave off ,above for below)
$w->insert_rows($sheet_id, $location, @rows);
@rows should be something like
[ [ {"columnId" => 7960873114331012, "value" => JSON::true}, {"columnId" => 642523719853956, "value" => "New status 1", "strict" => false} ], [ {"columnId" => 7960873114331012, "value" => JSON::false}, {"columnId" => 642523719853956, "value" => "New status 2", "strict" => false} ] ]
Note: JSON::true instead of "true" or 1 is necessary
Given sheet id, returns the entire sheet:
{ "accessLevel": "OWNER", "projectSettings": { "workingDays": [ "MONDAY", "TUESDAY", "WEDNESDAY" ], "nonWorkingDays": [ "2018-01-01" ], "lengthOfDay": 6 }, "columns": [ { "id": 4583173393803140, "index": 0, "primary": true, "title": "Primary Column", "type": "TEXT_NUMBER", "validation": false }, { "id": 2331373580117892, "index": 1, "options": [ "new", "in progress", "completed" ], "title": "status", "type": "PICKLIST", "validation": true } ], "createdAt": "2012-07-24T18:22:29-07:00", "id": 4583173393803140, "modifiedAt": "2012-07-24T18:30:52-07:00", "name": "sheet 1", "permalink": "https://app.smartsheet.com/b/home?lx=pWNSDH9itjBXxBzFmyf-5w", "rows": [] }
The code of this client is free software. Access to the services of Smartsheet requires registration and payment.
API Documentation
Probably needs a get_all_sheet_shares, update_sheet_share, delete_sheet_share, delete_column
Gabor Szabo <szabgab@cpan.org>
This software is copyright (c) 2018 by Gabor Szabo.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install WWW::SmartSheet, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WWW::SmartSheet
CPAN shell
perl -MCPAN -e shell install WWW::SmartSheet
For more information on module installation, please visit the detailed CPAN module installation guide.