Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Field Values Query Parameter Usage

In order to transfer field values to the report, you need to use the field values query parameter.

...

Code Block
// Form JS object representation of values that should be passed
const fieldValues = {"stringField": "testString"};

// Convert JS object to JSON string
const fieldValuesJSON = JSON.stringify(fieldValues);

// Pass encoded JSON string as a fieldValues query parameter (in address line)
?fieldValues=${encodeURI(fieldValuesJSON)}

List of field values

Input parameter type

Expected format

Data example

String

<string>

“testString”

Number

<number>

10001

Issue Picker

{

“label”: <string>,

“value”: <string>

}

Code Block
{
    "label": "KT32-4 Issue A",
    "value": "KT32-4"
}

Date

YYYY-MM-DD

"2021-08-08"

Checkbox

<boolean>

true

Textarea

<string>

“Textarea Text"

Radio Button

<string> (option value)

“optionValue”

JQL

<string>

"assignee = currentUser()"

Project Picker

{

“label”: <string>,

“value”: <string>

}

Code Block
{
    "label": "First Project  (FP)",
    "value": "FP"
  }

User Picker

{

“label”: <string>,

“value”: <string>

}

Code Block
{
    "label": "User Name",
    "value": "41abdsbfe17eda2b3fdd0565"
}

Data Range Picker

{

“start” : YYYY-MM-DD,

“end”: YYYY-MM-DD,

“definedPeriod”: <periodValue>

}

List of period values: today,yesterday,thisWeek,lastWeek,thisMonth,lastMonth

Code Block
{
    "start": "2021-08-15",
    "end": "2021-08-21",
    "definedPeriod": null
}

Field Picker

{

“label”: <string>,

“value”: <string>

}

Code Block
{
    "label": "Created",
    "value": "created",
}

Issue Type Picker

{

“label”: <string>,

“value”: <string>

}

Code Block
"issueTypeField": {
    "label": "Task",
    "value": "10002"
}

Select List

<string> (option value)

“selectItemValue”

Example:

Code Block
{
  "stringField": "testString",
  "numberField": 10001,
  "issuePickerField": {
    "label": "KT32-4 Issue A",
    "value": "KT32-4"
  },
  "dateField": "2021-08-08",
  "checkboxField": true,
  "textareaField": "Textarea Text",
  "radioButtonField": "optionValue",
  "jqlField": "assignee  %3D currentUser() ",
  "projectField": {
    "label": "First Project  (FP)",
    "value": "FP"
  },
  "userPickerField": {
    "label": "User Name",
    "value": "41abdsbfe17eda2b3fdd0565"
  },
  "rangeField": {
    "start": "2021-08-15",
    "end": "2021-08-21",
    "definedPeriod": null
  },
  "fieldsPicker": {
    "label": "Created",
    "value": "created"
  },
  "issueTypeField": {
    "label": "Task",
    "value": "10002"
  },
  "selectField": "selectItemValue"
}

...