Class KnowledgebaseService

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-knowledgebase

Hierarchy

  • CommonHttpService
    • KnowledgebaseService

Constructors

constructor

Methods

getArticles initialize

Constructors

constructor

  • new KnowledgebaseService(getClientInstance): KnowledgebaseService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns KnowledgebaseService

Methods

getArticles

  • getArticles(params): Promise<PagedDtoArticleDto>

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

    Permissions required: Permission to access the customer portal.

    Parameters

    • params: {
          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.

    Returns Promise<PagedDtoArticleDto>

    Returns the articles, on the specified page of the results.

    example:

    {
      "_expands": [],
      "size": 2,
      "start": 2,
      "limit": 2,
      "isLastPage": false,
      "_links": {
        "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
        "context": "context",
        "next": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article?start=4&limit=2",
        "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article?start=0&limit=2"
      },
      "values": [
        {
          "title": "Stolen computer",
          "excerpt": "assuming your computer was stolen",
          "source": {
            "type": "confluence",
            "pageId": "8786177",
            "spaceKey": "IT"
          },
          "content": {
            "iframeSrc": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8786177"
          }
        },
        {
          "title": "Upgrading computer",
          "excerpt": "each computer older then 3 years can be upgraded",
          "source": {
            "type": "confluence",
            "pageId": "8785228",
            "spaceKey": "IT"
          },
          "content": {
            "iframeSrc": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8785228"
          }
        }
      ]
    }

    Path

    GET /rest/servicedeskapi/knowledgebase/article @scopes-current read:servicedesk-request @scopes-beta read:knowledgebase:jira-service-management

    See

    https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-knowledgebase#api-rest-servicedeskapi-knowledgebase-article-get

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods