Constructor Detail

Method Detail

• copyNode

  @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/nodes/{nodeId}/copy") abstract NodeEntry copyNode(@Path(value = "nodeId") String nodeId, @Body() NodeBodyCopy nodeBodyCopy, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a node.

  nodeBodyCopy - The targetParentId and, optionally, a new name which should include the file extension.

  include - Returns additional information about the node.

  fields - A list of field names.

• createAssociation

  @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/nodes/{nodeId}/targets") abstract AssociationEntry createAssociation(@Path(value = "nodeId") String nodeId, @Body() AssociationBody associationBodyCreate, @Query(value = "fields") List<String> 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\": { ... } } ] } } `` The endpoint is owned by defaultname service owner @param nodeId The identifier of a source node. (required) @param associationBodyCreate The target node id and assoc type. (required) @param fields 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)

• createNode

  @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/nodes/{nodeId}/children") abstract NodeEntry createNode(@Path(value = "nodeId") String nodeId, @Body() NodeBodyCreate nodeBodyCreate, @Query(value = "autoRename") Boolean autoRename, @Query(value = "majorVersion") Boolean majorVersion, @Query(value = "versioningEnabled") Boolean versioningEnabled, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> 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 filedata=@test.txt`` You can use the name field to give an alternative name for the new file. You can use the nodeType field to create a specific type. The default is cm:content. You can use the renditions field to create renditions (e.g. doclib) asynchronously upon upload. Also, as requesting rendition is a background process, any rendition failure (e.g. No transformer is currently available) will not fail the whole upload and has the potential to silently fail. Use overwrite to overwrite an existing file, matched by name. If the file is versionable, the existing content is replaced. When you overwrite existing content, you can set the majorVersion boolean field to true to indicate a major version should be created. The default for majorVersion is false. Setting majorVersion enables versioning of the node, if it is not already versioned. When you overwrite existing content, you can use the comment field to add a version comment that appears in the version history. This also enables versioning of this node, if it is not already versioned. You can set the autoRename boolean field to automatically resolve name clashes. If there is a name clash, then the API method tries to create a unique name using an integer suffix. You can use the relativePath field to specify the folder structure to create relative to the node nodeId. Folders in the relativePath that do not exist are created before the node is created. Any other field provided will be treated as a property to set on the newly created node. Note: setting properties of type d:content and d:category are not supported. 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 | <br> 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 | <br> The endpoint is owned by defaultname service owner @param nodeId The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root- (required) @param nodeBodyCreate The node information to create. (required) @param autoRename If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix. (optional) @param majorVersion If true, then created node will be version 1.0 MAJOR. If false, then created node will be version 0.1 MINOR. (optional) @param versioningEnabled If true, then created node will be versioned. If false, then created node will be unversioned and auto-versioning disabled. (optional) @param include Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isLocked * path * permissions * definition (optional) @param fields 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)

• createSecondaryChildAssociation

  @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/nodes/{nodeId}/secondary-children") abstract ChildAssociationEntry createSecondaryChildAssociation(@Path(value = "nodeId") String nodeId, @Body() ChildAssociationBody secondaryChildAssociationBodyCreate, @Query(value = "fields") List<String> 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\": { ... } } ] } } `` The endpoint is owned by defaultname service owner @param nodeId The identifier of a parent node. (required) @param secondaryChildAssociationBodyCreate The child node id and assoc type. (required) @param fields 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)

• deleteAssociation

  @Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/nodes/{nodeId}/targets/{targetId}") abstract Unit deleteAssociation(@Path(value = "nodeId") String nodeId, @Path(value = "targetId") String targetId, @Query(value = "assocType") String assocType)

  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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a source node.

  targetId - The identifier of a target node.

  assocType - Only delete associations of this type.

• deleteNode

  @Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/nodes/{nodeId}") abstract Unit deleteNode(@Path(value = "nodeId") String nodeId, @Query(value = "permanent") Boolean 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a node.

  permanent - If true then the node is deleted permanently, without moving to the trashcan.

• deleteSecondaryChildAssociation

  @Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/nodes/{nodeId}/secondary-children/{childId}") abstract Unit deleteSecondaryChildAssociation(@Path(value = "nodeId") String nodeId, @Path(value = "childId") String childId, @Query(value = "assocType") String assocType)

  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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a parent node.

  childId - The identifier of a child node.

  assocType - Only delete associations of this type.

• getNode

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/nodes/{nodeId}") abstract NodeEntry getNode(@Path(value = "nodeId") String nodeId, @Query(value = "include") List<String> include, @Query(value = "relativePath") String relativePath, @Query(value = "fields") List<String> 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a node.

  include - Returns additional information about the node.

  relativePath - A path relative to the nodeId.

  fields - A list of field names.

• getNodeContent

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/nodes/{nodeId}/content") abstract ResponseBody getNodeContent(@Path(value = "nodeId") String nodeId, @Query(value = "attachment") Boolean attachment, @Header(value = "If-Modified-Since") ZonedDateTime ifModifiedSince, @Header(value = "Range") String 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a node.

  attachment - true enables a web browser to download the file as an attachment.

  ifModifiedSince - Only returns the content if it has been modified since the date provided.

  range - The Range header indicates the part of a document that the server should return.

