alfresco_api

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

Core API Provides access to the core 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

gem 'alfresco_api', '~> 1.0.0'

Install from Git

gem 'alfresco_api', :git => 'https://github.com/elissonmichael/alfresco_api_ruby.git'

Getting Started

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

# Load the gem
require 'alfresco_api'

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

api_instance = AlfrescoAPI::ActivitiesApi.new

person_id = "person_id_example" # String | The identifier of a person.

opts = {
  skip_count: 0, # Integer | The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0.
  max_items: 100, # Integer | The maximum number of items to return in the list.  If not supplied then the default value is 100.
  who: "who_example", # String | A filter to include the user's activities only `me`, other user's activities only `others`'
  site_id: "site_id_example", # String | Include only activity feed entries relating to this site.
  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
}

begin
  #List activities
  result = api_instance.list_activities_for_person(person_id, opts)
  p result
rescue AlfrescoAPI::ApiError => e
  puts "Exception when calling ActivitiesApi->list_activities_for_person: #{e}"
end

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AlfrescoAPI::ActivitiesApi	list_activities_for_person	GET /people/personId/activities	List activities
AlfrescoAPI::AuditApi	delete_audit_entries_for_audit_app	DELETE /audit-applications/auditApplicationId/audit-entries	Permanently delete audit entries for an audit application
AlfrescoAPI::AuditApi	delete_audit_entry	DELETE /audit-applications/auditApplicationId/audit-entries/auditEntryId	Permanently delete an audit entry
AlfrescoAPI::AuditApi	get_audit_app	GET /audit-applications/auditApplicationId	Get audit application info
AlfrescoAPI::AuditApi	get_audit_entry	GET /audit-applications/auditApplicationId/audit-entries/auditEntryId	Get audit entry
AlfrescoAPI::AuditApi	list_audit_apps	GET /audit-applications	List audit applications
AlfrescoAPI::AuditApi	list_audit_entries_for_audit_app	GET /audit-applications/auditApplicationId/audit-entries	List audit entries for an audit application
AlfrescoAPI::AuditApi	list_audit_entries_for_node	GET /nodes/nodeId/audit-entries	List audit entries for a node
AlfrescoAPI::AuditApi	update_audit_app	PUT /audit-applications/auditApplicationId	Update audit application info
AlfrescoAPI::CommentsApi	create_comment	POST /nodes/nodeId/comments	Create a comment
AlfrescoAPI::CommentsApi	delete_comment	DELETE /nodes/nodeId/comments/commentId	Delete a comment
AlfrescoAPI::CommentsApi	list_comments	GET /nodes/nodeId/comments	List comments
AlfrescoAPI::CommentsApi	update_comment	PUT /nodes/nodeId/comments/commentId	Update a comment
AlfrescoAPI::DownloadsApi	cancel_download	DELETE /downloads/downloadId	Cancel a download
AlfrescoAPI::DownloadsApi	create_download	POST /downloads	Create a new download
AlfrescoAPI::DownloadsApi	get_download	GET /downloads/downloadId	Get a download
AlfrescoAPI::FavoritesApi	create_favorite	POST /people/personId/favorites	Create a favorite
AlfrescoAPI::FavoritesApi	create_site_favorite	POST /people/personId/favorite-sites	Create a site favorite
AlfrescoAPI::FavoritesApi	delete_favorite	DELETE /people/personId/favorites/favoriteId	Delete a favorite
AlfrescoAPI::FavoritesApi	delete_site_favorite	DELETE /people/personId/favorite-sites/siteId	Delete a site favorite
AlfrescoAPI::FavoritesApi	get_favorite	GET /people/personId/favorites/favoriteId	Get a favorite
AlfrescoAPI::FavoritesApi	get_favorite_site	GET /people/personId/favorite-sites/siteId	Get a favorite site
AlfrescoAPI::FavoritesApi	list_favorite_sites_for_person	GET /people/personId/favorite-sites	List favorite sites
AlfrescoAPI::FavoritesApi	list_favorites	GET /people/personId/favorites	List favorites
AlfrescoAPI::GroupsApi	create_group	POST /groups	Create a group
AlfrescoAPI::GroupsApi	create_group_membership	POST /groups/groupId/members	Create a group membership
AlfrescoAPI::GroupsApi	delete_group	DELETE /groups/groupId	Delete a group
AlfrescoAPI::GroupsApi	delete_group_membership	DELETE /groups/groupId/members/groupMemberId	Delete a group membership
AlfrescoAPI::GroupsApi	get_group	GET /groups/groupId	Get group details
AlfrescoAPI::GroupsApi	list_group_memberships	GET /groups/groupId/members	List memberships of a group
AlfrescoAPI::GroupsApi	list_group_memberships_for_person	GET /people/personId/groups	List group memberships
AlfrescoAPI::GroupsApi	list_groups	GET /groups	List groups
AlfrescoAPI::GroupsApi	update_group	PUT /groups/groupId	Update group details
AlfrescoAPI::NetworksApi	get_network	GET /networks/networkId	Get a network
AlfrescoAPI::NetworksApi	get_network_for_person	GET /people/personId/networks/networkId	Get network information
AlfrescoAPI::NetworksApi	list_networks_for_person	GET /people/personId/networks	List network membership
AlfrescoAPI::NodesApi	copy_node	POST /nodes/nodeId/copy	Copy a node
AlfrescoAPI::NodesApi	create_assocation	POST /nodes/nodeId/targets	Create node association
AlfrescoAPI::NodesApi	create_node	POST /nodes/nodeId/children	Create a node
AlfrescoAPI::NodesApi	create_secondary_child_assocation	POST /nodes/nodeId/secondary-children	Create secondary child
AlfrescoAPI::NodesApi	delete_assocation	DELETE /nodes/nodeId/targets/targetId	Delete node association(s)
AlfrescoAPI::NodesApi	delete_node	DELETE /nodes/nodeId	Delete a node
AlfrescoAPI::NodesApi	delete_secondary_child_assocation	DELETE /nodes/nodeId/secondary-children/childId	Delete secondary child or children
AlfrescoAPI::NodesApi	get_node	GET /nodes/nodeId	Get a node
AlfrescoAPI::NodesApi	get_node_content	GET /nodes/nodeId/content	Get node content
AlfrescoAPI::NodesApi	list_node_children	GET /nodes/nodeId/children	List node children
AlfrescoAPI::NodesApi	list_parents	GET /nodes/nodeId/parents	List parents
AlfrescoAPI::NodesApi	list_secondary_children	GET /nodes/nodeId/secondary-children	List secondary children
AlfrescoAPI::NodesApi	list_source_associations	GET /nodes/nodeId/sources	List source associations
AlfrescoAPI::NodesApi	list_target_associations	GET /nodes/nodeId/targets	List target associations
AlfrescoAPI::NodesApi	lock_node	POST /nodes/nodeId/lock	Lock a node
AlfrescoAPI::NodesApi	move_node	POST /nodes/nodeId/move	Move a node
AlfrescoAPI::NodesApi	unlock_node	POST /nodes/nodeId/unlock	Unlock a node
AlfrescoAPI::NodesApi	update_node	PUT /nodes/nodeId	Update a node
AlfrescoAPI::NodesApi	update_node_content	PUT /nodes/nodeId/content	Update node content
AlfrescoAPI::PeopleApi	create_person	POST /people	Create person
AlfrescoAPI::PeopleApi	delete_avatar_image	DELETE /people/personId/avatar	Delete avatar image
AlfrescoAPI::PeopleApi	get_avatar_image	GET /people/personId/avatar	Get avatar image
AlfrescoAPI::PeopleApi	get_person	GET /people/personId	Get a person
AlfrescoAPI::PeopleApi	list_people	GET /people	List people
AlfrescoAPI::PeopleApi	request_password_reset	POST /people/personId/request-password-reset	Request password reset
AlfrescoAPI::PeopleApi	reset_password	POST /people/personId/reset-password	Reset password
AlfrescoAPI::PeopleApi	update_avatar_image	PUT /people/personId/avatar	Update avatar image
AlfrescoAPI::PeopleApi	update_person	PUT /people/personId	Update person
AlfrescoAPI::PreferencesApi	get_preference	GET /people/personId/preferences/preferenceName	Get a preference
AlfrescoAPI::PreferencesApi	list_preferences	GET /people/personId/preferences	List preferences
AlfrescoAPI::QueriesApi	find_nodes	GET /queries/nodes	Find nodes
AlfrescoAPI::QueriesApi	find_people	GET /queries/people	Find people
AlfrescoAPI::QueriesApi	find_sites	GET /queries/sites	Find sites
AlfrescoAPI::RatingsApi	create_rating	POST /nodes/nodeId/ratings	Create a rating
AlfrescoAPI::RatingsApi	delete_rating	DELETE /nodes/nodeId/ratings/ratingId	Delete a rating
AlfrescoAPI::RatingsApi	get_rating	GET /nodes/nodeId/ratings/ratingId	Get a rating
AlfrescoAPI::RatingsApi	list_ratings	GET /nodes/nodeId/ratings	List ratings
AlfrescoAPI::RenditionsApi	create_rendition	POST /nodes/nodeId/renditions	Create rendition
AlfrescoAPI::RenditionsApi	get_rendition	GET /nodes/nodeId/renditions/renditionId	Get rendition information
AlfrescoAPI::RenditionsApi	get_rendition_content	GET /nodes/nodeId/renditions/renditionId/content	Get rendition content
AlfrescoAPI::RenditionsApi	list_renditions	GET /nodes/nodeId/renditions	List renditions
AlfrescoAPI::SharedlinksApi	create_shared_link	POST /shared-links	Create a shared link to a file
AlfrescoAPI::SharedlinksApi	delete_shared_link	DELETE /shared-links/sharedId	Deletes a shared link
AlfrescoAPI::SharedlinksApi	email_shared_link	POST /shared-links/sharedId/email	Email shared link
AlfrescoAPI::SharedlinksApi	get_shared_link	GET /shared-links/sharedId	Get a shared link
AlfrescoAPI::SharedlinksApi	get_shared_link_content	GET /shared-links/sharedId/content	Get shared link content
AlfrescoAPI::SharedlinksApi	get_shared_link_rendition	GET /shared-links/sharedId/renditions/renditionId	Get shared link rendition information
AlfrescoAPI::SharedlinksApi	get_shared_link_rendition_content	GET /shared-links/sharedId/renditions/renditionId/content	Get shared link rendition content
AlfrescoAPI::SharedlinksApi	list_shared_link_renditions	GET /shared-links/sharedId/renditions	List renditions for a shared link
AlfrescoAPI::SharedlinksApi	list_shared_links	GET /shared-links	List shared links
AlfrescoAPI::SitesApi	create_site	POST /sites	Create a site
AlfrescoAPI::SitesApi	create_site_membership	POST /sites/siteId/members	Create a site membership
AlfrescoAPI::SitesApi	create_site_membership_request_for_person	POST /people/personId/site-membership-requests	Create a site membership request
AlfrescoAPI::SitesApi	delete_site	DELETE /sites/siteId	Delete a site
AlfrescoAPI::SitesApi	delete_site_membership	DELETE /sites/siteId/members/personId	Delete a site membership
AlfrescoAPI::SitesApi	delete_site_membership_for_person	DELETE /people/personId/sites/siteId	Delete a site membership
AlfrescoAPI::SitesApi	delete_site_membership_request_for_person	DELETE /people/personId/site-membership-requests/siteId	Delete a site membership request
AlfrescoAPI::SitesApi	get_site	GET /sites/siteId	Get a site
AlfrescoAPI::SitesApi	get_site_container	GET /sites/siteId/containers/containerId	Get a site container
AlfrescoAPI::SitesApi	get_site_membership	GET /sites/siteId/members/personId	Get a site membership
AlfrescoAPI::SitesApi	get_site_membership_for_person	GET /people/personId/sites/siteId	Get a site membership
AlfrescoAPI::SitesApi	get_site_membership_request_for_person	GET /people/personId/site-membership-requests/siteId	Get a site membership request
AlfrescoAPI::SitesApi	list_site_containers	GET /sites/siteId/containers	List site containers
AlfrescoAPI::SitesApi	list_site_membership_requests_for_person	GET /people/personId/site-membership-requests	List site membership requests
AlfrescoAPI::SitesApi	list_site_memberships	GET /sites/siteId/members	List site memberships
AlfrescoAPI::SitesApi	list_site_memberships_for_person	GET /people/personId/sites	List site memberships
AlfrescoAPI::SitesApi	list_sites	GET /sites	List sites
AlfrescoAPI::SitesApi	update_site	PUT /sites/siteId	Update a site
AlfrescoAPI::SitesApi	update_site_membership	PUT /sites/siteId/members/personId	Update a site membership
AlfrescoAPI::SitesApi	update_site_membership_request_for_person	PUT /people/personId/site-membership-requests/siteId	Update a site membership request
AlfrescoAPI::TagsApi	create_tag_for_node	POST /nodes/nodeId/tags	Create a tag for a node
AlfrescoAPI::TagsApi	delete_tag_from_node	DELETE /nodes/nodeId/tags/tagId	Delete a tag from a node
AlfrescoAPI::TagsApi	get_tag	GET /tags/tagId	Get a tag
AlfrescoAPI::TagsApi	list_tags	GET /tags	List tags
AlfrescoAPI::TagsApi	list_tags_for_node	GET /nodes/nodeId/tags	List tags for a node
AlfrescoAPI::TagsApi	update_tag	PUT /tags/tagId	Update a tag
AlfrescoAPI::TrashcanApi	delete_deleted_node	DELETE /deleted-nodes/nodeId	Permanently delete a deleted node
AlfrescoAPI::TrashcanApi	get_archived_node_rendition	GET /deleted-nodes/nodeId/renditions/renditionId	Get rendition information for a deleted node
AlfrescoAPI::TrashcanApi	get_archived_node_rendition_content	GET /deleted-nodes/nodeId/renditions/renditionId/content	Get rendition content of a deleted node
AlfrescoAPI::TrashcanApi	get_deleted_node	GET /deleted-nodes/nodeId	Get a deleted node
AlfrescoAPI::TrashcanApi	get_deleted_node_content	GET /deleted-nodes/nodeId/content	Get deleted node content
AlfrescoAPI::TrashcanApi	list_deleted_node_renditions	GET /deleted-nodes/nodeId/renditions	List renditions for a deleted node
AlfrescoAPI::TrashcanApi	list_deleted_nodes	GET /deleted-nodes	List deleted nodes
AlfrescoAPI::TrashcanApi	restore_deleted_node	POST /deleted-nodes/nodeId/restore	Restore a deleted node
AlfrescoAPI::VersionsApi	delete_version	DELETE /nodes/nodeId/versions/versionId	Delete a version
AlfrescoAPI::VersionsApi	get_version	GET /nodes/nodeId/versions/versionId	Get version information
AlfrescoAPI::VersionsApi	get_version_content	GET /nodes/nodeId/versions/versionId/content	Get version content
AlfrescoAPI::VersionsApi	list_version_history	GET /nodes/nodeId/versions	List version history
AlfrescoAPI::VersionsApi	revert_version	POST /nodes/nodeId/versions/versionId/revert	Revert a version

