Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

JIRA Service Desk Data Model

Navigation: Schema: Service > Tables

ArticlesByQuery: JIRA Service Desk Articles by Query

Contents Previous Home Next More

Catalog: JIRA

Schema: Service

Primary Keys: id

Label: Articles by Query

This is a read-only table function. The JIRA Service Desk API may not support changing the data or the Invantive SQL driver for JIRA Service Desk does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the JIRA Service Desk API.

Select JIRA Service Desk API URL: /knowledgebase/article

Insert JIRA Service Desk API URL: /knowledgebase/article

Update JIRA Service Desk API URL: /knowledgebase/article

Delete JIRA Service Desk API URL: /knowledgebase/article

Field Selection Method: NotRequired

Base Path: values[*]

Table Function Parameters

The following parameters can be used to control the behaviour of the table function ArticlesByQuery. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

highlight

boolean

False

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

highlight

boolean

False

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

query

string

 

The string used to filter the articles.

 

Table Function Columns

The columns of the table function ArticlesByQuery are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

content_iframeSrc

string

 

URL containing the body of the article (without title), suitable for rendering in an iframe.

excerpt

string

 

Excerpt of the article which matches the given query string.

source_type

string

 

Type of the knowledge base source.

title

string

 

Title of the article.

 

29-09-2021 12:46 Version 20.2.43-PROD+3437