tbngDeleteRows

Syntax

tbngDeleteRows(tableGridNGFieldName, stringArray)

Description

This routine deletes 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

stringArray

string[]

contains the row ids of the rows, which should be deleted

Return type

Examples

For all examples we use the default configuration of the custom field:

Basic example:

string[] deletes = {"rowId_5284542f-1539-4b49-841a-ec1aa4d6a7f3"};
tbngDeleteRows("TEST-1", "My Grid Field", deletes);

In this example we delete all rows from the Table Grid Next Generation custom field:

struct TbGridAssignee {
    string key;
}
 
struct MyGridFieldRow {
    string jsummary;
    TbGridAssignee jassignee;
    string jstatus;
    string jseq;
}
 
struct MyGridField {
    string rowId;
    MyGridFieldRow columns;
}
 
MyGridField[] myGridField = fromJson(tbngGetRows("My Grid Field"));
string[] deletes;
 
for (MyGridField row in myGridField) {
    addElement(deletes, row.rowId);
}
 
tbngDeleteRows(key, "My Grid Field", deletes);