alfresco_api 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +351 -0
- data/Rakefile +8 -0
- data/alfresco_api.gemspec +45 -0
- data/docs/ActivitiesApi.md +74 -0
- data/docs/Activity.md +14 -0
- data/docs/ActivityEntry.md +8 -0
- data/docs/ActivityPaging.md +8 -0
- data/docs/ActivityPagingList.md +9 -0
- data/docs/Association.md +9 -0
- data/docs/AssociationBody.md +9 -0
- data/docs/AssociationEntry.md +8 -0
- data/docs/AssociationInfo.md +8 -0
- data/docs/AuditApi.md +495 -0
- data/docs/AuditApp.md +10 -0
- data/docs/AuditAppEntry.md +8 -0
- data/docs/AuditAppPaging.md +8 -0
- data/docs/AuditAppPagingList.md +9 -0
- data/docs/AuditBodyUpdate.md +8 -0
- data/docs/AuditEntry.md +12 -0
- data/docs/AuditEntryEntry.md +8 -0
- data/docs/AuditEntryPaging.md +8 -0
- data/docs/AuditEntryPagingList.md +9 -0
- data/docs/ChildAssociation.md +9 -0
- data/docs/ChildAssociationBody.md +9 -0
- data/docs/ChildAssociationEntry.md +8 -0
- data/docs/ChildAssociationInfo.md +9 -0
- data/docs/ClientBody.md +8 -0
- data/docs/Comment.md +16 -0
- data/docs/CommentBody.md +8 -0
- data/docs/CommentEntry.md +8 -0
- data/docs/CommentPaging.md +8 -0
- data/docs/CommentPagingList.md +9 -0
- data/docs/CommentsApi.md +251 -0
- data/docs/Company.md +15 -0
- data/docs/ContentInfo.md +11 -0
- data/docs/DeletedNode.md +27 -0
- data/docs/DeletedNodeEntry.md +8 -0
- data/docs/DeletedNodesPaging.md +8 -0
- data/docs/DeletedNodesPagingList.md +9 -0
- data/docs/Download.md +13 -0
- data/docs/DownloadBodyCreate.md +8 -0
- data/docs/DownloadEntry.md +8 -0
- data/docs/DownloadsApi.md +177 -0
- data/docs/Error.md +8 -0
- data/docs/ErrorError.md +13 -0
- data/docs/Favorite.md +10 -0
- data/docs/FavoriteBodyCreate.md +8 -0
- data/docs/FavoriteEntry.md +8 -0
- data/docs/FavoritePaging.md +8 -0
- data/docs/FavoritePagingList.md +9 -0
- data/docs/FavoriteSite.md +8 -0
- data/docs/FavoriteSiteBodyCreate.md +8 -0
- data/docs/FavoriteSiteEntry.md +8 -0
- data/docs/FavoritesApi.md +496 -0
- data/docs/Group.md +12 -0
- data/docs/GroupBodyCreate.md +10 -0
- data/docs/GroupBodyUpdate.md +8 -0
- data/docs/GroupEntry.md +8 -0
- data/docs/GroupMember.md +10 -0
- data/docs/GroupMemberEntry.md +8 -0
- data/docs/GroupMemberPaging.md +8 -0
- data/docs/GroupMemberPagingList.md +9 -0
- data/docs/GroupMembershipBodyCreate.md +9 -0
- data/docs/GroupPaging.md +8 -0
- data/docs/GroupPagingList.md +9 -0
- data/docs/GroupsApi.md +564 -0
- data/docs/NetworkQuota.md +10 -0
- data/docs/NetworksApi.md +189 -0
- data/docs/Node.md +25 -0
- data/docs/NodeAssociation.md +26 -0
- data/docs/NodeAssociationEntry.md +8 -0
- data/docs/NodeAssociationPaging.md +8 -0
- data/docs/NodeAssociationPagingList.md +10 -0
- data/docs/NodeBodyCopy.md +9 -0
- data/docs/NodeBodyCreate.md +15 -0
- data/docs/NodeBodyCreateAssociation.md +8 -0
- data/docs/NodeBodyLock.md +10 -0
- data/docs/NodeBodyMove.md +9 -0
- data/docs/NodeBodyUpdate.md +12 -0
- data/docs/NodeChildAssociation.md +26 -0
- data/docs/NodeChildAssociationEntry.md +8 -0
- data/docs/NodeChildAssociationPaging.md +8 -0
- data/docs/NodeChildAssociationPagingList.md +10 -0
- data/docs/NodeEntry.md +8 -0
- data/docs/NodePaging.md +8 -0
- data/docs/NodePagingList.md +10 -0
- data/docs/NodesApi.md +1206 -0
- data/docs/Pagination.md +12 -0
- data/docs/PasswordResetBody.md +10 -0
- data/docs/PathElement.md +11 -0
- data/docs/PathInfo.md +10 -0
- data/docs/PeopleApi.md +530 -0
- data/docs/PermissionElement.md +10 -0
- data/docs/PermissionsBodyUpdate.md +9 -0
- data/docs/PermissionsInfo.md +11 -0
- data/docs/Person.md +27 -0
- data/docs/PersonBodyCreate.md +26 -0
- data/docs/PersonBodyUpdate.md +26 -0
- data/docs/PersonEntry.md +8 -0
- data/docs/PersonNetwork.md +14 -0
- data/docs/PersonNetworkEntry.md +8 -0
- data/docs/PersonNetworkPaging.md +8 -0
- data/docs/PersonNetworkPagingList.md +9 -0
- data/docs/PersonPaging.md +8 -0
- data/docs/PersonPagingList.md +9 -0
- data/docs/Preference.md +9 -0
- data/docs/PreferenceEntry.md +8 -0
- data/docs/PreferencePaging.md +8 -0
- data/docs/PreferencePagingList.md +9 -0
- data/docs/PreferencesApi.md +131 -0
- data/docs/QueriesApi.md +206 -0
- data/docs/Rating.md +11 -0
- data/docs/RatingAggregate.md +9 -0
- data/docs/RatingBody.md +9 -0
- data/docs/RatingEntry.md +8 -0
- data/docs/RatingPaging.md +8 -0
- data/docs/RatingPagingList.md +9 -0
- data/docs/RatingsApi.md +248 -0
- data/docs/Rendition.md +10 -0
- data/docs/RenditionBodyCreate.md +8 -0
- data/docs/RenditionEntry.md +8 -0
- data/docs/RenditionPaging.md +8 -0
- data/docs/RenditionPagingList.md +9 -0
- data/docs/RenditionsApi.md +243 -0
- data/docs/RevertBody.md +9 -0
- data/docs/SharedLink.md +19 -0
- data/docs/SharedLinkBodyCreate.md +9 -0
- data/docs/SharedLinkBodyEmail.md +11 -0
- data/docs/SharedLinkEntry.md +8 -0
- data/docs/SharedLinkPaging.md +8 -0
- data/docs/SharedLinkPagingList.md +9 -0
- data/docs/SharedlinksApi.md +530 -0
- data/docs/Site.md +14 -0
- data/docs/SiteBodyCreate.md +11 -0
- data/docs/SiteBodyUpdate.md +10 -0
- data/docs/SiteContainer.md +9 -0
- data/docs/SiteContainerEntry.md +8 -0
- data/docs/SiteContainerPaging.md +8 -0
- data/docs/SiteContainerPagingList.md +9 -0
- data/docs/SiteEntry.md +8 -0
- data/docs/SiteMember.md +10 -0
- data/docs/SiteMemberEntry.md +8 -0
- data/docs/SiteMemberPaging.md +8 -0
- data/docs/SiteMemberPagingList.md +9 -0
- data/docs/SiteMembershipBodyCreate.md +9 -0
- data/docs/SiteMembershipBodyUpdate.md +8 -0
- data/docs/SiteMembershipRequest.md +11 -0
- data/docs/SiteMembershipRequestBodyCreate.md +10 -0
- data/docs/SiteMembershipRequestBodyUpdate.md +8 -0
- data/docs/SiteMembershipRequestEntry.md +8 -0
- data/docs/SiteMembershipRequestPaging.md +8 -0
- data/docs/SiteMembershipRequestPagingList.md +9 -0
- data/docs/SitePaging.md +8 -0
- data/docs/SitePagingList.md +9 -0
- data/docs/SiteRole.md +11 -0
- data/docs/SiteRoleEntry.md +8 -0
- data/docs/SiteRolePaging.md +8 -0
- data/docs/SiteRolePagingList.md +9 -0
- data/docs/SitesApi.md +1225 -0
- data/docs/Tag.md +9 -0
- data/docs/TagBody.md +8 -0
- data/docs/TagEntry.md +8 -0
- data/docs/TagPaging.md +8 -0
- data/docs/TagPagingList.md +9 -0
- data/docs/TagsApi.md +365 -0
- data/docs/TrashcanApi.md +474 -0
- data/docs/UserInfo.md +9 -0
- data/docs/Version.md +18 -0
- data/docs/VersionEntry.md +8 -0
- data/docs/VersionPaging.md +8 -0
- data/docs/VersionPagingList.md +9 -0
- data/docs/VersionsApi.md +311 -0
- data/git_push.sh +55 -0
- data/lib/alfresco_api.rb +208 -0
- data/lib/alfresco_api/api/activities_api.rb +101 -0
- data/lib/alfresco_api/api/audit_api.rb +558 -0
- data/lib/alfresco_api/api/comments_api.rb +289 -0
- data/lib/alfresco_api/api/downloads_api.rb +193 -0
- data/lib/alfresco_api/api/favorites_api.rb +555 -0
- data/lib/alfresco_api/api/groups_api.rb +627 -0
- data/lib/alfresco_api/api/networks_api.rb +217 -0
- data/lib/alfresco_api/api/nodes_api.rb +1314 -0
- data/lib/alfresco_api/api/people_api.rb +572 -0
- data/lib/alfresco_api/api/preferences_api.rb +159 -0
- data/lib/alfresco_api/api/queries_api.rb +260 -0
- data/lib/alfresco_api/api/ratings_api.rb +283 -0
- data/lib/alfresco_api/api/renditions_api.rb +271 -0
- data/lib/alfresco_api/api/sharedlinks_api.rb +570 -0
- data/lib/alfresco_api/api/sites_api.rb +1342 -0
- data/lib/alfresco_api/api/tags_api.rb +407 -0
- data/lib/alfresco_api/api/trashcan_api.rb +507 -0
- data/lib/alfresco_api/api/versions_api.rb +355 -0
- data/lib/alfresco_api/api_client.rb +389 -0
- data/lib/alfresco_api/api_error.rb +38 -0
- data/lib/alfresco_api/configuration.rb +209 -0
- data/lib/alfresco_api/models/activity.rb +271 -0
- data/lib/alfresco_api/models/activity_entry.rb +193 -0
- data/lib/alfresco_api/models/activity_paging.rb +188 -0
- data/lib/alfresco_api/models/activity_paging_list.rb +209 -0
- data/lib/alfresco_api/models/association.rb +207 -0
- data/lib/alfresco_api/models/association_body.rb +207 -0
- data/lib/alfresco_api/models/association_entry.rb +193 -0
- data/lib/alfresco_api/models/association_info.rb +193 -0
- data/lib/alfresco_api/models/audit_app.rb +213 -0
- data/lib/alfresco_api/models/audit_app_entry.rb +188 -0
- data/lib/alfresco_api/models/audit_app_paging.rb +188 -0
- data/lib/alfresco_api/models/audit_app_paging_list.rb +199 -0
- data/lib/alfresco_api/models/audit_body_update.rb +188 -0
- data/lib/alfresco_api/models/audit_entry.rb +246 -0
- data/lib/alfresco_api/models/audit_entry_entry.rb +188 -0
- data/lib/alfresco_api/models/audit_entry_paging.rb +188 -0
- data/lib/alfresco_api/models/audit_entry_paging_list.rb +199 -0
- data/lib/alfresco_api/models/child_association.rb +207 -0
- data/lib/alfresco_api/models/child_association_body.rb +207 -0
- data/lib/alfresco_api/models/child_association_entry.rb +193 -0
- data/lib/alfresco_api/models/child_association_info.rb +207 -0
- data/lib/alfresco_api/models/client_body.rb +194 -0
- data/lib/alfresco_api/models/comment.rb +305 -0
- data/lib/alfresco_api/models/comment_body.rb +193 -0
- data/lib/alfresco_api/models/comment_entry.rb +193 -0
- data/lib/alfresco_api/models/comment_paging.rb +188 -0
- data/lib/alfresco_api/models/comment_paging_list.rb +209 -0
- data/lib/alfresco_api/models/company.rb +251 -0
- data/lib/alfresco_api/models/content_info.rb +230 -0
- data/lib/alfresco_api/models/deleted_node.rb +440 -0
- data/lib/alfresco_api/models/deleted_node_entry.rb +188 -0
- data/lib/alfresco_api/models/deleted_nodes_paging.rb +188 -0
- data/lib/alfresco_api/models/deleted_nodes_paging_list.rb +199 -0
- data/lib/alfresco_api/models/download.rb +274 -0
- data/lib/alfresco_api/models/download_body_create.rb +195 -0
- data/lib/alfresco_api/models/download_entry.rb +193 -0
- data/lib/alfresco_api/models/error.rb +188 -0
- data/lib/alfresco_api/models/error_error.rb +253 -0
- data/lib/alfresco_api/models/favorite.rb +218 -0
- data/lib/alfresco_api/models/favorite_body_create.rb +193 -0
- data/lib/alfresco_api/models/favorite_entry.rb +193 -0
- data/lib/alfresco_api/models/favorite_paging.rb +188 -0
- data/lib/alfresco_api/models/favorite_paging_list.rb +209 -0
- data/lib/alfresco_api/models/favorite_site.rb +193 -0
- data/lib/alfresco_api/models/favorite_site_body_create.rb +193 -0
- data/lib/alfresco_api/models/favorite_site_entry.rb +193 -0
- data/lib/alfresco_api/models/group.rb +245 -0
- data/lib/alfresco_api/models/group_body_create.rb +218 -0
- data/lib/alfresco_api/models/group_body_update.rb +193 -0
- data/lib/alfresco_api/models/group_entry.rb +193 -0
- data/lib/alfresco_api/models/group_member.rb +254 -0
- data/lib/alfresco_api/models/group_member_entry.rb +193 -0
- data/lib/alfresco_api/models/group_member_paging.rb +188 -0
- data/lib/alfresco_api/models/group_member_paging_list.rb +199 -0
- data/lib/alfresco_api/models/group_membership_body_create.rb +240 -0
- data/lib/alfresco_api/models/group_paging.rb +188 -0
- data/lib/alfresco_api/models/group_paging_list.rb +199 -0
- data/lib/alfresco_api/models/network_quota.rb +221 -0
- data/lib/alfresco_api/models/node.rb +412 -0
- data/lib/alfresco_api/models/node_association.rb +421 -0
- data/lib/alfresco_api/models/node_association_entry.rb +193 -0
- data/lib/alfresco_api/models/node_association_paging.rb +188 -0
- data/lib/alfresco_api/models/node_association_paging_list.rb +208 -0
- data/lib/alfresco_api/models/node_body_copy.rb +219 -0
- data/lib/alfresco_api/models/node_body_create.rb +289 -0
- data/lib/alfresco_api/models/node_body_create_association.rb +188 -0
- data/lib/alfresco_api/models/node_body_lock.rb +271 -0
- data/lib/alfresco_api/models/node_body_move.rb +219 -0
- data/lib/alfresco_api/models/node_body_update.rb +245 -0
- data/lib/alfresco_api/models/node_child_association.rb +421 -0
- data/lib/alfresco_api/models/node_child_association_entry.rb +193 -0
- data/lib/alfresco_api/models/node_child_association_paging.rb +188 -0
- data/lib/alfresco_api/models/node_child_association_paging_list.rb +208 -0
- data/lib/alfresco_api/models/node_entry.rb +193 -0
- data/lib/alfresco_api/models/node_paging.rb +188 -0
- data/lib/alfresco_api/models/node_paging_list.rb +208 -0
- data/lib/alfresco_api/models/pagination.rb +249 -0
- data/lib/alfresco_api/models/password_reset_body.rb +224 -0
- data/lib/alfresco_api/models/path_element.rb +217 -0
- data/lib/alfresco_api/models/path_info.rb +208 -0
- data/lib/alfresco_api/models/permission_element.rb +241 -0
- data/lib/alfresco_api/models/permissions_body_update.rb +199 -0
- data/lib/alfresco_api/models/permissions_info.rb +221 -0
- data/lib/alfresco_api/models/person.rb +387 -0
- data/lib/alfresco_api/models/person_body_create.rb +378 -0
- data/lib/alfresco_api/models/person_body_update.rb +354 -0
- data/lib/alfresco_api/models/person_entry.rb +193 -0
- data/lib/alfresco_api/models/person_network.rb +289 -0
- data/lib/alfresco_api/models/person_network_entry.rb +193 -0
- data/lib/alfresco_api/models/person_network_paging.rb +188 -0
- data/lib/alfresco_api/models/person_network_paging_list.rb +209 -0
- data/lib/alfresco_api/models/person_paging.rb +188 -0
- data/lib/alfresco_api/models/person_paging_list.rb +199 -0
- data/lib/alfresco_api/models/preference.rb +204 -0
- data/lib/alfresco_api/models/preference_entry.rb +193 -0
- data/lib/alfresco_api/models/preference_paging.rb +188 -0
- data/lib/alfresco_api/models/preference_paging_list.rb +209 -0
- data/lib/alfresco_api/models/rating.rb +221 -0
- data/lib/alfresco_api/models/rating_aggregate.rb +202 -0
- data/lib/alfresco_api/models/rating_body.rb +244 -0
- data/lib/alfresco_api/models/rating_entry.rb +193 -0
- data/lib/alfresco_api/models/rating_paging.rb +188 -0
- data/lib/alfresco_api/models/rating_paging_list.rb +209 -0
- data/lib/alfresco_api/models/rendition.rb +239 -0
- data/lib/alfresco_api/models/rendition_body_create.rb +193 -0
- data/lib/alfresco_api/models/rendition_entry.rb +193 -0
- data/lib/alfresco_api/models/rendition_paging.rb +188 -0
- data/lib/alfresco_api/models/rendition_paging_list.rb +199 -0
- data/lib/alfresco_api/models/revert_body.rb +197 -0
- data/lib/alfresco_api/models/shared_link.rb +310 -0
- data/lib/alfresco_api/models/shared_link_body_create.rb +202 -0
- data/lib/alfresco_api/models/shared_link_body_email.rb +217 -0
- data/lib/alfresco_api/models/shared_link_entry.rb +193 -0
- data/lib/alfresco_api/models/shared_link_paging.rb +188 -0
- data/lib/alfresco_api/models/shared_link_paging_list.rb +209 -0
- data/lib/alfresco_api/models/site.rb +307 -0
- data/lib/alfresco_api/models/site_body_create.rb +260 -0
- data/lib/alfresco_api/models/site_body_update.rb +239 -0
- data/lib/alfresco_api/models/site_container.rb +207 -0
- data/lib/alfresco_api/models/site_container_entry.rb +193 -0
- data/lib/alfresco_api/models/site_container_paging.rb +188 -0
- data/lib/alfresco_api/models/site_container_paging_list.rb +209 -0
- data/lib/alfresco_api/models/site_entry.rb +193 -0
- data/lib/alfresco_api/models/site_member.rb +254 -0
- data/lib/alfresco_api/models/site_member_entry.rb +193 -0
- data/lib/alfresco_api/models/site_member_paging.rb +188 -0
- data/lib/alfresco_api/models/site_member_paging_list.rb +209 -0
- data/lib/alfresco_api/models/site_membership_body_create.rb +240 -0
- data/lib/alfresco_api/models/site_membership_body_update.rb +226 -0
- data/lib/alfresco_api/models/site_membership_request.rb +230 -0
- data/lib/alfresco_api/models/site_membership_request_body_create.rb +211 -0
- data/lib/alfresco_api/models/site_membership_request_body_update.rb +188 -0
- data/lib/alfresco_api/models/site_membership_request_entry.rb +193 -0
- data/lib/alfresco_api/models/site_membership_request_paging.rb +188 -0
- data/lib/alfresco_api/models/site_membership_request_paging_list.rb +209 -0
- data/lib/alfresco_api/models/site_paging.rb +188 -0
- data/lib/alfresco_api/models/site_paging_list.rb +209 -0
- data/lib/alfresco_api/models/site_role.rb +268 -0
- data/lib/alfresco_api/models/site_role_entry.rb +193 -0
- data/lib/alfresco_api/models/site_role_paging.rb +188 -0
- data/lib/alfresco_api/models/site_role_paging_list.rb +209 -0
- data/lib/alfresco_api/models/tag.rb +207 -0
- data/lib/alfresco_api/models/tag_body.rb +193 -0
- data/lib/alfresco_api/models/tag_entry.rb +193 -0
- data/lib/alfresco_api/models/tag_paging.rb +188 -0
- data/lib/alfresco_api/models/tag_paging_list.rb +209 -0
- data/lib/alfresco_api/models/user_info.rb +207 -0
- data/lib/alfresco_api/models/version.rb +337 -0
- data/lib/alfresco_api/models/version_entry.rb +188 -0
- data/lib/alfresco_api/models/version_paging.rb +188 -0
- data/lib/alfresco_api/models/version_paging_list.rb +199 -0
- data/lib/alfresco_api/version.rb +15 -0
- data/spec/api/activities_api_spec.rb +52 -0
- data/spec/api/audit_api_spec.rb +152 -0
- data/spec/api/comments_api_spec.rb +92 -0
- data/spec/api/downloads_api_spec.rb +73 -0
- data/spec/api/favorites_api_spec.rb +151 -0
- data/spec/api/groups_api_spec.rb +170 -0
- data/spec/api/networks_api_spec.rb +77 -0
- data/spec/api/nodes_api_spec.rb +327 -0
- data/spec/api/people_api_spec.rb +157 -0
- data/spec/api/preferences_api_spec.rb +64 -0
- data/spec/api/queries_api_spec.rb +86 -0
- data/spec/api/ratings_api_spec.rb +91 -0
- data/spec/api/renditions_api_spec.rb +90 -0
- data/spec/api/sharedlinks_api_spec.rb +157 -0
- data/spec/api/sites_api_spec.rb +323 -0
- data/spec/api/tags_api_spec.rb +118 -0
- data/spec/api/trashcan_api_spec.rb +143 -0
- data/spec/api/versions_api_spec.rb +107 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/activity_entry_spec.rb +42 -0
- data/spec/models/activity_paging_list_spec.rb +48 -0
- data/spec/models/activity_paging_spec.rb +42 -0
- data/spec/models/activity_spec.rb +78 -0
- data/spec/models/association_body_spec.rb +48 -0
- data/spec/models/association_entry_spec.rb +42 -0
- data/spec/models/association_info_spec.rb +42 -0
- data/spec/models/association_spec.rb +48 -0
- data/spec/models/audit_app_entry_spec.rb +42 -0
- data/spec/models/audit_app_paging_list_spec.rb +48 -0
- data/spec/models/audit_app_paging_spec.rb +42 -0
- data/spec/models/audit_app_spec.rb +54 -0
- data/spec/models/audit_body_update_spec.rb +42 -0
- data/spec/models/audit_entry_entry_spec.rb +42 -0
- data/spec/models/audit_entry_paging_list_spec.rb +48 -0
- data/spec/models/audit_entry_paging_spec.rb +42 -0
- data/spec/models/audit_entry_spec.rb +66 -0
- data/spec/models/child_association_body_spec.rb +48 -0
- data/spec/models/child_association_entry_spec.rb +42 -0
- data/spec/models/child_association_info_spec.rb +48 -0
- data/spec/models/child_association_spec.rb +48 -0
- data/spec/models/client_body_spec.rb +42 -0
- data/spec/models/comment_body_spec.rb +42 -0
- data/spec/models/comment_entry_spec.rb +42 -0
- data/spec/models/comment_paging_list_spec.rb +48 -0
- data/spec/models/comment_paging_spec.rb +42 -0
- data/spec/models/comment_spec.rb +90 -0
- data/spec/models/company_spec.rb +84 -0
- data/spec/models/content_info_spec.rb +60 -0
- data/spec/models/deleted_node_entry_spec.rb +42 -0
- data/spec/models/deleted_node_spec.rb +156 -0
- data/spec/models/deleted_nodes_paging_list_spec.rb +48 -0
- data/spec/models/deleted_nodes_paging_spec.rb +42 -0
- data/spec/models/download_body_create_spec.rb +42 -0
- data/spec/models/download_entry_spec.rb +42 -0
- data/spec/models/download_spec.rb +76 -0
- data/spec/models/error_error_spec.rb +72 -0
- data/spec/models/error_spec.rb +42 -0
- data/spec/models/favorite_body_create_spec.rb +42 -0
- data/spec/models/favorite_entry_spec.rb +42 -0
- data/spec/models/favorite_paging_list_spec.rb +48 -0
- data/spec/models/favorite_paging_spec.rb +42 -0
- data/spec/models/favorite_site_body_create_spec.rb +42 -0
- data/spec/models/favorite_site_entry_spec.rb +42 -0
- data/spec/models/favorite_site_spec.rb +42 -0
- data/spec/models/favorite_spec.rb +54 -0
- data/spec/models/group_body_create_spec.rb +54 -0
- data/spec/models/group_body_update_spec.rb +42 -0
- data/spec/models/group_entry_spec.rb +42 -0
- data/spec/models/group_member_entry_spec.rb +42 -0
- data/spec/models/group_member_paging_list_spec.rb +48 -0
- data/spec/models/group_member_paging_spec.rb +42 -0
- data/spec/models/group_member_spec.rb +58 -0
- data/spec/models/group_membership_body_create_spec.rb +52 -0
- data/spec/models/group_paging_list_spec.rb +48 -0
- data/spec/models/group_paging_spec.rb +42 -0
- data/spec/models/group_spec.rb +66 -0
- data/spec/models/network_quota_spec.rb +54 -0
- data/spec/models/node_association_entry_spec.rb +42 -0
- data/spec/models/node_association_paging_list_spec.rb +54 -0
- data/spec/models/node_association_paging_spec.rb +42 -0
- data/spec/models/node_association_spec.rb +150 -0
- data/spec/models/node_body_copy_spec.rb +48 -0
- data/spec/models/node_body_create_association_spec.rb +42 -0
- data/spec/models/node_body_create_spec.rb +84 -0
- data/spec/models/node_body_lock_spec.rb +62 -0
- data/spec/models/node_body_move_spec.rb +48 -0
- data/spec/models/node_body_update_spec.rb +66 -0
- data/spec/models/node_child_association_entry_spec.rb +42 -0
- data/spec/models/node_child_association_paging_list_spec.rb +54 -0
- data/spec/models/node_child_association_paging_spec.rb +42 -0
- data/spec/models/node_child_association_spec.rb +150 -0
- data/spec/models/node_entry_spec.rb +42 -0
- data/spec/models/node_paging_list_spec.rb +54 -0
- data/spec/models/node_paging_spec.rb +42 -0
- data/spec/models/node_spec.rb +144 -0
- data/spec/models/pagination_spec.rb +66 -0
- data/spec/models/password_reset_body_spec.rb +54 -0
- data/spec/models/path_element_spec.rb +60 -0
- data/spec/models/path_info_spec.rb +54 -0
- data/spec/models/permission_element_spec.rb +58 -0
- data/spec/models/permissions_body_update_spec.rb +48 -0
- data/spec/models/permissions_info_spec.rb +60 -0
- data/spec/models/person_body_create_spec.rb +150 -0
- data/spec/models/person_body_update_spec.rb +150 -0
- data/spec/models/person_entry_spec.rb +42 -0
- data/spec/models/person_network_entry_spec.rb +42 -0
- data/spec/models/person_network_paging_list_spec.rb +48 -0
- data/spec/models/person_network_paging_spec.rb +42 -0
- data/spec/models/person_network_spec.rb +82 -0
- data/spec/models/person_paging_list_spec.rb +48 -0
- data/spec/models/person_paging_spec.rb +42 -0
- data/spec/models/person_spec.rb +156 -0
- data/spec/models/preference_entry_spec.rb +42 -0
- data/spec/models/preference_paging_list_spec.rb +48 -0
- data/spec/models/preference_paging_spec.rb +42 -0
- data/spec/models/preference_spec.rb +48 -0
- data/spec/models/rating_aggregate_spec.rb +48 -0
- data/spec/models/rating_body_spec.rb +52 -0
- data/spec/models/rating_entry_spec.rb +42 -0
- data/spec/models/rating_paging_list_spec.rb +48 -0
- data/spec/models/rating_paging_spec.rb +42 -0
- data/spec/models/rating_spec.rb +60 -0
- data/spec/models/rendition_body_create_spec.rb +42 -0
- data/spec/models/rendition_entry_spec.rb +42 -0
- data/spec/models/rendition_paging_list_spec.rb +48 -0
- data/spec/models/rendition_paging_spec.rb +42 -0
- data/spec/models/rendition_spec.rb +58 -0
- data/spec/models/revert_body_spec.rb +48 -0
- data/spec/models/shared_link_body_create_spec.rb +48 -0
- data/spec/models/shared_link_body_email_spec.rb +60 -0
- data/spec/models/shared_link_entry_spec.rb +42 -0
- data/spec/models/shared_link_paging_list_spec.rb +48 -0
- data/spec/models/shared_link_paging_spec.rb +42 -0
- data/spec/models/shared_link_spec.rb +108 -0
- data/spec/models/site_body_create_spec.rb +64 -0
- data/spec/models/site_body_update_spec.rb +58 -0
- data/spec/models/site_container_entry_spec.rb +42 -0
- data/spec/models/site_container_paging_list_spec.rb +48 -0
- data/spec/models/site_container_paging_spec.rb +42 -0
- data/spec/models/site_container_spec.rb +48 -0
- data/spec/models/site_entry_spec.rb +42 -0
- data/spec/models/site_member_entry_spec.rb +42 -0
- data/spec/models/site_member_paging_list_spec.rb +48 -0
- data/spec/models/site_member_paging_spec.rb +42 -0
- data/spec/models/site_member_spec.rb +58 -0
- data/spec/models/site_membership_body_create_spec.rb +52 -0
- data/spec/models/site_membership_body_update_spec.rb +46 -0
- data/spec/models/site_membership_request_body_create_spec.rb +54 -0
- data/spec/models/site_membership_request_body_update_spec.rb +42 -0
- data/spec/models/site_membership_request_entry_spec.rb +42 -0
- data/spec/models/site_membership_request_paging_list_spec.rb +48 -0
- data/spec/models/site_membership_request_paging_spec.rb +42 -0
- data/spec/models/site_membership_request_spec.rb +60 -0
- data/spec/models/site_paging_list_spec.rb +48 -0
- data/spec/models/site_paging_spec.rb +42 -0
- data/spec/models/site_role_entry_spec.rb +42 -0
- data/spec/models/site_role_paging_list_spec.rb +48 -0
- data/spec/models/site_role_paging_spec.rb +42 -0
- data/spec/models/site_role_spec.rb +64 -0
- data/spec/models/site_spec.rb +86 -0
- data/spec/models/tag_body_spec.rb +42 -0
- data/spec/models/tag_entry_spec.rb +42 -0
- data/spec/models/tag_paging_list_spec.rb +48 -0
- data/spec/models/tag_paging_spec.rb +42 -0
- data/spec/models/tag_spec.rb +48 -0
- data/spec/models/user_info_spec.rb +48 -0
- data/spec/models/version_entry_spec.rb +42 -0
- data/spec/models/version_paging_list_spec.rb +48 -0
- data/spec/models/version_paging_spec.rb +42 -0
- data/spec/models/version_spec.rb +102 -0
- data/spec/spec_helper.rb +111 -0
- metadata +918 -0
data/docs/Activity.md
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
# AlfrescoAPI::Activity
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**post_person_id** | **String** | The id of the person who performed the activity |
|
7
|
+
**id** | **Integer** | The unique id of the activity |
|
8
|
+
**site_id** | **String** | The unique id of the site on which the activity was performed | [optional]
|
9
|
+
**posted_at** | **DateTime** | The date time at which the activity was performed | [optional]
|
10
|
+
**feed_person_id** | **String** | The feed on which this activity was posted |
|
11
|
+
**activity_summary** | **Hash<String, String>** | An object summarizing the activity | [optional]
|
12
|
+
**activity_type** | **String** | The type of the activity posted |
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# AlfrescoAPI::ActivityPagingList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**pagination** | [**Pagination**](Pagination.md) | |
|
7
|
+
**entries** | [**Array<ActivityEntry>**](ActivityEntry.md) | |
|
8
|
+
|
9
|
+
|
data/docs/Association.md
ADDED
data/docs/AuditApi.md
ADDED
@@ -0,0 +1,495 @@
|
|
1
|
+
# AlfrescoAPI::AuditApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**delete_audit_entries_for_audit_app**](AuditApi.md#delete_audit_entries_for_audit_app) | **DELETE** /audit-applications/{auditApplicationId}/audit-entries | Permanently delete audit entries for an audit application
|
8
|
+
[**delete_audit_entry**](AuditApi.md#delete_audit_entry) | **DELETE** /audit-applications/{auditApplicationId}/audit-entries/{auditEntryId} | Permanently delete an audit entry
|
9
|
+
[**get_audit_app**](AuditApi.md#get_audit_app) | **GET** /audit-applications/{auditApplicationId} | Get audit application info
|
10
|
+
[**get_audit_entry**](AuditApi.md#get_audit_entry) | **GET** /audit-applications/{auditApplicationId}/audit-entries/{auditEntryId} | Get audit entry
|
11
|
+
[**list_audit_apps**](AuditApi.md#list_audit_apps) | **GET** /audit-applications | List audit applications
|
12
|
+
[**list_audit_entries_for_audit_app**](AuditApi.md#list_audit_entries_for_audit_app) | **GET** /audit-applications/{auditApplicationId}/audit-entries | List audit entries for an audit application
|
13
|
+
[**list_audit_entries_for_node**](AuditApi.md#list_audit_entries_for_node) | **GET** /nodes/{nodeId}/audit-entries | List audit entries for a node
|
14
|
+
[**update_audit_app**](AuditApi.md#update_audit_app) | **PUT** /audit-applications/{auditApplicationId} | Update audit application info
|
15
|
+
|
16
|
+
|
17
|
+
# **delete_audit_entries_for_audit_app**
|
18
|
+
> delete_audit_entries_for_audit_app(audit_application_id, where)
|
19
|
+
|
20
|
+
Permanently delete audit entries for an audit application
|
21
|
+
|
22
|
+
**Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. Permanently delete audit entries for an audit application **auditApplicationId**. The **where** clause must be specified, either with an inclusive time period or for an inclusive range of ids. The delete is within the context of the given audit application. For example: * ```where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(id BETWEEN ('1234', '4321')``` You must have admin rights to delete audit information.
|
23
|
+
|
24
|
+
### Example
|
25
|
+
```ruby
|
26
|
+
# load the gem
|
27
|
+
require 'alfresco_api'
|
28
|
+
# setup authorization
|
29
|
+
AlfrescoAPI.configure do |config|
|
30
|
+
# Configure HTTP basic authorization: basicAuth
|
31
|
+
config.username = 'YOUR USERNAME'
|
32
|
+
config.password = 'YOUR PASSWORD'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = AlfrescoAPI::AuditApi.new
|
36
|
+
|
37
|
+
audit_application_id = "audit_application_id_example" # String | The identifier of an audit application.
|
38
|
+
|
39
|
+
where = "where_example" # String | Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. For example: * ```where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(id BETWEEN ('1234', '4321')```
|
40
|
+
|
41
|
+
|
42
|
+
begin
|
43
|
+
#Permanently delete audit entries for an audit application
|
44
|
+
api_instance.delete_audit_entries_for_audit_app(audit_application_id, where)
|
45
|
+
rescue AlfrescoAPI::ApiError => e
|
46
|
+
puts "Exception when calling AuditApi->delete_audit_entries_for_audit_app: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
### Parameters
|
51
|
+
|
52
|
+
Name | Type | Description | Notes
|
53
|
+
------------- | ------------- | ------------- | -------------
|
54
|
+
**audit_application_id** | **String**| The identifier of an audit application. |
|
55
|
+
**where** | **String**| Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. For example: * ```where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(id BETWEEN ('1234', '4321')``` |
|
56
|
+
|
57
|
+
### Return type
|
58
|
+
|
59
|
+
nil (empty response body)
|
60
|
+
|
61
|
+
### Authorization
|
62
|
+
|
63
|
+
[basicAuth](../README.md#basicAuth)
|
64
|
+
|
65
|
+
### HTTP request headers
|
66
|
+
|
67
|
+
- **Content-Type**: application/json
|
68
|
+
- **Accept**: application/json
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
# **delete_audit_entry**
|
73
|
+
> delete_audit_entry(audit_application_id, audit_entry_id)
|
74
|
+
|
75
|
+
Permanently delete an audit entry
|
76
|
+
|
77
|
+
**Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. Permanently delete a single audit entry **auditEntryId**. You must have admin rights to delete audit information.
|
78
|
+
|
79
|
+
### Example
|
80
|
+
```ruby
|
81
|
+
# load the gem
|
82
|
+
require 'alfresco_api'
|
83
|
+
# setup authorization
|
84
|
+
AlfrescoAPI.configure do |config|
|
85
|
+
# Configure HTTP basic authorization: basicAuth
|
86
|
+
config.username = 'YOUR USERNAME'
|
87
|
+
config.password = 'YOUR PASSWORD'
|
88
|
+
end
|
89
|
+
|
90
|
+
api_instance = AlfrescoAPI::AuditApi.new
|
91
|
+
|
92
|
+
audit_application_id = "audit_application_id_example" # String | The identifier of an audit application.
|
93
|
+
|
94
|
+
audit_entry_id = "audit_entry_id_example" # String | The identifier of an audit entry.
|
95
|
+
|
96
|
+
|
97
|
+
begin
|
98
|
+
#Permanently delete an audit entry
|
99
|
+
api_instance.delete_audit_entry(audit_application_id, audit_entry_id)
|
100
|
+
rescue AlfrescoAPI::ApiError => e
|
101
|
+
puts "Exception when calling AuditApi->delete_audit_entry: #{e}"
|
102
|
+
end
|
103
|
+
```
|
104
|
+
|
105
|
+
### Parameters
|
106
|
+
|
107
|
+
Name | Type | Description | Notes
|
108
|
+
------------- | ------------- | ------------- | -------------
|
109
|
+
**audit_application_id** | **String**| The identifier of an audit application. |
|
110
|
+
**audit_entry_id** | **String**| The identifier of an audit entry. |
|
111
|
+
|
112
|
+
### Return type
|
113
|
+
|
114
|
+
nil (empty response body)
|
115
|
+
|
116
|
+
### Authorization
|
117
|
+
|
118
|
+
[basicAuth](../README.md#basicAuth)
|
119
|
+
|
120
|
+
### HTTP request headers
|
121
|
+
|
122
|
+
- **Content-Type**: application/json
|
123
|
+
- **Accept**: application/json
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
# **get_audit_app**
|
128
|
+
> AuditApp get_audit_app(audit_application_id, , opts)
|
129
|
+
|
130
|
+
Get audit application info
|
131
|
+
|
132
|
+
**Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. Get status of an audit application **auditApplicationId**. You must have admin rights to retrieve audit information.
|
133
|
+
|
134
|
+
### Example
|
135
|
+
```ruby
|
136
|
+
# load the gem
|
137
|
+
require 'alfresco_api'
|
138
|
+
# setup authorization
|
139
|
+
AlfrescoAPI.configure do |config|
|
140
|
+
# Configure HTTP basic authorization: basicAuth
|
141
|
+
config.username = 'YOUR USERNAME'
|
142
|
+
config.password = 'YOUR PASSWORD'
|
143
|
+
end
|
144
|
+
|
145
|
+
api_instance = AlfrescoAPI::AuditApi.new
|
146
|
+
|
147
|
+
audit_application_id = "audit_application_id_example" # String | The identifier of an audit application.
|
148
|
+
|
149
|
+
opts = {
|
150
|
+
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.
|
151
|
+
}
|
152
|
+
|
153
|
+
begin
|
154
|
+
#Get audit application info
|
155
|
+
result = api_instance.get_audit_app(audit_application_id, , opts)
|
156
|
+
p result
|
157
|
+
rescue AlfrescoAPI::ApiError => e
|
158
|
+
puts "Exception when calling AuditApi->get_audit_app: #{e}"
|
159
|
+
end
|
160
|
+
```
|
161
|
+
|
162
|
+
### Parameters
|
163
|
+
|
164
|
+
Name | Type | Description | Notes
|
165
|
+
------------- | ------------- | ------------- | -------------
|
166
|
+
**audit_application_id** | **String**| The identifier of an audit application. |
|
167
|
+
**fields** | [**Array<String>**](String.md)| 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. | [optional]
|
168
|
+
|
169
|
+
### Return type
|
170
|
+
|
171
|
+
[**AuditApp**](AuditApp.md)
|
172
|
+
|
173
|
+
### Authorization
|
174
|
+
|
175
|
+
[basicAuth](../README.md#basicAuth)
|
176
|
+
|
177
|
+
### HTTP request headers
|
178
|
+
|
179
|
+
- **Content-Type**: application/json
|
180
|
+
- **Accept**: application/json
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
# **get_audit_entry**
|
185
|
+
> AuditEntryEntry get_audit_entry(audit_application_id, audit_entry_id, opts)
|
186
|
+
|
187
|
+
Get audit entry
|
188
|
+
|
189
|
+
**Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. Gets audit entry **auditEntryId**. You must have admin rights to access audit information.
|
190
|
+
|
191
|
+
### Example
|
192
|
+
```ruby
|
193
|
+
# load the gem
|
194
|
+
require 'alfresco_api'
|
195
|
+
# setup authorization
|
196
|
+
AlfrescoAPI.configure do |config|
|
197
|
+
# Configure HTTP basic authorization: basicAuth
|
198
|
+
config.username = 'YOUR USERNAME'
|
199
|
+
config.password = 'YOUR PASSWORD'
|
200
|
+
end
|
201
|
+
|
202
|
+
api_instance = AlfrescoAPI::AuditApi.new
|
203
|
+
|
204
|
+
audit_application_id = "audit_application_id_example" # String | The identifier of an audit application.
|
205
|
+
|
206
|
+
audit_entry_id = "audit_entry_id_example" # String | The identifier of an audit entry.
|
207
|
+
|
208
|
+
opts = {
|
209
|
+
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.
|
210
|
+
}
|
211
|
+
|
212
|
+
begin
|
213
|
+
#Get audit entry
|
214
|
+
result = api_instance.get_audit_entry(audit_application_id, audit_entry_id, opts)
|
215
|
+
p result
|
216
|
+
rescue AlfrescoAPI::ApiError => e
|
217
|
+
puts "Exception when calling AuditApi->get_audit_entry: #{e}"
|
218
|
+
end
|
219
|
+
```
|
220
|
+
|
221
|
+
### Parameters
|
222
|
+
|
223
|
+
Name | Type | Description | Notes
|
224
|
+
------------- | ------------- | ------------- | -------------
|
225
|
+
**audit_application_id** | **String**| The identifier of an audit application. |
|
226
|
+
**audit_entry_id** | **String**| The identifier of an audit entry. |
|
227
|
+
**fields** | [**Array<String>**](String.md)| 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. | [optional]
|
228
|
+
|
229
|
+
### Return type
|
230
|
+
|
231
|
+
[**AuditEntryEntry**](AuditEntryEntry.md)
|
232
|
+
|
233
|
+
### Authorization
|
234
|
+
|
235
|
+
[basicAuth](../README.md#basicAuth)
|
236
|
+
|
237
|
+
### HTTP request headers
|
238
|
+
|
239
|
+
- **Content-Type**: application/json
|
240
|
+
- **Accept**: application/json
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
# **list_audit_apps**
|
245
|
+
> AuditAppPaging list_audit_apps(opts)
|
246
|
+
|
247
|
+
List audit applications
|
248
|
+
|
249
|
+
**Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. Gets a list of audit applications in this repository. This list may include pre-configured audit applications, if enabled, such as: * alfresco-access * CMISChangeLog * Alfresco Tagging Service * Alfresco Sync Service (used by Enterprise Cloud Sync) You must have admin rights to retrieve audit information.
|
250
|
+
|
251
|
+
### Example
|
252
|
+
```ruby
|
253
|
+
# load the gem
|
254
|
+
require 'alfresco_api'
|
255
|
+
# setup authorization
|
256
|
+
AlfrescoAPI.configure do |config|
|
257
|
+
# Configure HTTP basic authorization: basicAuth
|
258
|
+
config.username = 'YOUR USERNAME'
|
259
|
+
config.password = 'YOUR PASSWORD'
|
260
|
+
end
|
261
|
+
|
262
|
+
api_instance = AlfrescoAPI::AuditApi.new
|
263
|
+
|
264
|
+
opts = {
|
265
|
+
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.
|
266
|
+
max_items: 100, # Integer | The maximum number of items to return in the list. If not supplied then the default value is 100.
|
267
|
+
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.
|
268
|
+
}
|
269
|
+
|
270
|
+
begin
|
271
|
+
#List audit applications
|
272
|
+
result = api_instance.list_audit_apps(opts)
|
273
|
+
p result
|
274
|
+
rescue AlfrescoAPI::ApiError => e
|
275
|
+
puts "Exception when calling AuditApi->list_audit_apps: #{e}"
|
276
|
+
end
|
277
|
+
```
|
278
|
+
|
279
|
+
### Parameters
|
280
|
+
|
281
|
+
Name | Type | Description | Notes
|
282
|
+
------------- | ------------- | ------------- | -------------
|
283
|
+
**skip_count** | **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. | [optional] [default to 0]
|
284
|
+
**max_items** | **Integer**| The maximum number of items to return in the list. If not supplied then the default value is 100. | [optional] [default to 100]
|
285
|
+
**fields** | [**Array<String>**](String.md)| 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. | [optional]
|
286
|
+
|
287
|
+
### Return type
|
288
|
+
|
289
|
+
[**AuditAppPaging**](AuditAppPaging.md)
|
290
|
+
|
291
|
+
### Authorization
|
292
|
+
|
293
|
+
[basicAuth](../README.md#basicAuth)
|
294
|
+
|
295
|
+
### HTTP request headers
|
296
|
+
|
297
|
+
- **Content-Type**: application/json
|
298
|
+
- **Accept**: application/json
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
# **list_audit_entries_for_audit_app**
|
303
|
+
> AuditEntryPaging list_audit_entries_for_audit_app(audit_application_id, , opts)
|
304
|
+
|
305
|
+
List audit entries for an audit application
|
306
|
+
|
307
|
+
**Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. Gets a list of audit entries for audit application **auditApplicationId**. You can use the **include** parameter to return additional **values** information. The list can be filtered by one or more of: * **createdByUser** person id * **createdAt** inclusive time period * **id** inclusive range of ids * **valuesKey** audit entry values contains the exact matching key * **valuesValue** audit entry values contains the exact matching value The default sort order is **createdAt** ascending, but you can use an optional **ASC** or **DESC** modifier to specify an ascending or descending sort order. For example, specifying ```orderBy=createdAt DESC``` returns audit entries in descending **createdAt** order. You must have admin rights to retrieve audit information.
|
308
|
+
|
309
|
+
### Example
|
310
|
+
```ruby
|
311
|
+
# load the gem
|
312
|
+
require 'alfresco_api'
|
313
|
+
# setup authorization
|
314
|
+
AlfrescoAPI.configure do |config|
|
315
|
+
# Configure HTTP basic authorization: basicAuth
|
316
|
+
config.username = 'YOUR USERNAME'
|
317
|
+
config.password = 'YOUR PASSWORD'
|
318
|
+
end
|
319
|
+
|
320
|
+
api_instance = AlfrescoAPI::AuditApi.new
|
321
|
+
|
322
|
+
audit_application_id = "audit_application_id_example" # String | The identifier of an audit application.
|
323
|
+
|
324
|
+
opts = {
|
325
|
+
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.
|
326
|
+
order_by: ["order_by_example"], # Array<String> | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
|
327
|
+
max_items: 100, # Integer | The maximum number of items to return in the list. If not supplied then the default value is 100.
|
328
|
+
where: "where_example", # String | Optionally filter the list. Here are some examples: * ```where=(createdByUser='jbloggs')``` * ```where=(id BETWEEN ('1234', '4321')``` * ```where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(valuesKey='/alfresco-access/login/user')``` * ```where=(valuesKey='/alfresco-access/transaction/action' and valuesValue='DELETE')```
|
329
|
+
include: ["include_example"], # Array<String> | Returns additional information about the audit entry. The following optional fields can be requested: * values
|
330
|
+
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.
|
331
|
+
}
|
332
|
+
|
333
|
+
begin
|
334
|
+
#List audit entries for an audit application
|
335
|
+
result = api_instance.list_audit_entries_for_audit_app(audit_application_id, , opts)
|
336
|
+
p result
|
337
|
+
rescue AlfrescoAPI::ApiError => e
|
338
|
+
puts "Exception when calling AuditApi->list_audit_entries_for_audit_app: #{e}"
|
339
|
+
end
|
340
|
+
```
|
341
|
+
|
342
|
+
### Parameters
|
343
|
+
|
344
|
+
Name | Type | Description | Notes
|
345
|
+
------------- | ------------- | ------------- | -------------
|
346
|
+
**audit_application_id** | **String**| The identifier of an audit application. |
|
347
|
+
**skip_count** | **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. | [optional] [default to 0]
|
348
|
+
**order_by** | [**Array<String>**](String.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field. | [optional]
|
349
|
+
**max_items** | **Integer**| The maximum number of items to return in the list. If not supplied then the default value is 100. | [optional] [default to 100]
|
350
|
+
**where** | **String**| Optionally filter the list. Here are some examples: * ```where=(createdByUser='jbloggs')``` * ```where=(id BETWEEN ('1234', '4321')``` * ```where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(valuesKey='/alfresco-access/login/user')``` * ```where=(valuesKey='/alfresco-access/transaction/action' and valuesValue='DELETE')``` | [optional]
|
351
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the audit entry. The following optional fields can be requested: * values | [optional]
|
352
|
+
**fields** | [**Array<String>**](String.md)| 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. | [optional]
|
353
|
+
|
354
|
+
### Return type
|
355
|
+
|
356
|
+
[**AuditEntryPaging**](AuditEntryPaging.md)
|
357
|
+
|
358
|
+
### Authorization
|
359
|
+
|
360
|
+
[basicAuth](../README.md#basicAuth)
|
361
|
+
|
362
|
+
### HTTP request headers
|
363
|
+
|
364
|
+
- **Content-Type**: application/json
|
365
|
+
- **Accept**: application/json
|
366
|
+
|
367
|
+
|
368
|
+
|
369
|
+
# **list_audit_entries_for_node**
|
370
|
+
> AuditEntryPaging list_audit_entries_for_node(node_id, opts)
|
371
|
+
|
372
|
+
List audit entries for a node
|
373
|
+
|
374
|
+
**Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. Gets a list of audit entries for node **nodeId**. The list can be filtered by **createdByUser** and for a given inclusive time period. The default sort order is **createdAt** ascending, but you can use an optional **ASC** or **DESC** modifier to specify an ascending or descending sort order. For example, specifying ```orderBy=createdAt DESC``` returns audit entries in descending **createdAt** order. This relies on the pre-configured 'alfresco-access' audit application.
|
375
|
+
|
376
|
+
### Example
|
377
|
+
```ruby
|
378
|
+
# load the gem
|
379
|
+
require 'alfresco_api'
|
380
|
+
# setup authorization
|
381
|
+
AlfrescoAPI.configure do |config|
|
382
|
+
# Configure HTTP basic authorization: basicAuth
|
383
|
+
config.username = 'YOUR USERNAME'
|
384
|
+
config.password = 'YOUR PASSWORD'
|
385
|
+
end
|
386
|
+
|
387
|
+
api_instance = AlfrescoAPI::AuditApi.new
|
388
|
+
|
389
|
+
node_id = "node_id_example" # String | The identifier of a node.
|
390
|
+
|
391
|
+
opts = {
|
392
|
+
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.
|
393
|
+
order_by: ["order_by_example"], # Array<String> | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
|
394
|
+
max_items: 100, # Integer | The maximum number of items to return in the list. If not supplied then the default value is 100.
|
395
|
+
where: "where_example", # String | Optionally filter the list. Here are some examples: * ```where=(createdByUser='-me-')``` * ```where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')```
|
396
|
+
include: ["include_example"], # Array<String> | Returns additional information about the audit entry. The following optional fields can be requested: * values
|
397
|
+
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.
|
398
|
+
}
|
399
|
+
|
400
|
+
begin
|
401
|
+
#List audit entries for a node
|
402
|
+
result = api_instance.list_audit_entries_for_node(node_id, opts)
|
403
|
+
p result
|
404
|
+
rescue AlfrescoAPI::ApiError => e
|
405
|
+
puts "Exception when calling AuditApi->list_audit_entries_for_node: #{e}"
|
406
|
+
end
|
407
|
+
```
|
408
|
+
|
409
|
+
### Parameters
|
410
|
+
|
411
|
+
Name | Type | Description | Notes
|
412
|
+
------------- | ------------- | ------------- | -------------
|
413
|
+
**node_id** | **String**| The identifier of a node. |
|
414
|
+
**skip_count** | **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. | [optional] [default to 0]
|
415
|
+
**order_by** | [**Array<String>**](String.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field. | [optional]
|
416
|
+
**max_items** | **Integer**| The maximum number of items to return in the list. If not supplied then the default value is 100. | [optional] [default to 100]
|
417
|
+
**where** | **String**| Optionally filter the list. Here are some examples: * ```where=(createdByUser='-me-')``` * ```where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` | [optional]
|
418
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the audit entry. The following optional fields can be requested: * values | [optional]
|
419
|
+
**fields** | [**Array<String>**](String.md)| 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. | [optional]
|
420
|
+
|
421
|
+
### Return type
|
422
|
+
|
423
|
+
[**AuditEntryPaging**](AuditEntryPaging.md)
|
424
|
+
|
425
|
+
### Authorization
|
426
|
+
|
427
|
+
[basicAuth](../README.md#basicAuth)
|
428
|
+
|
429
|
+
### HTTP request headers
|
430
|
+
|
431
|
+
- **Content-Type**: application/json
|
432
|
+
- **Accept**: application/json
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
# **update_audit_app**
|
437
|
+
> AuditApp update_audit_app(audit_application_id, audit_app_body_update, opts)
|
438
|
+
|
439
|
+
Update audit application info
|
440
|
+
|
441
|
+
**Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. Disable or re-enable the audit application **auditApplicationId**. New audit entries will not be created for a disabled audit application until it is re-enabled (and system-wide auditing is also enabled). Note, it is still possible to query &/or delete any existing audit entries even if auditing is disabled for the audit application. You must have admin rights to update audit application.
|
442
|
+
|
443
|
+
### Example
|
444
|
+
```ruby
|
445
|
+
# load the gem
|
446
|
+
require 'alfresco_api'
|
447
|
+
# setup authorization
|
448
|
+
AlfrescoAPI.configure do |config|
|
449
|
+
# Configure HTTP basic authorization: basicAuth
|
450
|
+
config.username = 'YOUR USERNAME'
|
451
|
+
config.password = 'YOUR PASSWORD'
|
452
|
+
end
|
453
|
+
|
454
|
+
api_instance = AlfrescoAPI::AuditApi.new
|
455
|
+
|
456
|
+
audit_application_id = "audit_application_id_example" # String | The identifier of an audit application.
|
457
|
+
|
458
|
+
audit_app_body_update = AlfrescoAPI::AuditBodyUpdate.new # AuditBodyUpdate | The audit application to update.
|
459
|
+
|
460
|
+
opts = {
|
461
|
+
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.
|
462
|
+
}
|
463
|
+
|
464
|
+
begin
|
465
|
+
#Update audit application info
|
466
|
+
result = api_instance.update_audit_app(audit_application_id, audit_app_body_update, opts)
|
467
|
+
p result
|
468
|
+
rescue AlfrescoAPI::ApiError => e
|
469
|
+
puts "Exception when calling AuditApi->update_audit_app: #{e}"
|
470
|
+
end
|
471
|
+
```
|
472
|
+
|
473
|
+
### Parameters
|
474
|
+
|
475
|
+
Name | Type | Description | Notes
|
476
|
+
------------- | ------------- | ------------- | -------------
|
477
|
+
**audit_application_id** | **String**| The identifier of an audit application. |
|
478
|
+
**audit_app_body_update** | [**AuditBodyUpdate**](AuditBodyUpdate.md)| The audit application to update. |
|
479
|
+
**fields** | [**Array<String>**](String.md)| 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. | [optional]
|
480
|
+
|
481
|
+
### Return type
|
482
|
+
|
483
|
+
[**AuditApp**](AuditApp.md)
|
484
|
+
|
485
|
+
### Authorization
|
486
|
+
|
487
|
+
[basicAuth](../README.md#basicAuth)
|
488
|
+
|
489
|
+
### HTTP request headers
|
490
|
+
|
491
|
+
- **Content-Type**: application/json
|
492
|
+
- **Accept**: application/json
|
493
|
+
|
494
|
+
|
495
|
+
|