Documentation for Models

• AlfrescoAPI::Activity
• AlfrescoAPI::ActivityEntry
• AlfrescoAPI::ActivityPaging
• AlfrescoAPI::ActivityPagingList
• AlfrescoAPI::Association
• AlfrescoAPI::AssociationBody
• AlfrescoAPI::AssociationEntry
• AlfrescoAPI::AssociationInfo
• AlfrescoAPI::AuditApp
• AlfrescoAPI::AuditAppEntry
• AlfrescoAPI::AuditAppPaging
• AlfrescoAPI::AuditAppPagingList
• AlfrescoAPI::AuditBodyUpdate
• AlfrescoAPI::AuditEntry
• AlfrescoAPI::AuditEntryEntry
• AlfrescoAPI::AuditEntryPaging
• AlfrescoAPI::AuditEntryPagingList
• AlfrescoAPI::ChildAssociation
• AlfrescoAPI::ChildAssociationBody
• AlfrescoAPI::ChildAssociationEntry
• AlfrescoAPI::ChildAssociationInfo
• AlfrescoAPI::ClientBody
• AlfrescoAPI::Comment
• AlfrescoAPI::CommentBody
• AlfrescoAPI::CommentEntry
• AlfrescoAPI::CommentPaging
• AlfrescoAPI::CommentPagingList
• AlfrescoAPI::Company
• AlfrescoAPI::ContentInfo
• AlfrescoAPI::DeletedNode
• AlfrescoAPI::DeletedNodeEntry
• AlfrescoAPI::DeletedNodesPaging
• AlfrescoAPI::DeletedNodesPagingList
• AlfrescoAPI::Download
• AlfrescoAPI::DownloadBodyCreate
• AlfrescoAPI::DownloadEntry
• AlfrescoAPI::Error
• AlfrescoAPI::ErrorError
• AlfrescoAPI::Favorite
• AlfrescoAPI::FavoriteBodyCreate
• AlfrescoAPI::FavoriteEntry
• AlfrescoAPI::FavoritePaging
• AlfrescoAPI::FavoritePagingList
• AlfrescoAPI::FavoriteSite
• AlfrescoAPI::FavoriteSiteBodyCreate
• AlfrescoAPI::FavoriteSiteEntry
• AlfrescoAPI::Group
• AlfrescoAPI::GroupBodyCreate
• AlfrescoAPI::GroupBodyUpdate
• AlfrescoAPI::GroupEntry
• AlfrescoAPI::GroupMember
• AlfrescoAPI::GroupMemberEntry
• AlfrescoAPI::GroupMemberPaging
• AlfrescoAPI::GroupMemberPagingList
• AlfrescoAPI::GroupMembershipBodyCreate
• AlfrescoAPI::GroupPaging
• AlfrescoAPI::GroupPagingList
• AlfrescoAPI::NetworkQuota
• AlfrescoAPI::Node
• AlfrescoAPI::NodeAssociation
• AlfrescoAPI::NodeAssociationEntry
• AlfrescoAPI::NodeAssociationPaging
• AlfrescoAPI::NodeAssociationPagingList
• AlfrescoAPI::NodeBodyCopy
• AlfrescoAPI::NodeBodyCreate
• AlfrescoAPI::NodeBodyCreateAssociation
• AlfrescoAPI::NodeBodyLock
• AlfrescoAPI::NodeBodyMove
• AlfrescoAPI::NodeBodyUpdate
• AlfrescoAPI::NodeChildAssociation
• AlfrescoAPI::NodeChildAssociationEntry
• AlfrescoAPI::NodeChildAssociationPaging
• AlfrescoAPI::NodeChildAssociationPagingList
• AlfrescoAPI::NodeEntry
• AlfrescoAPI::NodePaging
• AlfrescoAPI::NodePagingList
• AlfrescoAPI::Pagination
• AlfrescoAPI::PasswordResetBody
• AlfrescoAPI::PathElement
• AlfrescoAPI::PathInfo
• AlfrescoAPI::PermissionElement
• AlfrescoAPI::PermissionsBodyUpdate
• AlfrescoAPI::PermissionsInfo
• AlfrescoAPI::Person
• AlfrescoAPI::PersonBodyCreate
• AlfrescoAPI::PersonBodyUpdate
• AlfrescoAPI::PersonEntry
• AlfrescoAPI::PersonNetwork
• AlfrescoAPI::PersonNetworkEntry
• AlfrescoAPI::PersonNetworkPaging
• AlfrescoAPI::PersonNetworkPagingList
• AlfrescoAPI::PersonPaging
• AlfrescoAPI::PersonPagingList
• AlfrescoAPI::Preference
• AlfrescoAPI::PreferenceEntry
• AlfrescoAPI::PreferencePaging
• AlfrescoAPI::PreferencePagingList
• AlfrescoAPI::Rating
• AlfrescoAPI::RatingAggregate
• AlfrescoAPI::RatingBody
• AlfrescoAPI::RatingEntry
• AlfrescoAPI::RatingPaging
• AlfrescoAPI::RatingPagingList
• AlfrescoAPI::Rendition
• AlfrescoAPI::RenditionBodyCreate
• AlfrescoAPI::RenditionEntry
• AlfrescoAPI::RenditionPaging
• AlfrescoAPI::RenditionPagingList
• AlfrescoAPI::RevertBody
• AlfrescoAPI::SharedLink
• AlfrescoAPI::SharedLinkBodyCreate
• AlfrescoAPI::SharedLinkBodyEmail
• AlfrescoAPI::SharedLinkEntry
• AlfrescoAPI::SharedLinkPaging
• AlfrescoAPI::SharedLinkPagingList
• AlfrescoAPI::Site
• AlfrescoAPI::SiteBodyCreate
• AlfrescoAPI::SiteBodyUpdate
• AlfrescoAPI::SiteContainer
• AlfrescoAPI::SiteContainerEntry
• AlfrescoAPI::SiteContainerPaging
• AlfrescoAPI::SiteContainerPagingList
• AlfrescoAPI::SiteEntry
• AlfrescoAPI::SiteMember
• AlfrescoAPI::SiteMemberEntry
• AlfrescoAPI::SiteMemberPaging
• AlfrescoAPI::SiteMemberPagingList
• AlfrescoAPI::SiteMembershipBodyCreate
• AlfrescoAPI::SiteMembershipBodyUpdate
• AlfrescoAPI::SiteMembershipRequest
• AlfrescoAPI::SiteMembershipRequestBodyCreate
• AlfrescoAPI::SiteMembershipRequestBodyUpdate
• AlfrescoAPI::SiteMembershipRequestEntry
• AlfrescoAPI::SiteMembershipRequestPaging
• AlfrescoAPI::SiteMembershipRequestPagingList
• AlfrescoAPI::SitePaging
• AlfrescoAPI::SitePagingList
• AlfrescoAPI::SiteRole
• AlfrescoAPI::SiteRoleEntry
• AlfrescoAPI::SiteRolePaging
• AlfrescoAPI::SiteRolePagingList
• AlfrescoAPI::Tag
• AlfrescoAPI::TagBody
• AlfrescoAPI::TagEntry
• AlfrescoAPI::TagPaging
• AlfrescoAPI::TagPagingList
• AlfrescoAPI::UserInfo
• AlfrescoAPI::Version
• AlfrescoAPI::VersionEntry
• AlfrescoAPI::VersionPaging
• AlfrescoAPI::VersionPagingList

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication