Interface IEntriesClient

interface IEntriesClient {
    checkInDocument(
        args: {
            entryId: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.CheckInDocumentRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    checkOutDocument(
        args: {
            entryId: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.CheckOutDocumentRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    copyEntry(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.CopyEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    copyPages(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.CopyPagesRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    createEntry(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.CreateEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    createMultipartUploadUrls(
        args: {
            repositoryId: string;
            request: LfRepositoryClientV2.CreateMultipartUploadUrlsRequest;
        },
    ): Promise<LfRepositoryClientV2.CreateMultipartUploadUrlsResponse>;
    createPages(
        args: {
            entryId: number;
            generateText?: boolean;
            imageFiles?: LfRepositoryClientV2.FileParameter[];
            pageNumber?: null | number;
            repositoryId: string;
            request?: LfRepositoryClientV2.PagesContentRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    deleteElectronicDocument(
        args: { entryId: number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.Entry>;
    deletePages(
        args: {
            entryId: number;
            pageRange?: null | string;
            repositoryId: string;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    exportEntry(
        args: {
            entryId: number;
            pageRange?: null | string;
            repositoryId: string;
            request: LfRepositoryClientV2.ExportEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.ExportEntryResponse>;
    generateText(
        args: { entryId: number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.Entry>;
    getDocumentLockInfo(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.LockInfo>;
    getEntry(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.Entry>;
    getEntryByPath(
        args: {
            fallbackToClosestAncestor?: boolean;
            fullPath: string;
            repositoryId: string;
        },
    ): Promise<LfRepositoryClientV2.GetEntryByPathResponse>;
    getPageImage(
        args: {
            entryId: number;
            pageNumber: number;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.FileResponse>;
    getPageText(
        args: {
            entryId: number;
            pageNumber: number;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.PageTextResponse>;
    importEntry(
        args: {
            culture?: null | string;
            entryId: number;
            file?: LfRepositoryClientV2.FileParameter;
            imageFiles?: LfRepositoryClientV2.FileParameter[];
            repositoryId: string;
            request?: LfRepositoryClientV2.ImportEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    listDynamicFieldValues(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.ListDynamicFieldValuesRequest;
        },
    ): Promise<{ [key: string]: string[] }>;
    listEntries(
        args: {
            count?: boolean;
            culture?: null | string;
            entryId: number;
            fields?: null | string[];
            formatFieldValues?: boolean;
            groupByEntryType?: boolean;
            orderby?: null | string;
            prefer?: null | string;
            repositoryId: string;
            select?: null | string;
            skip?: number;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.EntryCollectionResponse>;
    listEntriesForEach(
        args: {
            callback: (
                response: LfRepositoryClientV2.EntryCollectionResponse,
            ) => Promise<boolean>;
            count?: boolean;
            culture?: string;
            entryId: number;
            fields?: string[];
            formatFieldValues?: boolean;
            groupByEntryType?: boolean;
            maxPageSize?: number;
            orderby?: string;
            prefer?: string;
            repositoryId: string;
            select?: string;
            skip?: number;
            top?: number;
        },
    ): Promise<void>;
    listEntriesNextLink(
        args: { maxPageSize?: number; nextLink: string },
    ): Promise<LfRepositoryClientV2.EntryCollectionResponse>;
    listFields(
        args: {
            count?: boolean;
            culture?: null | string;
            entryId: number;
            formatFieldValues?: boolean;
            orderby?: null | string;
            prefer?: null | string;
            repositoryId: string;
            select?: null | string;
            skip?: number;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.FieldCollectionResponse>;
    listFieldsForEach(
        args: {
            callback: (
                response: LfRepositoryClientV2.FieldCollectionResponse,
            ) => Promise<boolean>;
            count?: boolean;
            culture?: string;
            entryId: number;
            formatFieldValues?: boolean;
            maxPageSize?: number;
            orderby?: string;
            prefer?: string;
            repositoryId: string;
            select?: string;
            skip?: number;
            top?: number;
        },
    ): Promise<void>;
    listFieldsNextLink(
        args: { maxPageSize?: number; nextLink: string },
    ): Promise<LfRepositoryClientV2.FieldCollectionResponse>;
    listLinks(
        args: {
            count?: boolean;
            entryId: number;
            orderby?: null | string;
            prefer?: null | string;
            repositoryId: string;
            select?: null | string;
            skip?: number;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.LinkCollectionResponse>;
    listLinksForEach(
        args: {
            callback: (
                response: LfRepositoryClientV2.LinkCollectionResponse,
            ) => Promise<boolean>;
            count?: boolean;
            entryId: number;
            maxPageSize?: number;
            orderby?: string;
            prefer?: string;
            repositoryId: string;
            select?: string;
            skip?: number;
            top?: number;
        },
    ): Promise<void>;
    listLinksNextLink(
        args: { maxPageSize?: number; nextLink: string },
    ): Promise<LfRepositoryClientV2.LinkCollectionResponse>;
    listPageInfos(
        args: {
            count?: boolean;
            entryId: number;
            pageRange?: null | string;
            prefer?: null | string;
            repositoryId: string;
            select?: null | string;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.PageInfoCollectionResponse>;
    listTags(
        args: {
            count?: boolean;
            entryId: number;
            orderby?: null | string;
            prefer?: null | string;
            repositoryId: string;
            select?: null | string;
            skip?: number;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.TagCollectionResponse>;
    listTagsForEach(
        args: {
            callback: (
                response: LfRepositoryClientV2.TagDefinitionCollectionResponse,
            ) => Promise<boolean>;
            count?: boolean;
            entryId: number;
            maxPageSize?: number;
            orderby?: string;
            prefer?: string;
            repositoryId: string;
            select?: string;
            skip?: number;
            top?: number;
        },
    ): Promise<void>;
    listTagsNextLink(
        args: { maxPageSize?: number; nextLink: string },
    ): Promise<LfRepositoryClientV2.TagDefinitionCollectionResponse>;
    lockDocument(
        args: {
            entryId: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.LockDocumentRequest;
        },
    ): Promise<LfRepositoryClientV2.LockInfo>;
    movePages(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.MovePagesRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    putUnderVersionControl(
        args: { entryId: number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.Entry>;
    removeTemplate(
        args: { entryId: number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.Entry>;
    replacePages(
        args: {
            entryId: number;
            generateText?: boolean;
            imageFiles?: LfRepositoryClientV2.FileParameter[];
            repositoryId: string;
            request?: LfRepositoryClientV2.PagesContentRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    rotateImagePage(
        args: {
            entryId: number;
            pageNumber: number;
            repositoryId: string;
            request: LfRepositoryClientV2.RotateImagePageRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    setFields(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.SetFieldsRequest;
        },
    ): Promise<LfRepositoryClientV2.FieldCollectionResponse>;
    setLinks(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.SetLinksRequest;
        },
    ): Promise<LfRepositoryClientV2.LinkCollectionResponse>;
    setTags(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.SetTagsRequest;
        },
    ): Promise<LfRepositoryClientV2.TagCollectionResponse>;
    setTemplate(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.SetTemplateRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    startCopyEntry(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.StartCopyEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.StartTaskResponse>;
    startDeleteEntry(
        args: {
            entryId: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.StartDeleteEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.StartTaskResponse>;
    startExportEntry(
        args: {
            entryId: number;
            pageRange?: null | string;
            repositoryId: string;
            request: LfRepositoryClientV2.StartExportEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.StartTaskResponse>;
    startImportUploadedParts(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.StartImportUploadedPartsRequest;
        },
    ): Promise<LfRepositoryClientV2.StartTaskResponse>;
    undoCheckOut(
        args: { entryId: number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.Entry>;
    unlockDocument(
        args: {
            entryId: number;
            lockToken?: null | string;
            repositoryId: string;
        },
    ): Promise<void>;
    updateDocument(
        args: {
            culture?: null | string;
            entryId: number;
            file?: LfRepositoryClientV2.FileParameter;
            imageFiles?: LfRepositoryClientV2.FileParameter[];
            repositoryId: string;
            request?: LfRepositoryClientV2.UpdateDocumentRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    updateDocumentUploadedParts(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.UpdateDocumentUploadedPartsRequest;
        },
    ): Promise<LfRepositoryClientV2.StartTaskResponse>;
    updateEntry(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.UpdateEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    writePage(
        args: {
            entryId: number;
            generateText?: boolean;
            imageFile?: LfRepositoryClientV2.FileParameter;
            pageNumber: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.WritePageTextRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
}

Implemented by

Methods

checkInDocument checkOutDocument copyEntry copyPages createEntry createMultipartUploadUrls createPages deleteElectronicDocument deletePages exportEntry generateText getDocumentLockInfo getEntry getEntryByPath getPageImage getPageText importEntry listDynamicFieldValues listEntries listEntriesForEach listEntriesNextLink listFields listFieldsForEach listFieldsNextLink listLinks listLinksForEach listLinksNextLink listPageInfos listTags listTagsForEach listTagsNextLink lockDocument movePages putUnderVersionControl removeTemplate replacePages rotateImagePage setFields setLinks setTags setTemplate startCopyEntry startDeleteEntry startExportEntry startImportUploadedParts undoCheckOut unlockDocument updateDocument updateDocumentUploadedParts updateEntry writePage

Methods

checkInDocument

  • checkInDocument(
        args: {
            entryId: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.CheckInDocumentRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • Checks in the specified document, creating a new version in the version history.
    • By default, releases the persistent lock if one is held. Set unlock to false to keep the lock.
    • Returns an error if the document is not currently checked out.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully checked in the document. If a persistent lock was held and unlock was not set to false, the lock has been released.

checkOutDocument

  • checkOutDocument(
        args: {
            entryId: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.CheckOutDocumentRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • Checks out the specified document for editing. The document must be under version control.
    • By default, a persistent lock is automatically acquired (lock=true). Set lock=false to check out without locking.
    • Optionally specify a comment for the check-out.
    • Returns an error if the document is not under version control.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully checked out the document.

copyEntry

  • copyEntry(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.CopyEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • 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

    Parameters

    • args: {
          culture?: null | string;
          entryId: number;
          repositoryId: string;
          request: LfRepositoryClientV2.CopyEntryRequest;
      }
      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.

      • entryId: number

        The folder ID that the entry will be created in.

      • repositoryId: string

        The requested repository ID.

      • request: LfRepositoryClientV2.CopyEntryRequest

        The request body.

    Returns Promise<LfRepositoryClientV2.Entry>

    Entry was copied successfully. Returned copied entry.

copyPages

  • copyPages(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.CopyPagesRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • Copies the specified pages from the source document to the destination document.
    • The source document retains its pages; copies are inserted into the destination.
    • pageRange: A comma-separated string of non-overlapping single values or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12." The total number of distinct pages cannot exceed 500.
    • destinationEntryId: The entry ID of the destination document.
    • destinationPageNumber: The 1-based page number in the destination document where pages will be inserted before.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully copied pages from the source document to the destination document. The source document retains its pages. Returned the updated source entry.

createEntry

  • createEntry(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.CreateEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • 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

    Parameters

    • args: {
          culture?: null | string;
          entryId: number;
          repositoryId: string;
          request: LfRepositoryClientV2.CreateEntryRequest;
      }
      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.

      • entryId: number

        The folder ID that the entry will be created in.

      • repositoryId: string

        The requested repository ID.

      • request: LfRepositoryClientV2.CreateEntryRequest

        The request body.

    Returns Promise<LfRepositoryClientV2.Entry>

    Document was created successfully. Returns created entry.

createMultipartUploadUrls

  • createMultipartUploadUrls(
        args: {
            repositoryId: string;
            request: LfRepositoryClientV2.CreateMultipartUploadUrlsRequest;
        },
    ): Promise<LfRepositoryClientV2.CreateMultipartUploadUrlsResponse>
    • 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. For requesting the first batch of Upload URLs, leave UploadId empty or null.
    • Example: if a file is going to be uploaded in 10 chunks, the 10 Upload URLs can be retrieved by two successive calls to this api, each call requesting 5 Upload URLs. For this, the first call should have StartingPartNumber=1 and NumberOfParts=5, and the second call should have StartingPartNumber=6 and NumberOfParts=5, along with UploadId returned in the first call.
    • Each Upload URL expires after 15 minutes.
    • Each file chunk written to an Upload URL should be at least 5 MB and at most 5 GB. There is no minimum size limit for the last chunk.
    • The value of NumberOfParts must be in the range [1, 100], meaning that in each call to this api, a maximum of 100 Upload URLs can be requested.
    • The total number of Upload URLs for a single file is 1000, which means (StartingPartNumber + NumberOfParts) should be less than or equal to 1001.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.CreateMultipartUploadUrlsResponse>

    Returned response containing an upload ID and an array of upload URLs.

createPages

  • createPages(
        args: {
            entryId: number;
            generateText?: boolean;
            imageFiles?: LfRepositoryClientV2.FileParameter[];
            pageNumber?: null | number;
            repositoryId: string;
            request?: LfRepositoryClientV2.PagesContentRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • Creates one or more new pages in the specified document.
    • Optional imageFiles form field: up to 10 image files, 100 MB aggregate.
    • Optional textPages array in the request JSON part. Aggregate size must be below 100 MB.
    • The two arrays are paired by index: page[i] gets imageFiles[i] and textPages[i].
    • The number of pages created is max(imageFiles.Count, textPages.Count). If one array is shorter, pages beyond its length are created without that part.
    • If neither imageFiles nor textPages is provided, one empty page is created.
    • If pageNumber is omitted, pages are appended to the end. If provided, pages are inserted at that 1-based position; existing pages shift down.
    • generateText triggers OCR when imageFiles are provided. When generateText is true and imageFiles are present, textPages is ignored because OCR-generated text would overwrite any provided text.
    • Required OAuth scope: repository.Write

    Parameters

    • args: {
          entryId: number;
          generateText?: boolean;
          imageFiles?: LfRepositoryClientV2.FileParameter[];
          pageNumber?: null | number;
          repositoryId: string;
          request?: LfRepositoryClientV2.PagesContentRequest;
      }
      • entryId: number

        The requested document ID.

      • OptionalgenerateText?: boolean

        (optional) If true, triggers server-side text generation (OCR) for image pages. Default is false.

      • OptionalimageFiles?: LfRepositoryClientV2.FileParameter[]

        (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).

      • OptionalpageNumber?: null | number

        (optional) Optional 1-based page number. If omitted, pages are appended to the end. If provided, pages are inserted at that position.

      • repositoryId: string

        The requested repository ID.

      • Optionalrequest?: LfRepositoryClientV2.PagesContentRequest

        (optional)

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully created pages in the specified document. Returned the updated entry.

deleteElectronicDocument

  • deleteElectronicDocument(
        args: { entryId: number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.Entry>
    • Delete the edoc associated with the provided entry ID.
    • Required OAuth scope: repository.Write

    Parameters

    • args: { entryId: number; repositoryId: string }
      • entryId: number

        The requested document ID.

      • repositoryId: string

        The requested repository ID.

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully deleted edoc associated with the specified entry. Returned the updated entry.

deletePages

  • deletePages(
        args: {
            entryId: number;
            pageRange?: null | string;
            repositoryId: string;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • 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-separated string which contains non-overlapping single values, or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12."
    • Required OAuth scope: repository.Write

    Parameters

    • args: { entryId: number; pageRange?: null | string; repositoryId: string }
      • entryId: number

        The requested document ID.

      • OptionalpageRange?: null | string

        (optional) The pages to be deleted.

      • repositoryId: string

        The requested repository ID.

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully deleted pages associated with the specified entry. Returned the updated entry.

exportEntry

  • exportEntry(
        args: {
            entryId: number;
            pageRange?: null | string;
            repositoryId: string;
            request: LfRepositoryClientV2.ExportEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.ExportEntryResponse>
    • Export an entry.
    • The export may time out if it takes longer than 60 seconds. This value is subject to change at anytime. Use the long operation asynchronous export if you run into this restriction.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          entryId: number;
          pageRange?: null | string;
          repositoryId: string;
          request: LfRepositoryClientV2.ExportEntryRequest;
      }
      • entryId: number

        The ID of entry to export.

      • OptionalpageRange?: null | string

        (optional) A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc.

      • repositoryId: string

        The requested repository ID.

      • request: LfRepositoryClientV2.ExportEntryRequest

        The request body.

    Returns Promise<LfRepositoryClientV2.ExportEntryResponse>

    Export was successful. Returned a link to download the exported entry.

generateText

  • generateText(
        args: { entryId: number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.Entry>
    • Triggers server-side text generation for the specified document.
    • For documents with image pages, this performs OCR to generate searchable text.
    • For documents with an electronic document part (e.g., PDF), this extracts embedded text.
    • Required OAuth scope: repository.Write

    Parameters

    • args: { entryId: number; repositoryId: string }
      • entryId: number

        The requested document ID.

      • repositoryId: string

        The requested repository ID.

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully triggered text generation for the document. Returned the updated entry.

getDocumentLockInfo

  • getDocumentLockInfo(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.LockInfo>
    • Returns the current persistent lock state of the document, including who holds the lock, the lock token, comment, extent, and creation timestamp.
    • If the document is not locked, returns lock info with isActive set to false.
    • Required OAuth scope: repository.Read

    Parameters

    • args: { entryId: number; repositoryId: string; select?: null | string }
      • entryId: number

        The requested document ID.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.LockInfo>

    Successfully returned the lock state of the document.

getEntry

  • getEntry(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.Entry>
    • 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.
    • If the entry is a subtype (Folder, Document, or Shortcut), the response will automatically include properties specific to that entry type. For example, Document entries include page-related properties such as the number of image pages and whether an electronic document is attached. Entries with an electronic document component include the electronic document size (in bytes). Folder entries include whether the folder is a record series. Shortcut entries include the target entry ID.
    • Allowed OData query options: Select.
    • When OData Select query option is used, 'entryType' is always included in the result.
    • Required OAuth scope: repository.Read

    Parameters

    • args: { entryId: number; repositoryId: string; select?: null | string }
      • entryId: number

        The requested entry ID.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully retrieved requested entry.

getEntryByPath

  • getEntryByPath(
        args: {
            fallbackToClosestAncestor?: boolean;
            fullPath: string;
            repositoryId: string;
        },
    ): Promise<LfRepositoryClientV2.GetEntryByPathResponse>
    • 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.
    • Required OAuth scope: repository.Read

    Parameters

    • args: { fallbackToClosestAncestor?: boolean; fullPath: string; repositoryId: string }
      • OptionalfallbackToClosestAncestor?: boolean

        (optional) 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.

      • fullPath: string

        The requested entry path.

      • repositoryId: string

        The requested repository ID.

    Returns Promise<LfRepositoryClientV2.GetEntryByPathResponse>

    Successfully retrieved requested entry or ancestor entry.

getPageImage

  • getPageImage(
        args: {
            entryId: number;
            pageNumber: number;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.FileResponse>
    • Returns the raw image data for the specified page as a binary stream.
    • pageNumber is 1-based.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          entryId: number;
          pageNumber: number;
          repositoryId: string;
          select?: null | string;
      }
      • entryId: number

        The requested document ID.

      • pageNumber: number

        The 1-based page number of the page to retrieve the image for.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.FileResponse>

    Successfully retrieved the image content for the specified page.

getPageText

  • getPageText(
        args: {
            entryId: number;
            pageNumber: number;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.PageTextResponse>
    • Returns the text content for the specified page.
    • pageNumber is 1-based.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          entryId: number;
          pageNumber: number;
          repositoryId: string;
          select?: null | string;
      }
      • entryId: number

        The requested document ID.

      • pageNumber: number

        The 1-based page number of the page to retrieve the text for.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.PageTextResponse>

    Successfully retrieved the text content for the specified page.

importEntry

  • importEntry(
        args: {
            culture?: null | string;
            entryId: number;
            file?: LfRepositoryClientV2.FileParameter;
            imageFiles?: LfRepositoryClientV2.FileParameter[];
            repositoryId: string;
            request?: LfRepositoryClientV2.ImportEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • Imports a new document into the specified folder, optionally with electronic document content, image pages, and metadata.
    • The file form field is optional. When provided, it becomes either the electronic document or image pages of the new document:
    • If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, the file is stored as the electronic document. For supported edoc formats, pdfOptions.generatePages additionally produces server-rendered image pages, and pdfOptions.generateText triggers text extraction from the document (or OCR when the source is image-based).
    • Otherwise (image extension with importAsElectronicDocument=false), the file is imported as image pages. A multi-page TIFF produces multiple pages. pdfOptions.generateText triggers OCR for the resulting pages.
    • A zero-byte file creates an empty document with no electronic document and no pages.
    • The optional imageFiles form field accepts up to 10 image files (100 MB aggregate) that are appended as image pages. Set generateImagePagesText=false in the body to skip OCR for the pages added via imageFiles (default: true).
    • file and imageFiles can be combined whenever the file is imported as the electronic document — i.e. non-image file types, or image file types with importAsElectronicDocument=true. The request returns 400 only when both are provided and the file would itself become image pages (image file type with importAsElectronicDocument=false).
    • Metadata in the body is assigned to the newly created entry.
    • Size and time limits: file must be ≤ 100 MB and the request must complete within 60 seconds. These limits may change. Use the asynchronous long-operation import endpoint for larger files or slower imports.
    • Required OAuth scope: repository.Write

    Parameters

    • args: {
          culture?: null | string;
          entryId: number;
          file?: LfRepositoryClientV2.FileParameter;
          imageFiles?: LfRepositoryClientV2.FileParameter[];
          repositoryId: string;
          request?: LfRepositoryClientV2.ImportEntryRequest;
      }
      • Optionalculture?: null | string

        (optional) 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.

      • entryId: number

        The entry ID of the folder that the document will be created in.

      • Optionalfile?: LfRepositoryClientV2.FileParameter

        (optional) Optional. The file to import. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it is stored as the electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file creates an empty document with no electronic document and no pages.

      • OptionalimageFiles?: LfRepositoryClientV2.FileParameter[]

        (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).

      • repositoryId: string

        The requested repository ID.

      • Optionalrequest?: LfRepositoryClientV2.ImportEntryRequest

        (optional)

    Returns Promise<LfRepositoryClientV2.Entry>

    Document was created successfully. Returns created entry.

listDynamicFieldValues

  • listDynamicFieldValues(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.ListDynamicFieldValuesRequest;
        },
    ): Promise<{ [key: string]: string[] }>
    • 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

    Parameters

    Returns Promise<{ [key: string]: string[] }>

    Successfully returned dynamic field values for specified entry, template, and field values.

listEntries

  • listEntries(
        args: {
            count?: boolean;
            culture?: null | string;
            entryId: number;
            fields?: null | string[];
            formatFieldValues?: boolean;
            groupByEntryType?: boolean;
            orderby?: null | string;
            prefer?: null | string;
            repositoryId: string;
            select?: null | string;
            skip?: number;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.EntryCollectionResponse>
    • 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.
    • 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.
    • Optional query parameters: groupByEntryType (bool). This query parameter decides if results are returned in groups based on their entry type.
    • 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. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.
    • Default page size: 150. 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".
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          culture?: null | string;
          entryId: number;
          fields?: null | string[];
          formatFieldValues?: boolean;
          groupByEntryType?: boolean;
          orderby?: null | string;
          prefer?: null | string;
          repositoryId: string;
          select?: null | string;
          skip?: number;
          top?: number;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.

      • entryId: number

        The folder ID.

      • Optionalfields?: null | string[]

        (optional) Optional array of field names. Field values corresponding to the given field names will be returned for each entry.

      • OptionalformatFieldValues?: boolean

        (optional) Indicates if field values should be formatted. Only applicable if Fields are specified. The default value is false.

      • OptionalgroupByEntryType?: boolean

        (optional) Indicates if the result should be grouped by entry type or not. The default value is false.

      • Optionalorderby?: null | string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: null | string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection. The maximum value is 150.

    Returns Promise<LfRepositoryClientV2.EntryCollectionResponse>

    Successfully returned list of children entries in requested folder.

listEntriesForEach

  • listEntriesForEach(
        args: {
            callback: (
                response: LfRepositoryClientV2.EntryCollectionResponse,
            ) => Promise<boolean>;
            count?: boolean;
            culture?: string;
            entryId: number;
            fields?: string[];
            formatFieldValues?: boolean;
            groupByEntryType?: boolean;
            maxPageSize?: number;
            orderby?: string;
            prefer?: string;
            repositoryId: string;
            select?: string;
            skip?: number;
            top?: number;
        },
    ): Promise<void>

    It will continue to make the same call to get a list of entry listings of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.

    Parameters

    • args: {
          callback: (
              response: LfRepositoryClientV2.EntryCollectionResponse,
          ) => Promise<boolean>;
          count?: boolean;
          culture?: string;
          entryId: number;
          fields?: string[];
          formatFieldValues?: boolean;
          groupByEntryType?: boolean;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repositoryId: string;
          select?: string;
          skip?: number;
          top?: number;
      }
      • callback: (response: LfRepositoryClientV2.EntryCollectionResponse) => Promise<boolean>

        async callback function that will accept the current page results and return a boolean value to either continue or stop paging.

      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.

      • entryId: number

        The requested entry ID.

      • Optionalfields?: string[]

        (optional) Optional array of field names. Field values corresponding to the given field names will be returned for each entry.

      • OptionalformatFieldValues?: boolean

        (optional) Boolean for if field values should be formatted. Only applicable if Fields are specified.

      • OptionalgroupByEntryType?: boolean

        (optional) An optional query parameter used to indicate if the result should be grouped by entry type or not.

      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of entry listings allowed per API response schema.

      • Optionalorderby?: string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<void>

listEntriesNextLink

  • listEntriesNextLink(
        args: { maxPageSize?: number; nextLink: string },
    ): Promise<LfRepositoryClientV2.EntryCollectionResponse>

    Returns the children entries of a folder in the repository using a next link

    Parameters

    • args: { maxPageSize?: number; nextLink: string }
      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of entry listings allowed per API response schema

      • nextLink: string

        a url that allows retrieving the next subset of the requested collection

    Returns Promise<LfRepositoryClientV2.EntryCollectionResponse>

    A collection of children entries of a folder.

listFields

  • listFields(
        args: {
            count?: boolean;
            culture?: null | string;
            entryId: number;
            formatFieldValues?: boolean;
            orderby?: null | string;
            prefer?: null | string;
            repositoryId: string;
            select?: null | string;
            skip?: number;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.FieldCollectionResponse>
    • 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.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          culture?: null | string;
          entryId: number;
          formatFieldValues?: boolean;
          orderby?: null | string;
          prefer?: null | string;
          repositoryId: string;
          select?: null | string;
          skip?: number;
          top?: number;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.

      • entryId: number

        The requested entry ID.

      • OptionalformatFieldValues?: boolean

        (optional) An optional query parameter used to indicate if the field values should be formatted. The default value is false.

      • Optionalorderby?: null | string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: null | string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection. The maximum value is 150.

    Returns Promise<LfRepositoryClientV2.FieldCollectionResponse>

    Successfully returned field values for requested entry.

listFieldsForEach

  • listFieldsForEach(
        args: {
            callback: (
                response: LfRepositoryClientV2.FieldCollectionResponse,
            ) => Promise<boolean>;
            count?: boolean;
            culture?: string;
            entryId: number;
            formatFieldValues?: boolean;
            maxPageSize?: number;
            orderby?: string;
            prefer?: string;
            repositoryId: string;
            select?: string;
            skip?: number;
            top?: number;
        },
    ): Promise<void>

    It will continue to make the same call to get a list of field values of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.

    Parameters

    • args: {
          callback: (
              response: LfRepositoryClientV2.FieldCollectionResponse,
          ) => Promise<boolean>;
          count?: boolean;
          culture?: string;
          entryId: number;
          formatFieldValues?: boolean;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repositoryId: string;
          select?: string;
          skip?: number;
          top?: number;
      }
      • callback: (response: LfRepositoryClientV2.FieldCollectionResponse) => Promise<boolean>

        async callback function that will accept the current page results and return a boolean value to either continue or stop paging.

      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.

      • entryId: number

        The requested entry ID.

      • OptionalformatFieldValues?: boolean

        (optional) An optional query parameter used to indicate if the field values should be formatted. The default value is false.

      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of field values allowed per API response schema.

      • Optionalorderby?: string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<void>

listFieldsNextLink

  • listFieldsNextLink(
        args: { maxPageSize?: number; nextLink: string },
    ): Promise<LfRepositoryClientV2.FieldCollectionResponse>

    Returns the fields assigned to an entry using a next link

    Parameters

    • args: { maxPageSize?: number; nextLink: string }
      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of field values allowed per API response schema

      • nextLink: string

        a url that allows retrieving the next subset of the requested collection

    Returns Promise<LfRepositoryClientV2.FieldCollectionResponse>

    A collection of fields assigned to the entry.

listLinks

  • listLinks(
        args: {
            count?: boolean;
            entryId: number;
            orderby?: null | string;
            prefer?: null | string;
            repositoryId: string;
            select?: null | string;
            skip?: number;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.LinkCollectionResponse>
    • 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.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          entryId: number;
          orderby?: null | string;
          prefer?: null | string;
          repositoryId: string;
          select?: null | string;
          skip?: number;
          top?: number;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • entryId: number

        The requested entry ID.

      • Optionalorderby?: null | string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: null | string

        (optional) An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection. The maximum value is 150.

    Returns Promise<LfRepositoryClientV2.LinkCollectionResponse>

    Successfully returned list of links assigned to requested entry.

listLinksForEach

  • listLinksForEach(
        args: {
            callback: (
                response: LfRepositoryClientV2.LinkCollectionResponse,
            ) => Promise<boolean>;
            count?: boolean;
            entryId: number;
            maxPageSize?: number;
            orderby?: string;
            prefer?: string;
            repositoryId: string;
            select?: string;
            skip?: number;
            top?: number;
        },
    ): Promise<void>

    It will continue to make the same call to get a list of link values from entry of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.

    Parameters

    • args: {
          callback: (
              response: LfRepositoryClientV2.LinkCollectionResponse,
          ) => Promise<boolean>;
          count?: boolean;
          entryId: number;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repositoryId: string;
          select?: string;
          skip?: number;
          top?: number;
      }
      • callback: (response: LfRepositoryClientV2.LinkCollectionResponse) => Promise<boolean>

        async callback function that will accept the current page results and return a boolean value to either continue or stop paging.

      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • entryId: number

        The requested entry ID.

      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of link values from entry allowed per API response schema.

      • Optionalorderby?: string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<void>

listLinksNextLink

  • listLinksNextLink(
        args: { maxPageSize?: number; nextLink: string },
    ): Promise<LfRepositoryClientV2.LinkCollectionResponse>

    Get the links assigned to an entry using a next link

    Parameters

    • args: { maxPageSize?: number; nextLink: string }
      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of link values from entry allowed per API response schema

      • nextLink: string

        a url that allows retrieving the next subset of the requested collection

    Returns Promise<LfRepositoryClientV2.LinkCollectionResponse>

    A collection of links assigned to the entry.

listPageInfos

  • listPageInfos(
        args: {
            count?: boolean;
            entryId: number;
            pageRange?: null | string;
            prefer?: null | string;
            repositoryId: string;
            select?: null | string;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.PageInfoCollectionResponse>
    • Returns a list of page properties including image dimensions, rotation angle, and content flags.
    • Pages are returned in ascending pageNumber order; that order is fixed and not configurable.
    • Default page size: 150. Allowed OData query options: Select | Count | SkipToken | Top | Prefer.
    • pageRange filters which pages are returned before paging is applied. Combine pageRange with $top/$skiptoken to paginate within a known range.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          entryId: number;
          pageRange?: null | string;
          prefer?: null | string;
          repositoryId: string;
          select?: null | string;
          top?: number;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • entryId: number

        The requested document ID.

      • OptionalpageRange?: null | string

        (optional) Optional comma-separated page numbers and ranges (e.g., "1,3-5,8-10"). Ranges must not overlap. When omitted, all pages are returned (subject to paging).

      • Optionalprefer?: null | string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection. The maximum value is 150.

    Returns Promise<LfRepositoryClientV2.PageInfoCollectionResponse>

    Successfully retrieved a paged listing of page information for the document.

listTags

  • listTags(
        args: {
            count?: boolean;
            entryId: number;
            orderby?: null | string;
            prefer?: null | string;
            repositoryId: string;
            select?: null | string;
            skip?: number;
            top?: number;
        },
    ): Promise<LfRepositoryClientV2.TagCollectionResponse>
    • 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.
    • Required OAuth scope: repository.Read

    Parameters

    • args: {
          count?: boolean;
          entryId: number;
          orderby?: null | string;
          prefer?: null | string;
          repositoryId: string;
          select?: null | string;
          skip?: number;
          top?: number;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • entryId: number

        The requested entry ID.

      • Optionalorderby?: null | string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: null | string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection. The maximum value is 150.

    Returns Promise<LfRepositoryClientV2.TagCollectionResponse>

    Successfully returned tags for requested entry.

listTagsForEach

  • listTagsForEach(
        args: {
            callback: (
                response: LfRepositoryClientV2.TagDefinitionCollectionResponse,
            ) => Promise<boolean>;
            count?: boolean;
            entryId: number;
            maxPageSize?: number;
            orderby?: string;
            prefer?: string;
            repositoryId: string;
            select?: string;
            skip?: number;
            top?: number;
        },
    ): Promise<void>

    It will continue to make the same call to get a list of tags assigned to entry of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.

    Parameters

    • args: {
          callback: (
              response: LfRepositoryClientV2.TagDefinitionCollectionResponse,
          ) => Promise<boolean>;
          count?: boolean;
          entryId: number;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repositoryId: string;
          select?: string;
          skip?: number;
          top?: number;
      }
      • callback: (
            response: LfRepositoryClientV2.TagDefinitionCollectionResponse,
        ) => Promise<boolean>

        async callback function that will accept the current page results and return a boolean value to either continue or stop paging.

      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • entryId: number

        The requested entry ID.

      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of tags assigned to entry allowed per API response schema.

      • Optionalorderby?: string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repositoryId: string

        The requested repository ID.

      • Optionalselect?: string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<void>

listTagsNextLink

  • listTagsNextLink(
        args: { maxPageSize?: number; nextLink: string },
    ): Promise<LfRepositoryClientV2.TagDefinitionCollectionResponse>

    Get the tags assigned to an entry using a next link

    Parameters

    • args: { maxPageSize?: number; nextLink: string }
      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of tags assigned to entry allowed per API response schema

      • nextLink: string

        a url that allows retrieving the next subset of the requested collection

    Returns Promise<LfRepositoryClientV2.TagDefinitionCollectionResponse>

    A collection of tags assigned to the entry.

lockDocument

  • lockDocument(
        args: {
            entryId: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.LockDocumentRequest;
        },
    ): Promise<LfRepositoryClientV2.LockInfo>
    • Creates a persistent lock on the specified document. Persistent locks survive session disconnect and server restart.
    • Optionally specify a comment and lock extent (Page, Edoc, Metadata, or All). Defaults to All.
    • Returns lock info including the lock token, owner, and extent.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.LockInfo>

    Successfully created a persistent lock on the document.

movePages

  • movePages(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.MovePagesRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • Moves the specified pages within the same document to a new position.
    • pageRange: A comma-separated string of non-overlapping single values or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12."
    • destinationPageNumber: The 1-based page number where the pages will be moved before.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully moved pages within the specified document. Returned the updated entry.

putUnderVersionControl

  • putUnderVersionControl(
        args: { entryId: number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.Entry>
    • Puts the specified document under version control. No-op if already under version control.
    • Documents must be under version control before they can be checked out.
    • Required OAuth scope: repository.Write

    Parameters

    • args: { entryId: number; repositoryId: string }
      • entryId: number

        The requested document ID.

      • repositoryId: string

        The requested repository ID.

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully put the document under version control.

removeTemplate

  • removeTemplate(
        args: { entryId: number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.Entry>
    • 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

    Parameters

    • args: { entryId: number; repositoryId: string }
      • entryId: number

        The ID of the entry that will have its template removed.

      • repositoryId: string

        The requested repository ID.

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully removed the currently assigned template from requested entry. Returned updated entry.

replacePages

  • replacePages(
        args: {
            entryId: number;
            generateText?: boolean;
            imageFiles?: LfRepositoryClientV2.FileParameter[];
            repositoryId: string;
            request?: LfRepositoryClientV2.PagesContentRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • Deletes all existing pages on the document, then creates new pages from the provided content. This is a single operation — one lock scope, one auto-version if the document is under version control.
    • At least one imageFile or textPage must be provided. To delete all pages without replacement, use DELETE /Pages.
    • The imageFiles and textPages arrays are paired by index (same rules as POST /Pages).
    • Required OAuth scope: repository.Write

    Parameters

    • args: {
          entryId: number;
          generateText?: boolean;
          imageFiles?: LfRepositoryClientV2.FileParameter[];
          repositoryId: string;
          request?: LfRepositoryClientV2.PagesContentRequest;
      }
      • entryId: number

        The requested document ID.

      • OptionalgenerateText?: boolean

        (optional) If true, triggers server-side text generation (OCR) after creating pages. Default is false.

      • OptionalimageFiles?: LfRepositoryClientV2.FileParameter[]

        (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).

      • repositoryId: string

        The requested repository ID.

      • Optionalrequest?: LfRepositoryClientV2.PagesContentRequest

        (optional)

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully replaced all pages in the specified document. Returned the updated entry.

rotateImagePage

  • rotateImagePage(
        args: {
            entryId: number;
            pageNumber: number;
            repositoryId: string;
            request: LfRepositoryClientV2.RotateImagePageRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • Rotates the image of the specified page by the given angle.
    • rotationAngle: The rotation angle in degrees. Accepted values: 0, 90, 180, 270.
    • pageNumber is 1-based.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully rotated the image page. Returned the updated entry.

setFields

  • setFields(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.SetFieldsRequest;
        },
    ): Promise<LfRepositoryClientV2.FieldCollectionResponse>
    • 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.
    • Required OAuth scope: repository.Write

    Parameters

    • args: {
          culture?: null | string;
          entryId: number;
          repositoryId: string;
          request: LfRepositoryClientV2.SetFieldsRequest;
      }
      • Optionalculture?: null | string

        (optional) 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.

      • entryId: number

        The entry ID of the entry that will have its fields updated.

      • repositoryId: string

        The requested repository ID.

      • request: LfRepositoryClientV2.SetFieldsRequest

        The request body.

    Returns Promise<LfRepositoryClientV2.FieldCollectionResponse>

    Successfully updated field values on requested entry. Returned updated fields

setLinks

  • setLinks(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.SetLinksRequest;
        },
    ): Promise<LfRepositoryClientV2.LinkCollectionResponse>
    • 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.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.LinkCollectionResponse>

    Successfully returned list of links assigned to requested entry.

setTags

  • setTags(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.SetTagsRequest;
        },
    ): Promise<LfRepositoryClientV2.TagCollectionResponse>
    • 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.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.TagCollectionResponse>

    Successfully assigned tags to the requested entry. Returned updated tags.

setTemplate

  • setTemplate(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.SetTemplateRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • 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.
    • Required OAuth scope: repository.Write

    Parameters

    • args: {
          culture?: null | string;
          entryId: number;
          repositoryId: string;
          request: LfRepositoryClientV2.SetTemplateRequest;
      }
      • Optionalculture?: null | string

        (optional) 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.

      • entryId: number

        The ID of entry that will have its template updated.

      • repositoryId: string

        The requested repository ID.

      • request: LfRepositoryClientV2.SetTemplateRequest

        The template and template fields that will be assigned to the entry.

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully assigned specified template to requested entry. Returned updated entry.

startCopyEntry

  • startCopyEntry(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.StartCopyEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.StartTaskResponse>
    • 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

    Parameters

    • args: {
          culture?: null | string;
          entryId: number;
          repositoryId: string;
          request: LfRepositoryClientV2.StartCopyEntryRequest;
      }
      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.

      • entryId: number

        The folder ID that the entry will be created in.

      • repositoryId: string

        The requested repository ID.

      • request: LfRepositoryClientV2.StartCopyEntryRequest

        The request body.

    Returns Promise<LfRepositoryClientV2.StartTaskResponse>

    Operation was started successfully. Returned a long operation task ID.

startDeleteEntry

  • startDeleteEntry(
        args: {
            entryId: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.StartDeleteEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.StartTaskResponse>
    • 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). The entry will not be deleted immediately.
    • Optionally include an audit reason ID and comment in the JSON body. This route returns a taskId, and will run as an asynchronous operation. Check the progress via the Tasks route.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.StartTaskResponse>

    Operation was started successfully. Returned a long operation task ID.

startExportEntry

  • startExportEntry(
        args: {
            entryId: number;
            pageRange?: null | string;
            repositoryId: string;
            request: LfRepositoryClientV2.StartExportEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.StartTaskResponse>
    • 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

    Parameters

    • args: {
          entryId: number;
          pageRange?: null | string;
          repositoryId: string;
          request: LfRepositoryClientV2.StartExportEntryRequest;
      }
      • entryId: number

        The ID of entry to export.

      • OptionalpageRange?: null | string

        (optional) A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc.

      • repositoryId: string

        The requested repository ID.

      • request: LfRepositoryClientV2.StartExportEntryRequest

        The request body.

    Returns Promise<LfRepositoryClientV2.StartTaskResponse>

    Operation was started successfully. Returned a long operation task ID.

startImportUploadedParts

  • startImportUploadedParts(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.StartImportUploadedPartsRequest;
        },
    ): Promise<LfRepositoryClientV2.StartTaskResponse>
    • Imports a new document from previously uploaded parts into the specified folder. The parts are assembled server-side into a single file that is then processed like a direct import.
    • The uploadId is obtained from the CreateMultipartUploadUrls response. The partETags are the ETag values returned by S3 when uploading each file chunk to the pre-signed upload URLs, and should be provided in the order of their associated upload URLs.
    • The assembled file is imported as either the electronic document or image pages, following the same rules as the synchronous POST /Folder/Import:
    • If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, the file is stored as the electronic document. For supported edoc formats, pdfOptions.generatePages additionally produces server-rendered image pages, and pdfOptions.generateText triggers text extraction from the document (or OCR when the source is image-based).
    • Otherwise (image extension with importAsElectronicDocument=false), the file is imported as image pages. pdfOptions.generateText triggers OCR for the resulting pages.
    • Metadata in the body is assigned to the newly created entry.
    • Supports assembled files up to 64 GB — use this endpoint when the file exceeds the size or time limits of the synchronous POST /Folder/Import.
    • Returns 202 Accepted with a task ID. Poll the task endpoint for progress and completion. This route does not support partial success.
    • imageFiles and generateImagePagesText are not supported on this endpoint; use the synchronous POST /Folder/Import to attach image pages alongside the imported file.
    • Required OAuth scope: repository.Write

    Parameters

    • args: {
          culture?: null | string;
          entryId: number;
          repositoryId: string;
          request?: LfRepositoryClientV2.StartImportUploadedPartsRequest;
      }
      • Optionalculture?: null | string

        (optional) 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.

      • entryId: number

        The entry ID of the folder that the document will be created in.

      • repositoryId: string

        The requested repository ID.

      • Optionalrequest?: LfRepositoryClientV2.StartImportUploadedPartsRequest

        (optional) The request body.

    Returns Promise<LfRepositoryClientV2.StartTaskResponse>

    Operation was started successfully. Returned a long operation task ID.

undoCheckOut

  • undoCheckOut(
        args: { entryId: number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.Entry>
    • Releases the check-out state without creating a new version in the version history.
    • Always releases the persistent lock if one is held.
    • Returns an error if the document is not under version control.
    • Required OAuth scope: repository.Write

    Parameters

    • args: { entryId: number; repositoryId: string }
      • entryId: number

        The requested document ID.

      • repositoryId: string

        The requested repository ID.

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully undid the document check-out. Any persistent lock held on the document has been released.

unlockDocument

  • unlockDocument(
        args: {
            entryId: number;
            lockToken?: null | string;
            repositoryId: string;
        },
    ): Promise<void>
    • Without a lockToken query parameter, removes the current user's persistent lock on the document.
    • With a lockToken query parameter, removes the specified lock regardless of owner (administrative unlock).
    • Required OAuth scope: repository.Write

    Parameters

    • args: { entryId: number; lockToken?: null | string; repositoryId: string }
      • entryId: number

        The requested document ID.

      • OptionallockToken?: null | string

        (optional) Optional lock token to unlock a specific lock held by another user (administrative unlock).

      • repositoryId: string

        The requested repository ID.

    Returns Promise<void>

    Successfully removed the persistent lock from the document.

updateDocument

  • updateDocument(
        args: {
            culture?: null | string;
            entryId: number;
            file?: LfRepositoryClientV2.FileParameter;
            imageFiles?: LfRepositoryClientV2.FileParameter[];
            repositoryId: string;
            request?: LfRepositoryClientV2.UpdateDocumentRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • Updates the electronic document, image pages, and/or metadata of the specified document entry.
    • At least one of file, imageFiles, or metadata must be provided.
    • The file form field is optional. When provided, it replaces the electronic document or is imported as image pages, following the same rules as the import endpoint:
    • If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, the file replaces the existing electronic document. For supported edoc formats, pdfOptions.generatePages additionally produces server-rendered image pages, and pdfOptions.generateText triggers text extraction from the document (or OCR when the source is image-based).
    • Otherwise (image extension with importAsElectronicDocument=false), the file is imported as image pages. pdfOptions.generateText triggers OCR for the resulting pages.
    • A zero-byte file is rejected with 400. To delete the electronic document while preserving pages and metadata, use DELETE /Document/Edoc.
    • The optional imageFiles form field accepts up to 10 image files (100 MB aggregate) that are appended as image pages. Set generateImagePagesText=false in the body to skip OCR for the pages added via imageFiles (default: true).
    • file and imageFiles can be combined whenever the file is imported as the electronic document — i.e. non-image file types, or image file types with importAsElectronicDocument=true. The request returns 400 only when both are provided and the file would itself become image pages (image file type with importAsElectronicDocument=false).
    • Metadata updates are additive — only fields, tags, and links specified in the request are changed; everything else is preserved. Use PUT /fields, PUT /tags, or PUT /links for replace semantics.
    • Lock/checkout lifecycle: the endpoint executes all requested mutations inside a single lock scope so that only one version is produced. It detects the caller's starting state and preserves it — the caller's existing persistent lock and/or checkout are reused, and the endpoint adds only what's missing for atomicity (checking out when the document is under version control but not checked out, persistently locking when no plock is held). On success, anything the endpoint added is released in reverse order (unlock plock, then check in — creating one version). On error, the endpoint undoes what it acquired (delete plock, undo checkout — no partial version).
    • If the document is checked out or persistently locked by another user, this endpoint returns 423 Locked.
    • Required OAuth scope: repository.Write

    Parameters

    • args: {
          culture?: null | string;
          entryId: number;
          file?: LfRepositoryClientV2.FileParameter;
          imageFiles?: LfRepositoryClientV2.FileParameter[];
          repositoryId: string;
          request?: LfRepositoryClientV2.UpdateDocumentRequest;
      }
      • Optionalculture?: null | string

        (optional) 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.

      • entryId: number

        The requested document ID.

      • Optionalfile?: LfRepositoryClientV2.FileParameter

        (optional) Optional. The electronic document or image file to apply to the existing document. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it replaces the existing electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file is rejected with 400; use DELETE /Document/Edoc to remove the electronic document.

      • OptionalimageFiles?: LfRepositoryClientV2.FileParameter[]

        (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).

      • repositoryId: string

        The requested repository ID.

      • Optionalrequest?: LfRepositoryClientV2.UpdateDocumentRequest

        (optional)

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully updated the document. Returned the updated entry.

updateDocumentUploadedParts

  • updateDocumentUploadedParts(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.UpdateDocumentUploadedPartsRequest;
        },
    ): Promise<LfRepositoryClientV2.StartTaskResponse>
    • Updates a document entry from previously uploaded parts. The parts are assembled server-side into a single file that is then applied to the existing document.
    • The uploadId is obtained from the CreateMultipartUploadUrls response. The partETags are the ETag values returned by S3 when uploading each file chunk to the pre-signed upload URLs, and should be provided in the order of their associated upload URLs.
    • Use this endpoint when the file exceeds the upload size or time limits of the synchronous PATCH /Document endpoint.
    • The assembled file is applied as either the electronic document or image pages, following the same rules as the synchronous PATCH /Document:
    • If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, the file replaces the existing electronic document. For supported edoc formats, pdfOptions.generatePages additionally produces server-rendered image pages, and pdfOptions.generateText triggers text extraction from the document (or OCR when the source is image-based).
    • Otherwise (image extension with importAsElectronicDocument=false), the file is imported as image pages. pdfOptions.generateText triggers OCR for the resulting pages.
    • If metadata is provided, it additively updates the template, fields, tags, and links. Existing values not mentioned in the request are preserved.
    • Returns 202 Accepted with a task ID. Poll the task endpoint for progress and completion.
    • imageFiles, generateImagePagesText, and the overwriteContent query parameter are not supported on this endpoint; use the synchronous PATCH /Document to append image pages, OCR them automatically, or replace metadata wholesale.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.StartTaskResponse>

    Successfully started the update document from uploaded parts operation. Returns a task ID for polling progress.

updateEntry

  • updateEntry(
        args: {
            culture?: null | string;
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.UpdateEntryRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • Update an entry. (Move and/or Rename)
    • Move an entry to a new folder by setting the ParentId in the request body.
    • Rename an entry by setting the Name in the request body.
    • Required OAuth scope: repository.Write

    Parameters

    • args: {
          culture?: null | string;
          entryId: number;
          repositoryId: string;
          request: LfRepositoryClientV2.UpdateEntryRequest;
      }
      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.

      • entryId: number

        The requested entry ID.

      • repositoryId: string

        The requested repository ID.

      • request: LfRepositoryClientV2.UpdateEntryRequest

        The request containing the folder ID that the entry will be moved to and the new name the entry will be renamed to.

    Returns Promise<LfRepositoryClientV2.Entry>

    Succesfully moved and/or renamed the entry. Returned updated entry.

writePage

  • writePage(
        args: {
            entryId: number;
            generateText?: boolean;
            imageFile?: LfRepositoryClientV2.FileParameter;
            pageNumber: number;
            repositoryId: string;
            request?: LfRepositoryClientV2.WritePageTextRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • Overwrites the image and/or text part of the specified page. At least one of imageFile or request (with text) must be provided.
    • Parts not provided are left unchanged — e.g. providing only imageFile replaces the image without affecting existing text.
    • pageNumber is 1-based.
    • Required OAuth scope: repository.Write

    Parameters

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully wrote the image content of the specified page. Returned the updated entry.

Settings

Member Visibility

On This Page

Methods