FlatApi::CollectionApi

All URIs are relative to https://api.flat.io/v2

Method	HTTP request	Description
add_score_to_collection	PUT /collections/{collection}/scores/{score}	Add a score to the collection
create_collection	POST /collections	Create a new collection
delete_collection	DELETE /collections/{collection}	Delete the collection
delete_score_from_collection	DELETE /collections/{collection}/scores/{score}	Delete a score from the collection
edit_collection	PUT /collections/{collection}	Update a collection's metadata
get_collection	GET /collections/{collection}	Get collection details
list_collection_scores	GET /collections/{collection}/scores	List the scores contained in a collection
list_collections	GET /collections	List the collections
untrash_collection	POST /collections/{collection}/untrash	Untrash a collection

add_score_to_collection

add_score_to_collection(collection, score, opts)

Add a score to the collection

This operation will add a score to a collection. The default behavior will make the score available across multiple collections. You must have the capability canAddScores on the provided collection to perform the action.

Examples

require 'time'
require 'flat_api'
# setup authorization
FlatApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = FlatApi::CollectionApi.new
collection = 'collection_example' # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
score = 'score_example' # String | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). 
opts = {
  sharing_key: 'sharing_key_example' # String | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. 
}

begin
  # Add a score to the collection
  result = api_instance.add_score_to_collection(collection, score, opts)
  p result
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->add_score_to_collection: #{e}"
end

Using the add_score_to_collection_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> add_score_to_collection_with_http_info(collection, score, opts)

