Project

ubiquity-mediasilo-api-v3

0.0
No commit activity in last 3 years
No release in over 3 years
ubiquity-mediasilo-api-v3xplatform-consulting/ubiquity-mediasilo-api-v3HomepageDocumentationSource CodeBug TrackerWiki
A Library and Utilities to Interact with the MediaSilo API v3
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,201
Stars
0
Forks
0
Watchers
3
 Releases
Current version
1.0.0
Total releases
1
First release
2018-05-08
Latest release
2018-05-08
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2015-08-01
Reverse Dependencies
1

 Dependencies

Development

bundler
~> 1.6
rake
~> 10.0
 Project Readme

Ubiquity::Mediasilo::Api::V3

A Library and Utilities to Interact with the MediaSilo API v3

Installation

Add this line to your application's Gemfile:

gem 'ubiquity-mediasilo-api-v3'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ubiquity-mediasilo-api-v3

MediaSilo API V3 Executable bin/ubiquity-mediasilo-api-v3

An executable to interact with the MediaSilo API

Usage

Usage:

    ubiquity-mediasilo-api-v3 -h | --help
    ubiquity-mediasilo-api-v3 --hostname <HOSTNAME> --username <USERNAME> --password <PASSWORD> --method-name <METHOD NAME> --method-arguments <JSON>

Options:
        --hostname HOSTNAME          The hostname to authenticate with.
        --username USERNAME          The username to authenticate with.
        --password PASSWORD          The password to authenticate with.
        --method-name METHODNAME     The name of the method to call.
        --method-arguments JSON      The arguments to pass when calling the method.
        --pretty-print               Will format the output to be more human readable.
        --[no-]options-file [FILENAME]
                                     Path to a file which contains default command line arguments.
                                      default: ~/.options/ubiquity-mediasilo-api-v3
    -h, --help                       Display this message.

Examples

Assets
Asset Copy to Folder
Asset Copy to Project
Asset Create (Create a new asset)
ubiquity-mediasilo-api-v3 --hostname <HOSTNAME> --username <USERNAME> --password <PASSWORD> --method-name asset_create --method-arguments '{"project_id":"<PROJECT ID (GUID)>","source_url":"<SOURCE URL"}'

- project_id [String] (Required) The ID of the Project this asset belongs to.
- folder_id [String] The ID of the Folder this asset belongs to.
- title [String] Defaults to filename
- description [String] A brief description of the asset
- source_url [String] Must be a publicly-accessible URL. NOTE: ** SPACES MUST BE REPLACED WITH a plus '+'
- is_private [Boolean] If set to true, only authorized users can view the asset (this value may be overridden by account settings)
Asset Delete
ubiquity-mediasilo-api-v3 --hostname <HOSTNAME> --username <USERNAME> --password <PASSWORD> --method-name asset_create --method-arguments '{"asset_id":"<ASSET ID (GUID)>"}'

- asset_id [String] (Required) The id of the asset to delete.
Projects
Project Create (Create a project])
ubiquity-mediasilo-api-v3 --hostname <HOSTNAME> --username <USERNAME> --password <PASSWORD> --method-name project_create --method-arguments '{"name":"<PROJECT NAME>"}'

- name [String] (Required) Name of the project.
- description [String] Description of the project.
Project Delete (Delete a project])
ubiquity-mediasilo-api-v3 --hostname <HOSTNAME> --username <USERNAME> --password <PASSWORD> --method-name project_delete --method-arguments '{"id":"<PROJECT ID (GUID)>"}'

- project_id [String] (Required) The id of the project to delete.
Project Get by Id (Retrieve a project)
ubiquity-mediasilo-api-v3 --hostname <HOSTNAME> --username <USERNAME> --password <PASSWORD> --method-name project_get_by_id --method-arguments '{"id":"<PROJECT ID (GUID)>"}'

- id [String] (Required) Id (GUID) of the project.

Contributing

  1. Fork it ( https://github.com/XPlatform-Consulting/ubiquity-mediasilo-api-v3/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request