Skip to content

andrePankraz/alfresco_core_client

BranchesTags

Repository files navigation

alfresco-core-api-client

Core API

Provides access to the core features of Alfresco Content Services.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import alfresco_core_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import alfresco_core_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import alfresco_core_api_client
from alfresco_core_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost/alfresco/api/-default-/public/alfresco/versions/1
# See configuration.py for a list of all supported configuration parameters.
configuration = alfresco_core_api_client.Configuration(
    host = "http://localhost/alfresco/api/-default-/public/alfresco/versions/1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = alfresco_core_api_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with alfresco_core_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alfresco_core_api_client.ActionsApi(api_client)
    action_definition_id = 'action_definition_id_example' # str | The identifier of an action definition.

    try:
        # Retrieve the details of an action definition
        api_response = api_instance.action_details(action_definition_id)
        print("The response of ActionsApi->action_details:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ActionsApi->action_details: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
ActionsApi action_details GET /action-definitions/{actionDefinitionId} Retrieve the details of an action definition
ActionsApi action_exec POST /action-executions Execute an action
ActionsApi get_action_constraint GET /action-parameter-constraints/{parameterConstraintName} Retrieve an action parameter constraint by requested name
ActionsApi list_actions GET /action-definitions Retrieve list of available actions
ActionsApi node_actions GET /nodes/{nodeId}/action-definitions Retrieve actions for a node
ActivitiesApi list_activities_for_person GET /people/{personId}/activities List activities
AuditApi delete_audit_entries_for_audit_app DELETE /audit-applications/{auditApplicationId}/audit-entries Permanently delete audit entries for an audit application
AuditApi delete_audit_entry DELETE /audit-applications/{auditApplicationId}/audit-entries/{auditEntryId} Permanently delete an audit entry
AuditApi get_audit_app GET /audit-applications/{auditApplicationId} Get audit application info
AuditApi get_audit_entry GET /audit-applications/{auditApplicationId}/audit-entries/{auditEntryId} Get audit entry
AuditApi list_audit_apps GET /audit-applications List audit applications
AuditApi list_audit_entries_for_audit_app GET /audit-applications/{auditApplicationId}/audit-entries List audit entries for an audit application
AuditApi list_audit_entries_for_node GET /nodes/{nodeId}/audit-entries List audit entries for a node
AuditApi update_audit_app PUT /audit-applications/{auditApplicationId} Update audit application info
CategoriesApi create_category POST /categories/{categoryId}/subcategories Create a category
CategoriesApi create_category_link_for_node POST /nodes/{nodeId}/category-links Assign a node to a category
CategoriesApi delete_category DELETE /categories/{categoryId} Delete a category
CategoriesApi delete_category_link_from_node DELETE /nodes/{nodeId}/category-links/{categoryId} Unassign a node from a category
CategoriesApi get_category GET /categories/{categoryId} Get a category
CategoriesApi list_categories_for_node GET /nodes/{nodeId}/category-links List categories that a node is assigned to
CategoriesApi list_subcategories GET /categories/{categoryId}/subcategories List categories
CategoriesApi update_category PUT /categories/{categoryId} Update a category
CommentsApi create_comment POST /nodes/{nodeId}/comments Create a comment
CommentsApi delete_comment DELETE /nodes/{nodeId}/comments/{commentId} Delete a comment
CommentsApi list_comments GET /nodes/{nodeId}/comments List comments
CommentsApi update_comment PUT /nodes/{nodeId}/comments/{commentId} Update a comment
DownloadsApi cancel_download DELETE /downloads/{downloadId} Cancel a download
DownloadsApi create_download POST /downloads Create a new download
DownloadsApi get_download GET /downloads/{downloadId} Get a download
FavoritesApi create_favorite POST /people/{personId}/favorites Create a favorite
FavoritesApi create_site_favorite POST /people/{personId}/favorite-sites Create a site favorite
FavoritesApi delete_favorite DELETE /people/{personId}/favorites/{favoriteId} Delete a favorite
FavoritesApi delete_site_favorite DELETE /people/{personId}/favorite-sites/{siteId} Delete a site favorite
FavoritesApi get_favorite GET /people/{personId}/favorites/{favoriteId} Get a favorite
FavoritesApi get_favorite_site GET /people/{personId}/favorite-sites/{siteId} Get a favorite site
FavoritesApi list_favorite_sites_for_person GET /people/{personId}/favorite-sites List favorite sites
FavoritesApi list_favorites GET /people/{personId}/favorites List favorites
GroupsApi create_group POST /groups Create a group
GroupsApi create_group_membership POST /groups/{groupId}/members Create a group membership
GroupsApi delete_group DELETE /groups/{groupId} Delete a group
GroupsApi delete_group_membership DELETE /groups/{groupId}/members/{groupMemberId} Delete a group membership
GroupsApi get_group GET /groups/{groupId} Get group details
GroupsApi list_group_memberships GET /groups/{groupId}/members List memberships of a group
GroupsApi list_group_memberships_for_person GET /people/{personId}/groups List group memberships
GroupsApi list_groups GET /groups List groups
GroupsApi update_group PUT /groups/{groupId} Update group details
NetworksApi get_network GET /networks/{networkId} Get a network
NetworksApi get_network_for_person GET /people/{personId}/networks/{networkId} Get network information
NetworksApi list_networks_for_person GET /people/{personId}/networks List network membership
NodesApi copy_node POST /nodes/{nodeId}/copy Copy a node
NodesApi create_association POST /nodes/{nodeId}/targets Create node association
NodesApi create_node POST /nodes/{nodeId}/children Create a node
NodesApi create_secondary_child_association POST /nodes/{nodeId}/secondary-children Create secondary child
NodesApi delete_association DELETE /nodes/{nodeId}/targets/{targetId} Delete node association(s)
NodesApi delete_node DELETE /nodes/{nodeId} Delete a node
NodesApi delete_secondary_child_association DELETE /nodes/{nodeId}/secondary-children/{childId} Delete secondary child or children
NodesApi get_node GET /nodes/{nodeId} Get a node
NodesApi get_node_content GET /nodes/{nodeId}/content Get node content
NodesApi list_node_children GET /nodes/{nodeId}/children List node children
NodesApi list_parents GET /nodes/{nodeId}/parents List parents
NodesApi list_secondary_children GET /nodes/{nodeId}/secondary-children List secondary children
NodesApi list_source_associations GET /nodes/{nodeId}/sources List source associations
NodesApi list_target_associations GET /nodes/{nodeId}/targets List target associations
NodesApi lock_node POST /nodes/{nodeId}/lock Lock a node
NodesApi move_node POST /nodes/{nodeId}/move Move a node
NodesApi request_node_direct_access_url POST /nodes/{nodeId}/request-direct-access-url Generate a direct access content URL
NodesApi unlock_node POST /nodes/{nodeId}/unlock Unlock a node
NodesApi update_node PUT /nodes/{nodeId} Update a node
NodesApi update_node_content PUT /nodes/{nodeId}/content Update node content
PeopleApi create_person POST /people Create person
PeopleApi delete_avatar_image DELETE /people/{personId}/avatar Delete avatar image
PeopleApi get_avatar_image GET /people/{personId}/avatar Get avatar image
PeopleApi get_person GET /people/{personId} Get a person
PeopleApi list_people GET /people List people
PeopleApi request_password_reset POST /people/{personId}/request-password-reset Request password reset
PeopleApi reset_password POST /people/{personId}/reset-password Reset password
PeopleApi update_avatar_image PUT /people/{personId}/avatar Update avatar image
PeopleApi update_person PUT /people/{personId} Update person
PreferencesApi get_preference GET /people/{personId}/preferences/{preferenceName} Get a preference
PreferencesApi list_preferences GET /people/{personId}/preferences List preferences
ProbesApi get_probe GET /probes/{probeId} Check readiness and liveness of the repository
QueriesApi find_nodes GET /queries/nodes Find nodes
QueriesApi find_people GET /queries/people Find people
QueriesApi find_sites GET /queries/sites Find sites
RatingsApi create_rating POST /nodes/{nodeId}/ratings Create a rating
RatingsApi delete_rating DELETE /nodes/{nodeId}/ratings/{ratingId} Delete a rating
RatingsApi get_rating GET /nodes/{nodeId}/ratings/{ratingId} Get a rating
RatingsApi list_ratings GET /nodes/{nodeId}/ratings List ratings
RenditionsApi create_rendition POST /nodes/{nodeId}/renditions Create rendition
RenditionsApi delete_rendition DELETE /nodes/{nodeId}/renditions/{renditionId} Delete rendition
RenditionsApi get_rendition GET /nodes/{nodeId}/renditions/{renditionId} Get rendition information
RenditionsApi get_rendition_content GET /nodes/{nodeId}/renditions/{renditionId}/content Get rendition content
RenditionsApi list_renditions GET /nodes/{nodeId}/renditions List renditions
RenditionsApi request_rendition_direct_access_url POST /nodes/{nodeId}/renditions/{renditionId}/request-direct-access-url Generate a direct access content URL
SharedLinksApi create_shared_link POST /shared-links Create a shared link to a file
SharedLinksApi delete_shared_link DELETE /shared-links/{sharedId} Deletes a shared link
SharedLinksApi email_shared_link POST /shared-links/{sharedId}/email Email shared link
SharedLinksApi get_shared_link GET /shared-links/{sharedId} Get a shared link
SharedLinksApi get_shared_link_content GET /shared-links/{sharedId}/content Get shared link content
SharedLinksApi get_shared_link_rendition GET /shared-links/{sharedId}/renditions/{renditionId} Get shared link rendition information
SharedLinksApi get_shared_link_rendition_content GET /shared-links/{sharedId}/renditions/{renditionId}/content Get shared link rendition content
SharedLinksApi list_shared_link_renditions GET /shared-links/{sharedId}/renditions List renditions for a shared link
SharedLinksApi list_shared_links GET /shared-links List shared links
SitesApi approve_site_membership_request POST /sites/{siteId}/site-membership-requests/{inviteeId}/approve Approve a site membership request
SitesApi create_site POST /sites Create a site
SitesApi create_site_group_membership POST /sites/{siteId}/group-members Create a site membership for group
SitesApi create_site_membership POST /sites/{siteId}/members Create a site membership
SitesApi create_site_membership_request_for_person POST /people/{personId}/site-membership-requests Create a site membership request
SitesApi delete_site DELETE /sites/{siteId} Delete a site
SitesApi delete_site_group_membership DELETE /sites/{siteId}/group-members/{groupId} Delete a group membership for site
SitesApi delete_site_membership DELETE /sites/{siteId}/members/{personId} Delete a site membership
SitesApi delete_site_membership_for_person DELETE /people/{personId}/sites/{siteId} Delete a site membership
SitesApi delete_site_membership_request_for_person DELETE /people/{personId}/site-membership-requests/{siteId} Delete a site membership request
SitesApi get_site GET /sites/{siteId} Get a site
SitesApi get_site_container GET /sites/{siteId}/containers/{containerId} Get a site container
SitesApi get_site_group_membership GET /sites/{siteId}/group-members/{groupId} Get information about site membership of group
SitesApi get_site_membership GET /sites/{siteId}/members/{personId} Get a site membership
SitesApi get_site_membership_for_person GET /people/{personId}/sites/{siteId} Get a site membership
SitesApi get_site_membership_request_for_person GET /people/{personId}/site-membership-requests/{siteId} Get a site membership request
SitesApi get_site_membership_requests GET /site-membership-requests Get site membership requests
SitesApi list_site_containers GET /sites/{siteId}/containers List site containers
SitesApi list_site_groups GET /sites/{siteId}/group-members List group membership for site
SitesApi list_site_membership_requests_for_person GET /people/{personId}/site-membership-requests List site membership requests
SitesApi list_site_memberships GET /sites/{siteId}/members List site memberships
SitesApi list_site_memberships_for_person GET /people/{personId}/sites List site memberships
SitesApi list_sites GET /sites List sites
SitesApi reject_site_membership_request POST /sites/{siteId}/site-membership-requests/{inviteeId}/reject Reject a site membership request
SitesApi update_site PUT /sites/{siteId} Update a site
SitesApi update_site_group_membership PUT /sites/{siteId}/group-members/{groupId} Update site membership of group
SitesApi update_site_membership PUT /sites/{siteId}/members/{personId} Update a site membership
SitesApi update_site_membership_request_for_person PUT /people/{personId}/site-membership-requests/{siteId} Update a site membership request
StorageInfoApi get_storage_properties GET /nodes/{nodeId}/storage-info/{contentPropName} Retrieve storage properties for given content
StorageInfoApi get_version_storage_properties GET /nodes/{nodeId}/versions/{versionId}/storage-info/{contentPropName} Retrieve storage properties for given version content
StorageInfoApi request_archive_content POST /nodes/{nodeId}/storage-info/{contentPropName}/archive Request to send given content to archive
StorageInfoApi request_archive_version_content POST /nodes/{nodeId}/versions/{versionId}/storage-info/{contentPropName}/archive Request to send given version content to archive
StorageInfoApi request_restore_content_from_archive POST /nodes/{nodeId}/storage-info/{contentPropName}/archive-restore Request to restore given content from archive
StorageInfoApi request_restore_version_content_from_archive POST /nodes/{nodeId}/versions/{versionId}/storage-info/{contentPropName}/archive-restore Request to restore given version content from archive
TagsApi create_tag POST /tags Create a tag
TagsApi create_tag_for_node POST /nodes/{nodeId}/tags Create a tag for a node
TagsApi delete_tag DELETE /tags/{tagId} Delete a tag
TagsApi delete_tag_from_node DELETE /nodes/{nodeId}/tags/{tagId} Delete a tag from a node
TagsApi get_tag GET /tags/{tagId} Get a tag
TagsApi list_tags GET /tags List tags
TagsApi list_tags_for_node GET /nodes/{nodeId}/tags List tags for a node
TagsApi update_tag PUT /tags/{tagId} Update a tag
TrashcanApi delete_deleted_node DELETE /deleted-nodes/{nodeId} Permanently delete a deleted node
TrashcanApi get_archived_node_rendition GET /deleted-nodes/{nodeId}/renditions/{renditionId} Get rendition information for a deleted node
TrashcanApi get_archived_node_rendition_content GET /deleted-nodes/{nodeId}/renditions/{renditionId}/content Get rendition content of a deleted node
TrashcanApi get_deleted_node GET /deleted-nodes/{nodeId} Get a deleted node
TrashcanApi get_deleted_node_content GET /deleted-nodes/{nodeId}/content Get deleted node content
TrashcanApi list_deleted_node_renditions GET /deleted-nodes/{nodeId}/renditions List renditions for a deleted node
TrashcanApi list_deleted_nodes GET /deleted-nodes List deleted nodes
TrashcanApi request_archived_node_rendition_direct_access_url POST /deleted-nodes/{nodeId}/renditions/{renditionId}/request-direct-access-url Generate a direct access content URL
TrashcanApi request_deleted_node_direct_access_url POST /deleted-nodes/{nodeId}/request-direct-access-url Generate a direct access content URL
TrashcanApi restore_deleted_node POST /deleted-nodes/{nodeId}/restore Restore a deleted node
VersionsApi create_version_rendition POST /nodes/{nodeId}/versions/{versionId}/renditions Create rendition for a file version
VersionsApi delete_version DELETE /nodes/{nodeId}/versions/{versionId} Delete a version
VersionsApi delete_version_rendition DELETE /nodes/{nodeId}/versions/{versionId}/renditions/{renditionId} Delete rendition for a version
VersionsApi get_version GET /nodes/{nodeId}/versions/{versionId} Get version information
VersionsApi get_version_content GET /nodes/{nodeId}/versions/{versionId}/content Get version content
VersionsApi get_version_rendition GET /nodes/{nodeId}/versions/{versionId}/renditions/{renditionId} Get rendition information for a file version
VersionsApi get_version_rendition_content GET /nodes/{nodeId}/versions/{versionId}/renditions/{renditionId}/content Get rendition content for a file version
VersionsApi list_version_history GET /nodes/{nodeId}/versions List version history
VersionsApi list_version_renditions GET /nodes/{nodeId}/versions/{versionId}/renditions List renditions for a file version
VersionsApi request_version_direct_access_url POST /nodes/{nodeId}/versions/{versionId}/request-direct-access-url Generate a direct access content URL
VersionsApi request_version_rendition_direct_access_url POST /nodes/{nodeId}/versions/{versionId}/renditions/{renditionId}/request-direct-access-url Generate a direct access content URL
VersionsApi revert_version POST /nodes/{nodeId}/versions/{versionId}/revert Revert a version

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication

Author

Documentation for Client Generation

Generate Clients

  • Create via Generator in Docker container:
docker run --rm \
  -v ${PWD}:/local openapitools/openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/Alfresco/rest-api-explorer/master/src/main/webapp/definitions/alfresco-core.yaml \
  -g python \
  -o /local/alfresco_core_api_client \
  --package-name alfresco_core_api_client

Fix Bugs

  • Bug in code generation with field validator around >12 files with nested quotes!
  • Replace in 2 lines each leading and trailing double quote with single quote: r"...\"..." ==> r'...\"...'
    @field_validator('name')
    def name_validate_regular_expression(cls, value):
        """Validates the regular expression"""
        if not re.match(r"^(?!(.*[\\"\*\\\>\<\?\/\:\|]+.*)|(.*[\.]?.*[\.]+$)|(.*[ ]+$))", value):
            raise ValueError(r"must validate the regular expression /^(?!(.*[\\"\*\\\>\<\?\/\:\|]+.*)|(.*[\.]?.*[\.]+$)|(.*[ ]+$))/")
        return value

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages