There are some common parameters in the different API calls. They are documented here instead of repeating the docs for them under multiple sections:
| Parameter | Description | Usage |
|---|---|---|
| include | Use this parameter to return additional information about the node. The following optional fields can be requested: allowableOperations, aspectNames, association, isLink, isFavorite, isLocked, path, properties, permissions. | List<String> include = new ArrayList<>(); include.add("permissions"); |
| fields | 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 include parameter are returned in addition to those specified in the fields parameter. | List<String> fields = new ArrayList<>(); fields.add("content,createdAt");Note that all fields have to be added as one item comma separated. |
| where | Optionally filter the node list. | Here are some examples:(isFolder=true) (isFile=true) (nodeType='my:specialNodeType') (nodeType='my:specialNodeType INCLUDESUBTYPES') (id BETWEEN ('1', '79')) |
| 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 | Boolean includeSource = false; |
| orderBy | A string to control the order of the entities returned in a list. 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 | List<String> orderBy = new ArrayList<>(); orderBy.add("title"); |
| skipCount | The number of entities that exist in the collection before those included in this list, useful when implementing paging scenarios. If not supplied then the default value is 0. | Integer skipCount = 0; |
| maxItems | The maximum number of items to return in the list, useful when implementing paging scenarios. If not supplied then the default value is 100. | Integer maxItems = 100; |
| autoRename | If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix. | Boolean autoRename = true; |
| versioningEnabled | Should versioning of files be enabled at all? | Boolean versioningEnabled = true; |
| majorVersion | If true, then it will be a major version, such as 1.0, 2.0 etc. If false, then the version change will be 1.1, 1.2, which is a minor version change. | Boolean majorVersion = true; |
| updateComment | 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. | String updateComment = "A comment"; |
| updatedName | Optional new name of the node, sets cm:name. This should include the file extension. The name must not contain spaces or the following special characters: * " < > \ / ? : |. The character . must not be used at the end of the name. | String updatedName = null; if not updating or set to new name. |