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 |
|---|---|
ODataValueOfIListOfWEntryLinkInfo |
assignEntryLinks(ParametersForAssignEntryLinks 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. |
ODataValueOfIListOfFieldValue |
assignFieldValues(ParametersForAssignFieldValues 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. |
ODataValueOfIListOfWTagInfo |
assignTags(ParametersForAssignTags 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. |
AcceptedOperation |
copyEntryAsync(ParametersForCopyEntryAsync parameters)
- 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). |
Entry |
createOrCopyEntry(ParametersForCreateOrCopyEntry parameters)
- 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). |
Entry |
deleteAssignedTemplate(ParametersForDeleteAssignedTemplate 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. |
ODataValueOfBoolean |
deleteDocument(ParametersForDeleteDocument parameters)
- Delete the edoc associated with the provided entry ID.
|
AcceptedOperation |
deleteEntryInfo(ParametersForDeleteEntryInfo parameters)
- 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). |
ODataValueOfBoolean |
deletePages(ParametersForDeletePages parameters)
- Delete the pages associated with the provided entry ID.
|
void |
exportDocument(ParametersForExportDocument parameters)
- 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. |
InputStream |
exportDocumentAsStream(ParametersForExportDocument parameters)
Returns the input stream of an entry's edoc resource.
|
void |
exportDocumentWithAuditReason(ParametersForExportDocumentWithAuditReason parameters)
- 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. |
InputStream |
exportDocumentWithAuditReasonAsStream(ParametersForExportDocumentWithAuditReason parameters)
Returns the input stream of an entry's edoc resource while including an audit reason.
|
Map<String,String> |
getDocumentContentType(ParametersForGetDocumentContentType parameters)
- 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. |
Map<String,String[]> |
getDynamicFieldValues(ParametersForGetDynamicFieldValues 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. |
Entry |
getEntry(ParametersForGetEntry parameters)
- Returns a single entry object.
- Provide an entry ID, and get the entry associated with that ID. |
FindEntryResult |
getEntryByPath(ParametersForGetEntryByPath parameters)
- Returns a single entry object using the entry path.
- Optional query parameter: fallbackToClosestAncestor. |
ODataValueContextOfIListOfEntry |
getEntryListing(ParametersForGetEntryListing 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 |
getEntryListingForEach(Function<ODataValueContextOfIListOfEntry,Boolean> callback,
Integer maxPageSize,
ParametersForGetEntryListing parameters)
Provides the functionality to iteratively (i.e.
|
ODataValueContextOfIListOfEntry |
getEntryListingNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
ODataValueContextOfIListOfFieldValue |
getFieldValues(ParametersForGetFieldValues 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 |
getFieldValuesForEach(Function<ODataValueContextOfIListOfFieldValue,Boolean> callback,
Integer maxPageSize,
ParametersForGetFieldValues parameters)
Provides the functionality to iteratively (i.e.
|
ODataValueContextOfIListOfFieldValue |
getFieldValuesNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
ODataValueContextOfIListOfWEntryLinkInfo |
getLinkValuesFromEntry(ParametersForGetLinkValuesFromEntry 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 |
getLinkValuesFromEntryForEach(Function<ODataValueContextOfIListOfWEntryLinkInfo,Boolean> callback,
Integer maxPageSize,
ParametersForGetLinkValuesFromEntry parameters)
Provides the functionality to iteratively (i.e.
|
ODataValueContextOfIListOfWEntryLinkInfo |
getLinkValuesFromEntryNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
ODataValueContextOfIListOfWTagInfo |
getTagsAssignedToEntry(ParametersForGetTagsAssignedToEntry 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 |
getTagsAssignedToEntryForEach(Function<ODataValueContextOfIListOfWTagInfo,Boolean> callback,
Integer maxPageSize,
ParametersForGetTagsAssignedToEntry parameters)
Provides the functionality to iteratively (i.e.
|
ODataValueContextOfIListOfWTagInfo |
getTagsAssignedToEntryNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
CreateEntryResult |
importDocument(ParametersForImportDocument parameters)
- 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). |
Entry |
moveOrRenameEntry(ParametersForMoveOrRenameEntry parameters)
- 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). |
Entry |
writeTemplateValueToEntry(ParametersForWriteTemplateValueToEntry 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. |
public EntriesClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient, com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)
public ODataValueContextOfIListOfFieldValue getFieldValues(ParametersForGetFieldValues parameters)
EntriesClientgetFieldValues in interface EntriesClientparameters - An object of type ParametersForGetFieldValues which encapsulates the parameters of getFieldValues method.ODataValueContextOfIListOfFieldValue The return valuepublic ODataValueContextOfIListOfFieldValue getFieldValuesNextLink(String nextLink, int maxPageSize)
EntriesClientgetFieldValuesNextLink 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.ODataValueContextOfIListOfFieldValue The return valuepublic void getFieldValuesForEach(Function<ODataValueContextOfIListOfFieldValue,Boolean> callback, Integer maxPageSize, ParametersForGetFieldValues parameters)
EntriesClientgetFieldValues, and apply a function on the response of each iteration.getFieldValuesForEach 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 ParametersForGetFieldValues which encapsulates the parameters of getFieldValues method.public ODataValueOfIListOfFieldValue assignFieldValues(ParametersForAssignFieldValues parameters)
EntriesClientassignFieldValues in interface EntriesClientparameters - An object of type ParametersForAssignFieldValues which encapsulates the parameters of assignFieldValues method.ODataValueOfIListOfFieldValue The return valuepublic CreateEntryResult importDocument(ParametersForImportDocument parameters)
EntriesClientimportDocument in interface EntriesClientparameters - An object of type ParametersForImportDocument which encapsulates the parameters of importDocument method.CreateEntryResult The return valuepublic ODataValueContextOfIListOfWEntryLinkInfo getLinkValuesFromEntry(ParametersForGetLinkValuesFromEntry parameters)
EntriesClientgetLinkValuesFromEntry in interface EntriesClientparameters - An object of type ParametersForGetLinkValuesFromEntry which encapsulates the parameters of getLinkValuesFromEntry method.ODataValueContextOfIListOfWEntryLinkInfo The return valuepublic ODataValueContextOfIListOfWEntryLinkInfo getLinkValuesFromEntryNextLink(String nextLink, int maxPageSize)
EntriesClientgetLinkValuesFromEntryNextLink 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.ODataValueContextOfIListOfWEntryLinkInfo The return valuepublic void getLinkValuesFromEntryForEach(Function<ODataValueContextOfIListOfWEntryLinkInfo,Boolean> callback, Integer maxPageSize, ParametersForGetLinkValuesFromEntry parameters)
EntriesClientgetLinkValuesFromEntry, and apply a function on the response of each iteration.getLinkValuesFromEntryForEach 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 ParametersForGetLinkValuesFromEntry which encapsulates the parameters of getLinkValuesFromEntry method.public ODataValueOfIListOfWEntryLinkInfo assignEntryLinks(ParametersForAssignEntryLinks parameters)
EntriesClientassignEntryLinks in interface EntriesClientparameters - An object of type ParametersForAssignEntryLinks which encapsulates the parameters of assignEntryLinks method.ODataValueOfIListOfWEntryLinkInfo The return valuepublic Entry writeTemplateValueToEntry(ParametersForWriteTemplateValueToEntry parameters)
EntriesClientwriteTemplateValueToEntry in interface EntriesClientparameters - An object of type ParametersForWriteTemplateValueToEntry which encapsulates the parameters of writeTemplateValueToEntry method.Entry The return valuepublic Entry deleteAssignedTemplate(ParametersForDeleteAssignedTemplate parameters)
EntriesClientdeleteAssignedTemplate in interface EntriesClientparameters - An object of type ParametersForDeleteAssignedTemplate which encapsulates the parameters of deleteAssignedTemplate method.Entry The return valuepublic Map<String,String[]> getDynamicFieldValues(ParametersForGetDynamicFieldValues parameters)
EntriesClientgetDynamicFieldValues in interface EntriesClientparameters - An object of type ParametersForGetDynamicFieldValues which encapsulates the parameters of getDynamicFieldValues method.public FindEntryResult getEntryByPath(ParametersForGetEntryByPath parameters)
EntriesClientgetEntryByPath in interface EntriesClientparameters - An object of type ParametersForGetEntryByPath which encapsulates the parameters of getEntryByPath method.FindEntryResult The return valuepublic AcceptedOperation copyEntryAsync(ParametersForCopyEntryAsync parameters)
EntriesClientcopyEntryAsync in interface EntriesClientparameters - An object of type ParametersForCopyEntryAsync which encapsulates the parameters of copyEntryAsync method.AcceptedOperation 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 moveOrRenameEntry(ParametersForMoveOrRenameEntry parameters)
EntriesClientmoveOrRenameEntry in interface EntriesClientparameters - An object of type ParametersForMoveOrRenameEntry which encapsulates the parameters of moveOrRenameEntry method.Entry The return valuepublic AcceptedOperation deleteEntryInfo(ParametersForDeleteEntryInfo parameters)
EntriesClientdeleteEntryInfo in interface EntriesClientparameters - An object of type ParametersForDeleteEntryInfo which encapsulates the parameters of deleteEntryInfo method.AcceptedOperation The return valuepublic void exportDocumentWithAuditReason(ParametersForExportDocumentWithAuditReason parameters)
EntriesClientexportDocumentWithAuditReason in interface EntriesClientparameters - An object of type ParametersForExportDocumentWithAuditReason which encapsulates the parameters of exportDocumentWithAuditReason method.public InputStream exportDocumentWithAuditReasonAsStream(ParametersForExportDocumentWithAuditReason parameters)
EntriesClientexportDocumentWithAuditReasonAsStream in interface EntriesClientparameters - An object of type ParametersForExportDocumentWithAuditReason which encapsulates the parameters of exportDocumentWithAuditReason method.InputStream The return valuepublic void exportDocument(ParametersForExportDocument parameters)
EntriesClientexportDocument in interface EntriesClientparameters - An object of type ParametersForExportDocument which encapsulates the parameters of exportDocument method.public InputStream exportDocumentAsStream(ParametersForExportDocument parameters)
EntriesClientexportDocumentAsStream in interface EntriesClientparameters - An object of type ParametersForExportDocument which encapsulates the parameters of exportDocument method.InputStream The return valuepublic ODataValueOfBoolean deleteDocument(ParametersForDeleteDocument parameters)
EntriesClientdeleteDocument in interface EntriesClientparameters - An object of type ParametersForDeleteDocument which encapsulates the parameters of deleteDocument method.ODataValueOfBoolean The return valuepublic Map<String,String> getDocumentContentType(ParametersForGetDocumentContentType parameters)
EntriesClientgetDocumentContentType in interface EntriesClientparameters - An object of type ParametersForGetDocumentContentType which encapsulates the parameters of getDocumentContentType method.public ODataValueOfBoolean deletePages(ParametersForDeletePages parameters)
EntriesClientdeletePages in interface EntriesClientparameters - An object of type ParametersForDeletePages which encapsulates the parameters of deletePages method.ODataValueOfBoolean The return valuepublic ODataValueContextOfIListOfEntry getEntryListing(ParametersForGetEntryListing parameters)
EntriesClientgetEntryListing in interface EntriesClientparameters - An object of type ParametersForGetEntryListing which encapsulates the parameters of getEntryListing method.ODataValueContextOfIListOfEntry The return valuepublic ODataValueContextOfIListOfEntry getEntryListingNextLink(String nextLink, int maxPageSize)
EntriesClientgetEntryListingNextLink 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.ODataValueContextOfIListOfEntry The return valuepublic void getEntryListingForEach(Function<ODataValueContextOfIListOfEntry,Boolean> callback, Integer maxPageSize, ParametersForGetEntryListing parameters)
EntriesClientgetEntryListing, and apply a function on the response of each iteration.getEntryListingForEach 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 ParametersForGetEntryListing which encapsulates the parameters of getEntryListing method.public Entry createOrCopyEntry(ParametersForCreateOrCopyEntry parameters)
EntriesClientcreateOrCopyEntry in interface EntriesClientparameters - An object of type ParametersForCreateOrCopyEntry which encapsulates the parameters of createOrCopyEntry method.Entry The return valuepublic ODataValueContextOfIListOfWTagInfo getTagsAssignedToEntry(ParametersForGetTagsAssignedToEntry parameters)
EntriesClientgetTagsAssignedToEntry in interface EntriesClientparameters - An object of type ParametersForGetTagsAssignedToEntry which encapsulates the parameters of getTagsAssignedToEntry method.ODataValueContextOfIListOfWTagInfo The return valuepublic ODataValueContextOfIListOfWTagInfo getTagsAssignedToEntryNextLink(String nextLink, int maxPageSize)
EntriesClientgetTagsAssignedToEntryNextLink 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.ODataValueContextOfIListOfWTagInfo The return valuepublic void getTagsAssignedToEntryForEach(Function<ODataValueContextOfIListOfWTagInfo,Boolean> callback, Integer maxPageSize, ParametersForGetTagsAssignedToEntry parameters)
EntriesClientgetTagsAssignedToEntry, and apply a function on the response of each iteration.getTagsAssignedToEntryForEach 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 ParametersForGetTagsAssignedToEntry which encapsulates the parameters of getTagsAssignedToEntry method.public ODataValueOfIListOfWTagInfo assignTags(ParametersForAssignTags parameters)
EntriesClientassignTags in interface EntriesClientparameters - An object of type ParametersForAssignTags which encapsulates the parameters of assignTags method.ODataValueOfIListOfWTagInfo The return valueCopyright © 2025. All rights reserved.