Knowledge Base REST API Query Examples

[#1]

Hey everyone!

The purpose of this Community article is to provide a couple example queries for using this experimental API with both cURL and Postman, which is in reference to the KB API Developer Document here: The Jira Service Management Cloud REST API

Note that the method to run these queries may change over time as this is an experimental API.

cURL

First you will need to authenticate yourself, which will require an Access Token

Afterward you can use a command similar to the following in the terminal:

curl -v https:/mysite.atlassian.net --user myaddress@email.com:<accesstoken>

Once you are authenticated using your access token you will then need a Base64 encoded version of your username and password for the GET request. This can be completed using a Base64 encoding tool, such as: Base64 Encode and Decode - Online

Once you have this, your cURL command should look like the following:

curl --request GET \

        --url 'https://mysite.atlassian.net/rest/servicedeskapi/knowledgebase/article?query=article' \

        --header 'X-ExperimentalApi: opt-in'\

        --header 'Authorization: Basic base64encodedusernameandaccesstoken' \

        --header 'Accept: application/json'

And the results should look similar to the screenshot below:

Postman

First you will need to authenticate yourself using Basic auth, which will require your Username (email address) and your Password (which will be your access token):

Afterward, you can bill the GET request in Postman.

1. First, the URL should look similar to the following: https://mysiteatlassian.net/rest/servicedeskapi/knowledgebase/article?query=article'

2. As this is an experimental API the headers should have a KEY of X-ExperimentalAPI and a VALUE of opt-in

3. After these two things have been setup you should receive a response similar to the following:

It's important to note that the Knowledge Base API uses Basic Authentication, adding ?query=article to the GET URL and using X-ExperimentalApi: opt-in within the headers is necessary for these queries to run successfully.

Thanks for reading!

Cheers,

Christian

[KrishnaMohan]

Thanks for the informative post.

I am looking for the same to POST the data using graphql mutation. Do you have any thing, please redirect to me.