The Open API specification for Synapse is now available for download!

Download Open API Spec

CreateGridRequest

org.sagebionetworks.repo.model.grid.CreateGridRequest

Start a job to create a new Grid session.

Field Type Description
concreteType STRING
initialQuery Query
recordSetId STRING When provided, the grid will be initialized using the CSV file stored for the given record set id. The grid columns will match the header of the CSV. Optional, if present the initialQuery cannot be included.
ownerPrincipalId STRING The owner of the grid determines who is allowed to join and participate in the grid's session. The default owner will be the user that started the grid session, but only that user will have access to the grid. In order to allow other users to access the grid, set this value to the id of a team. When a team ID is provided as the owner, all members of that team will have equal access to the grid. Note: If a team ID is provided, the creator of the grid must be a member of the team.