public class EntriesClientImpl extends ApiClient implements EntriesClient
baseUrl, httpClient, httpRequestHandler, objectMapper| Constructor and Description |
|---|
EntriesClientImpl(String baseUrl,
kong.unirest.UnirestInstance httpClient,
com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler) |
| Modifier and Type | Method and Description |
|---|---|
Entry |
copyEntry(ParametersForCopyEntry parameters)
- Copy a new child entry in the designated folder.
- Provide the parent folder ID, and based on the request body, copy a child entry of the designated folder. - Required OAuth scope: repository.Write |
Entry |
createEntry(ParametersForCreateEntry parameters)
- Create a new child entry in the designated folder.
- Provide the parent folder ID, and based on the request body, create a folder/shortcut as a child entry of the designated folder. - Required OAuth scope: repository.Write |
CreateMultipartUploadUrlsResponse |
createMultipartUploadUrls(ParametersForCreateMultipartUploadUrls parameters)
- Requests Upload URLs to upload a large file in chunks.
- Returns an UploadId and an array of URLs to which the file chunks should be written in the same order. - To request a new batch of Upload URLs for the same file, set the value of UploadId to the one returned when the first batch of Upload URLs was requested. |
Entry |
deleteElectronicDocument(ParametersForDeleteElectronicDocument parameters)
- Delete the edoc associated with the provided entry ID.
- Required OAuth scope: repository.Write |
Entry |
deletePages(ParametersForDeletePages parameters)
- Delete the pages associated with the provided entry ID.
|
ExportEntryResponse |
exportEntry(ParametersForExportEntry parameters)
- Export an entry.
- The export may time out if it takes longer than 60 seconds. |
Entry |
getEntry(ParametersForGetEntry parameters)
- Returns a single entry object.
- Provide an entry ID, and get the entry associated with that ID. |
GetEntryByPathResponse |
getEntryByPath(ParametersForGetEntryByPath parameters)
- Returns a single entry object using the entry path.
- Optional query parameter: fallbackToClosestAncestor. |
Entry |
importEntry(ParametersForImportEntry parameters)
- Import a new document in the specified folder, and optionally assigns metadata.
- The import may fail if the file is greater than 100 MB or time out if it takes longer than 60 seconds. |
Map<String,String[]> |
listDynamicFieldValues(ParametersForListDynamicFieldValues parameters)
- 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. - Required OAuth scope: repository.Read |
EntryCollectionResponse |
listEntries(ParametersForListEntries parameters)
- 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. |
void |
listEntriesForEach(Function<EntryCollectionResponse,Boolean> callback,
Integer maxPageSize,
ParametersForListEntries parameters)
Provides the functionality to iteratively (i.e.
|
EntryCollectionResponse |
listEntriesNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
FieldCollectionResponse |
listFields(ParametersForListFields parameters)
- 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. |
void |
listFieldsForEach(Function<FieldCollectionResponse,Boolean> callback,
Integer maxPageSize,
ParametersForListFields parameters)
Provides the functionality to iteratively (i.e.
|
FieldCollectionResponse |
listFieldsNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
LinkCollectionResponse |
listLinks(ParametersForListLinks parameters)
- 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. |
void |
listLinksForEach(Function<LinkCollectionResponse,Boolean> callback,
Integer maxPageSize,
ParametersForListLinks parameters)
Provides the functionality to iteratively (i.e.
|
LinkCollectionResponse |
listLinksNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
TagCollectionResponse |
listTags(ParametersForListTags parameters)
- 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. |
void |
listTagsForEach(Function<TagCollectionResponse,Boolean> callback,
Integer maxPageSize,
ParametersForListTags parameters)
Provides the functionality to iteratively (i.e.
|
TagCollectionResponse |
listTagsNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
Entry |
removeTemplate(ParametersForRemoveTemplate parameters)
- 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. - Required OAuth scope: repository.Write |
FieldCollectionResponse |
setFields(ParametersForSetFields parameters)
- 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. |
LinkCollectionResponse |
setLinks(ParametersForSetLinks parameters)
- Assign links to an entry.
- Provide an entry ID and a list of links to assign to that entry. - This is an overwrite action. |
TagCollectionResponse |
setTags(ParametersForSetTags parameters)
- Assign tags to an entry.
- Provide an entry ID and a list of tags to assign to that entry. - This is an overwrite action. |
Entry |
setTemplate(ParametersForSetTemplate parameters)
- 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. |
StartTaskResponse |
startCopyEntry(ParametersForStartCopyEntry parameters)
- Copy a new child entry in the designated folder async, and potentially return a taskId.
- Provide the parent folder ID, and copy an entry as a child of the designated folder. - The status of the operation can be checked via the Tasks route. - Token substitution in the name of the copied entry is not supported. - Required OAuth scope: repository.Write |
StartTaskResponse |
startDeleteEntry(ParametersForStartDeleteEntry parameters)
- Begins a task to delete an entry, and returns a taskId.
- 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). |
StartTaskResponse |
startExportEntry(ParametersForStartExportEntry parameters)
- Starts an asynchronous export operation to export an entry.
- If successful, it returns a taskId which can be used to check the status of the export operation or download the export result, otherwise, it returns an error. - Required OAuth scope: repository.Read |
StartTaskResponse |
startImportUploadedParts(ParametersForStartImportUploadedParts parameters)
- Imports a new file in the specified folder.
|
Entry |
updateEntry(ParametersForUpdateEntry parameters)
- Update an entry.
|
public EntriesClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient, com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)
public StartTaskResponse startExportEntry(ParametersForStartExportEntry parameters)
EntriesClientstartExportEntry in interface EntriesClientparameters - An object of type ParametersForStartExportEntry which encapsulates the parameters of startExportEntry method.StartTaskResponse The return valuepublic FieldCollectionResponse listFields(ParametersForListFields parameters)
EntriesClientlistFields in interface EntriesClientparameters - An object of type ParametersForListFields which encapsulates the parameters of listFields method.FieldCollectionResponse The return valuepublic FieldCollectionResponse listFieldsNextLink(String nextLink, int maxPageSize)
EntriesClientlistFieldsNextLink in interface EntriesClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.FieldCollectionResponse The return valuepublic void listFieldsForEach(Function<FieldCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListFields parameters)
EntriesClientlistFields, and apply a function on the response of each iteration.listFieldsForEach in interface EntriesClientcallback - 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.parameters - An object of type ParametersForListFields which encapsulates the parameters of listFields method.public FieldCollectionResponse setFields(ParametersForSetFields parameters)
EntriesClientsetFields in interface EntriesClientparameters - An object of type ParametersForSetFields which encapsulates the parameters of setFields method.FieldCollectionResponse The return valuepublic Entry setTemplate(ParametersForSetTemplate parameters)
EntriesClientsetTemplate in interface EntriesClientparameters - An object of type ParametersForSetTemplate which encapsulates the parameters of setTemplate method.Entry The return valuepublic Entry removeTemplate(ParametersForRemoveTemplate parameters)
EntriesClientremoveTemplate in interface EntriesClientparameters - An object of type ParametersForRemoveTemplate which encapsulates the parameters of removeTemplate method.Entry The return valuepublic Entry getEntry(ParametersForGetEntry parameters)
EntriesClientgetEntry in interface EntriesClientparameters - An object of type ParametersForGetEntry which encapsulates the parameters of getEntry method.Entry The return valuepublic Entry updateEntry(ParametersForUpdateEntry parameters)
EntriesClientupdateEntry in interface EntriesClientparameters - An object of type ParametersForUpdateEntry which encapsulates the parameters of updateEntry method.Entry The return valuepublic StartTaskResponse startDeleteEntry(ParametersForStartDeleteEntry parameters)
EntriesClientstartDeleteEntry in interface EntriesClientparameters - An object of type ParametersForStartDeleteEntry which encapsulates the parameters of startDeleteEntry method.StartTaskResponse The return valuepublic CreateMultipartUploadUrlsResponse createMultipartUploadUrls(ParametersForCreateMultipartUploadUrls parameters)
EntriesClientcreateMultipartUploadUrls in interface EntriesClientparameters - An object of type ParametersForCreateMultipartUploadUrls which encapsulates the parameters of createMultipartUploadUrls method.CreateMultipartUploadUrlsResponse The return valuepublic Entry importEntry(ParametersForImportEntry parameters)
EntriesClientimportEntry in interface EntriesClientparameters - An object of type ParametersForImportEntry which encapsulates the parameters of importEntry method.Entry The return valuepublic GetEntryByPathResponse getEntryByPath(ParametersForGetEntryByPath parameters)
EntriesClientgetEntryByPath in interface EntriesClientparameters - An object of type ParametersForGetEntryByPath which encapsulates the parameters of getEntryByPath method.GetEntryByPathResponse The return valuepublic ExportEntryResponse exportEntry(ParametersForExportEntry parameters)
EntriesClientexportEntry in interface EntriesClientparameters - An object of type ParametersForExportEntry which encapsulates the parameters of exportEntry method.ExportEntryResponse The return valuepublic LinkCollectionResponse listLinks(ParametersForListLinks parameters)
EntriesClientlistLinks in interface EntriesClientparameters - An object of type ParametersForListLinks which encapsulates the parameters of listLinks method.LinkCollectionResponse The return valuepublic LinkCollectionResponse listLinksNextLink(String nextLink, int maxPageSize)
EntriesClientlistLinksNextLink in interface EntriesClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.LinkCollectionResponse The return valuepublic void listLinksForEach(Function<LinkCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListLinks parameters)
EntriesClientlistLinks, and apply a function on the response of each iteration.listLinksForEach in interface EntriesClientcallback - 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.parameters - An object of type ParametersForListLinks which encapsulates the parameters of listLinks method.public LinkCollectionResponse setLinks(ParametersForSetLinks parameters)
EntriesClientsetLinks in interface EntriesClientparameters - An object of type ParametersForSetLinks which encapsulates the parameters of setLinks method.LinkCollectionResponse The return valuepublic TagCollectionResponse listTags(ParametersForListTags parameters)
EntriesClientlistTags in interface EntriesClientparameters - An object of type ParametersForListTags which encapsulates the parameters of listTags method.TagCollectionResponse The return valuepublic TagCollectionResponse listTagsNextLink(String nextLink, int maxPageSize)
EntriesClientlistTagsNextLink in interface EntriesClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.TagCollectionResponse The return valuepublic void listTagsForEach(Function<TagCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListTags parameters)
EntriesClientlistTags, and apply a function on the response of each iteration.listTagsForEach in interface EntriesClientcallback - 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.parameters - An object of type ParametersForListTags which encapsulates the parameters of listTags method.public TagCollectionResponse setTags(ParametersForSetTags parameters)
EntriesClientsetTags in interface EntriesClientparameters - An object of type ParametersForSetTags which encapsulates the parameters of setTags method.TagCollectionResponse The return valuepublic StartTaskResponse startCopyEntry(ParametersForStartCopyEntry parameters)
EntriesClientstartCopyEntry in interface EntriesClientparameters - An object of type ParametersForStartCopyEntry which encapsulates the parameters of startCopyEntry method.StartTaskResponse The return valuepublic Entry deleteElectronicDocument(ParametersForDeleteElectronicDocument parameters)
EntriesClientdeleteElectronicDocument in interface EntriesClientparameters - An object of type ParametersForDeleteElectronicDocument which encapsulates the parameters of deleteElectronicDocument method.Entry The return valuepublic Entry deletePages(ParametersForDeletePages parameters)
EntriesClientdeletePages in interface EntriesClientparameters - An object of type ParametersForDeletePages which encapsulates the parameters of deletePages method.Entry The return valuepublic Map<String,String[]> listDynamicFieldValues(ParametersForListDynamicFieldValues parameters)
EntriesClientlistDynamicFieldValues in interface EntriesClientparameters - An object of type ParametersForListDynamicFieldValues which encapsulates the parameters of listDynamicFieldValues method.public StartTaskResponse startImportUploadedParts(ParametersForStartImportUploadedParts parameters)
EntriesClientstartImportUploadedParts in interface EntriesClientparameters - An object of type ParametersForStartImportUploadedParts which encapsulates the parameters of startImportUploadedParts method.StartTaskResponse The return valuepublic EntryCollectionResponse listEntries(ParametersForListEntries parameters)
EntriesClientlistEntries in interface EntriesClientparameters - An object of type ParametersForListEntries which encapsulates the parameters of listEntries method.EntryCollectionResponse The return valuepublic EntryCollectionResponse listEntriesNextLink(String nextLink, int maxPageSize)
EntriesClientlistEntriesNextLink in interface EntriesClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.EntryCollectionResponse The return valuepublic void listEntriesForEach(Function<EntryCollectionResponse,Boolean> callback, Integer maxPageSize, ParametersForListEntries parameters)
EntriesClientlistEntries, and apply a function on the response of each iteration.listEntriesForEach in interface EntriesClientcallback - 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.parameters - An object of type ParametersForListEntries which encapsulates the parameters of listEntries method.public Entry createEntry(ParametersForCreateEntry parameters)
EntriesClientcreateEntry in interface EntriesClientparameters - An object of type ParametersForCreateEntry which encapsulates the parameters of createEntry method.Entry The return valuepublic Entry copyEntry(ParametersForCopyEntry parameters)
EntriesClientcopyEntry in interface EntriesClientparameters - An object of type ParametersForCopyEntry which encapsulates the parameters of copyEntry method.Entry The return valueCopyright © 2025. All rights reserved.