jira.js
    Preparing search index...

    Function getArticles

    • Returns articles which match the given query string across all service desks.

      Permissions required: Permission to access the customer portal.

      Parameters

      • client: Client
      • parameters: {
            cursor?: string;
            highlight: boolean;
            limit?: number;
            prev?: boolean;
            query: string;
            start?: number;
        }
        • Optionalcursor?: string

          Pointer to a set of search results, returned as part of the next or prev URL from the previous search call.

        • highlight: boolean

          If set to true matching query term in the title and excerpt will be highlighted using the @@@hl@@@term@@@endhl@@@ syntax. Default: false.

        • Optionallimit?: number

          The maximum number of items to return per page. Default: 50.

        • Optionalprev?: boolean

          Should navigate to the previous page. Defaulted to false. Set to true as part of prev URL from the previous search call.

        • query: string

          The string used to filter the articles (required).

        • Optionalstart?: number

          (Deprecated) The starting index of the returned objects. Base index: 0.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              _expands?: string[];
              _links?: {
                  base?: string;
                  context?: string;
                  next?: string;
                  prev?: string;
                  self?: string;
                  [key: string]: unknown;
              };
              isLastPage?: boolean;
              limit?: number;
              size?: number;
              start?: number;
              values?: {
                  content?: { iframeSrc?: string; [key: string]: unknown };
                  excerpt?: string;
                  source?: { type?: string & {} | "confluence"; [key: string]: unknown };
                  title?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility