Skip to content

Add a helper to look up sample type row ids by name #3193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
labkey-jeckels wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Add a helper to look up sample type row ids by name #3193

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ebccdc
Docs and more
labkey-jeckels Sep 13, 2026
d44032f
Fix stray text
labkey-jeckels Sep 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/org/labkey/test/util/exp/SampleTypeAPIHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import org.junit.Assert;
import org.labkey.remoteapi.CommandException;
import org.labkey.remoteapi.Connection;
import org.labkey.remoteapi.query.ContainerFilter;
import org.labkey.remoteapi.query.Filter;
import org.labkey.remoteapi.query.SelectRowsCommand;
import org.labkey.remoteapi.query.SelectRowsResponse;
Expand Down Expand Up @@ -201,6 +202,27 @@ public static Map<String, Integer> getRowIdsForSamples(String containerPath, Str
return rowIds;
}

/**
* Row ids of every sample type named {@code sampleTypeName} that is visible from {@code containerPath}, in the
* CurrentPlusProjectAndShared scope a sample type lookup resolves against.
*
* <p>Manufacturing a rowId/name collision needs the id the server actually assigned, because
* {@code exp.MaterialSource.RowId} is a database-wide sequence: a hardcoded numeric sample type name collides
* only when the sequence happens to cooperate. Require exactly one match as well, since a resolver reports an
* ambiguity rather than picking, and that error is swallowed by the import code.
*/
public static List<Integer> getSampleTypeRowIds(String containerPath, String sampleTypeName) throws IOException, CommandException
{
SelectRowsCommand cmd = new SelectRowsCommand("exp", "SampleSets");
cmd.setColumns(List.of("RowId"));
cmd.addFilter("Name", sampleTypeName, Filter.Operator.EQUAL);
cmd.setContainerFilter(ContainerFilter.CurrentPlusProjectAndShared);

return cmd.execute(WebTestHelper.getRemoteApiConnection(), containerPath).getRows().stream()
.map(row -> Integer.parseInt(row.get("RowId").toString()))
.toList();
}

/**
* Get sample state IDs defined in the specified project/folder. Useful for updating sample status via API
* @param containerPath Path to the project/folder where the sample statuses are defined (typically project)
Expand Down