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

Download Open API Spec

GridSession

org.sagebionetworks.repo.model.grid.GridSession

Basic information about a grid session.

Field Type Description
sessionId STRING The unique sessionId that identifies the grid session.
startedBy STRING The user that started this session.
startedOn STRING The date-time when the session was started.
etag STRING Changes when the session chagnes.
modifiedOn STRING The date-time when the session was last changed.
lastReplicaIdClient INTEGER The last replica ID issued to a client. Client replica IDs are incremented.
lastReplicaIdService INTEGER The last replica ID issued to a service. Service replica IDs are decremented.
gridJsonSchema$Id STRING The $id of the JSON schema that will be used for model validation in this grid session.
sourceEntityId STRING The synId of the table/view/csv that this grid was cloned from.
ownerPrincipalId STRING The principal ID (user or team) that owns this grid session. If the owner is a user, only that user can access the grid. If the owner is a team, all members of that team have equal access to the grid.
authorizationMode AuthorizationMode Defines the authorization mode used to gate access to a grid session. The mode is set at session creation time and cannot be changed. It controls both who may join the session (create a replica) and which rows are included in the session's initial snapshot. SESSION_OWNER (default): Access is determined by the session owner. Only the owner (or members of the owner's team) may join. When the source is a view, the snapshot includes rows that the owner has access to; non-owner members see data through the owner's access scope. SOURCE_BENEFACTOR: Access is determined by EDIT access on the source entity's benefactor(s). At session creation the set of benefactor IDs that the creating user (the 'action user') has EDIT access on is captured and stored on the session. Any user who has EDIT access on all of those captured benefactors may join the session and see all rows in the snapshot. This mode is useful when a project administrator wants all editors of a project to be able to collaborate on a grid, without needing to manage a separate owner team.