Module: data_sheet

Enumeration: DefinitionType

TEXT	1
NUMBER	2

Enumeration: DataSheetSetOrderBy

TITLE	1
LAST_UPDATED_AT	2
CREATED_AT	3

Enumeration: DataSheetOrderBy

TITLE	1
LAST_UPDATED_AT	2

Union: DataSheetValue

Key	Field	Type	Description	Requiredness	Default value
1	nullValue	string	Representing the default empty holder, can be customized	default
2	text	string		default
3	number	common.PreciseNumber		default

Struct: DataSheetDefinition

Key	Field	Type	Description	Requiredness	Default value
1	id	common.UUID		default
2	createdAt	common.TimeInSecs		default
3	updatedAt	common.TimeInSecs		default
4	archivedAt	common.TimeInSecs		default
5	name	string		default
6	position	i32		default
7	type	DefinitionType		default
8	sheetValues	map<common.UUID, DataSheetValue>	Map of data sheet id -> data sheet value Used to populate existing data sheet values for a new definition	optional
9	archiveErr	common.SystemException	Is set when the checkArchiveId action is used on DefinitionOps and cannot be archived with this error	optional

Union: DataSheetDefinitionAction

Key	Field	Type	Description	Requiredness	Default value
1	add	DataSheetDefinition		default
2	update	DataSheetDefinition		default
3	getId	common.UUID		default
4	archiveId	common.UUID		default
5	unarchiveId	common.UUID		default
6	checkArchiveId	common.UUID	Checks to see if a definition can be archived (not used on a planned template) Sets the optional canArchive on the returned DataSheetDefinition	default

Struct: DataSheet

Key	Field	Type	Description	Requiredness	Default value
1	id	common.UUID		default
2	createdAt	common.TimeInSecs		default
3	updatedAt	common.TimeInSecs		default
4	archivedAt	common.TimeInSecs		default
5	name	string		default
6	description	string		default
7	lastAuthor	user.UserModular	Includes editing any content under the sheet	optional
8	idValues	map<common.UUID, DataSheetValue>	Map of definition id -> data sheet value Any missing definition ids are treated as having a "null" value Values are automatically removed if corresponding definitions are archived	optional

Union: DataSheetAction

Key	Field	Type	Description	Requiredness	Default value
1	add	DataSheet		default
2	update	DataSheet	Can update multiple values at once	default
3	getId	common.UUID		default
4	archiveId	common.UUID		default
5	unarchiveId	common.UUID		default

Struct: DataSheetSet

Key	Field	Type	Description	Requiredness	Default value
1	id	common.UUID		default
2	createdAt	common.TimeInSecs		default
3	updatedAt	common.TimeInSecs		default
4	archivedAt	common.TimeInSecs		default
5	name	string		default
6	description	string		default
7	lastAuthor	user.UserModular	Includes editing any content under the set	optional
8	definitions	list<DataSheetDefinition>	Can be re-ordered	optional
9	sheets	list<DataSheet>		optional
10	activeSheetCount	i32		optional
11	archivedSheetCount	i32		optional
12	attributes	list<abac.AbacAttribute>		optional

Struct: DataSheetSetOrder

Key	Field	Type	Description	Requiredness	Default value
1	field	DataSheetSetOrderBy		default
2	asc	bool		default	true

Struct: DataSheetSetOptions

Key	Field	Type	Description	Requiredness	Default value
1	showArchived	bool	Default to active sets only	optional
2	onlyArchived	bool	Show only the archived sets	optional
3	lastUpdatedAt	common.TimeInSecs	Only get sets modified after this timestamp	optional
4	title	string	Search for sets that contain this title	optional
20	pageReq	common.PageReq		optional
30	order	list<DataSheetSetOrder>	Default is by most recent edit	optional

Struct: DataSheetSetSelectOptions

Key	Field	Type	Description	Requiredness	Default value
1	includeDefinitions	bool	Includes active definition list	default	true
2	includeSheets	bool	Includes active data sheet list	default	true
3	sheetPageSize	i32	Includes only the first X sheets, 0 = all	default	0
4	includeActiveSheetCount	bool	Includes active sheet count	default	true
5	includeArchivedSheetCount	bool	Includes archived sheet count	default	true
6	definitionTitle	string	Includes only definitions that contain this title	optional
7	definitionTypes	list<DefinitionType>	Includes only these definition types, if not set, includes all	optional
8	includeAttributes	bool		default

