Module: FileboundClient::Endpoints::Query

Defined in:
lib/filebound_client/endpoints/query.rb

Overview

Module for Query resource endpoint

Instance Method Summary collapse

Instance Method Details

#query(projects_query, files_query, documents_query, query_params = nil) ⇒ Object

Runs a query against the API using the project, files and documents query supplied. See applications.filebound.com/v3/documentation/endpoints#Custom+Query for more detail.

Examples:

Get project named Invoices with Files that have a status of 1 and documents with a divider named HR

query('name_Invoices','status_1','divider_HR')

Parameters:

  • projects_query (String) —

    the comma-delimited projects query, pass ‘all’ for no filter (ex: name_Invoices)

  • files_query (String) —

    the comma-delimited files query, pass ‘all’ for no filter (ex: status_1)

  • documents_query (String) —

    the comma-delimited documents query, pass ‘all’ for no filter (ex: divider_HR)



12
13
14
 
# File 'lib/filebound_client/endpoints/query.rb', line 12

def query(projects_query, files_query, documents_query, query_params = nil)
  get("/query/#{projects_query}/#{files_query}/#{documents_query}", query_params)
end