Class EntriesClient

Implements

Constructors

constructor

Properties

jsonParseReviver

Methods

assignEntryLinks assignFieldValues assignTags copyEntry createOrCopyEntry deleteAssignedTemplate deleteDocument deleteEntryInfo deletePages exportDocument exportDocumentWithAuditReason getDocumentContentType getDynamicFieldValues getEntry getEntryByPath getEntryListing getEntryListingForEach getEntryListingNextLink getFieldValues getFieldValuesForEach getFieldValuesNextLink getLinkValuesFromEntry getLinkValuesFromEntryForEach getLinkValuesFromEntryNextLink getTagsAssignedToEntry getTagsAssignedToEntryForEach getTagsAssignedToEntryNextLink importDocument moveOrRenameEntry processAssignEntryLinks processAssignFieldValues processAssignTags processCopyEntry processCreateOrCopyEntry processDeleteAssignedTemplate processDeleteDocument processDeleteEntryInfo processDeletePages processExportDocument processExportDocumentWithAuditReason processGetDocumentContentType processGetDynamicFieldValues processGetEntry processGetEntryByPath processGetEntryListing processGetFieldValues processGetLinkValuesFromEntry processGetTagsAssignedToEntry processImportDocument processMoveOrRenameEntry processWriteTemplateValueToEntry writeTemplateValueToEntry

Constructors

constructor

Properties

ProtectedjsonParseReviver

jsonParseReviver: undefined | ((key: string, value: any) => any) = undefined

Methods

assignEntryLinks

assignFieldValues

  • assignFieldValues(args): Promise<ODataValueOfIListOfFieldValue>
    • Update the field values assigned to an entry.
    • Provide the new field values to assign to the entry, and remove/reset all previously assigned field values.
    • This is an overwrite action. The request body must include all desired field values, including any existing field values that should remain assigned to the entry. Field values that are not included in the request will be deleted from the entry. If the field value that is not included is part of a template, it will still be assigned (as required by the template), but its value will be reset.

    Parameters

    • args: {
          culture?: null | string;
          entryId: number;
          fieldsToUpdate?: {
              [key: string]: FieldToUpdate;
          };
          repoId: string;
      }
      • 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.

      • OptionalfieldsToUpdate?: {
            [key: string]: FieldToUpdate;
        }

        (optional)

      • repoId: string

        The requested repository ID.

    Returns Promise<ODataValueOfIListOfFieldValue>

    Update field values successfully.

assignTags

copyEntry

  • copyEntry(args): Promise<AcceptedOperation>
    • Copy a new child entry in the designated folder async, and potentially return an operationToken.
    • Provide the parent folder ID, and copy an entry as a child of the designated folder.
    • Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.
    • The status of the operation can be checked via the Tasks/{operationToken} route.
    • Token substitution in the name of the copied entry is not supported.

    Parameters

    • args: {
          autoRename?: boolean;
          culture?: null | string;
          entryId: number;
          repoId: string;
          request?: CopyAsyncRequest;
      }
      • OptionalautoRename?: boolean

        (optional) An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false.

      • 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.

      • repoId: string

        The requested repository ID.

      • Optionalrequest?: CopyAsyncRequest

        (optional) Copy entry request.

    Returns Promise<AcceptedOperation>

    Copy entry operation is started successfully.

createOrCopyEntry

  • createOrCopyEntry(args): Promise<Entry>
    • Create/copy a new child entry in the designated folder.
    • Provide the parent folder ID, and based on the request body, copy or create a folder/shortcut as a child entry of the designated folder.
    • Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.

    Parameters

    • args: {
          autoRename?: boolean;
          culture?: null | string;
          entryId: number;
          repoId: string;
          request?: PostEntryChildrenRequest;
      }
      • OptionalautoRename?: boolean

        (optional) An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false.

      • 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.

      • repoId: string

        The requested repository ID.

      • Optionalrequest?: PostEntryChildrenRequest

        (optional) The entry to create.

    Returns Promise<Entry>

    Created a new child entry successfully.

deleteAssignedTemplate

  • deleteAssignedTemplate(args): Promise<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.

    Parameters

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

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

      • repoId: string

        The requested repository ID.

    Returns Promise<Entry>

    Remove the currently assigned template successfully.

deleteDocument