Struct: DataSheetSetQueryResult

Key	Field	Type	Description	Requiredness	Default value
1	sets	list<DataSheetSet>		default
2	pageInfo	common.PageInfo		optional

Struct: DataSheetOrder

Key	Field	Type	Description	Requiredness	Default value
1	field	DataSheetOrderBy		default
2	asc	bool		default	true

Struct: DataSheetOptions

Key	Field	Type	Description	Requiredness	Default value
1	showArchived	bool	Default to active sheets only	optional
2	onlyArchived	bool	Show only the archived sheets	optional
3	title	string	Search for sheets that contain this title	optional
20	pageReq	common.PageReq		optional
30	order	list<DataSheetOrder>	Default is by most recent edit	optional

Struct: DataSheetQueryResult

Key	Field	Type	Description	Requiredness	Default value
1	sheets	list<DataSheet>		default
2	pageInfo	common.PageInfo		optional

Function: DataSheetService.querySets

DataSheetSetQueryResult querySets(common.UUID teamId,
                                  DataSheetSetOptions opts,
                                  DataSheetSetSelectOptions selectOpts)
    throws common.SystemException

Query data sheet sets on a team

Function: DataSheetService.createSet

DataSheetSet createSet(common.UUID teamId,
                       DataSheetSet dsSet,
                       list<abac.AbacAttribute> attributes)
    throws common.SystemException

Create a new data sheet set on a team (subject to max limit)
Can only create a data sheet set with name and description
Use definitionOps or sheetOps for other creations

Function: DataSheetService.updateSet

DataSheetSet updateSet(common.UUID dsSetId,
                       DataSheetSet dsSet)
    throws common.SystemException

Update a single data sheet set
Can only update name and description
Use definitionOps or sheetOps for other updates

Function: DataSheetService.getSet

DataSheetSet getSet(common.UUID dsSetId,
                    DataSheetSetSelectOptions selectOpts)
    throws common.SystemException

Get a single data sheet set
Use querySheets to list data sheets under this set

Function: DataSheetService.archiveSet

DataSheetSet archiveSet(common.UUID dsSetId)
    throws common.SystemException

Archive a single data sheet set

Function: DataSheetService.unarchiveSet

DataSheetSet unarchiveSet(common.UUID dsSetId)
    throws common.SystemException

Unarchive a single data sheet set (subject to max limit)

Function: DataSheetService.definitionOps

list<DataSheetDefinition> definitionOps(common.UUID dsSetId,
                                        list<DataSheetDefinitionAction> defActions)
    throws common.SystemException

Add/update/move/get/archive/unarchive data sheet definitions on an existing data sheet set (subject to max limit)
position = -1 appends to the end of the current list
Positions are applied in the order of the list, final positions depend on prior updates
Returns the updated definitions in the order passed in.

Function: DataSheetService.sheetOps

list<DataSheet> sheetOps(common.UUID dsSetId,
                         list<DataSheetAction> sheetActions)
    throws common.SystemException

Add/update/get/archive/unarchive data sheets on an existing data sheet set (subject to max limit)
Returns the updated sheets in the order passed in.

Function: DataSheetService.querySheets

DataSheetQueryResult querySheets(common.UUID dsSetId,
                                 DataSheetOptions opts)
    throws common.SystemException

Query data sheets on a data sheet set

Function: DataSheetService.updateAttribute

list<abac.AbacAttribute> updateAttribute(common.UUID dataSheetId,
                                         string attributeId,
                                         list<abac.AbacAttributeValue> values,
                                         abac.AbacUploadBehaviour behave)
    throws common.SystemException

Update a single attribute on a data sheet return value will always be a list with a single attribute determined by which attribute was updated param dataSheetId: data sheet to update param attributeId: the AttributeId of the team level attribute to be updated param values: the new AttributeValues to associated with Attribute attributeId on data sheet dataSheetId param behave: determine the behaviour of the endpoint, merge or clobber. Default: clobber