begin
  # Add a score to the collection
  data, status_code, headers = api_instance.add_score_to_collection_with_http_info(collection, score, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ScoreDetails>
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->add_score_to_collection_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
collection	String	Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
score	String	Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
sharing_key	String	This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.	[optional]

Return type

ScoreDetails

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

create_collection

create_collection(body)

Create a new collection

This method will create a new collection and add it to your root collection.

Examples

require 'time'
require 'flat_api'
# setup authorization
FlatApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = FlatApi::CollectionApi.new
body = FlatApi::CollectionCreation.new({title: 'title_example', privacy: FlatApi::CollectionPrivacy::PRIVATE}) # CollectionCreation | 

begin
  # Create a new collection
  result = api_instance.create_collection(body)
  p result
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->create_collection: #{e}"
end

Using the create_collection_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_collection_with_http_info(body)

begin
  # Create a new collection
  data, status_code, headers = api_instance.create_collection_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Collection>
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->create_collection_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	CollectionCreation

Return type

Collection

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

delete_collection

delete_collection(collection)

Delete the collection

This method will schedule the deletion of the collection. Until deleted, the collection will be available in the trash.

Examples

require 'time'
require 'flat_api'
# setup authorization
FlatApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = FlatApi::CollectionApi.new
collection = 'collection_example' # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 

begin
  # Delete the collection
  api_instance.delete_collection(collection)
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->delete_collection: #{e}"
end

Using the delete_collection_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_collection_with_http_info(collection)

begin
  # Delete the collection
  data, status_code, headers = api_instance.delete_collection_with_http_info(collection)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->delete_collection_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
collection	String	Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted

Return type

nil (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_score_from_collection

delete_score_from_collection(collection, score, opts)

Delete a score from the collection

This method will delete a score from the collection. Unlike DELETE /scores/{score}, this score will not remove the score from your account, but only from the collection. This can be used to move a score from one collection to another, or simply remove a score from one collection when this one is contained in multiple collections.

Examples

require 'time'
require 'flat_api'
# setup authorization
FlatApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = FlatApi::CollectionApi.new
collection = 'collection_example' # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
score = 'score_example' # String | Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`). 
opts = {
  sharing_key: 'sharing_key_example' # String | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. 
}

begin
  # Delete a score from the collection
  api_instance.delete_score_from_collection(collection, score, opts)
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->delete_score_from_collection: #{e}"
end

Using the delete_score_from_collection_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_score_from_collection_with_http_info(collection, score, opts)

begin
  # Delete a score from the collection
  data, status_code, headers = api_instance.delete_score_from_collection_with_http_info(collection, score, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->delete_score_from_collection_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
collection	String	Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
score	String	Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
sharing_key	String	This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.	[optional]

Return type

nil (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

edit_collection

edit_collection(collection, body)

Update a collection's metadata

Examples

require 'time'
require 'flat_api'
# setup authorization
FlatApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = FlatApi::CollectionApi.new
collection = 'collection_example' # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
body = FlatApi::CollectionModification.new # CollectionModification | 

begin
  # Update a collection's metadata
  result = api_instance.edit_collection(collection, body)
  p result
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->edit_collection: #{e}"
end

Using the edit_collection_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> edit_collection_with_http_info(collection, body)

begin
  # Update a collection's metadata
  data, status_code, headers = api_instance.edit_collection_with_http_info(collection, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Collection>
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->edit_collection_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
collection	String	Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
body	CollectionModification

Return type

Collection

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

get_collection

get_collection(collection, opts)

Get collection details

Examples

require 'time'
require 'flat_api'
# setup authorization
FlatApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = FlatApi::CollectionApi.new
collection = 'collection_example' # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
opts = {
  sharing_key: 'sharing_key_example' # String | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. 
}

begin
  # Get collection details
  result = api_instance.get_collection(collection, opts)
  p result
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->get_collection: #{e}"
end

Using the get_collection_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_collection_with_http_info(collection, opts)

begin
  # Get collection details
  data, status_code, headers = api_instance.get_collection_with_http_info(collection, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Collection>
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->get_collection_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
collection	String	Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
sharing_key	String	This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.	[optional]

Return type

Collection

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

list_collection_scores

<Array> list_collection_scores(collection, opts)

List the scores contained in a collection

Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by modificationDate desc. For example, to list the scores contained in your app collection, you can use GET /v2/collections/app/scores.

Examples

require 'time'
require 'flat_api'
# setup authorization
FlatApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = FlatApi::CollectionApi.new
collection = 'collection_example' # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 
opts = {
  sharing_key: 'sharing_key_example', # String | This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. 
  sort: 'creationDate', # String | Sort
  direction: 'asc', # String | Sort direction
  limit: 56, # Integer | This is the maximum number of objects that may be returned
  _next: '_next_example', # String | An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
  previous: 'previous_example' # String | An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
}

begin
  # List the scores contained in a collection
  result = api_instance.list_collection_scores(collection, opts)
  p result
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->list_collection_scores: #{e}"
end

Using the list_collection_scores_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> list_collection_scores_with_http_info(collection, opts)

begin
  # List the scores contained in a collection
  data, status_code, headers = api_instance.list_collection_scores_with_http_info(collection, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<ScoreDetails>>
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->list_collection_scores_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
collection	String	Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted
sharing_key	String	This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.	[optional]
sort	String	Sort	[optional]
direction	String	Sort direction	[optional]
limit	Integer	This is the maximum number of objects that may be returned	[optional][default to 25]
_next	String	An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.	[optional]
previous	String	An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.	[optional]

Return type

Array<ScoreDetails>

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

list_collections

<Array> list_collections(opts)

List the collections

Use this method to list the user's collections contained in parent (by default in the root collection). If no sort option is provided, the collections are sorted by creationDate desc. Note that this method will not include the parent collection in the listing. For example, if you need the details of the root collection, you can use GET /v2/collections/root. To fetch your app collection details, you can use GET /v2/collections/app.

Examples

require 'time'
require 'flat_api'
# setup authorization
FlatApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = FlatApi::CollectionApi.new
opts = {
  parent: 'parent_example', # String | List the collection contained in this `parent` collection.  This option doesn't provide a complete multi-level collection support. When sharing a collection with someone, this one will have as `parent` `sharedWithMe`. 
  sort: 'creationDate', # String | Sort
  direction: 'asc', # String | Sort direction
  limit: 56, # Integer | This is the maximum number of objects that may be returned
  _next: '_next_example', # String | An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
  previous: 'previous_example' # String | An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
}

begin
  # List the collections
  result = api_instance.list_collections(opts)
  p result
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->list_collections: #{e}"
end

Using the list_collections_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> list_collections_with_http_info(opts)

begin
  # List the collections
  data, status_code, headers = api_instance.list_collections_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<Collection>>
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->list_collections_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
parent	String	List the collection contained in this `parent` collection. This option doesn't provide a complete multi-level collection support. When sharing a collection with someone, this one will have as `parent` `sharedWithMe`.	[optional][default to 'root']
sort	String	Sort	[optional]
direction	String	Sort direction	[optional]
limit	Integer	This is the maximum number of objects that may be returned	[optional][default to 25]
_next	String	An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.	[optional]
previous	String	An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.	[optional]

Return type

Array<Collection>

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

untrash_collection

untrash_collection(collection)

Untrash a collection

This method will restore the collection by removing it from the trash and add it back to the root collection.

Examples

require 'time'
require 'flat_api'
# setup authorization
FlatApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = FlatApi::CollectionApi.new
collection = 'collection_example' # String | Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted 

begin
  # Untrash a collection
  api_instance.untrash_collection(collection)
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->untrash_collection: #{e}"
end

Using the untrash_collection_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> untrash_collection_with_http_info(collection)

begin
  # Untrash a collection
  data, status_code, headers = api_instance.untrash_collection_with_http_info(collection)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue FlatApi::ApiError => e
  puts "Error when calling CollectionApi->untrash_collection_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
collection	String	Unique identifier of the collection. The following aliases are supported: - `root`: The root collection of the account - `app`: Alias for the current app collection - `sharedWithMe`: Automatically contains new resources that have been shared individually - `trash`: Automatically contains resources that have been deleted

Return type

nil (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

CollectionApi.md

Latest commit

History

CollectionApi.md

File metadata and controls

FlatApi::CollectionApi

add_score_to_collection

Examples

Using the add_score_to_collection_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

create_collection

Examples

Using the create_collection_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_collection

Examples

Using the delete_collection_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_score_from_collection

Examples

Using the delete_score_from_collection_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

edit_collection

Examples

Using the edit_collection_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_collection

Examples

Using the get_collection_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

list_collection_scores

Examples

Using the list_collection_scores_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

list_collections

Examples

Using the list_collections_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

untrash_collection

Examples

Using the untrash_collection_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers