alfresco_core_api_client.VersionsApi

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

Method	HTTP request	Description
create_version_rendition	POST /nodes/{nodeId}/versions/{versionId}/renditions	Create rendition for a file version
delete_version	DELETE /nodes/{nodeId}/versions/{versionId}	Delete a version
delete_version_rendition	DELETE /nodes/{nodeId}/versions/{versionId}/renditions/{renditionId}	Delete rendition for a version
get_version	GET /nodes/{nodeId}/versions/{versionId}	Get version information
get_version_content	GET /nodes/{nodeId}/versions/{versionId}/content	Get version content
get_version_rendition	GET /nodes/{nodeId}/versions/{versionId}/renditions/{renditionId}	Get rendition information for a file version
get_version_rendition_content	GET /nodes/{nodeId}/versions/{versionId}/renditions/{renditionId}/content	Get rendition content for a file version
list_version_history	GET /nodes/{nodeId}/versions	List version history
list_version_renditions	GET /nodes/{nodeId}/versions/{versionId}/renditions	List renditions for a file version
request_version_direct_access_url	POST /nodes/{nodeId}/versions/{versionId}/request-direct-access-url	Generate a direct access content URL
request_version_rendition_direct_access_url	POST /nodes/{nodeId}/versions/{versionId}/renditions/{renditionId}/request-direct-access-url	Generate a direct access content URL
revert_version	POST /nodes/{nodeId}/versions/{versionId}/revert	Revert a version

create_version_rendition

create_version_rendition(node_id, version_id, rendition_body_create)

Create rendition for a file version

