All URIs are relative to http://localhost/alfresco/api/-default-/public/alfresco/versions/1
| Method | HTTP request | Description |
|---|---|---|
| copy_node | POST /nodes/{nodeId}/copy | Copy a node |
| create_association | POST /nodes/{nodeId}/targets | Create node association |
| create_node | POST /nodes/{nodeId}/children | Create a node |
| create_secondary_child_association | POST /nodes/{nodeId}/secondary-children | Create secondary child |
| delete_association | DELETE /nodes/{nodeId}/targets/{targetId} | Delete node association(s) |
| delete_node | DELETE /nodes/{nodeId} | Delete a node |
| delete_secondary_child_association | DELETE /nodes/{nodeId}/secondary-children/{childId} | Delete secondary child or children |
| get_node | GET /nodes/{nodeId} | Get a node |
| get_node_content | GET /nodes/{nodeId}/content | Get node content |
| list_node_children | GET /nodes/{nodeId}/children | List node children |
| list_parents | GET /nodes/{nodeId}/parents | List parents |
| list_secondary_children | GET /nodes/{nodeId}/secondary-children | List secondary children |
| list_source_associations | GET /nodes/{nodeId}/sources | List source associations |
| list_target_associations | GET /nodes/{nodeId}/targets | List target associations |
| lock_node | POST /nodes/{nodeId}/lock | Lock a node |
| move_node | POST /nodes/{nodeId}/move | Move a node |
| request_node_direct_access_url | POST /nodes/{nodeId}/request-direct-access-url | Generate a direct access content URL |
| unlock_node | POST /nodes/{nodeId}/unlock | Unlock a node |
| update_node | PUT /nodes/{nodeId} | Update a node |
| update_node_content | PUT /nodes/{nodeId}/content | Update node content |
NodeEntry copy_node(node_id, node_body_copy, include=include, fields=fields)
Copy a node
Note: this endpoint is available in Alfresco 5.2 and newer versions. Copies the node nodeId to the parent folder node targetParentId. You specify the targetParentId in the request body. The new node has the same name as the source node unless you specify a new name in the request body. If the source nodeId is a folder, then all of its children are also copied. If the source nodeId is a file, it's properties, aspects and tags are copied, it's ratings, comments and locks are not.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_body_copy import NodeBodyCopy
from alfresco_core_api_client.models.node_entry import NodeEntry
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a node.
node_body_copy = alfresco_core_api_client.NodeBodyCopy() # NodeBodyCopy | The targetParentId and, optionally, a new name which should include the file extension.
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition (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:
# Copy a node
api_response = api_instance.copy_node(node_id, node_body_copy, include=include, fields=fields)
print("The response of NodesApi->copy_node:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->copy_node: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a node. | |
| node_body_copy | NodeBodyCopy | The targetParentId and, optionally, a new name which should include the file extension. | |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition | [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 |
|---|---|---|
| 201 | Successful response | - |
| 400 | Invalid parameter: nodeId is not a valid format or nodeBodyCopy is invalid | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to copy nodeId | - |
| 404 | nodeId does not exist | - |
| 409 | New name clashes with an existing node in the destination parent folder | - |
| 422 | Model integrity exception including a file name containing invalid characters | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AssociationEntry create_association(node_id, association_body_create, fields=fields)
Create node association
Note: this endpoint is available in Alfresco 5.2 and newer versions. Create an association, with the given association type, between the source nodeId and a target node. Note: You can create more than one association by specifying a list of associations in the JSON body like this: JSON [ { \"targetId\": \"string\", \"assocType\": \"string\" }, { \"targetId\": \"string\", \"assocType\": \"string\" } ] If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } }
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.association_body import AssociationBody
from alfresco_core_api_client.models.association_entry import AssociationEntry
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a source node.
association_body_create = alfresco_core_api_client.AssociationBody() # AssociationBody | The target node id and assoc type.
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 node association
api_response = api_instance.create_association(node_id, association_body_create, fields=fields)
print("The response of NodesApi->create_association:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->create_association: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a source node. | |
| association_body_create | AssociationBody | The target node id and assoc type. | |
| 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 |
|---|---|---|
| 201 | Successful response | - |
| 400 | Invalid parameter: assocType is unknown, or the nodeId is not a valid format, or associationBodyCreate invalid | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission for nodeId | - |
| 404 | Source nodeId or targetId does not exist | - |
| 409 | An association of this assoc type already exists between these two nodes | - |
| 422 | Model integrity exception | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeEntry create_node(node_id, node_body_create, auto_rename=auto_rename, major_version=major_version, versioning_enabled=versioning_enabled, include=include, fields=fields)
Create a node
Note: this endpoint is available in Alfresco 5.2 and newer versions. Create a node and add it as a primary child of node nodeId. This endpoint supports both JSON and multipart/form-data (file upload). Using multipart/form-data Use the filedata field to represent the content to upload, for example, the following curl command will create a node with the contents of test.txt in the test user's home folder. curl -utest:test -X POST host:port/alfresco/api/-default-/public/alfresco/versions/1/nodes/-my-/children -F [email protected] You can use the name field to give an alternative name for the new file. You can use the nodeType field to create a specific type. The default is cm:content. You can use the renditions field to create renditions (e.g. doclib) asynchronously upon upload. Also, as requesting rendition is a background process, any rendition failure (e.g. No transformer is currently available) will not fail the whole upload and has the potential to silently fail. Use overwrite to overwrite an existing file, matched by name. If the file is versionable, the existing content is replaced. It is not possible to overwrite an existing file which is not versionable. When you overwrite existing content, you can set the majorVersion boolean field to true to indicate a major version should be created. The default for majorVersion is false. When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history. This also enables versioning of this node, if it is not already versioned. You can set the autoRename boolean field to automatically resolve name clashes. If there is a name clash, then the API method tries to create a unique name using an integer suffix. You can use the relativePath field to specify the folder structure to create relative to the node nodeId. Folders in the relativePath that do not exist are created before the node is created. Any other field provided will be treated as a property to set on the newly created node. Note: setting properties of type d:content and d:category are not supported. Note: When creating a new node using multipart/form-data by default versioning is enabled and set to MAJOR Version. Since Alfresco 6.2.3 versioningEnabled flag was introduced offering better control over the new node Versioning. | versioningEnabled | majorVersion | Version Type | |-----------------------|------------------|------------------| | unset | unset | MAJOR | | unset | true | MAJOR | | unset | false | MINOR | | true | unset | MAJOR | | true | true | MAJOR | | true | false | MINOR | | false | true | Unversioned | | false | false | Unversioned | | false | true | Unversioned |
Using JSON You must specify at least a name and nodeType. For example, to create a folder: JSON { \"name\":\"My Folder\", \"nodeType\":\"cm:folder\" } You can create an empty file like this: JSON { \"name\":\"My text file.txt\", \"nodeType\":\"cm:content\" } You can update binary content using the PUT /nodes/{nodeId} API method. You can create a folder, or other node, inside a folder hierarchy: JSON { \"name\":\"My Special Folder\", \"nodeType\":\"cm:folder\", \"relativePath\":\"X/Y/Z\" } The relativePath specifies the folder structure to create relative to the node nodeId. Folders in the relativePath that do not exist are created before the node is created. You can set properties when you create a new node: JSON { \"name\":\"My Other Folder\", \"nodeType\":\"cm:folder\", \"properties\": { \"cm:title\":\"Folder title\", \"cm:description\":\"This is an important folder\" } } You can set multi-value properties when you create a new node which supports properties of type multiple. JSON { \"name\":\"My Other Folder\", \"nodeType\":\"custom:destination\", \"properties\": { \"cm:title\":\"Folder title\", \"cm:description\":\"This is an important folder\", \"custom:locations\": [ \"location X\", \"location Y\" ] } } Any missing aspects are applied automatically. For example, cm:titled in the JSON shown above. You can set aspects explicitly, if needed, using an aspectNames field. Note: setting properties of type d:content and d:category are not supported. You can also optionally disable (or enable) inherited permissions via isInheritanceEnabled flag: JSON { \"permissions\": { \"isInheritanceEnabled\": false, \"locallySet\": [ {\"authorityId\": \"GROUP_special\", \"name\": \"Read\", \"accessStatus\":\"DENIED\"}, {\"authorityId\": \"testuser\", \"name\": \"Contributor\", \"accessStatus\":\"ALLOWED\"} ] } } Typically, for files and folders, the primary children are created within the parent folder using the default "cm:contains" assocType. If the content model allows then it is also possible to create primary children with a different assoc type. For example: JSON { \"name\":\"My Node\", \"nodeType\":\"my:specialNodeType\", \"association\": { \"assocType\":\"my:specialAssocType\" } } Additional associations can be added after creating a node. You can also add associations at the time the node is created. This is required, for example, if the content model specifies that a node has mandatory associations to one or more existing nodes. You can optionally specify an array of secondaryChildren to create one or more secondary child associations, such that the newly created node acts as a parent node. You can optionally specify an array of targets to create one or more peer associations such that the newly created node acts as a source node. For example, to associate one or more secondary children at time of creation: JSON { \"name\":\"My Folder\", \"nodeType\":\"cm:folder\", \"secondaryChildren\": [ {\"childId\":\"abcde-01234-...\", \"assocType\":\"my:specialChildAssocType\"} ] } For example, to associate one or more targets at time of creation: JSON { \"name\":\"My Folder\", \"nodeType\":\"cm:folder\", \"targets\": [ {\"targetId\":\"abcde-01234-...\", \"assocType\":\"my:specialPeerAssocType\"} ] } Note: You can create more than one child by specifying a list of nodes in the JSON body. For example, the following JSON body creates two folders inside the specified nodeId, if the nodeId identifies a folder: JSON [ { \"name\":\"My Folder 1\", \"nodeType\":\"cm:folder\" }, { \"name\":\"My Folder 2\", \"nodeType\":\"cm:folder\" } ] If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } } Note: When creating a new node using JSON by default versioning is disabled. Since Alfresco 6.2.3 versioningEnabled flag was introduced offering better control over the new node Versioning. | versioningEnabled | majorVersion | Version Type | |-----------------------|------------------|------------------| | unset | unset | Unversioned | | unset | true | MAJOR | | unset | false | MINOR | | true | unset | MAJOR | | true | true | MAJOR | | true | false | MINOR | | false | true | Unversioned | | false | false | Unversioned | | false | true | Unversioned |
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_body_create import NodeBodyCreate
from alfresco_core_api_client.models.node_entry import NodeEntry
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
node_body_create = alfresco_core_api_client.NodeBodyCreate() # NodeBodyCreate | The node information to create.
auto_rename = True # bool | If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix. (optional)
major_version = True # bool | If true, then created node will be version *1.0 MAJOR*. If false, then created node will be version *0.1 MINOR*. (optional)
versioning_enabled = True # bool | If true, then created node will be versioned. If false, then created node will be unversioned and auto-versioning disabled. (optional)
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition (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 node
api_response = api_instance.create_node(node_id, node_body_create, auto_rename=auto_rename, major_version=major_version, versioning_enabled=versioning_enabled, include=include, fields=fields)
print("The response of NodesApi->create_node:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->create_node: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root- | |
| node_body_create | NodeBodyCreate | The node information to create. | |
| auto_rename | bool | If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix. | [optional] |
| major_version | bool | If true, then created node will be version 1.0 MAJOR. If false, then created node will be version 0.1 MINOR. | [optional] |
| versioning_enabled | bool | If true, then created node will be versioned. If false, then created node will be unversioned and auto-versioning disabled. | [optional] |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition | [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, multipart/form-data
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful response | - |
| 400 | Invalid parameter: nodeId is not a valid format or nodeBodyCreate is invalid | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to create children of nodeId | - |
| 404 | nodeId or renditionId does not exist | - |
| 409 | New name clashes with an existing node in the current parent folder | - |
| 413 | Content exceeds individual file size limit configured for the network or system | - |
| 415 | Content Type is not supported | - |
| 422 | Model integrity exception including a file name containing invalid characters | - |
| 507 | Content exceeds overall storage quota limit configured for the network or system | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ChildAssociationEntry create_secondary_child_association(node_id, secondary_child_association_body_create, fields=fields)
Create secondary child
Note: this endpoint is available in Alfresco 5.2 and newer versions. Create a secondary child association, with the given association type, between the parent nodeId and a child node. Note: You can create more than one secondary child association by specifying a list of associations in the JSON body like this: JSON [ { \"childId\": \"string\", \"assocType\": \"string\" }, { \"childId\": \"string\", \"assocType\": \"string\" } ] If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } }
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.child_association_body import ChildAssociationBody
from alfresco_core_api_client.models.child_association_entry import ChildAssociationEntry
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a parent node.
secondary_child_association_body_create = alfresco_core_api_client.ChildAssociationBody() # ChildAssociationBody | The child node id and assoc type.
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 secondary child
api_response = api_instance.create_secondary_child_association(node_id, secondary_child_association_body_create, fields=fields)
print("The response of NodesApi->create_secondary_child_association:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->create_secondary_child_association: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a parent node. | |
| secondary_child_association_body_create | ChildAssociationBody | The child node id and assoc type. | |
| 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 |
|---|---|---|
| 201 | Successful response | - |
| 400 | Invalid parameter: assocType is unknown, or the nodeId is not a valid format, or secondaryChildAssociationBodyCreate invalid | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to create secondary children of nodeId | - |
| 404 | Parent nodeId or childId does not exist | - |
| 409 | An association of this assoc type already exists between these two nodes | - |
| 422 | Model integrity exception | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_association(node_id, target_id, assoc_type=assoc_type)
Delete node association(s)
Note: this endpoint is available in Alfresco 5.2 and newer versions. Delete an association, or associations, from the source *nodeId to a target node for the given association type. If the association type is not specified, then all peer associations, of any type, in the direction from source to target, are deleted. Note: After removal of the peer association, or associations, from source to target, the two nodes may still have peer associations in the other direction.
- 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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a source node.
target_id = 'target_id_example' # str | The identifier of a target node.
assoc_type = 'assoc_type_example' # str | Only delete associations of this type. (optional)
try:
# Delete node association(s)
api_instance.delete_association(node_id, target_id, assoc_type=assoc_type)
except Exception as e:
print("Exception when calling NodesApi->delete_association: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a source node. | |
| target_id | str | The identifier of a target node. | |
| assoc_type | str | Only delete associations of this type. | [optional] |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | Successful response | - |
| 400 | Invalid parameter: assocType is unknown, or the nodeId is not a valid format, or targetId is invalid | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission for nodeId | - |
| 404 | Source nodeId or targetId does not exist (with given assocType, if specified) | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_node(node_id, permanent=permanent)
Delete a node
Note: this endpoint is available in Alfresco 5.2 and newer versions. Deletes the node nodeId. If nodeId is a folder, then its children are also deleted. Deleted nodes move to the trashcan unless the permanent query parameter is true and the current user is the owner of the node or an admin. Deleting a node deletes it from its primary parent and also from any secondary parents. Peer associations are also deleted, where the deleted node is either a source or target of an association. This applies recursively to any hierarchy of primary children of the deleted node. Note: If the node is not permanently deleted, and is later successfully restored to its former primary parent, then the primary child association is restored. This applies recursively for any primary children. No other secondary child associations or peer associations are restored for any of the nodes in the primary parent-child hierarchy of restored nodes, regardless of whether the original associations were to nodes inside or outside the restored hierarchy.
- 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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a node.
permanent = False # bool | If **true** then the node is deleted permanently, without moving to the trashcan. Only the owner of the node or an admin can permanently delete the node. (optional) (default to False)
try:
# Delete a node
api_instance.delete_node(node_id, permanent=permanent)
except Exception as e:
print("Exception when calling NodesApi->delete_node: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a node. | |
| permanent | bool | If true then the node is deleted permanently, without moving to the trashcan. Only the owner of the node or an admin can permanently delete the node. | [optional] [default to False] |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | Successful response | - |
| 400 | Invalid parameter: nodeId is not a valid format | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to delete nodeId | - |
| 404 | nodeId does not exist | - |
| 409 | nodeId is locked and cannot be deleted | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_secondary_child_association(node_id, child_id, assoc_type=assoc_type)
Delete secondary child or children
Note: this endpoint is available in Alfresco 5.2 and newer versions. Delete secondary child associations between the parent nodeId and child nodes for the given association type. If the association type is not specified, then all secondary child associations, of any type in the direction from parent to secondary child, will be deleted. The child will still have a primary parent and may still be associated as a secondary child with other secondary parents.
- 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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a parent node.
child_id = 'child_id_example' # str | The identifier of a child node.
assoc_type = 'assoc_type_example' # str | Only delete associations of this type. (optional)
try:
# Delete secondary child or children
api_instance.delete_secondary_child_association(node_id, child_id, assoc_type=assoc_type)
except Exception as e:
print("Exception when calling NodesApi->delete_secondary_child_association: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a parent node. | |
| child_id | str | The identifier of a child node. | |
| assoc_type | str | Only delete associations of this type. | [optional] |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | Successful response | - |
| 400 | Invalid parameter: assocType is unknown or you are trying to delete a primary assocType. Use delete node instead | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission for nodeId | - |
| 404 | Parent nodeId or childId does not exist (with given assocType, if specified) | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeEntry get_node(node_id, include=include, relative_path=relative_path, fields=fields)
Get a node
Note: this endpoint is available in Alfresco 5.2 and newer versions. Get information for node nodeId. You can use the include parameter to return additional information.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_entry import NodeEntry
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition (optional)
relative_path = 'relative_path_example' # str | A path relative to the **nodeId**. If you set this, information is returned on the node resolved by this path. (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:
# Get a node
api_response = api_instance.get_node(node_id, include=include, relative_path=relative_path, fields=fields)
print("The response of NodesApi->get_node:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->get_node: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root- | |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition | [optional] |
| relative_path | str | A path relative to the nodeId. If you set this, information is returned on the node resolved by this path. | [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: nodeId is not a valid format | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to retrieve nodeId | - |
| 404 | nodeId does not exist | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
bytearray get_node_content(node_id, attachment=attachment, if_modified_since=if_modified_since, range=range)
Get node content
Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets the content of the node with identifier nodeId.
- 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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier 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 node content
api_response = api_instance.get_node_content(node_id, attachment=attachment, if_modified_since=if_modified_since, range=range)
print("The response of NodesApi->get_node_content:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->get_node_content: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier 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] |
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: nodeId is not a valid format, or is not a file | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to retrieve content of nodeId | - |
| 404 | nodeId 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]
NodeChildAssociationPaging list_node_children(node_id, skip_count=skip_count, max_items=max_items, order_by=order_by, where=where, include=include, relative_path=relative_path, include_source=include_source, fields=fields)
List node children
Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of children of the parent node nodeId. Minimal information for each child is returned by default. You can use the include parameter to return additional information. The list of child nodes includes primary children and secondary children, if there are any. You can use the include parameter (include=association) to return child association details for each child, including the assocType and the isPrimary flag. The default sort order for the returned list is for folders to be sorted before files, and by ascending name. You can override the default using orderBy to specify one or more fields to sort by. The default order is always ascending, but you can use an optional ASC or DESC modifier to specify an ascending or descending sort order. For example, specifying orderBy=name DESC returns a mixed folder/file list in descending name order. You can use any of the following fields to order the results: * isFolder * name * mimeType * nodeType * sizeInBytes * modifiedAt * createdAt * modifiedByUser * createdByUser
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_child_association_paging import NodeChildAssociationPaging
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
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)
order_by = ['order_by_example'] # List[str] | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field. (optional)
where = 'where_example' # str | Optionally filter the list. Here are some examples: * ```where=(isFolder=true)``` * ```where=(isFile=true)``` * ```where=(nodeType='my:specialNodeType')``` * ```where=(nodeType='my:specialNodeType INCLUDESUBTYPES')``` * ```where=(isPrimary=true)``` * ```where=(assocType='my:specialAssocType')``` * ```where=(isPrimary=false and assocType='my:specialAssocType')``` (optional)
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * properties * permissions (optional)
relative_path = 'relative_path_example' # str | Return information on children in the folder resolved by this path. The path is relative to **nodeId**. (optional)
include_source = True # bool | Also include **source** in addition to **entries** with folder information on the parent node – either the specified parent **nodeId**, or as resolved by **relativePath**. (optional)
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 node children
api_response = api_instance.list_node_children(node_id, skip_count=skip_count, max_items=max_items, order_by=order_by, where=where, include=include, relative_path=relative_path, include_source=include_source, fields=fields)
print("The response of NodesApi->list_node_children:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->list_node_children: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root- | |
| 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] |
| order_by | List[str] | A string to control the order of the entities returned in a list. You can use the orderBy parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field. | [optional] |
| where | str | Optionally filter the list. Here are some examples: * ```where=(isFolder=true)``` * ```where=(isFile=true)``` * ```where=(nodeType='my:specialNodeType')``` * ```where=(nodeType='my:specialNodeType INCLUDESUBTYPES')``` * ```where=(isPrimary=true)``` * ```where=(assocType='my:specialAssocType')``` * ```where=(isPrimary=false and assocType='my:specialAssocType')``` | [optional] |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * properties * permissions | [optional] |
| relative_path | str | Return information on children in the folder resolved by this path. The path is relative to nodeId. | [optional] |
| include_source | bool | Also include source in addition to entries with folder information on the parent node – either the specified parent nodeId, or as resolved by relativePath. | [optional] |
| 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: nodeId is not a valid format, nodeId is not a folder or orderBy is invalid | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to retrieve children of nodeId | - |
| 404 | nodeId does not exist | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeAssociationPaging list_parents(node_id, where=where, include=include, skip_count=skip_count, max_items=max_items, include_source=include_source, fields=fields)
List parents
Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of parent nodes that are associated with the current child nodeId. The list includes both the primary parent and any secondary parents.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_association_paging import NodeAssociationPaging
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a child node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
where = 'where_example' # str | Optionally filter the list by **assocType** and/or **isPrimary**. Here are some example filters: * ```where=(assocType='my:specialAssocType')``` * ```where=(isPrimary=true)``` * ```where=(isPrimary=false and assocType='my:specialAssocType')``` (optional)
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * properties (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)
include_source = True # bool | Also include **source** (in addition to **entries**) with folder information on **nodeId** (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 parents
api_response = api_instance.list_parents(node_id, where=where, include=include, skip_count=skip_count, max_items=max_items, include_source=include_source, fields=fields)
print("The response of NodesApi->list_parents:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->list_parents: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a child node. You can also use one of these well-known aliases: * -my- * -shared- * -root- | |
| where | str | Optionally filter the list by assocType and/or isPrimary. Here are some example filters: * ```where=(assocType='my:specialAssocType')``` * ```where=(isPrimary=true)``` * ```where=(isPrimary=false and assocType='my:specialAssocType')``` | [optional] |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * properties | [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] |
| include_source | bool | Also include source (in addition to entries) with folder information on nodeId | [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: assocType is unknown or the nodeId is not a valid format | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission for nodeId | - |
| 404 | Child nodeId does not exist | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeChildAssociationPaging list_secondary_children(node_id, where=where, include=include, skip_count=skip_count, max_items=max_items, include_source=include_source, fields=fields)
List secondary children
Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of secondary child nodes that are associated with the current parent nodeId, via a secondary child association.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_child_association_paging import NodeChildAssociationPaging
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a parent node. You can also use one of these well-known aliases: * -my- * -shared- * -root-
where = 'where_example' # str | Optionally filter the list by assocType. Here's an example: * ```where=(assocType='my:specialAssocType')``` (optional)
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * properties (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)
include_source = True # bool | Also include **source** (in addition to **entries**) with folder information on **nodeId** (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 secondary children
api_response = api_instance.list_secondary_children(node_id, where=where, include=include, skip_count=skip_count, max_items=max_items, include_source=include_source, fields=fields)
print("The response of NodesApi->list_secondary_children:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->list_secondary_children: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a parent node. You can also use one of these well-known aliases: * -my- * -shared- * -root- | |
| where | str | Optionally filter the list by assocType. Here's an example: * ```where=(assocType='my:specialAssocType')``` | [optional] |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * properties | [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] |
| include_source | bool | Also include source (in addition to entries) with folder information on nodeId | [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: assocType is unknown or the nodeId is not a valid format | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission for nodeId | - |
| 404 | Parent nodeId does not exist | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeAssociationPaging list_source_associations(node_id, where=where, include=include, skip_count=skip_count, max_items=max_items, fields=fields)
List source associations
Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of source nodes that are associated with the current target nodeId.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_association_paging import NodeAssociationPaging
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a target node.
where = 'where_example' # str | Optionally filter the list by **assocType**. Here's an example: * ```where=(assocType='my:specialAssocType')``` (optional)
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * properties (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)
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 source associations
api_response = api_instance.list_source_associations(node_id, where=where, include=include, skip_count=skip_count, max_items=max_items, fields=fields)
print("The response of NodesApi->list_source_associations:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->list_source_associations: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a target node. | |
| where | str | Optionally filter the list by assocType. Here's an example: * ```where=(assocType='my:specialAssocType')``` | [optional] |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * properties | [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] |
| 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: nodeId is not a valid format or assocType is unknown | - |
| 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]
NodeAssociationPaging list_target_associations(node_id, where=where, include=include, skip_count=skip_count, max_items=max_items, fields=fields)
List target associations
Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of target nodes that are associated with the current source nodeId.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_association_paging import NodeAssociationPaging
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a source node.
where = 'where_example' # str | Optionally filter the list by **assocType**. Here's an example: * ```where=(assocType='my:specialAssocType')``` (optional)
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * properties (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)
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 target associations
api_response = api_instance.list_target_associations(node_id, where=where, include=include, skip_count=skip_count, max_items=max_items, fields=fields)
print("The response of NodesApi->list_target_associations:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->list_target_associations: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a source node. | |
| where | str | Optionally filter the list by assocType. Here's an example: * ```where=(assocType='my:specialAssocType')``` | [optional] |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * properties | [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] |
| 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: assocType is unknown or the nodeId is not a valid format | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission for nodeId | - |
| 404 | Source nodeId does not exist | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeEntry lock_node(node_id, node_body_lock, include=include, fields=fields)
Lock a node
Note: this endpoint is available in Alfresco 5.2 and newer versions. Places a lock on node nodeId. Note: you can only lock files. More specifically, a node can only be locked if it is of type cm:content or a subtype of cm:content. The lock is owned by the current user, and prevents other users or processes from making updates to the node until the lock is released. If the timeToExpire is not set or is zero, then the lock never expires. Otherwise, the timeToExpire is the number of seconds before the lock expires. When a lock expires, the lock is released. If the node is already locked, and the user is the lock owner, then the lock is renewed with the new timeToExpire. By default, a lock is applied that allows the owner to update or delete the node. You can use type to change the lock type to one of the following: * ALLOW_OWNER_CHANGES (default) changes to the node can be made only by the lock owner. This enum is the same value as the deprecated WRITE_LOCK described in org.alfresco.service.cmr.lock.LockType in the Alfresco Public Java API. This is the default value. * FULL no changes by any user are allowed. This enum is the same value as the deprecated READ_ONLY_LOCK described in org.alfresco.service.cmr.lock.LockType in the Alfresco Public Java API. By default, a lock is persisted in the database. You can create a volatile in-memory lock by setting the lifetime property to EPHEMERAL. You might choose use EPHEMERAL locks, for example, if you are taking frequent short-term locks that you don't need to be kept over a restart of the repository. In this case you don't need the overhead of writing the locks to the database. If a lock on the node cannot be taken, then an error is returned.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_body_lock import NodeBodyLock
from alfresco_core_api_client.models.node_entry import NodeEntry
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a node.
node_body_lock = alfresco_core_api_client.NodeBodyLock() # NodeBodyLock | Lock details.
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition (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:
# Lock a node
api_response = api_instance.lock_node(node_id, node_body_lock, include=include, fields=fields)
print("The response of NodesApi->lock_node:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->lock_node: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a node. | |
| node_body_lock | NodeBodyLock | Lock details. | |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition | [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 nodeBodyLock is invalid, or a lock was attempted on a node that is not a file | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to lock nodeId | - |
| 404 | nodeId does not exist | - |
| 422 | nodeId could not be locked | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeEntry move_node(node_id, node_body_move, include=include, fields=fields)
Move a node
Note: this endpoint is available in Alfresco 5.2 and newer versions. Move the node nodeId to the parent folder node targetParentId. The targetParentId is specified in the in request body. The moved node retains its name unless you specify a new name in the request body. If the source nodeId is a folder, then its children are also moved. The move will effectively change the primary parent.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_body_move import NodeBodyMove
from alfresco_core_api_client.models.node_entry import NodeEntry
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a node.
node_body_move = alfresco_core_api_client.NodeBodyMove() # NodeBodyMove | The targetParentId and, optionally, a new name which should include the file extension.
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition (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:
# Move a node
api_response = api_instance.move_node(node_id, node_body_move, include=include, fields=fields)
print("The response of NodesApi->move_node:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->move_node: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a node. | |
| node_body_move | NodeBodyMove | The targetParentId and, optionally, a new name which should include the file extension. | |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition | [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 targetParentId is not a folder, or nodeBodyMove is invalid | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to move nodeId | - |
| 404 | nodeId does not exist | - |
| 409 | New name clashes with an existing node in the destination parent folder | - |
| 422 | Model integrity exception including a file name containing invalid characters | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DirectAccessUrlEntry request_node_direct_access_url(node_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.
- 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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier 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_node_direct_access_url(node_id, request_content_url_body_create=request_content_url_body_create)
print("The response of NodesApi->request_node_direct_access_url:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->request_node_direct_access_url: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier 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] |
- 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 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]
NodeEntry unlock_node(node_id, include=include, fields=fields)
Unlock a node
Note: this endpoint is available in Alfresco 5.2 and newer versions. Deletes a lock on node nodeId. The current user must be the owner of the locks or have admin rights, otherwise an error is returned. If a lock on the node cannot be released, then an error is returned.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_entry import NodeEntry
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a node.
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition (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:
# Unlock a node
api_response = api_instance.unlock_node(node_id, include=include, fields=fields)
print("The response of NodesApi->unlock_node:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->unlock_node: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a node. | |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition | [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: nodeId is not a valid format | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to unlock nodeId | - |
| 404 | nodeId does not exist | - |
| 422 | nodeId could not be unlocked | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeEntry update_node(node_id, node_body_update, include=include, fields=fields)
Update a node
Note: this endpoint is available in Alfresco 5.2 and newer versions. Updates the node nodeId. For example, you can rename a file or folder: JSON { \"name\":\"My new name\" } You can also set or update one or more properties: JSON { \"properties\": { \"cm:title\":\"Folder title\" } } You can update multi-value properties of a node which supports properties of type multiple. JSON { \"name\":\"My Other Folder\", \"nodeType\":\"custom:destination\", \"properties\": { \"cm:title\":\"Folder title\", \"cm:description\":\"This is an important folder\", \"custom:locations\": [ \"location NewX\", \"location NewY\" ] } } Note: setting properties of type d:content and d:category are not supported. Note: if you want to add or remove aspects, then you must use GET /nodes/{nodeId} first to get the complete set of aspectNames. You can add (or remove) locallySet permissions, if any, in addition to any inherited permissions. You can also optionally disable (or re-enable) inherited permissions via isInheritanceEnabled flag: JSON { \"permissions\": { \"isInheritanceEnabled\": false, \"locallySet\": [ {\"authorityId\": \"GROUP_special\", \"name\": \"Read\", \"accessStatus\":\"DENIED\"}, {\"authorityId\": \"testuser\", \"name\": \"Contributor\", \"accessStatus\":\"ALLOWED\"} ] } } Note: if you want to add or remove locally set permissions then you must use GET /nodes/{nodeId} first to get the complete set of locallySet permissions. Note: Currently there is no optimistic locking for updates, so they are applied in "last one wins" order.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_body_update import NodeBodyUpdate
from alfresco_core_api_client.models.node_entry import NodeEntry
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a node.
node_body_update = alfresco_core_api_client.NodeBodyUpdate() # NodeBodyUpdate | The node information to update.
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition (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:
# Update a node
api_response = api_instance.update_node(node_id, node_body_update, include=include, fields=fields)
print("The response of NodesApi->update_node:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->update_node: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a node. | |
| node_body_update | NodeBodyUpdate | The node information to update. | |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition | [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: the update request is invalid or nodeId is not a valid format or nodeBodyUpdate is invalid | - |
| 401 | Authentication failed | - |
| 403 | Current user does not have permission to update nodeId | - |
| 404 | nodeId does not exist | - |
| 409 | Updated name clashes with an existing node in the current parent folder | - |
| 422 | Model integrity exception including a file name containing invalid characters | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeEntry update_node_content(node_id, content_body_update, major_version=major_version, comment=comment, name=name, include=include, fields=fields)
Update node content
Note: this endpoint is available in Alfresco 5.2 and newer versions. Updates the content of the node with identifier nodeId. The request body for this endpoint can be any text or binary stream. The majorVersion and comment parameters can be used to control versioning behaviour. If the content is versionable, a new minor version is created by default. Optionally a new name parameter can also be specified that must be unique within the parent folder. If specified and valid then this will rename the node. If invalid then an error is returned and the content is not updated. Note: This API method accepts any content type, but for testing with this tool text based content can be provided. This is because the OpenAPI Specification does not allow a wildcard to be provided or the ability for tooling to accept an arbitrary file.
- Basic Authentication (basicAuth):
import time
import os
import alfresco_core_api_client
from alfresco_core_api_client.models.node_entry import NodeEntry
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.NodesApi(api_client)
node_id = 'node_id_example' # str | The identifier of a node.
content_body_update = None # bytearray | The binary content
major_version = False # bool | If **true**, create a major version. Setting this parameter also enables versioning of this node, if it is not already versioned. (optional) (default to False)
comment = 'comment_example' # str | Add a version comment which will appear in version history. Setting this parameter also enables versioning of this node, if it is not already versioned. (optional)
name = 'name_example' # str | Optional new name. This should include the file extension. The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |. The character `.` must not be used at the end of the name. (optional)
include = ['include_example'] # List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition (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:
# Update node content
api_response = api_instance.update_node_content(node_id, content_body_update, major_version=major_version, comment=comment, name=name, include=include, fields=fields)
print("The response of NodesApi->update_node_content:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NodesApi->update_node_content: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| node_id | str | The identifier of a node. | |
| content_body_update | bytearray | The binary content | |
| major_version | bool | If true, create a major version. Setting this parameter also enables versioning of this node, if it is not already versioned. | [optional] [default to False] |
| comment | str | Add a version comment which will appear in version history. Setting this parameter also enables versioning of this node, if it is not already versioned. | [optional] |
| name | str | Optional new name. This should include the file extension. The name must not contain spaces or the following special characters: * " < > \ / ? : and | . The character `.` must not be used at the end of the name. |
| include | List[str] | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isDirectLinkEnabled * isLocked * path * permissions * definition | [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/octet-stream
- Accept: application/json
| 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 to update nodeId | - |
| 404 | nodeId does not exist | - |
| 409 | Optional new name clashes with an existing node in the current parent folder | - |
| 413 | Content exceeds individual file size limit (configured for network/system) | - |
| 422 | Model integrity exception including a file name containing invalid characters | - |
| 507 | Content exceeds overall storage quota limit configured for the network/system | - |
| 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]