Sign in

v3

latestOpenAPI 3.0.12026-08-0474115357.9 KB
Servicedesk

Get articles

Returns articles which match the given query and belong to the knowledge base linked to the service desk.

Permissions required: Permission to access the service desk.

get/rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article

Path parameters

serviceDeskIdstring required

Query parameters

querystring required

The string used to filter the articles (required).

highlightboolean

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

startinteger

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

limitinteger

The maximum number of items to return per page. Default: 50. See the section for more details.

cursorstring

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

prevboolean

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

Response

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

_expandsstring[]
isLastPageboolean

Indicates if this is the last page of records (true) or not (false).

limitinteger

Number of items to be returned per page, up to the maximum set for these objects in the current implementation.

sizeinteger

Number of items returned in the page.

startinteger

Index of the first item returned in the page.