Interface IAuditReasonsClient

listAuditReasons

• listAuditReasons(
      args: {
          count?: boolean;
          orderby?: null | string;
          prefer?: null | string;
          repositoryId: string;
          select?: null | string;
          skip?: number;
          top?: number;
      },
  ): Promise<AuditReasonCollectionResponse>
  • Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included.
  • Only includes audit reasons associated with available API functionalities, like delete entry and export document.
  • If the authenticated user does not have the appropriate Laserfiche feature right, the audit reasons associated with that feature right will not be included.
  • Required OAuth scope: repository.Read

  Parameters

  • args: {
        count?: 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.

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

  Returns Promise<AuditReasonCollectionResponse>

  A collection of audit reasons.