alfresco

Alfresco - the Ruby gem for the Alfresco Content Services REST API

Search API Provides access to the search features of Alfresco Content Services.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Add this to the Gemfile:

gem 'alfresco', '~> 1.0.0'

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'alfresco'

# Setup authorization
Alfresco.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.host = 'YOUR HOST'
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Alfresco::SearchApi.new

query_body = Alfresco::SearchRequest.new # SearchRequest | Generic query API


begin
  #Searches Alfresco
  result = api_instance.search(query_body)
  p result
rescue Alfresco::ApiError => e
  puts "Exception when calling SearchApi->search: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://localhost/alfresco/api/-default-/public/search/versions/1

Class	Method	HTTP request	Description
Alfresco::SearchApi	search	POST /search	Searches Alfresco

Documentation for Models

• Alfresco::ContentInfo
• Alfresco::Error
• Alfresco::ErrorError
• Alfresco::GenericBucket
• Alfresco::GenericBucketBucketInfo
• Alfresco::GenericFacetResponse
• Alfresco::GenericMetric
• Alfresco::Node
• Alfresco::Pagination
• Alfresco::PathElement
• Alfresco::PathInfo
• Alfresco::RequestDefaults
• Alfresco::RequestFacetField
• Alfresco::RequestFacetFields
• Alfresco::RequestFacetIntervals
• Alfresco::RequestFacetIntervalsIntervals
• Alfresco::RequestFacetQueries
• Alfresco::RequestFacetQueriesInner
• Alfresco::RequestFacetSet
• Alfresco::RequestFields
• Alfresco::RequestFilterQueries
• Alfresco::RequestFilterQueriesInner
• Alfresco::RequestHighlight
• Alfresco::RequestHighlightFields
• Alfresco::RequestInclude
• Alfresco::RequestLimits
• Alfresco::RequestLocalization
• Alfresco::RequestPagination
• Alfresco::RequestPivot
• Alfresco::RequestQuery
• Alfresco::RequestRange
• Alfresco::RequestScope
• Alfresco::RequestSortDefinition
• Alfresco::RequestSortDefinitionInner
• Alfresco::RequestSpellcheck
• Alfresco::RequestStats
• Alfresco::RequestTemplates
• Alfresco::RequestTemplatesInner
• Alfresco::ResponseConsistency
• Alfresco::ResultBuckets
• Alfresco::ResultBucketsBuckets
• Alfresco::ResultNode
• Alfresco::ResultSetContext
• Alfresco::ResultSetContextFacetQueries
• Alfresco::ResultSetContextSpellcheck
• Alfresco::ResultSetPaging
• Alfresco::ResultSetPagingList
• Alfresco::ResultSetRowEntry
• Alfresco::SearchEntry
• Alfresco::SearchEntryHighlight
• Alfresco::SearchRequest
• Alfresco::UserInfo

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication