All URIs are relative to http://localhost/alfresco/api/-default-/public/alfresco/versions/1
| Method | HTTP request | Description |
|---|---|---|
| create_shared_link | POST /shared-links | Create a shared link to a file |
| delete_shared_link | DELETE /shared-links/{sharedId} | Deletes a shared link |
| email_shared_link | POST /shared-links/{sharedId}/email | Email shared link |
| get_shared_link | GET /shared-links/{sharedId} | Get a shared link |
| get_shared_link_content | GET /shared-links/{sharedId}/content | Get shared link content |
| get_shared_link_rendition | GET /shared-links/{sharedId}/renditions/{renditionId} | Get shared link rendition information |
| get_shared_link_rendition_content | GET /shared-links/{sharedId}/renditions/{renditionId}/content | Get shared link rendition content |
| list_shared_link_renditions | GET /shared-links/{sharedId}/renditions | List renditions for a shared link |
| list_shared_links | GET /shared-links | List shared links |
SharedLinkEntry create_shared_link(shared_link_body_create, include=include, fields=fields)
Create a shared link to a file
Note: this endpoint is available in Alfresco 5.2 and newer versions. Create a shared link to the file nodeId in the request body. Also, an optional expiry date could be set, so the shared link would become invalid when the expiry date is reached. For example: JSON { \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-3333333333\", \"expiresAt\": \"2017-03-23T23:00:00.000+0000\" } Note: You can create shared links to more than one file specifying a list of nodeIds in the JSON body like this: JSON [ { \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-4444444444\" }, { \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-5555555555\" } ] 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\": { ... } } ] } }
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.shared_link_body_create import SharedLinkBodyCreate
from alfresco_core_api_client.models.shared_link_entry import SharedLinkEntry
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.SharedLinksApi(api_client)
shared_link_body_create = alfresco_core_api_client.SharedLinkBodyCreate() # SharedLinkBodyCreate | The nodeId to create a shared link for.
include = ['include_example'] # List[str] | Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path * properties * isFavorite * 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)
try:
# Create a shared link to a file
api_response = api_instance.create_shared_link(shared_link_body_create, include=include, fields=fields)
print("The response of SharedLinksApi->create_shared_link:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SharedLinksApi->create_shared_link: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| shared_link_body_create | SharedLinkBodyCreate | The nodeId to create a shared link for. | |
| include | List[str] | Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path * properties * isFavorite * 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] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Invalid parameter: nodeId is not a valid format, or does not identify a file, or sharedLinkBodyCreate invalid, or the specified expiry date is invalid. E.g. the expiry date has already passed | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to create sharedId (for example, no read permission) | - |
| 404 | nodeId does not exist | - |
| 409 | Shared link already exists for nodeId | - |
| 501 | Shared links are disabled for the system | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_shared_link(shared_id)
Deletes a shared link
Note: this endpoint is available in Alfresco 5.2 and newer versions. Deletes the shared link with identifier sharedId.
- 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.SharedLinksApi(api_client)
shared_id = 'shared_id_example' # str | The identifier of a shared link to a file.
try:
# Deletes a shared link
api_instance.delete_shared_link(shared_id)
except Exception as e:
print("Exception when calling SharedLinksApi->delete_shared_link: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| shared_id | str | The identifier of a shared link to a file. |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | Successful response | - |
| 400 | Invalid parameter: sharedId is not a valid format | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to delete sharedId | - |
| 404 | sharedId does not exist | - |
| 501 | Shared links are disabled for the system | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
email_shared_link(shared_id, shared_link_body_email)
Email shared link
Note: this endpoint is available in Alfresco 5.2 and newer versions. Sends email with app-specific url including identifier sharedId. The client and recipientEmails properties are mandatory in the request body. For example, to email a shared link with minimum info: JSON { \"client\": \"myClient\", \"recipientEmails\": [\"[email protected]\", \"[email protected]\"] } A plain text message property can be optionally provided in the request body to customise the sent email. Also, a locale property can be optionally provided in the request body to send the emails in a particular language (if the locale is supported by Alfresco). For example, to email a shared link with a messages and a locale: JSON { \"client\": \"myClient\", \"recipientEmails\": [\"[email protected]\", \"[email protected]\"], \"message\": \"myMessage\", \"locale\":\"en-GB\" } Note: The client must be registered before you can send a shared link email. See [server documentation]. However, out-of-the-box share is registered as a default client, so you could pass share as the client name: JSON { \"client\": \"share\", \"recipientEmails\": [\"[email protected]\"] }
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.shared_link_body_email import SharedLinkBodyEmail
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.SharedLinksApi(api_client)
shared_id = 'shared_id_example' # str | The identifier of a shared link to a file.
shared_link_body_email = alfresco_core_api_client.SharedLinkBodyEmail() # SharedLinkBodyEmail | The shared link email to send.
try:
# Email shared link
api_instance.email_shared_link(shared_id, shared_link_body_email)
except Exception as e:
print("Exception when calling SharedLinksApi->email_shared_link: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| shared_id | str | The identifier of a shared link to a file. | |
| shared_link_body_email | SharedLinkBodyEmail | The shared link email to send. |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 202 | Successful response | - |
| 400 | Invalid parameter: sharedId is not a valid format or sharedLinkBodyEmail invalid | - |
| 401 | Authentication failed | - |
| 404 | sharedId does not exist or client is not registered | - |
| 501 | Shared links are disabled for the system | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SharedLinkEntry get_shared_link(shared_id, fields=fields)
Get a shared link
Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets minimal information for the file with shared link identifier sharedId. Note: No authentication is required to call this endpoint.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.shared_link_entry import SharedLinkEntry
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.SharedLinksApi(api_client)
shared_id = 'shared_id_example' # str | The identifier of a shared link to a file.
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:
# Get a shared link
api_response = api_instance.get_shared_link(shared_id, fields=fields)
print("The response of SharedLinksApi->get_shared_link:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SharedLinksApi->get_shared_link: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| shared_id | str | The identifier of a shared link to a file. | |
| 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] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Invalid parameter: sharedId is not a valid format | - |
| 404 | sharedId does not exist | - |
| 501 | Shared links are disabled for the system | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bytearray get_shared_link_content(shared_id, attachment=attachment, if_modified_since=if_modified_since, range=range)
Get shared link content
Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the content of the file with shared link identifier sharedId. Note: No authentication is required to call this endpoint.
- 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.SharedLinksApi(api_client)
shared_id = 'shared_id_example' # str | The identifier of a shared link to a file.
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 shared link content
api_response = api_instance.get_shared_link_content(shared_id, attachment=attachment, if_modified_since=if_modified_since, range=range)
print("The response of SharedLinksApi->get_shared_link_content:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SharedLinksApi->get_shared_link_content: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| shared_id | str | The identifier of a shared link to a file. | |
| 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] |
bytearray
- Content-Type: Not defined
- Accept: application/octet-stream
| 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: sharedId is not a valid format | - |
| 404 | sharedId does not exist | - |
| 412 | Content is archived and is inaccessible | - |
| 416 | Range Not Satisfiable | - |
| 501 | Shared links are disabled for the system | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RenditionEntry get_shared_link_rendition(shared_id, rendition_id)
Get shared link rendition information
Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets rendition information for the file with shared link identifier sharedId. This API method returns rendition information where the rendition status is CREATED, which means the rendition is available to view/download. Note: No authentication is required to call this endpoint.
- 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.SharedLinksApi(api_client)
shared_id = 'shared_id_example' # str | The identifier of a shared link to a file.
rendition_id = 'rendition_id_example' # str | The name of a thumbnail rendition, for example *doclib*, or *pdf*.
try:
# Get shared link rendition information
api_response = api_instance.get_shared_link_rendition(shared_id, rendition_id)
print("The response of SharedLinksApi->get_shared_link_rendition:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SharedLinksApi->get_shared_link_rendition: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| shared_id | str | The identifier of a shared link to a file. | |
| rendition_id | str | The name of a thumbnail rendition, for example doclib, or pdf. |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Invalid parameter: sharedId is not a valid format, or renditionId is invalid | - |
| 404 | sharedId or renditionId does not exist (ie. not CREATED) | - |
| 501 | Shared links are disabled for the system | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bytearray get_shared_link_rendition_content(shared_id, rendition_id, attachment=attachment, if_modified_since=if_modified_since, range=range)
Get shared link rendition content
Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition content for file with shared link identifier sharedId. Note: No authentication is required to call this endpoint.
- 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.SharedLinksApi(api_client)
shared_id = 'shared_id_example' # str | The identifier of a shared link to a file.
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)
try:
# Get shared link rendition content
api_response = api_instance.get_shared_link_rendition_content(shared_id, rendition_id, attachment=attachment, if_modified_since=if_modified_since, range=range)
print("The response of SharedLinksApi->get_shared_link_rendition_content:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SharedLinksApi->get_shared_link_rendition_content: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| shared_id | str | The identifier of a shared link to a file. | |
| 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] |
bytearray
- Content-Type: Not defined
- Accept: application/octet-stream
| 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: sharedId is not a valid format, or renditionId is invalid | - |
| 404 | sharedId does not exist | - |
| 412 | Content is archived and is inaccessible | - |
| 416 | Range Not Satisfiable | - |
| 501 | Shared links are disabled for the system | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RenditionPaging list_shared_link_renditions(shared_id)
List renditions for a shared link
Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of the rendition information for the file with shared link identifier sharedId. This API method returns rendition information, including the rendition id, for each rendition where the rendition status is CREATED, which means the rendition is available to view/download. Note: No authentication is required to call this endpoint.
- 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.SharedLinksApi(api_client)
shared_id = 'shared_id_example' # str | The identifier of a shared link to a file.
try:
# List renditions for a shared link
api_response = api_instance.list_shared_link_renditions(shared_id)
print("The response of SharedLinksApi->list_shared_link_renditions:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SharedLinksApi->list_shared_link_renditions: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| shared_id | str | The identifier of a shared link to a file. |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Invalid parameter: sharedId is not a valid format | - |
| 404 | sharedId does not exist | - |
| 501 | Shared links are disabled for the system | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SharedLinkPaging list_shared_links(skip_count=skip_count, max_items=max_items, where=where, include=include, fields=fields)
List shared links
Note: this endpoint is available in Alfresco 5.2 and newer versions. Get a list of links that the current user has read permission on source node. The list is ordered in descending modified order. Note: The list of links is eventually consistent so newly created shared links may not appear immediately.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.shared_link_paging import SharedLinkPaging
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.SharedLinksApi(api_client)
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)
where = 'where_example' # str | Optionally filter the list by \"sharedByUser\" userid of person who shared the link (can also use -me-) * ```where=(sharedByUser='jbloggs')``` * ```where=(sharedByUser='-me-')``` (optional)
include = ['include_example'] # List[str] | Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path * properties * isFavorite * 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)
try:
# List shared links
api_response = api_instance.list_shared_links(skip_count=skip_count, max_items=max_items, where=where, include=include, fields=fields)
print("The response of SharedLinksApi->list_shared_links:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SharedLinksApi->list_shared_links: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| 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] |
| where | str | Optionally filter the list by "sharedByUser" userid of person who shared the link (can also use -me-) * ```where=(sharedByUser='jbloggs')``` * ```where=(sharedByUser='-me-')``` | [optional] |
| include | List[str] | Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path * properties * isFavorite * 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] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 400 | Invalid parameter: value of maxItems or skipCount is invalid | - |
| 401 | Authentication failed | - |
| 501 | Shared links are disabled for the system | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]