deleteEntryInfo

  • deleteEntryInfo(args): Promise<AcceptedOperation>
    • Begins a task to delete an entry, and returns an operationToken.
    • Provide an entry ID, and queue a delete task to remove it from the repository (includes nested objects if the entry is a Folder type). The entry will not be deleted immediately.
    • Optionally include an audit reason ID and comment in the JSON body. This route returns an operationToken, and will run as an asynchronous operation. Check the progress via the Tasks/{operationToken} route.

    Parameters

    • args: {
          entryId: number;
          repoId: string;
          request?: DeleteEntryWithAuditReason;
      }
      • entryId: number

        The requested entry ID.

      • repoId: string

        The requested repository ID.

      • Optionalrequest?: DeleteEntryWithAuditReason

        (optional) The submitted audit reason.

    Returns Promise<AcceptedOperation>

    Delete entry operation start successfully.

deletePages

  • deletePages(args): Promise<ODataValueOfBoolean>
    • Delete the pages associated with the provided entry ID. If no pageRange is specified, all pages will be deleted.
    • Optional parameter: pageRange (default empty). The value should be a comma-seperated string which contains non-overlapping single values, or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12."

    Parameters

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

        The requested document ID.

      • OptionalpageRange?: null | string

        (optional) The pages to be deleted.

      • repoId: string

        The requested repository ID.

    Returns Promise<ODataValueOfBoolean>

    Deleted pages successfully.

exportDocument

  • exportDocument(args): Promise<FileResponse>
    • Returns an entry's edoc resource in a stream format.
    • Provide an entry ID, and get the edoc resource as part of the response content.
    • Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc.

    Parameters

    • args: {
          entryId: number;
          range?: null | string;
          repoId: string;
      }
      • entryId: number

        The requested document ID.

      • Optionalrange?: null | string

        (optional) An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.

      • repoId: string

        The requested repository ID.

    Returns Promise<FileResponse>

    Get edoc successfully.

exportDocumentWithAuditReason

  • exportDocumentWithAuditReason(args): Promise<FileResponse>
    • Returns an entry's edoc resource in a stream format while including an audit reason.
    • Provide an entry ID and audit reason/comment in the request body, and get the edoc resource as part of the response content.
    • Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. This route is identical to the GET edoc route, but allows clients to include an audit reason when downloading the edoc.

    Parameters

    • args: {
          entryId: number;
          range?: null | string;
          repoId: string;
          request?: GetEdocWithAuditReasonRequest;
      }
      • entryId: number

        The requested document ID.

      • Optionalrange?: null | string

        (optional) An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.

      • repoId: string

        The requested repository ID.

      • Optionalrequest?: GetEdocWithAuditReasonRequest

        (optional)

    Returns Promise<FileResponse>

    Get edoc successfully.

getDocumentContentType

  • getDocumentContentType(args): Promise<HttpResponseHead<void>>
    • Returns information about the edoc content of an entry, without downloading the edoc in its entirety.
    • Provide an entry ID, and get back the Content-Type and Content-Length in the response headers.
    • This route does not provide a way to download the actual edoc. Instead, it just gives metadata information about the edoc associated with the entry.
    • If an error occurs, the error message can be found in the X-APIServer-Error HTTP response header.

    Parameters

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

        The requested document ID.

      • repoId: string

        The requested repository ID.

    Returns Promise<HttpResponseHead<void>>

    Get edoc info successfully.

getDynamicFieldValues

  • getDynamicFieldValues(args): 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.

    Parameters

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

    Get dynamic field logic values successfully.

getEntry

  • getEntry(args): Promise<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.
    • Allowed OData query options: Select. If the entry is a subtype (Folder, Document, or Shortcut), the entry will automatically be converted to include those model-specific properties.

    Parameters

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

        The requested entry ID.

      • repoId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<Entry>

    Get entry successfully.

getEntryByPath

  • getEntryByPath(args): Promise<FindEntryResult>
    • Returns a single entry object using the entry path.
    • Optional query parameter: fallbackToClosestAncestor. Use the fallbackToClosestAncestor query parameter to return the closest existing ancestor if the initial entry path is not found.

    Parameters

    • args: {
          fallbackToClosestAncestor?: boolean;
          fullPath: null | string;
          repoId: 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: null | string

        The requested entry path.

      • repoId: string

        The requested repository ID.

    Returns Promise<FindEntryResult>

    Get entry successfully.

getEntryListing

  • getEntryListing(args): Promise<ODataValueContextOfIListOfEntry>
    • Returns the children entries of a folder in the repository.
    • Provide an entry ID (must be a folder), and get a paged listing of entries in that folder. Used as a way of navigating through the repository.
    • Default page size: 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". Optional query parameters: groupByOrderType (bool). This query parameter decides if results are returned in groups based on their entry type. Entries returned in the listing are not automatically converted to their subtype (Folder, Shortcut, Document), so clients who want model-specific information should request it via the GET entry by ID route.
    • Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names.
    • If field values are requested, only the first value is returned if it is a multi value field.
    • Null or Empty field values should not be used to determine if a field is assigned to the entry.

    Parameters

    • args: {
          count?: boolean;
          culture?: null | string;
          entryId: number;
          fields?: null | string[];
          formatFields?: boolean;
          groupByEntryType?: boolean;
          orderby?: null | string;
          prefer?: null | string;
          repoId: 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 formatFields 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.

      • OptionalformatFields?: 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.

      • 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.

      • repoId: 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.

    Returns Promise<ODataValueContextOfIListOfEntry>

    Get the children entries of a Folder successfully.

getEntryListingForEach

  • getEntryListingForEach(args): 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: ODataValueContextOfIListOfEntry) => Promise<boolean>);
          count?: boolean;
          culture?: string;
          entryId: number;
          fields?: string[];
          formatFields?: boolean;
          groupByEntryType?: boolean;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repoId: string;
          select?: string;
          skip?: number;
          top?: number;
      }
      • callback: ((response: ODataValueContextOfIListOfEntry) => 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 formatFields 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.

      • OptionalformatFields?: 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.

      • repoId: 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>

getEntryListingNextLink

getFieldValues

  • getFieldValues(args): Promise<ODataValueContextOfIListOfFieldValue>
    • Returns the fields assigned to an entry.
    • Provide an entry ID, and get a paged listing of all fields assigned to that entry.
    • Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.

    Parameters

    • args: {
          count?: boolean;
          culture?: null | string;
          entryId: number;
          formatValue?: boolean;
          orderby?: null | string;
          prefer?: null | string;
          repoId: 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 formatValue query parameter must be set to true, otherwise culture will not be used for formatting.

      • entryId: number

        The requested entry ID.

      • OptionalformatValue?: 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.

      • repoId: 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.

    Returns Promise<ODataValueContextOfIListOfFieldValue>

    Get field values successfully.

getFieldValuesForEach

  • getFieldValuesForEach(args): 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: ODataValueContextOfIListOfFieldValue) => Promise<boolean>);
          count?: boolean;
          culture?: string;
          entryId: number;
          formatValue?: boolean;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repoId: string;
          select?: string;
          skip?: number;
          top?: number;
      }
      • callback: ((response: ODataValueContextOfIListOfFieldValue) => 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 formatFields query parameter must be set to true, otherwise culture will not be used for formatting.

      • entryId: number

        The requested entry ID.

      • OptionalformatValue?: 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.

      • repoId: 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>

getFieldValuesNextLink

getLinkValuesFromEntry

  • getLinkValuesFromEntry(args): Promise<ODataValueContextOfIListOfWEntryLinkInfo>
    • Returns the links assigned to an entry.
    • Provide an entry ID, and get a paged listing of links assigned to that entry.
    • Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.

    Parameters

    • args: {
          count?: boolean;
          entryId: number;
          orderby?: null | string;
          prefer?: null | string;
          repoId: 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.

      • repoId: 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.

    Returns Promise<ODataValueContextOfIListOfWEntryLinkInfo>

    Get links successfully.

getLinkValuesFromEntryForEach

  • getLinkValuesFromEntryForEach(args): 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: ODataValueContextOfIListOfWEntryLinkInfo) => Promise<boolean>);
          count?: boolean;
          entryId: number;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repoId: string;
          select?: string;
          skip?: number;
          top?: number;
      }
      • callback: ((response: ODataValueContextOfIListOfWEntryLinkInfo) => 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.

      • repoId: 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>

getLinkValuesFromEntryNextLink

getTagsAssignedToEntry

  • getTagsAssignedToEntry(args): Promise<ODataValueContextOfIListOfWTagInfo>
    • Returns the tags assigned to an entry.
    • Provide an entry ID, and get a paged listing of tags assigned to that entry.
    • Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.

    Parameters

    • args: {
          count?: boolean;
          entryId: number;
          orderby?: null | string;
          prefer?: null | string;
          repoId: 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.

      • repoId: 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.

    Returns Promise<ODataValueContextOfIListOfWTagInfo>

    Get entry tags successfully.

getTagsAssignedToEntryForEach

  • getTagsAssignedToEntryForEach(args): 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: ODataValueContextOfIListOfWTagInfo) => Promise<boolean>);
          count?: boolean;
          entryId: number;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repoId: string;
          select?: string;
          skip?: number;
          top?: number;
      }
      • callback: ((response: ODataValueContextOfIListOfWTagInfo) => 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.

      • repoId: 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>

getTagsAssignedToEntryNextLink

importDocument

  • importDocument(args): Promise<CreateEntryResult>
    • Creates a new document in the specified folder with file (no more than 100 MB).
    • Optionally sets metadata and electronic document component.
    • Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. With this route, partial success is possible. The response returns multiple operation (entryCreate operation, setEdoc operation, setLinks operation, etc..) objects, which contain information about any errors that may have occurred during the creation. As long as the entryCreate operation succeeds, the entry will be created, even if all other operations fail.

    Parameters

    • args: {
          autoRename?: boolean;
          culture?: null | string;
          electronicDocument?: FileParameter;
          fileName: string;
          parentEntryId: number;
          repoId: string;
          request?: PostEntryWithEdocMetadataRequest;
      }
      • OptionalautoRename?: boolean

        (optional) An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false.

      • 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.

      • OptionalelectronicDocument?: FileParameter

        (optional)

      • fileName: string

        The created document's file name.

      • parentEntryId: number

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

      • repoId: string

        The requested repository ID.

      • Optionalrequest?: PostEntryWithEdocMetadataRequest

        (optional)

    Returns Promise<CreateEntryResult>

    Document creation is success.

moveOrRenameEntry

  • moveOrRenameEntry(args): Promise<Entry>
    • Moves and/or renames an entry.
    • Move and/or rename an entry by passing in the new parent folder ID or name in the JSON body.
    • Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.

    Parameters

    • args: {
          autoRename?: boolean;
          culture?: null | string;
          entryId: number;
          repoId: string;
          request?: PatchEntryRequest;
      }
      • OptionalautoRename?: boolean

        (optional) An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false.

      • 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.

      • repoId: string

        The requested repository ID.

      • Optionalrequest?: PatchEntryRequest

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

    Moves and/or renames an entry successfully.

ProtectedprocessAssignEntryLinks

ProtectedprocessAssignFieldValues

ProtectedprocessAssignTags

ProtectedprocessCopyEntry

ProtectedprocessCreateOrCopyEntry

ProtectedprocessDeleteAssignedTemplate

ProtectedprocessDeleteDocument

ProtectedprocessDeleteEntryInfo

ProtectedprocessDeletePages

ProtectedprocessExportDocument

ProtectedprocessExportDocumentWithAuditReason

ProtectedprocessGetDocumentContentType

ProtectedprocessGetDynamicFieldValues

ProtectedprocessGetEntry

ProtectedprocessGetEntryByPath

ProtectedprocessGetEntryListing

ProtectedprocessGetFieldValues

ProtectedprocessGetLinkValuesFromEntry

ProtectedprocessGetTagsAssignedToEntry

ProtectedprocessImportDocument

ProtectedprocessMoveOrRenameEntry

ProtectedprocessWriteTemplateValueToEntry

writeTemplateValueToEntry

  • writeTemplateValueToEntry(args): Promise<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.

    Parameters

    • args: {
          culture?: null | string;
          entryId: number;
          repoId: string;
          request?: PutTemplateRequest;
      }
      • 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.

      • repoId: string

        The requested repository ID.

      • Optionalrequest?: PutTemplateRequest

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

    Returns Promise<Entry>

    Assign a template successfully.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
assignEntryLinksassignFieldValuesassignTagscopyEntrycreateOrCopyEntrydeleteAssignedTemplatedeleteDocumentdeleteEntryInfodeletePagesexportDocumentexportDocumentWithAuditReasongetDocumentContentTypegetDynamicFieldValuesgetEntrygetEntryByPathgetEntryListinggetEntryListingForEachgetEntryListingNextLinkgetFieldValuesgetFieldValuesForEachgetFieldValuesNextLinkgetLinkValuesFromEntrygetLinkValuesFromEntryForEachgetLinkValuesFromEntryNextLinkgetTagsAssignedToEntrygetTagsAssignedToEntryForEachgetTagsAssignedToEntryNextLinkimportDocumentmoveOrRenameEntryprocessAssignEntryLinksprocessAssignFieldValuesprocessAssignTagsprocessCopyEntryprocessCreateOrCopyEntryprocessDeleteAssignedTemplateprocessDeleteDocumentprocessDeleteEntryInfoprocessDeletePagesprocessExportDocumentprocessExportDocumentWithAuditReasonprocessGetDocumentContentTypeprocessGetDynamicFieldValuesprocessGetEntryprocessGetEntryByPathprocessGetEntryListingprocessGetFieldValuesprocessGetLinkValuesFromEntryprocessGetTagsAssignedToEntryprocessImportDocumentprocessMoveOrRenameEntryprocessWriteTemplateValueToEntrywriteTemplateValueToEntry