Note: this endpoint is available in Alfresco 7.0.0 and newer versions. An asynchronous request to create a rendition for version of file nodeId and versionId. The version rendition is specified by name id in the request body: JSON { \"id\":\"doclib\" } Multiple names may be specified as a comma separated list or using a list format: JSON [ { \"id\": \"doclib\" }, { \"id\": \"avatar\" } ]

Example

Basic Authentication (basicAuth):

import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.rendition_body_create import RenditionBodyCreate
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    version_id = 'version_id_example' # str | The identifier of a version, ie. version label, within the version history of a node.
    rendition_body_create = alfresco_core_api_client.RenditionBodyCreate() # RenditionBodyCreate | The rendition \"id\".

    try:
        # Create rendition for a file version
        api_instance.create_version_rendition(node_id, version_id, rendition_body_create)
    except Exception as e:
        print("Exception when calling VersionsApi->create_version_rendition: %s\n" % e)

Parameters

Name	Type	Description
node_id	str	The identifier of a node.
version_id	str	The identifier of a version, ie. version label, within the version history of a node.
rendition_body_create	RenditionBodyCreate	The rendition "id".

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Request accepted	-
400	Invalid parameter: nodeId is not a valid format, or is not a file, or versionId is invalid, or renditionBodyCreate is invalid	-
401	Authentication failed	-
403	Current user does not have permission for nodeId	-
404	nodeId or versionId or renditionId does not exist	-
409	All requested renditions already exist	-
501	Renditions/thumbnails are disabled for the system	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_version

delete_version(node_id, version_id)

Delete a version

Note: this endpoint is available in Alfresco 5.2 and newer versions. Delete the version identified by versionId and *nodeId. If the version is successfully deleted then the content and metadata for that versioned node will be deleted and will no longer appear in the version history. This operation cannot be undone. If the most recent version is deleted the live node will revert to the next most recent version. We currently do not allow the last version to be deleted. If you wish to clear the history then you can remove the "cm:versionable" aspect (via update node) which will also disable versioning. In this case, you can re-enable versioning by adding back the "cm:versionable" aspect or using the version params (majorVersion and comment) on a subsequent file content update.

Example

Basic Authentication (basicAuth):

import time
import os
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    version_id = 'version_id_example' # str | The identifier of a version, ie. version label, within the version history of a node.

    try:
        # Delete a version
        api_instance.delete_version(node_id, version_id)
    except Exception as e:
        print("Exception when calling VersionsApi->delete_version: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_id	str	The identifier of a node.
version_id	str	The identifier of a version, ie. version label, within the version history of a node.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Successful response	-
400	Invalid parameter: nodeId is not a valid format, or exists but does not identify a file, or versionId is invalid	-
401	Authentication failed	-
403	Current user does not have permission to delete the versioned node	-
404	nodeId or versionId does not exist	-
422	Cannot delete the last remaining version	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_version_rendition

delete_version_rendition(node_id, version_id, rendition_id)

Delete rendition for a version

Note: this endpoint is available in Alfresco 7.1.1 and newer versions. Delete the rendition for renditionId of version versionId of nodeId. If the rendition is successfully deleted then the content for that rendition node will be cleared.

Example

Basic Authentication (basicAuth):

import time
import os
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    version_id = 'version_id_example' # str | The identifier of a version, ie. version label, within the version history of a node.
    rendition_id = 'rendition_id_example' # str | The name of a thumbnail rendition, for example *doclib*, or *pdf*.

    try:
        # Delete rendition for a version
        api_instance.delete_version_rendition(node_id, version_id, rendition_id)
    except Exception as e:
        print("Exception when calling VersionsApi->delete_version_rendition: %s\n" % e)

Parameters

Name	Type	Description
node_id	str	The identifier of a node.
version_id	str	The identifier of a version, ie. version label, within the version history of a node.
rendition_id	str	The name of a thumbnail rendition, for example doclib, or pdf.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Successful response	-
400	Invalid parameter: nodeId is not a valid format or versionId or renditionId is invalid	-
401	Authentication failed	-
403	Current user does not have permission to delete the version rendition	-
404	nodeId, versionId or renditionId does not exist	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_version

VersionEntry get_version(node_id, version_id)

Get version information

Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the version information for versionId of file node nodeId.

Example

Basic Authentication (basicAuth):

import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.version_entry import VersionEntry
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    version_id = 'version_id_example' # str | The identifier of a version, ie. version label, within the version history of a node.

    try:
        # Get version information
        api_response = api_instance.get_version(node_id, version_id)
        print("The response of VersionsApi->get_version:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VersionsApi->get_version: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_id	str	The identifier of a node.
version_id	str	The identifier of a version, ie. version label, within the version history of a node.

Return type

VersionEntry

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Invalid parameter: nodeId is not a valid format, or it exists but does not identify a file, or versionId is invalid	-
401	Authentication failed	-
403	Current user does not have permission for nodeId	-
404	nodeId or versionId does not exist	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_version_content

bytearray get_version_content(node_id, version_id, attachment=attachment, if_modified_since=if_modified_since, range=range)

Get version content

Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the version content for versionId of file node nodeId.

Example

Basic Authentication (basicAuth):

import time
import os
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    version_id = 'version_id_example' # str | The identifier of a version, ie. version label, within the version history of a node.
    attachment = True # bool | **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.  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)
    if_modified_since = '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`.  (optional)
    range = 'range_example' # str | The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.  (optional)

    try:
        # Get version content
        api_response = api_instance.get_version_content(node_id, version_id, attachment=attachment, if_modified_since=if_modified_since, range=range)
        print("The response of VersionsApi->get_version_content:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VersionsApi->get_version_content: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_id	str	The identifier of a node.
version_id	str	The identifier of a version, ie. version label, within the version history of a node.
attachment	bool	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. 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]
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]
range	str	The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.	[optional]

Return type

bytearray

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

HTTP response details

Status code	Description	Response headers
200	Successful response	-
206	Partial Content	-
304	Content has not been modified since the date provided in the If-Modified-Since header	-
400	Invalid parameter: nodeId is not a valid format, or is not a file, or versionId is invalid	-
401	Authentication failed	-
403	Current user does not have permission for nodeId	-
404	nodeId or versionId does not exist	-
412	Content is archived and is inaccessible	-
416	Range Not Satisfiable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_version_rendition

RenditionEntry get_version_rendition(node_id, version_id, rendition_id)

Get rendition information for a file version

Note: this endpoint is available in Alfresco 7.0.0 and newer versions. Gets the rendition information for renditionId of version of file nodeId and versionId.

Example

Basic Authentication (basicAuth):

import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.rendition_entry import RenditionEntry
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    version_id = 'version_id_example' # str | The identifier of a version, ie. version label, within the version history of a node.
    rendition_id = 'rendition_id_example' # str | The name of a thumbnail rendition, for example *doclib*, or *pdf*.

    try:
        # Get rendition information for a file version
        api_response = api_instance.get_version_rendition(node_id, version_id, rendition_id)
        print("The response of VersionsApi->get_version_rendition:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VersionsApi->get_version_rendition: %s\n" % e)

Parameters

Name	Type	Description
node_id	str	The identifier of a node.
version_id	str	The identifier of a version, ie. version label, within the version history of a node.
rendition_id	str	The name of a thumbnail rendition, for example doclib, or pdf.

Return type

RenditionEntry

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Invalid parameter: nodeId is not a valid format, or is not a file, or versionId is invalid, or renditionId is invalid	-
401	Authentication failed	-
403	Current user does not have permission for nodeId	-
404	nodeId or versionId or renditionId does not exist	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_version_rendition_content

bytearray get_version_rendition_content(node_id, version_id, rendition_id, attachment=attachment, if_modified_since=if_modified_since, range=range, placeholder=placeholder)

Get rendition content for a file version

Note: this endpoint is available in Alfresco 7.0.0 and newer versions. Gets the rendition content for renditionId of version of file nodeId and versionId.

Example

Basic Authentication (basicAuth):

import time
import os
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    version_id = 'version_id_example' # str | The identifier of a version, ie. version label, within the version history of a node.
    rendition_id = 'rendition_id_example' # str | The name of a thumbnail rendition, for example *doclib*, or *pdf*.
    attachment = True # bool | **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.  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)
    if_modified_since = '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`.  (optional)
    range = 'range_example' # str | The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.  (optional)
    placeholder = False # bool | If **true** and there is no rendition for this **nodeId** and **renditionId**, then the placeholder image for the mime type of this rendition is returned, rather than a 404 response.  (optional) (default to False)

    try:
        # Get rendition content for a file version
        api_response = api_instance.get_version_rendition_content(node_id, version_id, rendition_id, attachment=attachment, if_modified_since=if_modified_since, range=range, placeholder=placeholder)
        print("The response of VersionsApi->get_version_rendition_content:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VersionsApi->get_version_rendition_content: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_id	str	The identifier of a node.
version_id	str	The identifier of a version, ie. version label, within the version history of a node.
rendition_id	str	The name of a thumbnail rendition, for example doclib, or pdf.
attachment	bool	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. 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]
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]
range	str	The Range header indicates the part of a document that the server should return. Single part request supported, for example: bytes=1-10.	[optional]
placeholder	bool	If true and there is no rendition for this nodeId and renditionId, then the placeholder image for the mime type of this rendition is returned, rather than a 404 response.	[optional] [default to False]

Return type

bytearray

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

HTTP response details

Status code	Description	Response headers
200	Successful response	-
206	Partial Content	-
304	Content has not been modified since the date provided in the If-Modified-Since header	-
400	Invalid parameter: nodeId is not a valid format, or is not a file, or versionId is invalid, or renditionId is invalid	-
401	Authentication failed	-
403	Current user does not have permission for nodeId	-
404	nodeId or versionId or renditionId does not exist	-
412	Content is archived and is inaccessible	-
416	Range Not Satisfiable	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_version_history

VersionPaging list_version_history(node_id, include=include, fields=fields, skip_count=skip_count, max_items=max_items)

List version history

Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the version history as an ordered list of versions for the specified nodeId. The list is ordered in descending modified order. So the most recent version is first and the original version is last in the list.

Example

Basic Authentication (basicAuth):

import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.version_paging import VersionPaging
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    include = ['include_example'] # List[str] | Returns additional information about the version node. The following optional fields can be requested: * properties * aspectNames  (optional)
    fields = ['fields_example'] # List[str] | 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)
    skip_count = 0 # int | 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)
    max_items = 100 # int | The maximum number of items to return in the list. If not supplied then the default value is 100.  (optional) (default to 100)

    try:
        # List version history
        api_response = api_instance.list_version_history(node_id, include=include, fields=fields, skip_count=skip_count, max_items=max_items)
        print("The response of VersionsApi->list_version_history:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VersionsApi->list_version_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_id	str	The identifier of a node.
include	List[str]	Returns additional information about the version node. The following optional fields can be requested: * properties * aspectNames	[optional]
fields	List[str]	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]
skip_count	int	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]
max_items	int	The maximum number of items to return in the list. If not supplied then the default value is 100.	[optional] [default to 100]

