EntriesClient (Laserfiche Repository API Client 1.2.0 API)

All Known Implementing Classes:

EntriesClientImpl
```
public interface EntriesClient
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<ODataValueOfIListOfWEntryLinkInfo>`	`assignEntryLinks(String repoId, Integer entryId, List<PutLinksRequest> requestBody)` - Assign links to an entry.
`CompletableFuture<ODataValueOfIListOfFieldValue>`	`assignFieldValues(String repoId, Integer entryId, Map<String,FieldToUpdate> requestBody, String culture)` - Update the field values assigned to an entry.
`CompletableFuture<ODataValueOfIListOfWTagInfo>`	`assignTags(String repoId, Integer entryId, PutTagRequest requestBody)` - Assign tags to an entry.
`CompletableFuture<AcceptedOperation>`	`copyEntryAsync(String repoId, Integer entryId, CopyAsyncRequest requestBody, Boolean autoRename, String culture)` - Copy a new child entry in the designated folder async, and potentially return an operationToken.
`CompletableFuture<Entry>`	`createOrCopyEntry(String repoId, Integer entryId, PostEntryChildrenRequest requestBody, Boolean autoRename, String culture)` - Create/copy a new child entry in the designated folder.
`CompletableFuture<Entry>`	`deleteAssignedTemplate(String repoId, Integer entryId)` - Remove the currently assigned template from the specified entry.
`CompletableFuture<ODataValueOfBoolean>`	`deleteDocument(String repoId, Integer entryId)` - Delete the edoc associated with the provided entry ID.
`CompletableFuture<AcceptedOperation>`	`deleteEntryInfo(String repoId, Integer entryId, DeleteEntryWithAuditReason requestBody)` - Begins a task to delete an entry, and returns an operationToken.
`CompletableFuture<ODataValueOfBoolean>`	`deletePages(String repoId, Integer entryId, String pageRange)` - Delete the pages associated with the provided entry ID.
`CompletableFuture<Void>`	`exportDocument(String repoId, Integer entryId, String range, Consumer<InputStream> inputStreamConsumer)` - Returns an entry's edoc resource in a stream format.
`CompletableFuture<Void>`	`exportDocumentWithAuditReason(String repoId, Integer entryId, GetEdocWithAuditReasonRequest requestBody, String range, Consumer<InputStream> inputStreamConsumer)` - Returns an entry's edoc resource in a stream format while including an audit reason.
`CompletableFuture<Map<String,String>>`	`getDocumentContentType(String repoId, Integer entryId)` - Returns information about the edoc content of an entry, without downloading the edoc in its entirety.
`CompletableFuture<Map<String,String[]>>`	`getDynamicFieldValues(String repoId, Integer entryId, GetDynamicFieldLogicValueRequest requestBody)` - Returns dynamic field logic values with the current values of the fields in the template.
`CompletableFuture<Entry>`	`getEntry(String repoId, Integer entryId, String select)` - Returns a single entry object.
`CompletableFuture<FindEntryResult>`	`getEntryByPath(String repoId, String fullPath, Boolean fallbackToClosestAncestor)` - Returns a single entry object using the entry path.
`CompletableFuture<ODataValueContextOfIListOfEntry>`	`getEntryListing(String repoId, Integer entryId, Boolean groupByEntryType, String[] fields, Boolean formatFields, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)` - Returns the children entries of a folder in the repository.
`CompletableFuture<Void>`	`getEntryListingForEach(Function<CompletableFuture<ODataValueContextOfIListOfEntry>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, Integer entryId, Boolean groupByEntryType, String[] fields, Boolean formatFields, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)` Provides the functionality to iteratively (i.e.
`CompletableFuture<ODataValueContextOfIListOfEntry>`	`getEntryListingNextLink(String nextLink, Integer maxPageSize)` Returns the next subset of the requested collection, using a nextlink url.
`CompletableFuture<ODataValueContextOfIListOfFieldValue>`	`getFieldValues(String repoId, Integer entryId, String prefer, Boolean formatValue, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)` - Returns the fields assigned to an entry.
`CompletableFuture<Void>`	`getFieldValuesForEach(Function<CompletableFuture<ODataValueContextOfIListOfFieldValue>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, Integer entryId, String prefer, Boolean formatValue, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)` Provides the functionality to iteratively (i.e.
`CompletableFuture<ODataValueContextOfIListOfFieldValue>`	`getFieldValuesNextLink(String nextLink, Integer maxPageSize)` Returns the next subset of the requested collection, using a nextlink url.
`CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo>`	`getLinkValuesFromEntry(String repoId, Integer entryId, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count)` - Returns the links assigned to an entry.
`CompletableFuture<Void>`	`getLinkValuesFromEntryForEach(Function<CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, Integer entryId, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count)` Provides the functionality to iteratively (i.e.
`CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo>`	`getLinkValuesFromEntryNextLink(String nextLink, Integer maxPageSize)` Returns the next subset of the requested collection, using a nextlink url.
`CompletableFuture<ODataValueContextOfIListOfWTagInfo>`	`getTagsAssignedToEntry(String repoId, Integer entryId, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count)` - Returns the tags assigned to an entry.
`CompletableFuture<Void>`	`getTagsAssignedToEntryForEach(Function<CompletableFuture<ODataValueContextOfIListOfWTagInfo>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, Integer entryId, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count)` Provides the functionality to iteratively (i.e.
`CompletableFuture<ODataValueContextOfIListOfWTagInfo>`	`getTagsAssignedToEntryNextLink(String nextLink, Integer maxPageSize)` Returns the next subset of the requested collection, using a nextlink url.
`CompletableFuture<CreateEntryResult>`	`importDocument(String repoId, Integer parentEntryId, String fileName, Boolean autoRename, String culture, InputStream inputStream, PostEntryWithEdocMetadataRequest requestBody)` - Creates a new document in the specified folder with file (no more than 100 MB).
`CompletableFuture<Entry>`	`moveOrRenameEntry(String repoId, Integer entryId, PatchEntryRequest requestBody, Boolean autoRename, String culture)` - Moves and/or renames an entry.
`CompletableFuture<Entry>`	`writeTemplateValueToEntry(String repoId, Integer entryId, PutTemplateRequest requestBody, String culture)` - Assign a template to an entry.

- Method Detail
 - getFieldValues
```
CompletableFuture<ODataValueContextOfIListOfFieldValue> getFieldValues(String repoId,
 Integer entryId,
 String prefer,
 Boolean formatValue,
 String culture,
 String select,
 String orderby,
 Integer top,
 Integer skip,
 Boolean count)
```
 - Returns the fields assigned to an entry. - Provide an entry ID, and get a paged listing of all fields assigned to that entry. - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested entry ID.
 
 prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
 
 formatValue - An optional query parameter used to indicate if the field values should be formatted. The default value is false.
 
 culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise culture will not be used for formatting.
 
 select - Limits the properties returned in the result.
 
 orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.
 
 top - Limits the number of items returned from a collection.
 
 skip - Excludes the specified number of items of the queried collection from the result.
 
 count - Indicates whether the total count of items within a collection are returned in the result.
 
 Returns:
 
 CompletableFuture<ODataValueContextOfIListOfFieldValue> The return value
 - getFieldValuesNextLink
```
CompletableFuture<ODataValueContextOfIListOfFieldValue> getFieldValuesNextLink(String nextLink,
 Integer maxPageSize)
```
 Returns the next subset of the requested collection, using a nextlink url.
 
 Parameters:
 
 nextLink - A url that allows retrieving the next subset of the requested collection.
 
 maxPageSize - Optionally specify the maximum number of items to retrieve.
 
 Returns:
 
 CompletableFuture<ODataValueContextOfIListOfFieldValue> The return value
 - getFieldValuesForEach
```
CompletableFuture<Void> getFieldValuesForEach(Function<CompletableFuture<ODataValueContextOfIListOfFieldValue>,CompletableFuture<Boolean>> callback,
 Integer maxPageSize,
 String repoId,
 Integer entryId,
 String prefer,
 Boolean formatValue,
 String culture,
 String select,
 String orderby,
 Integer top,
 Integer skip,
 Boolean count)
```
 Provides the functionality to iteratively (i.e. through paging) call getFieldValues, and apply a function on the response of each iteration.
 
 Parameters:
 
 callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.
 
 maxPageSize - Optionally specify the maximum number of items to retrieve.
 
 repoId - The requested repository ID.
 
 entryId - The requested entry ID.
 
 prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
 
 formatValue - An optional query parameter used to indicate if the field values should be formatted. The default value is false.
 
 culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise culture will not be used for formatting.
 
 select - Limits the properties returned in the result.
 
 orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.
 
 top - Limits the number of items returned from a collection.
 
 skip - Excludes the specified number of items of the queried collection from the result.
 
 count - Indicates whether the total count of items within a collection are returned in the result.
 
 Returns:
 
 CompletableFuture<Void> The return value
 - assignFieldValues
```
CompletableFuture<ODataValueOfIListOfFieldValue> assignFieldValues(String repoId,
 Integer entryId,
 Map<String,FieldToUpdate> requestBody,
 String culture)
```
 - Update the field values assigned to an entry. - Provide the new field values to assign to the entry, and remove/reset all previously assigned field values. - This is an overwrite action. The request body must include all desired field values, including any existing field values that should remain assigned to the entry. Field values that are not included in the request will be deleted from the entry. If the field value that is not included is part of a template, it will still be assigned (as required by the template), but its value will be reset.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The entry ID of the entry that will have its fields updated.
 
 requestBody -
 
 culture - An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
 
 Returns:
 
 CompletableFuture<ODataValueOfIListOfFieldValue> The return value
 - importDocument
```
CompletableFuture<CreateEntryResult> importDocument(String repoId,
 Integer parentEntryId,
 String fileName,
 Boolean autoRename,
 String culture,
 InputStream inputStream,
 PostEntryWithEdocMetadataRequest requestBody)
```
 - Creates a new document in the specified folder with file (no more than 100 MB). - Optionally sets metadata and electronic document component. - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. With this route, partial success is possible. The response returns multiple operation (entryCreate operation, setEdoc operation, setLinks operation, etc..) objects, which contain information about any errors that may have occurred during the creation. As long as the entryCreate operation succeeds, the entry will be created, even if all other operations fail.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 parentEntryId - The entry ID of the folder that the document will be created in.
 
 fileName - The created document's file name.
 
 autoRename - An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false.
 
 culture - An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
 
 inputStream - An InputStream object to read the raw bytes for the file to be uploaded.
 
 requestBody - A value of type PostEntryWithEdocMetadataRequest.
 
 Returns:
 
 CompletableFuture<CreateEntryResult> The return value
 - getLinkValuesFromEntry
```
CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo> getLinkValuesFromEntry(String repoId,
 Integer entryId,
 String prefer,
 String select,
 String orderby,
 Integer top,
 Integer skip,
 Boolean count)
```
 - Returns the links assigned to an entry. - Provide an entry ID, and get a paged listing of links assigned to that entry. - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested entry ID.
 
 prefer - An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.
 
 select - Limits the properties returned in the result.
 
 orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.
 
 top - Limits the number of items returned from a collection.
 
 skip - Excludes the specified number of items of the queried collection from the result.
 
 count - Indicates whether the total count of items within a collection are returned in the result.
 
 Returns:
 
 CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo> The return value
 - getLinkValuesFromEntryNextLink
```
CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo> getLinkValuesFromEntryNextLink(String nextLink,
 Integer maxPageSize)
```
 Returns the next subset of the requested collection, using a nextlink url.
 
 Parameters:
 
 nextLink - A url that allows retrieving the next subset of the requested collection.
 
 maxPageSize - Optionally specify the maximum number of items to retrieve.
 
 Returns:
 
 CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo> The return value
 - getLinkValuesFromEntryForEach
```
CompletableFuture<Void> getLinkValuesFromEntryForEach(Function<CompletableFuture<ODataValueContextOfIListOfWEntryLinkInfo>,CompletableFuture<Boolean>> callback,
 Integer maxPageSize,
 String repoId,
 Integer entryId,
 String prefer,
 String select,
 String orderby,
 Integer top,
 Integer skip,
 Boolean count)
```
 Provides the functionality to iteratively (i.e. through paging) call getLinkValuesFromEntry, and apply a function on the response of each iteration.
 
 Parameters:
 
 callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.
 
 maxPageSize - Optionally specify the maximum number of items to retrieve.
 
 repoId - The requested repository ID.
 
 entryId - The requested entry ID.
 
 prefer - An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.
 
 select - Limits the properties returned in the result.
 
 orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.
 
 top - Limits the number of items returned from a collection.
 
 skip - Excludes the specified number of items of the queried collection from the result.
 
 count - Indicates whether the total count of items within a collection are returned in the result.
 
 Returns:
 
 CompletableFuture<Void> The return value
 - assignEntryLinks
```
CompletableFuture<ODataValueOfIListOfWEntryLinkInfo> assignEntryLinks(String repoId,
 Integer entryId,
 List<PutLinksRequest> requestBody)
```
 - Assign links to an entry. - Provide an entry ID and a list of links to assign to that entry. - This is an overwrite action. The request must include all links to assign to the entry, including existing links that should remain assigned to the entry.
 
 Parameters:
 
 repoId - The request repository ID.
 
 entryId - The requested entry ID.
 
 requestBody - A value of type List<PutLinksRequest>.
 
 Returns:
 
 CompletableFuture<ODataValueOfIListOfWEntryLinkInfo> The return value
 - writeTemplateValueToEntry
```
CompletableFuture<Entry> writeTemplateValueToEntry(String repoId,
 Integer entryId,
 PutTemplateRequest requestBody,
 String culture)
```
 - Assign a template to an entry. - Provide an entry ID, template name, and a list of template fields to assign to that entry. - Only template values will be modified. Any existing independent fields on the entry will not be modified, nor will they be added if included in the request. The only modification to fields will only occur on templated fields. If the previously assigned template includes common template fields as the newly assigned template, the common field values will not be modified.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The ID of entry that will have its template updated.
 
 requestBody - The template and template fields that will be assigned to the entry.
 
 culture - An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
 
 Returns:
 
 CompletableFuture<Entry> The return value
 - deleteAssignedTemplate
```
CompletableFuture<Entry> deleteAssignedTemplate(String repoId,
 Integer entryId)
```
 - Remove the currently assigned template from the specified entry. - Provide an entry ID to clear template value on. - If the entry does not have a template assigned, no change will be made.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The ID of the entry that will have its template removed.
 
 Returns:
 
 CompletableFuture<Entry> The return value
 - getDynamicFieldValues
```
CompletableFuture<Map<String,String[]>> getDynamicFieldValues(String repoId,
 Integer entryId,
 GetDynamicFieldLogicValueRequest requestBody)
```
 - Returns dynamic field logic values with the current values of the fields in the template. - Provide an entry ID and field values in the JSON body to get dynamic field logic values. Independent and non-dynamic fields in the request body will be ignored, and only related dynamic field logic values for the assigned template will be returned.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested entry ID.
 
 requestBody - A value of type GetDynamicFieldLogicValueRequest.
 
 Returns:
 
 CompletableFuture<Map<String,String[]>> The return value
 - getEntryByPath
```
CompletableFuture<FindEntryResult> getEntryByPath(String repoId,
 String fullPath,
 Boolean fallbackToClosestAncestor)
```
 - Returns a single entry object using the entry path. - Optional query parameter: fallbackToClosestAncestor. Use the fallbackToClosestAncestor query parameter to return the closest existing ancestor if the initial entry path is not found.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 fullPath - The requested entry path.
 
 fallbackToClosestAncestor - An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false.
 
 Returns:
 
 CompletableFuture<FindEntryResult> The return value
 - copyEntryAsync
```
CompletableFuture<AcceptedOperation> copyEntryAsync(String repoId,
 Integer entryId,
 CopyAsyncRequest requestBody,
 Boolean autoRename,
 String culture)
```
 - Copy a new child entry in the designated folder async, and potentially return an operationToken. - Provide the parent folder ID, and copy an entry as a child of the designated folder. - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. - The status of the operation can be checked via the Tasks/{operationToken} route.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The folder ID that the entry will be created in.
 
 requestBody - Copy entry request.
 
 autoRename - An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false.
 
 culture - An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
 
 Returns:
 
 CompletableFuture<AcceptedOperation> The return value
 - getEntry
```
CompletableFuture<Entry> getEntry(String repoId,
 Integer entryId,
 String select)
```
 - Returns a single entry object. - Provide an entry ID, and get the entry associated with that ID. Useful when detailed information about the entry is required, such as metadata, path information, etc. - Allowed OData query options: Select. If the entry is a subtype (Folder, Document, or Shortcut), the entry will automatically be converted to include those model-specific properties.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested entry ID.
 
 select - Limits the properties returned in the result.
 
 Returns:
 
 CompletableFuture<Entry> The return value
 - moveOrRenameEntry
```
CompletableFuture<Entry> moveOrRenameEntry(String repoId,
 Integer entryId,
 PatchEntryRequest requestBody,
 Boolean autoRename,
 String culture)
```
 - Moves and/or renames an entry. - Move and/or rename an entry by passing in the new parent folder ID or name in the JSON body. - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested entry ID.
 
 requestBody - The request containing the folder ID that the entry will be moved to and the new name the entry will be renamed to.
 
 autoRename - An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false.
 
 culture - An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
 
 Returns:
 
 CompletableFuture<Entry> The return value
 - deleteEntryInfo
```
CompletableFuture<AcceptedOperation> deleteEntryInfo(String repoId,
 Integer entryId,
 DeleteEntryWithAuditReason requestBody)
```
 - Begins a task to delete an entry, and returns an operationToken. - Provide an entry ID, and queue a delete task to remove it from the repository (includes nested objects if the entry is a Folder type). The entry will not be deleted immediately. - Optionally include an audit reason ID and comment in the JSON body. This route returns an operationToken, and will run as an asynchronous operation. Check the progress via the Tasks/{operationToken} route.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested entry ID.
 
 requestBody - The submitted audit reason.
 
 Returns:
 
 CompletableFuture<AcceptedOperation> The return value
 - exportDocumentWithAuditReason
```
CompletableFuture<Void> exportDocumentWithAuditReason(String repoId,
 Integer entryId,
 GetEdocWithAuditReasonRequest requestBody,
 String range,
 Consumer<InputStream> inputStreamConsumer)
```
 - Returns an entry's edoc resource in a stream format while including an audit reason. - Provide an entry ID and audit reason/comment in the request body, and get the edoc resource as part of the response content. - Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. This route is identical to the GET edoc route, but allows clients to include an audit reason when downloading the edoc.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested document ID.
 
 requestBody - A value of type GetEdocWithAuditReasonRequest.
 
 range - An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.
 
 inputStreamConsumer - A Consumer<InputStream> object that the is provided with the response's inputStream to consume it, if the request has been successful.
 
 Returns:
 
 CompletableFuture<Void> The return value
 - exportDocument
```
CompletableFuture<Void> exportDocument(String repoId,
 Integer entryId,
 String range,
 Consumer<InputStream> inputStreamConsumer)
```
 - Returns an entry's edoc resource in a stream format. - Provide an entry ID, and get the edoc resource as part of the response content. - Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested document ID.
 
 range - An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.
 
 inputStreamConsumer - A Consumer<InputStream> object that the is provided with the response's inputStream to consume it, if the request has been successful.
 
 Returns:
 
 CompletableFuture<Void> The return value
 - deleteDocument
```
CompletableFuture<ODataValueOfBoolean> deleteDocument(String repoId,
 Integer entryId)
```
 - Delete the edoc associated with the provided entry ID.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested document ID.
 
 Returns:
 
 CompletableFuture<ODataValueOfBoolean> The return value
 - getDocumentContentType
```
CompletableFuture<Map<String,String>> getDocumentContentType(String repoId,
 Integer entryId)
```
 - Returns information about the edoc content of an entry, without downloading the edoc in its entirety. - Provide an entry ID, and get back the Content-Type and Content-Length in the response headers. - This route does not provide a way to download the actual edoc. Instead, it just gives metadata information about the edoc associated with the entry.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested document ID.
 
 Returns:
 
 CompletableFuture<Map<String,String>> The return value
 - deletePages
```
CompletableFuture<ODataValueOfBoolean> deletePages(String repoId,
 Integer entryId,
 String pageRange)
```
 - Delete the pages associated with the provided entry ID. If no pageRange is specified, all pages will be deleted. - Optional parameter: pageRange (default empty). The value should be a comma-seperated string which contains non-overlapping single values, or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12."
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested document ID.
 
 pageRange - The pages to be deleted.
 
 Returns:
 
 CompletableFuture<ODataValueOfBoolean> The return value
 - getEntryListing
```
CompletableFuture<ODataValueContextOfIListOfEntry> getEntryListing(String repoId,
 Integer entryId,
 Boolean groupByEntryType,
 String[] fields,
 Boolean formatFields,
 String prefer,
 String culture,
 String select,
 String orderby,
 Integer top,
 Integer skip,
 Boolean count)
```
 - Returns the children entries of a folder in the repository. - Provide an entry ID (must be a folder), and get a paged listing of entries in that folder. Used as a way of navigating through the repository. - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". Sort order can be either value "asc" or "desc". Optional query parameters: groupByOrderType (bool). This query parameter decides if results are returned in groups based on their entry type. Entries returned in the listing are not automatically converted to their subtype (Folder, Shortcut, Document), so clients who want model-specific information should request it via the GET entry by ID route. - Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. - If field values are requested, only the first value is returned if it is a multi value field. - Null or Empty field values should not be used to determine if a field is assigned to the entry.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The folder ID.
 
 groupByEntryType - An optional query parameter used to indicate if the result should be grouped by entry type or not.
 
 fields - Optional array of field names. Field values corresponding to the given field names will be returned for each entry.
 
 formatFields - Boolean for if field values should be formatted. Only applicable if Fields are specified.
 
 prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
 
 culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting.
 
 select - Limits the properties returned in the result.
 
 orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.
 
 top - Limits the number of items returned from a collection.
 
 skip - Excludes the specified number of items of the queried collection from the result.
 
 count - Indicates whether the total count of items within a collection are returned in the result.
 
 Returns:
 
 CompletableFuture<ODataValueContextOfIListOfEntry> The return value
 - getEntryListingNextLink
```
CompletableFuture<ODataValueContextOfIListOfEntry> getEntryListingNextLink(String nextLink,
 Integer maxPageSize)
```
 Returns the next subset of the requested collection, using a nextlink url.
 
 Parameters:
 
 nextLink - A url that allows retrieving the next subset of the requested collection.
 
 maxPageSize - Optionally specify the maximum number of items to retrieve.
 
 Returns:
 
 CompletableFuture<ODataValueContextOfIListOfEntry> The return value
 - getEntryListingForEach
```
CompletableFuture<Void> getEntryListingForEach(Function<CompletableFuture<ODataValueContextOfIListOfEntry>,CompletableFuture<Boolean>> callback,
 Integer maxPageSize,
 String repoId,
 Integer entryId,
 Boolean groupByEntryType,
 String[] fields,
 Boolean formatFields,
 String prefer,
 String culture,
 String select,
 String orderby,
 Integer top,
 Integer skip,
 Boolean count)
```
 Provides the functionality to iteratively (i.e. through paging) call getEntryListing, and apply a function on the response of each iteration.
 
 Parameters:
 
 callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.
 
 maxPageSize - Optionally specify the maximum number of items to retrieve.
 
 repoId - The requested repository ID.
 
 entryId - The folder ID.
 
 groupByEntryType - An optional query parameter used to indicate if the result should be grouped by entry type or not.
 
 fields - Optional array of field names. Field values corresponding to the given field names will be returned for each entry.
 
 formatFields - Boolean for if field values should be formatted. Only applicable if Fields are specified.
 
 prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
 
 culture - An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting.
 
 select - Limits the properties returned in the result.
 
 orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.
 
 top - Limits the number of items returned from a collection.
 
 skip - Excludes the specified number of items of the queried collection from the result.
 
 count - Indicates whether the total count of items within a collection are returned in the result.
 
 Returns:
 
 CompletableFuture<Void> The return value
 - createOrCopyEntry
```
CompletableFuture<Entry> createOrCopyEntry(String repoId,
 Integer entryId,
 PostEntryChildrenRequest requestBody,
 Boolean autoRename,
 String culture)
```
 - Create/copy a new child entry in the designated folder. - Provide the parent folder ID, and based on the request body, copy or create a folder/shortcut as a child entry of the designated folder. - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The folder ID that the entry will be created in.
 
 requestBody - The entry to create.
 
 autoRename - An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false.
 
 culture - An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
 
 Returns:
 
 CompletableFuture<Entry> The return value
 - getTagsAssignedToEntry
```
CompletableFuture<ODataValueContextOfIListOfWTagInfo> getTagsAssignedToEntry(String repoId,
 Integer entryId,
 String prefer,
 String select,
 String orderby,
 Integer top,
 Integer skip,
 Boolean count)
```
 - Returns the tags assigned to an entry. - Provide an entry ID, and get a paged listing of tags assigned to that entry. - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested entry ID.
 
 prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
 
 select - Limits the properties returned in the result.
 
 orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.
 
 top - Limits the number of items returned from a collection.
 
 skip - Excludes the specified number of items of the queried collection from the result.
 
 count - Indicates whether the total count of items within a collection are returned in the result.
 
 Returns:
 
 CompletableFuture<ODataValueContextOfIListOfWTagInfo> The return value
 - getTagsAssignedToEntryNextLink
```
CompletableFuture<ODataValueContextOfIListOfWTagInfo> getTagsAssignedToEntryNextLink(String nextLink,
 Integer maxPageSize)
```
 Returns the next subset of the requested collection, using a nextlink url.
 
 Parameters:
 
 nextLink - A url that allows retrieving the next subset of the requested collection.
 
 maxPageSize - Optionally specify the maximum number of items to retrieve.
 
 Returns:
 
 CompletableFuture<ODataValueContextOfIListOfWTagInfo> The return value
 - getTagsAssignedToEntryForEach
```
CompletableFuture<Void> getTagsAssignedToEntryForEach(Function<CompletableFuture<ODataValueContextOfIListOfWTagInfo>,CompletableFuture<Boolean>> callback,
 Integer maxPageSize,
 String repoId,
 Integer entryId,
 String prefer,
 String select,
 String orderby,
 Integer top,
 Integer skip,
 Boolean count)
```
 Provides the functionality to iteratively (i.e. through paging) call getTagsAssignedToEntry, and apply a function on the response of each iteration.
 
 Parameters:
 
 callback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.
 
 maxPageSize - Optionally specify the maximum number of items to retrieve.
 
 repoId - The requested repository ID.
 
 entryId - The requested entry ID.
 
 prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
 
 select - Limits the properties returned in the result.
 
 orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.
 
 top - Limits the number of items returned from a collection.
 
 skip - Excludes the specified number of items of the queried collection from the result.
 
 count - Indicates whether the total count of items within a collection are returned in the result.
 
 Returns:
 
 CompletableFuture<Void> The return value
 - assignTags
```
CompletableFuture<ODataValueOfIListOfWTagInfo> assignTags(String repoId,
 Integer entryId,
 PutTagRequest requestBody)
```
 - Assign tags to an entry. - Provide an entry ID and a list of tags to assign to that entry. - This is an overwrite action. The request must include all tags to assign to the entry, including existing tags that should remain assigned to the entry.
 
 Parameters:
 
 repoId - The requested repository ID.
 
 entryId - The requested entry ID.
 
 requestBody - The tags to add.
 
 Returns:
 
 CompletableFuture<ODataValueOfIListOfWTagInfo> The return value

Interface EntriesClient

Method Summary

Method Detail

getFieldValues

getFieldValuesNextLink

getFieldValuesForEach

assignFieldValues

importDocument

getLinkValuesFromEntry

getLinkValuesFromEntryNextLink

getLinkValuesFromEntryForEach

assignEntryLinks

writeTemplateValueToEntry

deleteAssignedTemplate

getDynamicFieldValues

getEntryByPath

copyEntryAsync

getEntry

moveOrRenameEntry

deleteEntryInfo

exportDocumentWithAuditReason

exportDocument

deleteDocument

getDocumentContentType

deletePages

getEntryListing

getEntryListingNextLink

getEntryListingForEach

createOrCopyEntry

getTagsAssignedToEntry

getTagsAssignedToEntryNextLink

getTagsAssignedToEntryForEach

assignTags