tbngGetRows

Syntax

tbngGetRows(tableGridNGFieldName)

Description

This routine retrieves all rows from a Table Grid Next Generation custom field.

Parameters

Parameter name

Type

Required

Description

issue key

string

No

the key of the issue which will be updated

tableGridNGFieldName

string

Yes

the name of a Table Grid Next Generation custom field. The name can be represented as:

the name
the id (customfield_NNNNN)
the alias

Return type

string

Examples

We return the data of a Table Grid Next Generation custom field to a string variable. The return value is in the JSON format.

string json = tbngGetRows("TEST-1", "My Grid Field");

We return the data of a Table Grid Next Generation custom field to an array of structs. We use the default configuration of the custom field:

Here is the code:

struct TbGridAssignee {
    string key;
}
 
struct MyGridFieldRow {
    string jsummary;
    TbGridAssignee jassignee;
    string jstatus;
    string jseq;
}
 
struct MyGridField {
    string rowId;
    MyGridFieldRow columns;
}
 
MyGridField[] myGridFields = fromJson(tbngGetRows(key, "My Grid Field"));