alfresco_api 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- 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/NodesApi.md
ADDED
@@ -0,0 +1,1206 @@
|
|
1
|
+
# AlfrescoAPI::NodesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**copy_node**](NodesApi.md#copy_node) | **POST** /nodes/{nodeId}/copy | Copy a node
|
8
|
+
[**create_assocation**](NodesApi.md#create_assocation) | **POST** /nodes/{nodeId}/targets | Create node association
|
9
|
+
[**create_node**](NodesApi.md#create_node) | **POST** /nodes/{nodeId}/children | Create a node
|
10
|
+
[**create_secondary_child_assocation**](NodesApi.md#create_secondary_child_assocation) | **POST** /nodes/{nodeId}/secondary-children | Create secondary child
|
11
|
+
[**delete_assocation**](NodesApi.md#delete_assocation) | **DELETE** /nodes/{nodeId}/targets/{targetId} | Delete node association(s)
|
12
|
+
[**delete_node**](NodesApi.md#delete_node) | **DELETE** /nodes/{nodeId} | Delete a node
|
13
|
+
[**delete_secondary_child_assocation**](NodesApi.md#delete_secondary_child_assocation) | **DELETE** /nodes/{nodeId}/secondary-children/{childId} | Delete secondary child or children
|
14
|
+
[**get_node**](NodesApi.md#get_node) | **GET** /nodes/{nodeId} | Get a node
|
15
|
+
[**get_node_content**](NodesApi.md#get_node_content) | **GET** /nodes/{nodeId}/content | Get node content
|
16
|
+
[**list_node_children**](NodesApi.md#list_node_children) | **GET** /nodes/{nodeId}/children | List node children
|
17
|
+
[**list_parents**](NodesApi.md#list_parents) | **GET** /nodes/{nodeId}/parents | List parents
|
18
|
+
[**list_secondary_children**](NodesApi.md#list_secondary_children) | **GET** /nodes/{nodeId}/secondary-children | List secondary children
|
19
|
+
[**list_source_associations**](NodesApi.md#list_source_associations) | **GET** /nodes/{nodeId}/sources | List source associations
|
20
|
+
[**list_target_associations**](NodesApi.md#list_target_associations) | **GET** /nodes/{nodeId}/targets | List target associations
|
21
|
+
[**lock_node**](NodesApi.md#lock_node) | **POST** /nodes/{nodeId}/lock | Lock a node
|
22
|
+
[**move_node**](NodesApi.md#move_node) | **POST** /nodes/{nodeId}/move | Move a node
|
23
|
+
[**unlock_node**](NodesApi.md#unlock_node) | **POST** /nodes/{nodeId}/unlock | Unlock a node
|
24
|
+
[**update_node**](NodesApi.md#update_node) | **PUT** /nodes/{nodeId} | Update a node
|
25
|
+
[**update_node_content**](NodesApi.md#update_node_content) | **PUT** /nodes/{nodeId}/content | Update node content
|
26
|
+
|
27
|
+
|
28
|
+
# **copy_node**
|
29
|
+
> NodeEntry copy_node(node_idnode_body_copy, opts)
|
30
|
+
|
31
|
+
Copy a node
|
32
|
+
|
33
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Copies the node **nodeId** to the parent folder node **targetParentId**. You specify the **targetParentId** in the request body. The new node has the same name as the source node unless you specify a new **name** in the request body. If the source **nodeId** is a folder, then all of its children are also copied. If the source **nodeId** is a file, it's properties, aspects and tags are copied, it's ratings, comments and locks are not.
|
34
|
+
|
35
|
+
### Example
|
36
|
+
```ruby
|
37
|
+
# load the gem
|
38
|
+
require 'alfresco_api'
|
39
|
+
# setup authorization
|
40
|
+
AlfrescoAPI.configure do |config|
|
41
|
+
# Configure HTTP basic authorization: basicAuth
|
42
|
+
config.username = 'YOUR USERNAME'
|
43
|
+
config.password = 'YOUR PASSWORD'
|
44
|
+
end
|
45
|
+
|
46
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
47
|
+
|
48
|
+
node_id = "node_id_example" # String | The identifier of a node.
|
49
|
+
|
50
|
+
node_body_copy = AlfrescoAPI::NodeBodyCopy.new # NodeBodyCopy | The targetParentId and, optionally, a new name which should include the file extension.
|
51
|
+
|
52
|
+
opts = {
|
53
|
+
include: ["include_example"] # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions
|
54
|
+
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.
|
55
|
+
}
|
56
|
+
|
57
|
+
begin
|
58
|
+
#Copy a node
|
59
|
+
result = api_instance.copy_node(node_idnode_body_copy, opts)
|
60
|
+
p result
|
61
|
+
rescue AlfrescoAPI::ApiError => e
|
62
|
+
puts "Exception when calling NodesApi->copy_node: #{e}"
|
63
|
+
end
|
64
|
+
```
|
65
|
+
|
66
|
+
### Parameters
|
67
|
+
|
68
|
+
Name | Type | Description | Notes
|
69
|
+
------------- | ------------- | ------------- | -------------
|
70
|
+
**node_id** | **String**| The identifier of a node. |
|
71
|
+
**node_body_copy** | [**NodeBodyCopy**](NodeBodyCopy.md)| The targetParentId and, optionally, a new name which should include the file extension. |
|
72
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions | [optional]
|
73
|
+
**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]
|
74
|
+
|
75
|
+
### Return type
|
76
|
+
|
77
|
+
[**NodeEntry**](NodeEntry.md)
|
78
|
+
|
79
|
+
### Authorization
|
80
|
+
|
81
|
+
[basicAuth](../README.md#basicAuth)
|
82
|
+
|
83
|
+
### HTTP request headers
|
84
|
+
|
85
|
+
- **Content-Type**: application/json
|
86
|
+
- **Accept**: application/json
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
# **create_assocation**
|
91
|
+
> AssociationEntry create_assocation(node_id, association_body_create, opts)
|
92
|
+
|
93
|
+
Create node association
|
94
|
+
|
95
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Create an association, with the given association type, between the source **nodeId** and a target node. **Note:** You can create more than one association by specifying a list of associations in the JSON body like this: ```JSON [ { \"targetId\": \"string\", \"assocType\": \"string\" }, { \"targetId\": \"string\", \"assocType\": \"string\" } ] ``` If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: ```JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } } ```
|
96
|
+
|
97
|
+
### Example
|
98
|
+
```ruby
|
99
|
+
# load the gem
|
100
|
+
require 'alfresco_api'
|
101
|
+
# setup authorization
|
102
|
+
AlfrescoAPI.configure do |config|
|
103
|
+
# Configure HTTP basic authorization: basicAuth
|
104
|
+
config.username = 'YOUR USERNAME'
|
105
|
+
config.password = 'YOUR PASSWORD'
|
106
|
+
end
|
107
|
+
|
108
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
109
|
+
|
110
|
+
node_id = "node_id_example" # String | The identifier of a source node.
|
111
|
+
|
112
|
+
association_body_create = AlfrescoAPI::AssociationBody.new # AssociationBody | The target node id and assoc type.
|
113
|
+
|
114
|
+
opts = {
|
115
|
+
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.
|
116
|
+
}
|
117
|
+
|
118
|
+
begin
|
119
|
+
#Create node association
|
120
|
+
result = api_instance.create_assocation(node_id, association_body_create, opts)
|
121
|
+
p result
|
122
|
+
rescue AlfrescoAPI::ApiError => e
|
123
|
+
puts "Exception when calling NodesApi->create_assocation: #{e}"
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
### Parameters
|
128
|
+
|
129
|
+
Name | Type | Description | Notes
|
130
|
+
------------- | ------------- | ------------- | -------------
|
131
|
+
**node_id** | **String**| The identifier of a source node. |
|
132
|
+
**association_body_create** | [**AssociationBody**](AssociationBody.md)| The target node id and assoc type. |
|
133
|
+
**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]
|
134
|
+
|
135
|
+
### Return type
|
136
|
+
|
137
|
+
[**AssociationEntry**](AssociationEntry.md)
|
138
|
+
|
139
|
+
### Authorization
|
140
|
+
|
141
|
+
[basicAuth](../README.md#basicAuth)
|
142
|
+
|
143
|
+
### HTTP request headers
|
144
|
+
|
145
|
+
- **Content-Type**: application/json
|
146
|
+
- **Accept**: application/json
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
# **create_node**
|
151
|
+
> NodeEntry create_node(node_id, node_body_create, opts)
|
152
|
+
|
153
|
+
Create a node
|
154
|
+
|
155
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Create a node and add it as a primary child of node **nodeId**. This endpoint supports both JSON and multipart/form-data (file upload). **Using multipart/form-data** Use the **filedata** field to represent the content to upload, for example, the following curl command will create a node with the contents of test.txt in the test user's home folder. ```curl -utest:test -X POST host:port/alfresco/api/-default-/public/alfresco/versions/1/nodes/-my-/children -F filedata=@test.txt``` You can use the **name** field to give an alternative name for the new file. You can use the **nodeType** field to create a specific type. The default is cm:content. You can use the **renditions** field to create renditions (e.g. doclib) asynchronously upon upload. Note that currently only one rendition can be requested. Also, as requesting rendition is a background process, any rendition failure (e.g. No transformer is currently available) will not fail the whole upload and has the potential to silently fail. Use **overwrite** to overwrite an existing file, matched by name. If the file is versionable, the existing content is replaced. When you overwrite existing content, you can set the **majorVersion** boolean field to **true** to indicate a major version should be created. The default for **majorVersion** is **false**. Setting **majorVersion** enables versioning of the node, if it is not already versioned. When you overwrite existing content, you can use the **comment** field to add a version comment that appears in the version history. This also enables versioning of this node, if it is not already versioned. You can set the **autoRename** boolean field to automatically resolve name clashes. If there is a name clash, then the API method tries to create a unique name using an integer suffix. You can use the **relativePath** field to specify the folder structure to create relative to the node **nodeId**. Folders in the **relativePath** that do not exist are created before the node is created. Any other field provided will be treated as a property to set on the newly created node. **Note:** setting properties of type d:content and d:category are not supported. **Using JSON** You must specify at least a **name** and **nodeType**. For example, to create a folder: ```JSON { \"name\":\"My Folder\", \"nodeType\":\"cm:folder\" } ``` You can create an empty file like this: ```JSON { \"name\":\"My text file.txt\", \"nodeType\":\"cm:content\" } ``` You can update binary content using the ```PUT /nodes/{nodeId}``` API method. You can create a folder, or other node, inside a folder hierarchy: ```JSON { \"name\":\"My Special Folder\", \"nodeType\":\"cm:folder\", \"relativePath\":\"X/Y/Z\" } ``` The **relativePath** specifies the folder structure to create relative to the node **nodeId**. Folders in the **relativePath** that do not exist are created before the node is created. You can set properties when you create a new node: ```JSON { \"name\":\"My Other Folder\", \"nodeType\":\"cm:folder\", \"properties\": { \"cm:title\":\"Folder title\", \"cm:description\":\"This is an important folder\" } } ``` Any missing aspects are applied automatically. For example, **cm:titled** in the JSON shown above. You can set aspects explicitly, if needed, using an **aspectNames** field. **Note:** setting properties of type d:content and d:category are not supported. Typically, for files and folders, the primary children are created within the parent folder using the default \"cm:contains\" assocType. If the content model allows then it is also possible to create primary children with a different assoc type. For example: ```JSON { \"name\":\"My Node\", \"nodeType\":\"my:specialNodeType\", \"association\": { \"assocType\":\"my:specialAssocType\" } } ``` Additional associations can be added after creating a node. You can also add associations at the time the node is created. This is required, for example, if the content model specifies that a node has mandatory associations to one or more existing nodes. You can optionally specify an array of **secondaryChildren** to create one or more secondary child associations, such that the newly created node acts as a parent node. You can optionally specify an array of **targets** to create one or more peer associations such that the newly created node acts as a source node. For example, to associate one or more secondary children at time of creation: ```JSON { \"name\":\"My Folder\", \"nodeType\":\"cm:folder\", \"secondaryChildren\": [ {\"childId\":\"abcde-01234-...\", \"assocType\":\"my:specialChildAssocType\"} ] } ``` For example, to associate one or more targets at time of creation: ```JSON { \"name\":\"My Folder\", \"nodeType\":\"cm:folder\", \"targets\": [ {\"targetId\":\"abcde-01234-...\", \"assocType\":\"my:specialPeerAssocType\"} ] } ``` **Note:** You can create more than one child by specifying a list of nodes in the JSON body. For example, the following JSON body creates two folders inside the specified **nodeId**, if the **nodeId** identifies a folder: ```JSON [ { \"name\":\"My Folder 1\", \"nodeType\":\"cm:folder\" }, { \"name\":\"My Folder 2\", \"nodeType\":\"cm:folder\" } ] ``` If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: ```JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } } ```
|
156
|
+
|
157
|
+
### Example
|
158
|
+
```ruby
|
159
|
+
# load the gem
|
160
|
+
require 'alfresco_api'
|
161
|
+
# setup authorization
|
162
|
+
AlfrescoAPI.configure do |config|
|
163
|
+
# Configure HTTP basic authorization: basicAuth
|
164
|
+
config.username = 'YOUR USERNAME'
|
165
|
+
config.password = 'YOUR PASSWORD'
|
166
|
+
end
|
167
|
+
|
168
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
169
|
+
|
170
|
+
node_id = "node_id_example" # String | The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
|
171
|
+
|
172
|
+
node_body_create = AlfrescoAPI::NodeBodyCreate.new # NodeBodyCreate | The node information to create.
|
173
|
+
|
174
|
+
opts = {
|
175
|
+
auto_rename: true, # BOOLEAN | If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
176
|
+
include: ["include_example"] # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions
|
177
|
+
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.
|
178
|
+
}
|
179
|
+
|
180
|
+
begin
|
181
|
+
#Create a node
|
182
|
+
result = api_instance.create_node(node_id, node_body_create, opts)
|
183
|
+
p result
|
184
|
+
rescue AlfrescoAPI::ApiError => e
|
185
|
+
puts "Exception when calling NodesApi->create_node: #{e}"
|
186
|
+
end
|
187
|
+
```
|
188
|
+
|
189
|
+
### Parameters
|
190
|
+
|
191
|
+
Name | Type | Description | Notes
|
192
|
+
------------- | ------------- | ------------- | -------------
|
193
|
+
**node_id** | **String**| The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root- |
|
194
|
+
**node_body_create** | [**NodeBodyCreate**](NodeBodyCreate.md)| The node information to create. |
|
195
|
+
**auto_rename** | **BOOLEAN**| If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix. | [optional]
|
196
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions | [optional]
|
197
|
+
**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]
|
198
|
+
|
199
|
+
### Return type
|
200
|
+
|
201
|
+
[**NodeEntry**](NodeEntry.md)
|
202
|
+
|
203
|
+
### Authorization
|
204
|
+
|
205
|
+
[basicAuth](../README.md#basicAuth)
|
206
|
+
|
207
|
+
### HTTP request headers
|
208
|
+
|
209
|
+
- **Content-Type**: application/json, multipart/form-data
|
210
|
+
- **Accept**: application/json
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
# **create_secondary_child_assocation**
|
215
|
+
> ChildAssociationEntry create_secondary_child_assocation(node_id, secondary_child_association_body_create, opts)
|
216
|
+
|
217
|
+
Create secondary child
|
218
|
+
|
219
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Create a secondary child association, with the given association type, between the parent **nodeId** and a child node. **Note:** You can create more than one secondary child association by specifying a list of associations in the JSON body like this: ```JSON [ { \"childId\": \"string\", \"assocType\": \"string\" }, { \"childId\": \"string\", \"assocType\": \"string\" } ] ``` If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: ```JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } } ```
|
220
|
+
|
221
|
+
### Example
|
222
|
+
```ruby
|
223
|
+
# load the gem
|
224
|
+
require 'alfresco_api'
|
225
|
+
# setup authorization
|
226
|
+
AlfrescoAPI.configure do |config|
|
227
|
+
# Configure HTTP basic authorization: basicAuth
|
228
|
+
config.username = 'YOUR USERNAME'
|
229
|
+
config.password = 'YOUR PASSWORD'
|
230
|
+
end
|
231
|
+
|
232
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
233
|
+
|
234
|
+
node_id = "node_id_example" # String | The identifier of a parent node.
|
235
|
+
|
236
|
+
secondary_child_association_body_create = AlfrescoAPI::ChildAssociationBody.new # ChildAssociationBody | The child node id and assoc type.
|
237
|
+
|
238
|
+
opts = {
|
239
|
+
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.
|
240
|
+
}
|
241
|
+
|
242
|
+
begin
|
243
|
+
#Create secondary child
|
244
|
+
result = api_instance.create_secondary_child_assocation(node_id, secondary_child_association_body_create, opts)
|
245
|
+
p result
|
246
|
+
rescue AlfrescoAPI::ApiError => e
|
247
|
+
puts "Exception when calling NodesApi->create_secondary_child_assocation: #{e}"
|
248
|
+
end
|
249
|
+
```
|
250
|
+
|
251
|
+
### Parameters
|
252
|
+
|
253
|
+
Name | Type | Description | Notes
|
254
|
+
------------- | ------------- | ------------- | -------------
|
255
|
+
**node_id** | **String**| The identifier of a parent node. |
|
256
|
+
**secondary_child_association_body_create** | [**ChildAssociationBody**](ChildAssociationBody.md)| The child node id and assoc type. |
|
257
|
+
**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]
|
258
|
+
|
259
|
+
### Return type
|
260
|
+
|
261
|
+
[**ChildAssociationEntry**](ChildAssociationEntry.md)
|
262
|
+
|
263
|
+
### Authorization
|
264
|
+
|
265
|
+
[basicAuth](../README.md#basicAuth)
|
266
|
+
|
267
|
+
### HTTP request headers
|
268
|
+
|
269
|
+
- **Content-Type**: application/json
|
270
|
+
- **Accept**: application/json
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
# **delete_assocation**
|
275
|
+
> delete_assocation(node_id, target_id, opts)
|
276
|
+
|
277
|
+
Delete node association(s)
|
278
|
+
|
279
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Delete an association, or associations, from the source **nodeId* to a target node for the given association type. If the association type is **not** specified, then all peer associations, of any type, in the direction from source to target, are deleted. **Note:** After removal of the peer association, or associations, from source to target, the two nodes may still have peer associations in the other direction.
|
280
|
+
|
281
|
+
### Example
|
282
|
+
```ruby
|
283
|
+
# load the gem
|
284
|
+
require 'alfresco_api'
|
285
|
+
# setup authorization
|
286
|
+
AlfrescoAPI.configure do |config|
|
287
|
+
# Configure HTTP basic authorization: basicAuth
|
288
|
+
config.username = 'YOUR USERNAME'
|
289
|
+
config.password = 'YOUR PASSWORD'
|
290
|
+
end
|
291
|
+
|
292
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
293
|
+
|
294
|
+
node_id = "node_id_example" # String | The identifier of a source node.
|
295
|
+
|
296
|
+
target_id = "target_id_example" # String | The identifier of a target node.
|
297
|
+
|
298
|
+
opts = {
|
299
|
+
assoc_type: "assoc_type_example" # String | Only delete associations of this type.
|
300
|
+
}
|
301
|
+
|
302
|
+
begin
|
303
|
+
#Delete node association(s)
|
304
|
+
api_instance.delete_assocation(node_id, target_id, opts)
|
305
|
+
rescue AlfrescoAPI::ApiError => e
|
306
|
+
puts "Exception when calling NodesApi->delete_assocation: #{e}"
|
307
|
+
end
|
308
|
+
```
|
309
|
+
|
310
|
+
### Parameters
|
311
|
+
|
312
|
+
Name | Type | Description | Notes
|
313
|
+
------------- | ------------- | ------------- | -------------
|
314
|
+
**node_id** | **String**| The identifier of a source node. |
|
315
|
+
**target_id** | **String**| The identifier of a target node. |
|
316
|
+
**assoc_type** | **String**| Only delete associations of this type. | [optional]
|
317
|
+
|
318
|
+
### Return type
|
319
|
+
|
320
|
+
nil (empty response body)
|
321
|
+
|
322
|
+
### Authorization
|
323
|
+
|
324
|
+
[basicAuth](../README.md#basicAuth)
|
325
|
+
|
326
|
+
### HTTP request headers
|
327
|
+
|
328
|
+
- **Content-Type**: application/json
|
329
|
+
- **Accept**: application/json
|
330
|
+
|
331
|
+
|
332
|
+
|
333
|
+
# **delete_node**
|
334
|
+
> delete_node(node_id, opts)
|
335
|
+
|
336
|
+
Delete a node
|
337
|
+
|
338
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Deletes the node **nodeId**. If **nodeId** is a folder, then its children are also deleted. Deleted nodes move to the trashcan unless the **permanent** query parameter is **true** and the current user is the owner of the node or an admin. Deleting a node deletes it from its primary parent and also from any secondary parents. Peer associations are also deleted, where the deleted node is either a source or target of an association. This applies recursively to any hierarchy of primary children of the deleted node. **Note:** If the node is not permanently deleted, and is later successfully restored to its former primary parent, then the primary child association is restored. This applies recursively for any primary children. No other secondary child associations or peer associations are restored for any of the nodes in the primary parent-child hierarchy of restored nodes, regardless of whether the original associations were to nodes inside or outside the restored hierarchy.
|
339
|
+
|
340
|
+
### Example
|
341
|
+
```ruby
|
342
|
+
# load the gem
|
343
|
+
require 'alfresco_api'
|
344
|
+
# setup authorization
|
345
|
+
AlfrescoAPI.configure do |config|
|
346
|
+
# Configure HTTP basic authorization: basicAuth
|
347
|
+
config.username = 'YOUR USERNAME'
|
348
|
+
config.password = 'YOUR PASSWORD'
|
349
|
+
end
|
350
|
+
|
351
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
352
|
+
|
353
|
+
node_id = "node_id_example" # String | The identifier of a node.
|
354
|
+
|
355
|
+
opts = {
|
356
|
+
permanent: false # BOOLEAN | If **true** then the node is deleted permanently, without moving to the trashcan. Only the owner of the node or an admin can permanently delete the node.
|
357
|
+
}
|
358
|
+
|
359
|
+
begin
|
360
|
+
#Delete a node
|
361
|
+
api_instance.delete_node(node_id, opts)
|
362
|
+
rescue AlfrescoAPI::ApiError => e
|
363
|
+
puts "Exception when calling NodesApi->delete_node: #{e}"
|
364
|
+
end
|
365
|
+
```
|
366
|
+
|
367
|
+
### Parameters
|
368
|
+
|
369
|
+
Name | Type | Description | Notes
|
370
|
+
------------- | ------------- | ------------- | -------------
|
371
|
+
**node_id** | **String**| The identifier of a node. |
|
372
|
+
**permanent** | **BOOLEAN**| If **true** then the node is deleted permanently, without moving to the trashcan. Only the owner of the node or an admin can permanently delete the node. | [optional] [default to false]
|
373
|
+
|
374
|
+
### Return type
|
375
|
+
|
376
|
+
nil (empty response body)
|
377
|
+
|
378
|
+
### Authorization
|
379
|
+
|
380
|
+
[basicAuth](../README.md#basicAuth)
|
381
|
+
|
382
|
+
### HTTP request headers
|
383
|
+
|
384
|
+
- **Content-Type**: application/json
|
385
|
+
- **Accept**: application/json
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
# **delete_secondary_child_assocation**
|
390
|
+
> delete_secondary_child_assocation(node_id, child_id, opts)
|
391
|
+
|
392
|
+
Delete secondary child or children
|
393
|
+
|
394
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Delete secondary child associations between the parent **nodeId** and child nodes for the given association type. If the association type is **not** specified, then all secondary child associations, of any type in the direction from parent to secondary child, will be deleted. The child will still have a primary parent and may still be associated as a secondary child with other secondary parents.
|
395
|
+
|
396
|
+
### Example
|
397
|
+
```ruby
|
398
|
+
# load the gem
|
399
|
+
require 'alfresco_api'
|
400
|
+
# setup authorization
|
401
|
+
AlfrescoAPI.configure do |config|
|
402
|
+
# Configure HTTP basic authorization: basicAuth
|
403
|
+
config.username = 'YOUR USERNAME'
|
404
|
+
config.password = 'YOUR PASSWORD'
|
405
|
+
end
|
406
|
+
|
407
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
408
|
+
|
409
|
+
node_id = "node_id_example" # String | The identifier of a parent node.
|
410
|
+
|
411
|
+
child_id = "child_id_example" # String | The identifier of a child node.
|
412
|
+
|
413
|
+
opts = {
|
414
|
+
assoc_type: "assoc_type_example" # String | Only delete associations of this type.
|
415
|
+
}
|
416
|
+
|
417
|
+
begin
|
418
|
+
#Delete secondary child or children
|
419
|
+
api_instance.delete_secondary_child_assocation(node_id, child_id, opts)
|
420
|
+
rescue AlfrescoAPI::ApiError => e
|
421
|
+
puts "Exception when calling NodesApi->delete_secondary_child_assocation: #{e}"
|
422
|
+
end
|
423
|
+
```
|
424
|
+
|
425
|
+
### Parameters
|
426
|
+
|
427
|
+
Name | Type | Description | Notes
|
428
|
+
------------- | ------------- | ------------- | -------------
|
429
|
+
**node_id** | **String**| The identifier of a parent node. |
|
430
|
+
**child_id** | **String**| The identifier of a child node. |
|
431
|
+
**assoc_type** | **String**| Only delete associations of this type. | [optional]
|
432
|
+
|
433
|
+
### Return type
|
434
|
+
|
435
|
+
nil (empty response body)
|
436
|
+
|
437
|
+
### Authorization
|
438
|
+
|
439
|
+
[basicAuth](../README.md#basicAuth)
|
440
|
+
|
441
|
+
### HTTP request headers
|
442
|
+
|
443
|
+
- **Content-Type**: application/json
|
444
|
+
- **Accept**: application/json
|
445
|
+
|
446
|
+
|
447
|
+
|
448
|
+
# **get_node**
|
449
|
+
> NodeEntry get_node(node_id, , opts)
|
450
|
+
|
451
|
+
Get a node
|
452
|
+
|
453
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Get information for node **nodeId**. You can use the **include** parameter to return additional information.
|
454
|
+
|
455
|
+
### Example
|
456
|
+
```ruby
|
457
|
+
# load the gem
|
458
|
+
require 'alfresco_api'
|
459
|
+
# setup authorization
|
460
|
+
AlfrescoAPI.configure do |config|
|
461
|
+
# Configure HTTP basic authorization: basicAuth
|
462
|
+
config.username = 'YOUR USERNAME'
|
463
|
+
config.password = 'YOUR PASSWORD'
|
464
|
+
end
|
465
|
+
|
466
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
467
|
+
|
468
|
+
node_id = "node_id_example" # String | The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
|
469
|
+
|
470
|
+
opts = {
|
471
|
+
include: ["include_example"] # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions
|
472
|
+
relative_path: "relative_path_example", # String | A path relative to the **nodeId**. If you set this, information is returned on the node resolved by this path.
|
473
|
+
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.
|
474
|
+
}
|
475
|
+
|
476
|
+
begin
|
477
|
+
#Get a node
|
478
|
+
result = api_instance.get_node(node_id, , opts)
|
479
|
+
p result
|
480
|
+
rescue AlfrescoAPI::ApiError => e
|
481
|
+
puts "Exception when calling NodesApi->get_node: #{e}"
|
482
|
+
end
|
483
|
+
```
|
484
|
+
|
485
|
+
### Parameters
|
486
|
+
|
487
|
+
Name | Type | Description | Notes
|
488
|
+
------------- | ------------- | ------------- | -------------
|
489
|
+
**node_id** | **String**| The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root- |
|
490
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions | [optional]
|
491
|
+
**relative_path** | **String**| A path relative to the **nodeId**. If you set this, information is returned on the node resolved by this path. | [optional]
|
492
|
+
**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]
|
493
|
+
|
494
|
+
### Return type
|
495
|
+
|
496
|
+
[**NodeEntry**](NodeEntry.md)
|
497
|
+
|
498
|
+
### Authorization
|
499
|
+
|
500
|
+
[basicAuth](../README.md#basicAuth)
|
501
|
+
|
502
|
+
### HTTP request headers
|
503
|
+
|
504
|
+
- **Content-Type**: application/json
|
505
|
+
- **Accept**: application/json
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
# **get_node_content**
|
510
|
+
> get_node_content(node_id, opts)
|
511
|
+
|
512
|
+
Get node content
|
513
|
+
|
514
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets the content of the node with identifier **nodeId**.
|
515
|
+
|
516
|
+
### Example
|
517
|
+
```ruby
|
518
|
+
# load the gem
|
519
|
+
require 'alfresco_api'
|
520
|
+
# setup authorization
|
521
|
+
AlfrescoAPI.configure do |config|
|
522
|
+
# Configure HTTP basic authorization: basicAuth
|
523
|
+
config.username = 'YOUR USERNAME'
|
524
|
+
config.password = 'YOUR PASSWORD'
|
525
|
+
end
|
526
|
+
|
527
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
528
|
+
|
529
|
+
node_id = "node_id_example" # String | The identifier of a node.
|
530
|
+
|
531
|
+
opts = {
|
532
|
+
attachment: true, # BOOLEAN | **true** enables a web browser to download the file as an attachment. **false** means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to **false** if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of **false** is ignored, and the attachment will be returned in the response.
|
533
|
+
if_modified_since: DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, `Wed, 09 Mar 2016 16:56:34 GMT`.
|
534
|
+
}
|
535
|
+
|
536
|
+
begin
|
537
|
+
#Get node content
|
538
|
+
api_instance.get_node_content(node_id, opts)
|
539
|
+
rescue AlfrescoAPI::ApiError => e
|
540
|
+
puts "Exception when calling NodesApi->get_node_content: #{e}"
|
541
|
+
end
|
542
|
+
```
|
543
|
+
|
544
|
+
### Parameters
|
545
|
+
|
546
|
+
Name | Type | Description | Notes
|
547
|
+
------------- | ------------- | ------------- | -------------
|
548
|
+
**node_id** | **String**| The identifier of a node. |
|
549
|
+
**attachment** | **BOOLEAN**| **true** enables a web browser to download the file as an attachment. **false** means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to **false** if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of **false** is ignored, and the attachment will be returned in the response. | [optional] [default to true]
|
550
|
+
**if_modified_since** | **DateTime**| Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, `Wed, 09 Mar 2016 16:56:34 GMT`. | [optional]
|
551
|
+
|
552
|
+
### Return type
|
553
|
+
|
554
|
+
nil (empty response body)
|
555
|
+
|
556
|
+
### Authorization
|
557
|
+
|
558
|
+
[basicAuth](../README.md#basicAuth)
|
559
|
+
|
560
|
+
### HTTP request headers
|
561
|
+
|
562
|
+
- **Content-Type**: application/json
|
563
|
+
- **Accept**: application/json
|
564
|
+
|
565
|
+
|
566
|
+
|
567
|
+
# **list_node_children**
|
568
|
+
> NodeChildAssociationPaging list_node_children(node_id, , opts)
|
569
|
+
|
570
|
+
List node children
|
571
|
+
|
572
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of children of the parent node **nodeId**. Minimal information for each child is returned by default. You can use the **include** parameter to return additional information. The list of child nodes includes primary children and secondary children, if there are any. You can use the **include** parameter (include=association) to return child association details for each child, including the **assocTyp**e and the **isPrimary** flag. The default sort order for the returned list is for folders to be sorted before files, and by ascending name. You can override the default using **orderBy** to specify one or more fields to sort by. The default order is always ascending, but you can use an optional **ASC** or **DESC** modifier to specify an ascending or descending sort order. For example, specifying ```orderBy=name DESC``` returns a mixed folder/file list in descending **name** order. You can use any of the following fields to order the results: * isFolder * name * mimeType * nodeType * sizeInBytes * modifiedAt * createdAt * modifiedByUser * createdByUser
|
573
|
+
|
574
|
+
### Example
|
575
|
+
```ruby
|
576
|
+
# load the gem
|
577
|
+
require 'alfresco_api'
|
578
|
+
# setup authorization
|
579
|
+
AlfrescoAPI.configure do |config|
|
580
|
+
# Configure HTTP basic authorization: basicAuth
|
581
|
+
config.username = 'YOUR USERNAME'
|
582
|
+
config.password = 'YOUR PASSWORD'
|
583
|
+
end
|
584
|
+
|
585
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
586
|
+
|
587
|
+
node_id = "node_id_example" # String | The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
|
588
|
+
|
589
|
+
opts = {
|
590
|
+
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.
|
591
|
+
max_items: 100, # Integer | The maximum number of items to return in the list. If not supplied then the default value is 100.
|
592
|
+
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.
|
593
|
+
where: "where_example", # String | Optionally filter the list. Here are some examples: * ```where=(isFolder=true)``` * ```where=(isFile=true)``` * ```where=(nodeType='my:specialNodeType')``` * ```where=(nodeType='my:specialNodeType INCLUDESUBTYPES')``` * ```where=(isPrimary=true)``` * ```where=(assocType='my:specialAssocType')``` * ```where=(isPrimary=false and assocType='my:specialAssocType')```
|
594
|
+
include: ["include_example"] # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * association * isLink * isLocked * path * properties * permissions
|
595
|
+
relative_path: "relative_path_example", # String | Return information on children in the folder resolved by this path. The path is relative to **nodeId**.
|
596
|
+
include_source: true, # BOOLEAN | Also include **source** in addition to **entries** with folder information on the parent node – either the specified parent **nodeId**, or as resolved by **relativePath**.
|
597
|
+
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.
|
598
|
+
}
|
599
|
+
|
600
|
+
begin
|
601
|
+
#List node children
|
602
|
+
result = api_instance.list_node_children(node_id, , opts)
|
603
|
+
p result
|
604
|
+
rescue AlfrescoAPI::ApiError => e
|
605
|
+
puts "Exception when calling NodesApi->list_node_children: #{e}"
|
606
|
+
end
|
607
|
+
```
|
608
|
+
|
609
|
+
### Parameters
|
610
|
+
|
611
|
+
Name | Type | Description | Notes
|
612
|
+
------------- | ------------- | ------------- | -------------
|
613
|
+
**node_id** | **String**| The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root- |
|
614
|
+
**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]
|
615
|
+
**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]
|
616
|
+
**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]
|
617
|
+
**where** | **String**| Optionally filter the list. Here are some examples: * ```where=(isFolder=true)``` * ```where=(isFile=true)``` * ```where=(nodeType='my:specialNodeType')``` * ```where=(nodeType='my:specialNodeType INCLUDESUBTYPES')``` * ```where=(isPrimary=true)``` * ```where=(assocType='my:specialAssocType')``` * ```where=(isPrimary=false and assocType='my:specialAssocType')``` | [optional]
|
618
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * association * isLink * isLocked * path * properties * permissions | [optional]
|
619
|
+
**relative_path** | **String**| Return information on children in the folder resolved by this path. The path is relative to **nodeId**. | [optional]
|
620
|
+
**include_source** | **BOOLEAN**| Also include **source** in addition to **entries** with folder information on the parent node – either the specified parent **nodeId**, or as resolved by **relativePath**. | [optional]
|
621
|
+
**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]
|
622
|
+
|
623
|
+
### Return type
|
624
|
+
|
625
|
+
[**NodeChildAssociationPaging**](NodeChildAssociationPaging.md)
|
626
|
+
|
627
|
+
### Authorization
|
628
|
+
|
629
|
+
[basicAuth](../README.md#basicAuth)
|
630
|
+
|
631
|
+
### HTTP request headers
|
632
|
+
|
633
|
+
- **Content-Type**: application/json
|
634
|
+
- **Accept**: application/json
|
635
|
+
|
636
|
+
|
637
|
+
|
638
|
+
# **list_parents**
|
639
|
+
> NodeAssociationPaging list_parents(node_id, opts)
|
640
|
+
|
641
|
+
List parents
|
642
|
+
|
643
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of parent nodes that are associated with the current child **nodeId**. The list includes both the primary parent and any secondary parents.
|
644
|
+
|
645
|
+
### Example
|
646
|
+
```ruby
|
647
|
+
# load the gem
|
648
|
+
require 'alfresco_api'
|
649
|
+
# setup authorization
|
650
|
+
AlfrescoAPI.configure do |config|
|
651
|
+
# Configure HTTP basic authorization: basicAuth
|
652
|
+
config.username = 'YOUR USERNAME'
|
653
|
+
config.password = 'YOUR PASSWORD'
|
654
|
+
end
|
655
|
+
|
656
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
657
|
+
|
658
|
+
node_id = "node_id_example" # String | The identifier of a child node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
|
659
|
+
|
660
|
+
opts = {
|
661
|
+
where: "where_example", # String | Optionally filter the list by **assocType** and/or **isPrimary**. Here are some example filters: * ```where=(assocType='my:specialAssocType')``` * ```where=(isPrimary=true)``` * ```where=(isPrimary=false and assocType='my:specialAssocType')```
|
662
|
+
include: ["include_example"], # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties
|
663
|
+
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.
|
664
|
+
max_items: 100, # Integer | The maximum number of items to return in the list. If not supplied then the default value is 100.
|
665
|
+
include_source: true, # BOOLEAN | Also include **source** (in addition to **entries**) with folder information on **nodeId**
|
666
|
+
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.
|
667
|
+
}
|
668
|
+
|
669
|
+
begin
|
670
|
+
#List parents
|
671
|
+
result = api_instance.list_parents(node_id, opts)
|
672
|
+
p result
|
673
|
+
rescue AlfrescoAPI::ApiError => e
|
674
|
+
puts "Exception when calling NodesApi->list_parents: #{e}"
|
675
|
+
end
|
676
|
+
```
|
677
|
+
|
678
|
+
### Parameters
|
679
|
+
|
680
|
+
Name | Type | Description | Notes
|
681
|
+
------------- | ------------- | ------------- | -------------
|
682
|
+
**node_id** | **String**| The identifier of a child node. You can also use one of these well-known aliases: * -my- * -shared- * -root- |
|
683
|
+
**where** | **String**| Optionally filter the list by **assocType** and/or **isPrimary**. Here are some example filters: * ```where=(assocType='my:specialAssocType')``` * ```where=(isPrimary=true)``` * ```where=(isPrimary=false and assocType='my:specialAssocType')``` | [optional]
|
684
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties | [optional]
|
685
|
+
**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]
|
686
|
+
**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]
|
687
|
+
**include_source** | **BOOLEAN**| Also include **source** (in addition to **entries**) with folder information on **nodeId** | [optional]
|
688
|
+
**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]
|
689
|
+
|
690
|
+
### Return type
|
691
|
+
|
692
|
+
[**NodeAssociationPaging**](NodeAssociationPaging.md)
|
693
|
+
|
694
|
+
### Authorization
|
695
|
+
|
696
|
+
[basicAuth](../README.md#basicAuth)
|
697
|
+
|
698
|
+
### HTTP request headers
|
699
|
+
|
700
|
+
- **Content-Type**: application/json
|
701
|
+
- **Accept**: application/json
|
702
|
+
|
703
|
+
|
704
|
+
|
705
|
+
# **list_secondary_children**
|
706
|
+
> NodeChildAssociationPaging list_secondary_children(node_id, opts)
|
707
|
+
|
708
|
+
List secondary children
|
709
|
+
|
710
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of secondary child nodes that are associated with the current parent **nodeId**, via a secondary child association.
|
711
|
+
|
712
|
+
### Example
|
713
|
+
```ruby
|
714
|
+
# load the gem
|
715
|
+
require 'alfresco_api'
|
716
|
+
# setup authorization
|
717
|
+
AlfrescoAPI.configure do |config|
|
718
|
+
# Configure HTTP basic authorization: basicAuth
|
719
|
+
config.username = 'YOUR USERNAME'
|
720
|
+
config.password = 'YOUR PASSWORD'
|
721
|
+
end
|
722
|
+
|
723
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
724
|
+
|
725
|
+
node_id = "node_id_example" # String | The identifier of a parent node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
|
726
|
+
|
727
|
+
opts = {
|
728
|
+
where: "where_example", # String | Optionally filter the list by assocType. Here's an example: * ```where=(assocType='my:specialAssocType')```
|
729
|
+
include: ["include_example"], # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties
|
730
|
+
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.
|
731
|
+
max_items: 100, # Integer | The maximum number of items to return in the list. If not supplied then the default value is 100.
|
732
|
+
include_source: true, # BOOLEAN | Also include **source** (in addition to **entries**) with folder information on **nodeId**
|
733
|
+
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.
|
734
|
+
}
|
735
|
+
|
736
|
+
begin
|
737
|
+
#List secondary children
|
738
|
+
result = api_instance.list_secondary_children(node_id, opts)
|
739
|
+
p result
|
740
|
+
rescue AlfrescoAPI::ApiError => e
|
741
|
+
puts "Exception when calling NodesApi->list_secondary_children: #{e}"
|
742
|
+
end
|
743
|
+
```
|
744
|
+
|
745
|
+
### Parameters
|
746
|
+
|
747
|
+
Name | Type | Description | Notes
|
748
|
+
------------- | ------------- | ------------- | -------------
|
749
|
+
**node_id** | **String**| The identifier of a parent node. You can also use one of these well-known aliases: * -my- * -shared- * -root- |
|
750
|
+
**where** | **String**| Optionally filter the list by assocType. Here's an example: * ```where=(assocType='my:specialAssocType')``` | [optional]
|
751
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties | [optional]
|
752
|
+
**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]
|
753
|
+
**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]
|
754
|
+
**include_source** | **BOOLEAN**| Also include **source** (in addition to **entries**) with folder information on **nodeId** | [optional]
|
755
|
+
**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]
|
756
|
+
|
757
|
+
### Return type
|
758
|
+
|
759
|
+
[**NodeChildAssociationPaging**](NodeChildAssociationPaging.md)
|
760
|
+
|
761
|
+
### Authorization
|
762
|
+
|
763
|
+
[basicAuth](../README.md#basicAuth)
|
764
|
+
|
765
|
+
### HTTP request headers
|
766
|
+
|
767
|
+
- **Content-Type**: application/json
|
768
|
+
- **Accept**: application/json
|
769
|
+
|
770
|
+
|
771
|
+
|
772
|
+
# **list_source_associations**
|
773
|
+
> NodeAssociationPaging list_source_associations(node_id, opts)
|
774
|
+
|
775
|
+
List source associations
|
776
|
+
|
777
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of source nodes that are associated with the current target **nodeId**.
|
778
|
+
|
779
|
+
### Example
|
780
|
+
```ruby
|
781
|
+
# load the gem
|
782
|
+
require 'alfresco_api'
|
783
|
+
# setup authorization
|
784
|
+
AlfrescoAPI.configure do |config|
|
785
|
+
# Configure HTTP basic authorization: basicAuth
|
786
|
+
config.username = 'YOUR USERNAME'
|
787
|
+
config.password = 'YOUR PASSWORD'
|
788
|
+
end
|
789
|
+
|
790
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
791
|
+
|
792
|
+
node_id = "node_id_example" # String | The identifier of a target node.
|
793
|
+
|
794
|
+
opts = {
|
795
|
+
where: "where_example", # String | Optionally filter the list by **assocType**. Here's an example: * ```where=(assocType='my:specialAssocType')```
|
796
|
+
include: ["include_example"], # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties
|
797
|
+
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.
|
798
|
+
}
|
799
|
+
|
800
|
+
begin
|
801
|
+
#List source associations
|
802
|
+
result = api_instance.list_source_associations(node_id, opts)
|
803
|
+
p result
|
804
|
+
rescue AlfrescoAPI::ApiError => e
|
805
|
+
puts "Exception when calling NodesApi->list_source_associations: #{e}"
|
806
|
+
end
|
807
|
+
```
|
808
|
+
|
809
|
+
### Parameters
|
810
|
+
|
811
|
+
Name | Type | Description | Notes
|
812
|
+
------------- | ------------- | ------------- | -------------
|
813
|
+
**node_id** | **String**| The identifier of a target node. |
|
814
|
+
**where** | **String**| Optionally filter the list by **assocType**. Here's an example: * ```where=(assocType='my:specialAssocType')``` | [optional]
|
815
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties | [optional]
|
816
|
+
**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]
|
817
|
+
|
818
|
+
### Return type
|
819
|
+
|
820
|
+
[**NodeAssociationPaging**](NodeAssociationPaging.md)
|
821
|
+
|
822
|
+
### Authorization
|
823
|
+
|
824
|
+
[basicAuth](../README.md#basicAuth)
|
825
|
+
|
826
|
+
### HTTP request headers
|
827
|
+
|
828
|
+
- **Content-Type**: application/json
|
829
|
+
- **Accept**: application/json
|
830
|
+
|
831
|
+
|
832
|
+
|
833
|
+
# **list_target_associations**
|
834
|
+
> NodeAssociationPaging list_target_associations(node_id, , opts)
|
835
|
+
|
836
|
+
List target associations
|
837
|
+
|
838
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of target nodes that are associated with the current source **nodeId**.
|
839
|
+
|
840
|
+
### Example
|
841
|
+
```ruby
|
842
|
+
# load the gem
|
843
|
+
require 'alfresco_api'
|
844
|
+
# setup authorization
|
845
|
+
AlfrescoAPI.configure do |config|
|
846
|
+
# Configure HTTP basic authorization: basicAuth
|
847
|
+
config.username = 'YOUR USERNAME'
|
848
|
+
config.password = 'YOUR PASSWORD'
|
849
|
+
end
|
850
|
+
|
851
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
852
|
+
|
853
|
+
node_id = "node_id_example" # String | The identifier of a source node.
|
854
|
+
|
855
|
+
opts = {
|
856
|
+
where: "where_example", # String | Optionally filter the list by **assocType**. Here's an example: * ```where=(assocType='my:specialAssocType')```
|
857
|
+
include: ["include_example"], # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties
|
858
|
+
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.
|
859
|
+
}
|
860
|
+
|
861
|
+
begin
|
862
|
+
#List target associations
|
863
|
+
result = api_instance.list_target_associations(node_id, , opts)
|
864
|
+
p result
|
865
|
+
rescue AlfrescoAPI::ApiError => e
|
866
|
+
puts "Exception when calling NodesApi->list_target_associations: #{e}"
|
867
|
+
end
|
868
|
+
```
|
869
|
+
|
870
|
+
### Parameters
|
871
|
+
|
872
|
+
Name | Type | Description | Notes
|
873
|
+
------------- | ------------- | ------------- | -------------
|
874
|
+
**node_id** | **String**| The identifier of a source node. |
|
875
|
+
**where** | **String**| Optionally filter the list by **assocType**. Here's an example: * ```where=(assocType='my:specialAssocType')``` | [optional]
|
876
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties | [optional]
|
877
|
+
**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]
|
878
|
+
|
879
|
+
### Return type
|
880
|
+
|
881
|
+
[**NodeAssociationPaging**](NodeAssociationPaging.md)
|
882
|
+
|
883
|
+
### Authorization
|
884
|
+
|
885
|
+
[basicAuth](../README.md#basicAuth)
|
886
|
+
|
887
|
+
### HTTP request headers
|
888
|
+
|
889
|
+
- **Content-Type**: application/json
|
890
|
+
- **Accept**: application/json
|
891
|
+
|
892
|
+
|
893
|
+
|
894
|
+
# **lock_node**
|
895
|
+
> NodeEntry lock_node(node_idnode_body_lock, opts)
|
896
|
+
|
897
|
+
Lock a node
|
898
|
+
|
899
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Places a lock on node **nodeId**. **Note:** you can only lock files. More specifically, a node can only be locked if it is of type `cm:content` or a subtype of `cm:content`. The lock is owned by the current user, and prevents other users or processes from making updates to the node until the lock is released. If the **timeToExpire** is not set or is zero, then the lock never expires. Otherwise, the **timeToExpire** is the number of seconds before the lock expires. When a lock expires, the lock is released. If the node is already locked, and the user is the lock owner, then the lock is renewed with the new **timeToExpire**. By default, a lock is applied that allows the owner to update or delete the node. You can use **type** to change the lock type to one of the following: * **ALLOW_OWNER_CHANGES** (default) changes to the node can be made only by the lock owner. This enum is the same value as the deprecated WRITE_LOCK described in `org.alfresco.service.cmr.lock.LockType` in the Alfresco Public Java API. This is the default value. * **FULL** no changes by any user are allowed. This enum is the same value as the deprecated READ_ONLY_LOCK described in `org.alfresco.service.cmr.lock.LockType` in the Alfresco Public Java API. By default, a lock is persisted in the database. You can create a volatile in-memory lock by setting the **lifetime** property to EPHEMERAL. You might choose use EPHEMERAL locks, for example, if you are taking frequent short-term locks that you don't need to be kept over a restart of the repository. In this case you don't need the overhead of writing the locks to the database. If a lock on the node cannot be taken, then an error is returned.
|
900
|
+
|
901
|
+
### Example
|
902
|
+
```ruby
|
903
|
+
# load the gem
|
904
|
+
require 'alfresco_api'
|
905
|
+
# setup authorization
|
906
|
+
AlfrescoAPI.configure do |config|
|
907
|
+
# Configure HTTP basic authorization: basicAuth
|
908
|
+
config.username = 'YOUR USERNAME'
|
909
|
+
config.password = 'YOUR PASSWORD'
|
910
|
+
end
|
911
|
+
|
912
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
913
|
+
|
914
|
+
node_id = "node_id_example" # String | The identifier of a node.
|
915
|
+
|
916
|
+
node_body_lock = AlfrescoAPI::NodeBodyLock.new # NodeBodyLock | Lock details.
|
917
|
+
|
918
|
+
opts = {
|
919
|
+
include: ["include_example"] # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions
|
920
|
+
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.
|
921
|
+
}
|
922
|
+
|
923
|
+
begin
|
924
|
+
#Lock a node
|
925
|
+
result = api_instance.lock_node(node_idnode_body_lock, opts)
|
926
|
+
p result
|
927
|
+
rescue AlfrescoAPI::ApiError => e
|
928
|
+
puts "Exception when calling NodesApi->lock_node: #{e}"
|
929
|
+
end
|
930
|
+
```
|
931
|
+
|
932
|
+
### Parameters
|
933
|
+
|
934
|
+
Name | Type | Description | Notes
|
935
|
+
------------- | ------------- | ------------- | -------------
|
936
|
+
**node_id** | **String**| The identifier of a node. |
|
937
|
+
**node_body_lock** | [**NodeBodyLock**](NodeBodyLock.md)| Lock details. |
|
938
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions | [optional]
|
939
|
+
**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]
|
940
|
+
|
941
|
+
### Return type
|
942
|
+
|
943
|
+
[**NodeEntry**](NodeEntry.md)
|
944
|
+
|
945
|
+
### Authorization
|
946
|
+
|
947
|
+
[basicAuth](../README.md#basicAuth)
|
948
|
+
|
949
|
+
### HTTP request headers
|
950
|
+
|
951
|
+
- **Content-Type**: application/json
|
952
|
+
- **Accept**: application/json
|
953
|
+
|
954
|
+
|
955
|
+
|
956
|
+
# **move_node**
|
957
|
+
> NodeEntry move_node(node_idnode_body_move, opts)
|
958
|
+
|
959
|
+
Move a node
|
960
|
+
|
961
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Move the node **nodeId** to the parent folder node **targetParentId**. The **targetParentId** is specified in the in request body. The moved node retains its name unless you specify a new **name** in the request body. If the source **nodeId** is a folder, then its children are also moved. The move will effectively change the primary parent.
|
962
|
+
|
963
|
+
### Example
|
964
|
+
```ruby
|
965
|
+
# load the gem
|
966
|
+
require 'alfresco_api'
|
967
|
+
# setup authorization
|
968
|
+
AlfrescoAPI.configure do |config|
|
969
|
+
# Configure HTTP basic authorization: basicAuth
|
970
|
+
config.username = 'YOUR USERNAME'
|
971
|
+
config.password = 'YOUR PASSWORD'
|
972
|
+
end
|
973
|
+
|
974
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
975
|
+
|
976
|
+
node_id = "node_id_example" # String | The identifier of a node.
|
977
|
+
|
978
|
+
node_body_move = AlfrescoAPI::NodeBodyMove.new # NodeBodyMove | The targetParentId and, optionally, a new name which should include the file extension.
|
979
|
+
|
980
|
+
opts = {
|
981
|
+
include: ["include_example"] # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions
|
982
|
+
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.
|
983
|
+
}
|
984
|
+
|
985
|
+
begin
|
986
|
+
#Move a node
|
987
|
+
result = api_instance.move_node(node_idnode_body_move, opts)
|
988
|
+
p result
|
989
|
+
rescue AlfrescoAPI::ApiError => e
|
990
|
+
puts "Exception when calling NodesApi->move_node: #{e}"
|
991
|
+
end
|
992
|
+
```
|
993
|
+
|
994
|
+
### Parameters
|
995
|
+
|
996
|
+
Name | Type | Description | Notes
|
997
|
+
------------- | ------------- | ------------- | -------------
|
998
|
+
**node_id** | **String**| The identifier of a node. |
|
999
|
+
**node_body_move** | [**NodeBodyMove**](NodeBodyMove.md)| The targetParentId and, optionally, a new name which should include the file extension. |
|
1000
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions | [optional]
|
1001
|
+
**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]
|
1002
|
+
|
1003
|
+
### Return type
|
1004
|
+
|
1005
|
+
[**NodeEntry**](NodeEntry.md)
|
1006
|
+
|
1007
|
+
### Authorization
|
1008
|
+
|
1009
|
+
[basicAuth](../README.md#basicAuth)
|
1010
|
+
|
1011
|
+
### HTTP request headers
|
1012
|
+
|
1013
|
+
- **Content-Type**: application/json
|
1014
|
+
- **Accept**: application/json
|
1015
|
+
|
1016
|
+
|
1017
|
+
|
1018
|
+
# **unlock_node**
|
1019
|
+
> NodeEntry unlock_node(node_id, opts)
|
1020
|
+
|
1021
|
+
Unlock a node
|
1022
|
+
|
1023
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Deletes a lock on node **nodeId**. The current user must be the owner of the locks or have admin rights, otherwise an error is returned. If a lock on the node cannot be released, then an error is returned.
|
1024
|
+
|
1025
|
+
### Example
|
1026
|
+
```ruby
|
1027
|
+
# load the gem
|
1028
|
+
require 'alfresco_api'
|
1029
|
+
# setup authorization
|
1030
|
+
AlfrescoAPI.configure do |config|
|
1031
|
+
# Configure HTTP basic authorization: basicAuth
|
1032
|
+
config.username = 'YOUR USERNAME'
|
1033
|
+
config.password = 'YOUR PASSWORD'
|
1034
|
+
end
|
1035
|
+
|
1036
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
1037
|
+
|
1038
|
+
node_id = "node_id_example" # String | The identifier of a node.
|
1039
|
+
|
1040
|
+
opts = {
|
1041
|
+
include: ["include_example"] # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions
|
1042
|
+
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.
|
1043
|
+
}
|
1044
|
+
|
1045
|
+
begin
|
1046
|
+
#Unlock a node
|
1047
|
+
result = api_instance.unlock_node(node_id, opts)
|
1048
|
+
p result
|
1049
|
+
rescue AlfrescoAPI::ApiError => e
|
1050
|
+
puts "Exception when calling NodesApi->unlock_node: #{e}"
|
1051
|
+
end
|
1052
|
+
```
|
1053
|
+
|
1054
|
+
### Parameters
|
1055
|
+
|
1056
|
+
Name | Type | Description | Notes
|
1057
|
+
------------- | ------------- | ------------- | -------------
|
1058
|
+
**node_id** | **String**| The identifier of a node. |
|
1059
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions | [optional]
|
1060
|
+
**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]
|
1061
|
+
|
1062
|
+
### Return type
|
1063
|
+
|
1064
|
+
[**NodeEntry**](NodeEntry.md)
|
1065
|
+
|
1066
|
+
### Authorization
|
1067
|
+
|
1068
|
+
[basicAuth](../README.md#basicAuth)
|
1069
|
+
|
1070
|
+
### HTTP request headers
|
1071
|
+
|
1072
|
+
- **Content-Type**: application/json
|
1073
|
+
- **Accept**: application/json
|
1074
|
+
|
1075
|
+
|
1076
|
+
|
1077
|
+
# **update_node**
|
1078
|
+
> NodeEntry update_node(node_idnode_body_update, opts)
|
1079
|
+
|
1080
|
+
Update a node
|
1081
|
+
|
1082
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Updates the node **nodeId**. For example, you can rename a file or folder: ```JSON { \"name\":\"My new name\" } ``` You can also set or update one or more properties: ```JSON { \"properties\": { \"cm:title\":\"Folder title\" } } ``` **Note:** setting properties of type d:content and d:category are not supported. **Note:** if you want to add or remove aspects, then you must use **GET /nodes/{nodeId}** first to get the complete set of *aspectNames*. You can add (or remove) *locallySet* permissions, if any, in addition to any inherited permissions. You can also optionally disable (or re-enable) inherited permissions via *isInheritanceEnabled* flag: ```JSON { \"permissions\": { \"isInheritanceEnabled\": false, \"locallySet\": [ {\"authorityId\": \"GROUP_special\", \"name\": \"Read\", \"accessStatus\":\"DENIED\"}, {\"authorityId\": \"testuser\", \"name\": \"Contributor\", \"accessStatus\":\"ALLOWED\"} ] } } ``` **Note:** if you want to add or remove locally set permissions then you must use **GET /nodes/{nodeId}** first to get the complete set of *locallySet* permissions. **Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
1083
|
+
|
1084
|
+
### Example
|
1085
|
+
```ruby
|
1086
|
+
# load the gem
|
1087
|
+
require 'alfresco_api'
|
1088
|
+
# setup authorization
|
1089
|
+
AlfrescoAPI.configure do |config|
|
1090
|
+
# Configure HTTP basic authorization: basicAuth
|
1091
|
+
config.username = 'YOUR USERNAME'
|
1092
|
+
config.password = 'YOUR PASSWORD'
|
1093
|
+
end
|
1094
|
+
|
1095
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
1096
|
+
|
1097
|
+
node_id = "node_id_example" # String | The identifier of a node.
|
1098
|
+
|
1099
|
+
node_body_update = AlfrescoAPI::NodeBodyUpdate.new # NodeBodyUpdate | The node information to update.
|
1100
|
+
|
1101
|
+
opts = {
|
1102
|
+
include: ["include_example"] # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions
|
1103
|
+
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.
|
1104
|
+
}
|
1105
|
+
|
1106
|
+
begin
|
1107
|
+
#Update a node
|
1108
|
+
result = api_instance.update_node(node_idnode_body_update, opts)
|
1109
|
+
p result
|
1110
|
+
rescue AlfrescoAPI::ApiError => e
|
1111
|
+
puts "Exception when calling NodesApi->update_node: #{e}"
|
1112
|
+
end
|
1113
|
+
```
|
1114
|
+
|
1115
|
+
### Parameters
|
1116
|
+
|
1117
|
+
Name | Type | Description | Notes
|
1118
|
+
------------- | ------------- | ------------- | -------------
|
1119
|
+
**node_id** | **String**| The identifier of a node. |
|
1120
|
+
**node_body_update** | [**NodeBodyUpdate**](NodeBodyUpdate.md)| The node information to update. |
|
1121
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions | [optional]
|
1122
|
+
**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]
|
1123
|
+
|
1124
|
+
### Return type
|
1125
|
+
|
1126
|
+
[**NodeEntry**](NodeEntry.md)
|
1127
|
+
|
1128
|
+
### Authorization
|
1129
|
+
|
1130
|
+
[basicAuth](../README.md#basicAuth)
|
1131
|
+
|
1132
|
+
### HTTP request headers
|
1133
|
+
|
1134
|
+
- **Content-Type**: application/json
|
1135
|
+
- **Accept**: application/json
|
1136
|
+
|
1137
|
+
|
1138
|
+
|
1139
|
+
# **update_node_content**
|
1140
|
+
> NodeEntry update_node_content(node_idcontent_body_update, opts)
|
1141
|
+
|
1142
|
+
Update node content
|
1143
|
+
|
1144
|
+
**Note:** this endpoint is available in Alfresco 5.2 and newer versions. Updates the content of the node with identifier **nodeId**. The request body for this endpoint can be any text or binary stream. The **majorVersion** and **comment** parameters can be used to control versioning behaviour. If the content is versionable, a new minor version is created by default. Optionally a new **name** parameter can also be specified that must be unique within the parent folder. If specified and valid then this will rename the node. If invalid then an error is returned and the content is not updated. **Note:** This API method accepts any content type, but for testing with this tool text based content can be provided. This is because the OpenAPI Specification does not allow a wildcard to be provided or the ability for tooling to accept an arbitrary file.
|
1145
|
+
|
1146
|
+
### Example
|
1147
|
+
```ruby
|
1148
|
+
# load the gem
|
1149
|
+
require 'alfresco_api'
|
1150
|
+
# setup authorization
|
1151
|
+
AlfrescoAPI.configure do |config|
|
1152
|
+
# Configure HTTP basic authorization: basicAuth
|
1153
|
+
config.username = 'YOUR USERNAME'
|
1154
|
+
config.password = 'YOUR PASSWORD'
|
1155
|
+
end
|
1156
|
+
|
1157
|
+
api_instance = AlfrescoAPI::NodesApi.new
|
1158
|
+
|
1159
|
+
node_id = "node_id_example" # String | The identifier of a node.
|
1160
|
+
|
1161
|
+
content_body_update = "B" # String | The binary content
|
1162
|
+
|
1163
|
+
opts = {
|
1164
|
+
major_version: false, # BOOLEAN | If **true**, create a major version. Setting this parameter also enables versioning of this node, if it is not already versioned.
|
1165
|
+
comment: "comment_example", # String | Add a version comment which will appear in version history. Setting this parameter also enables versioning of this node, if it is not already versioned.
|
1166
|
+
name: "name_example", # String | Optional new name. This should include the file extension. The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |. The character `.` must not be used at the end of the name.
|
1167
|
+
include: ["include_example"] # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions
|
1168
|
+
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.
|
1169
|
+
}
|
1170
|
+
|
1171
|
+
begin
|
1172
|
+
#Update node content
|
1173
|
+
result = api_instance.update_node_content(node_idcontent_body_update, opts)
|
1174
|
+
p result
|
1175
|
+
rescue AlfrescoAPI::ApiError => e
|
1176
|
+
puts "Exception when calling NodesApi->update_node_content: #{e}"
|
1177
|
+
end
|
1178
|
+
```
|
1179
|
+
|
1180
|
+
### Parameters
|
1181
|
+
|
1182
|
+
Name | Type | Description | Notes
|
1183
|
+
------------- | ------------- | ------------- | -------------
|
1184
|
+
**node_id** | **String**| The identifier of a node. |
|
1185
|
+
**content_body_update** | **String**| The binary content |
|
1186
|
+
**major_version** | **BOOLEAN**| If **true**, create a major version. Setting this parameter also enables versioning of this node, if it is not already versioned. | [optional] [default to false]
|
1187
|
+
**comment** | **String**| Add a version comment which will appear in version history. Setting this parameter also enables versioning of this node, if it is not already versioned. | [optional]
|
1188
|
+
**name** | **String**| Optional new name. This should include the file extension. The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |. The character `.` must not be used at the end of the name. | [optional]
|
1189
|
+
**include** | [**Array<String>**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isLocked * path * permissions | [optional]
|
1190
|
+
**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]
|
1191
|
+
|
1192
|
+
### Return type
|
1193
|
+
|
1194
|
+
[**NodeEntry**](NodeEntry.md)
|
1195
|
+
|
1196
|
+
### Authorization
|
1197
|
+
|
1198
|
+
[basicAuth](../README.md#basicAuth)
|
1199
|
+
|
1200
|
+
### HTTP request headers
|
1201
|
+
|
1202
|
+
- **Content-Type**: application/octet-stream
|
1203
|
+
- **Accept**: application/json
|
1204
|
+
|
1205
|
+
|
1206
|
+
|