• listNodeChildren

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/nodes/{nodeId}/children") abstract NodeChildAssociationPaging listNodeChildren(@Path(value = "nodeId") String nodeId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "orderBy") List<String> orderBy, @Query(value = "where") String where, @Query(value = "include") List<String> include, @Query(value = "relativePath") String relativePath, @Query(value = "includeSource") Boolean includeSource, @Query(value = "fields") List<String> 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 The endpoint is owned by defaultname service owner @param nodeId The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- * -root- (required) @param skipCount 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) @param maxItems The maximum number of items to return in the list. If not supplied then the default value is 100. (optional, default to 100) @param orderBy 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) @param where 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) @param include Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * association * isLink * isFavorite * isLocked * path * properties * permissions (optional) @param relativePath Return information on children in the folder resolved by this path. The path is relative to nodeId. (optional) @param includeSource 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) @param fields 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)

• listParents

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/nodes/{nodeId}/parents") abstract NodeAssociationPaging listParents(@Path(value = "nodeId") String nodeId, @Query(value = "where") String where, @Query(value = "include") List<String> include, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "includeSource") Boolean includeSource, @Query(value = "fields") List<String> 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a child node.

  where - Optionally filter the list by assocType and/or isPrimary.

  include - Returns additional information about the node.

  skipCount - The number of entities that exist in the collection before those included in this list.

  maxItems - The maximum number of items to return in the list.

  includeSource - Also include source (in addition to entries) with folder information on nodeId (optional)

  fields - A list of field names.

• listSecondaryChildren

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/nodes/{nodeId}/secondary-children") abstract NodeChildAssociationPaging listSecondaryChildren(@Path(value = "nodeId") String nodeId, @Query(value = "where") String where, @Query(value = "include") List<String> include, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "includeSource") Boolean includeSource, @Query(value = "fields") List<String> 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a parent node.

  where - Optionally filter the list by assocType.

  include - Returns additional information about the node.

  skipCount - The number of entities that exist in the collection before those included in this list.

  maxItems - The maximum number of items to return in the list.

  includeSource - Also include source (in addition to entries) with folder information on nodeId (optional)

  fields - A list of field names.

• listSourceAssociations

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/nodes/{nodeId}/sources") abstract NodeAssociationPaging listSourceAssociations(@Path(value = "nodeId") String nodeId, @Query(value = "where") String where, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a target node.

  where - Optionally filter the list by assocType.

  include - Returns additional information about the node.

  fields - A list of field names.

• listTargetAssociations

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/nodes/{nodeId}/targets") abstract NodeAssociationPaging listTargetAssociations(@Path(value = "nodeId") String nodeId, @Query(value = "where") String where, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a source node.

  where - Optionally filter the list by assocType.

  include - Returns additional information about the node.

  fields - A list of field names.

• lockNode

  @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/nodes/{nodeId}/lock") abstract NodeEntry lockNode(@Path(value = "nodeId") String nodeId, @Body() NodeBodyLock nodeBodyLock, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a node.

  nodeBodyLock - Lock details.

  include - Returns additional information about the node.

  fields - A list of field names.

• moveNode

  @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/nodes/{nodeId}/move") abstract NodeEntry moveNode(@Path(value = "nodeId") String nodeId, @Body() NodeBodyMove nodeBodyMove, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a node.

  nodeBodyMove - The targetParentId and, optionally, a new name which should include the file extension.

  include - Returns additional information about the node.

  fields - A list of field names.

• unlockNode

  @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/nodes/{nodeId}/unlock") abstract NodeEntry unlockNode(@Path(value = "nodeId") String nodeId, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a node.

  include - Returns additional information about the node.

  fields - A list of field names.

• updateNode

  @Headers(value = {"Content-Type: application/json"})@PUT(value = "alfresco/versions/1/nodes/{nodeId}") abstract NodeEntry updateNode(@Path(value = "nodeId") String nodeId, @Body() NodeBodyUpdate nodeBodyUpdate, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> 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. The endpoint is owned by defaultname service owner @param nodeId The identifier of a node. (required) @param nodeBodyUpdate The node information to update. (required) @param include Returns additional information about the node. The following optional fields can be requested: * allowableOperations * association * isLink * isFavorite * isLocked * path * permissions * definition (optional) @param fields 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)

• updateNodeContent

  @Headers(value = {"Content-Type: application/octet-stream"})@PUT(value = "alfresco/versions/1/nodes/{nodeId}/content") abstract NodeEntry updateNodeContent(@Path(value = "nodeId") String nodeId, @Body() List<Byte> contentBodyUpdate, @Query(value = "majorVersion") Boolean majorVersion, @Query(value = "comment") String comment, @Query(value = "name") String name, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> 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. The endpoint is owned by defaultname service owner

  Parameters:

  nodeId - The identifier of a node.

  contentBodyUpdate - The binary content (required)

  majorVersion - If true, create a major version.

  comment - Add a version comment which will appear in version history.

  name - Optional new name.

  include - Returns additional information about the node.

  fields - A list of field names.