Return type

VersionPaging

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Invalid parameter: nodeId is not a valid format	-
401	Authentication failed	-
403	Current user does not have permission for nodeId	-
404	Target nodeId does not exist	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_version_renditions

RenditionPaging list_version_renditions(node_id, version_id, where=where)

List renditions for a file version

Note: this endpoint is available in Alfresco 7.0.0 and newer versions. Gets a list of the rendition information for each rendition of the version of file nodeId and versionId, including the rendition id. Each rendition returned has a status: CREATED means it is available to view or download, NOT_CREATED means the rendition can be requested. You can use the where parameter to filter the returned renditions by status. For example, the following where clause will return just the CREATED renditions: (status='CREATED')

Example

Basic Authentication (basicAuth):

import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.rendition_paging import RenditionPaging
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    version_id = 'version_id_example' # str | The identifier of a version, ie. version label, within the version history of a node.
    where = 'where_example' # str | A string to restrict the returned objects by using a predicate. (optional)

    try:
        # List renditions for a file version
        api_response = api_instance.list_version_renditions(node_id, version_id, where=where)
        print("The response of VersionsApi->list_version_renditions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VersionsApi->list_version_renditions: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_id	str	The identifier of a node.
version_id	str	The identifier of a version, ie. version label, within the version history of a node.
where	str	A string to restrict the returned objects by using a predicate.	[optional]

Return type

RenditionPaging

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Invalid parameter: nodeId is not a valid format, or is not a file, or versionId is invalid, or where is invalid	-
401	Authentication failed	-
403	Current user does not have permission for nodeId	-
404	nodeId or versionId does not exist	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

request_version_direct_access_url

DirectAccessUrlEntry request_version_direct_access_url(node_id, version_id, request_content_url_body_create=request_content_url_body_create)

Generate a direct access content URL

Note: this endpoint is available in Alfresco 7.1 and newer versions. Generate a direct access content url for the given nodeId.

Example

Basic Authentication (basicAuth):

import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.direct_access_url_body_create import DirectAccessUrlBodyCreate
from alfresco_core_api_client.models.direct_access_url_entry import DirectAccessUrlEntry
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    version_id = 'version_id_example' # str | The identifier of a version, ie. version label, within the version history of a node.
    request_content_url_body_create = alfresco_core_api_client.DirectAccessUrlBodyCreate() # DirectAccessUrlBodyCreate | Direct Access URL options and flags.  Note: It is up to the actual ContentStore implementation if it can fulfil this request or not.  The **attachment** flag controls the download method of the generated URL. It defaults  to **true**, meaning the value for the Content Disposition response header will be **attachment**.  **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.  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)

    try:
        # Generate a direct access content URL
        api_response = api_instance.request_version_direct_access_url(node_id, version_id, request_content_url_body_create=request_content_url_body_create)
        print("The response of VersionsApi->request_version_direct_access_url:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VersionsApi->request_version_direct_access_url: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_id	str	The identifier of a node.
version_id	str	The identifier of a version, ie. version label, within the version history of a node.
request_content_url_body_create	DirectAccessUrlBodyCreate	Direct Access URL options and flags. Note: It is up to the actual ContentStore implementation if it can fulfil this request or not. The attachment flag controls the download method of the generated URL. It defaults to true, meaning the value for the Content Disposition response header will be attachment. 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. 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]

Return type

DirectAccessUrlEntry

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Invalid parameter: nodeId is not a valid format, or is not a file	-
401	Authentication failed	-
403	Current user does not have permission for nodeId	-
404	nodeId does not exist	-
412	Content is archived and is inaccessible	-
501	The actual ContentStore implementation can't fulfil this request	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

request_version_rendition_direct_access_url

DirectAccessUrlEntry request_version_rendition_direct_access_url(node_id, version_id, rendition_id, request_content_url_body_create=request_content_url_body_create)

Generate a direct access content URL

Note: this endpoint is available in Alfresco 7.2 and newer versions. Generate a direct access content url for the given nodeId.

Example

Basic Authentication (basicAuth):

import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.direct_access_url_body_create import DirectAccessUrlBodyCreate
from alfresco_core_api_client.models.direct_access_url_entry import DirectAccessUrlEntry
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    version_id = 'version_id_example' # str | The identifier of a version, ie. version label, within the version history of a node.
    rendition_id = 'rendition_id_example' # str | The name of a thumbnail rendition, for example *doclib*, or *pdf*.
    request_content_url_body_create = alfresco_core_api_client.DirectAccessUrlBodyCreate() # DirectAccessUrlBodyCreate | Direct Access URL options and flags.  It can be used to set the **attachment** flag, which controls the download method of the generated URL (attachment DAU vs embedded DAU). It defaults to **true**, meaning the value for the Content Disposition response header will be **attachment**.  Note: It is up to the actual ContentStore implementation if it can fulfil this request or not.  (optional)

    try:
        # Generate a direct access content URL
        api_response = api_instance.request_version_rendition_direct_access_url(node_id, version_id, rendition_id, request_content_url_body_create=request_content_url_body_create)
        print("The response of VersionsApi->request_version_rendition_direct_access_url:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VersionsApi->request_version_rendition_direct_access_url: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_id	str	The identifier of a node.
version_id	str	The identifier of a version, ie. version label, within the version history of a node.
rendition_id	str	The name of a thumbnail rendition, for example doclib, or pdf.
request_content_url_body_create	DirectAccessUrlBodyCreate	Direct Access URL options and flags. It can be used to set the attachment flag, which controls the download method of the generated URL (attachment DAU vs embedded DAU). It defaults to true, meaning the value for the Content Disposition response header will be attachment. Note: It is up to the actual ContentStore implementation if it can fulfil this request or not.	[optional]

Return type

DirectAccessUrlEntry

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Invalid parameter: nodeId is not a valid format, or is not a file	-
401	Authentication failed	-
403	Current user does not have permission for nodeId	-
404	nodeId does not exist	-
501	The actual ContentStore implementation can't fulfil this request	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

revert_version

VersionEntry revert_version(node_id, version_id, revert_body, fields=fields)

Revert a version

Note: this endpoint is available in Alfresco 5.2 and newer versions. Attempts to revert the version identified by versionId and nodeId to the live node. If the node is successfully reverted then the content and metadata for that versioned node will be promoted to the live node and a new version will appear in the version history.

Example

Basic Authentication (basicAuth):

import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.revert_body import RevertBody
from alfresco_core_api_client.models.version_entry import VersionEntry
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.VersionsApi(api_client)
    node_id = 'node_id_example' # str | The identifier of a node.
    version_id = 'version_id_example' # str | The identifier of a version, ie. version label, within the version history of a node.
    revert_body = alfresco_core_api_client.RevertBody() # RevertBody | Optionally, specify a version comment and whether this should be a major version, or not.
    fields = ['fields_example'] # List[str] | 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)

    try:
        # Revert a version
        api_response = api_instance.revert_version(node_id, version_id, revert_body, fields=fields)
        print("The response of VersionsApi->revert_version:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VersionsApi->revert_version: %s\n" % e)

Parameters

Name	Type	Description	Notes
node_id	str	The identifier of a node.
version_id	str	The identifier of a version, ie. version label, within the version history of a node.
revert_body	RevertBody	Optionally, specify a version comment and whether this should be a major version, or not.
fields	List[str]	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]

Return type

VersionEntry

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Invalid parameter: nodeId is not a valid format, or it exists but does not identify a file, or versionId is invalid, or revertBody invalid	-
401	Authentication failed	-
403	Current user does not have permission to revert the versioned node	-
404	nodeId or versionId does not exist	-
422	Model integrity exception trying to revert the node	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

VersionsApi.md

Latest commit

History

VersionsApi.md

File metadata and controls

alfresco_core_api_client.VersionsApi

create_version_rendition

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_version

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_version_rendition

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_version

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_version_content

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_version_rendition

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_version_rendition_content

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_version_history

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_version_renditions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

request_version_direct_access_url

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

request_version_rendition_direct_access_url

Example

Parameters