DependentWorkSpaceQueryDTO

QueryDTO to retrieve a dependent WorkSpace. If no masterWorkSpaceMetaData is passed, a newWorkSpace will be created using the given master entity and pk. To access a master WorkSpacethat was already created in this session, it is required to pass the masterWorkSpaceMetaData.

Sub Type Property: "_type" : "DEPENDENT_WS"

Fields

Type
Name
Description
Optional
Default Value
String  
masterEntity
The master entity.
false
 
String  
masterPk
The pk of the master entry.
false
 
String  
relation
The relation name.
false
 
WorkSpaceMetaDataDTO  
masterWorkSpaceMetaData
The metaData of the master WorkSpace (may be null).
true
null
List
String
additionalPks
The List of entry pks to be included in the dependent workspace.
true
null
List
SearchOrderEntryDTO
searchOrderBy
Definition of how the server side search result will be sorted.
true
null
List
SearchOrderEntryDTO
viewOrderBy
Definition of how the view of the result will be sorted.
true
null
Boolean  
useDistinct
Flag to enable/disable a distinct search.
true
false

Example

{
	"_type" : "DEPENDENT_WS",
	"searchOrderBy" : null,
	"viewOrderBy" : [
		{
			"field" : "<fieldNameToSortBy>",
			"sort" : "DESCENDING"
		}
	],
	"useDistinct" : null,
	"topCount" : null,
	"masterEntity" : "ContactPerson",
	"masterPk" : "alskan0213zvbasjCoPe",
	"relation" : "rCoPeAc",
	"masterWorkSpaceMetaData" : {
		"id" : "poh1i2uh36vasContactPerson",
		"entity" : "ContactPerson",
		"insertAllowed" : true,
		"removeAllowed" : true,
		"linkable" : true,
		"roleWorkSpace" : true,
		"parent" : null,
		"createDate" : "2025-12-12T22:32:06+00:00"
	},
	"additionalPks" : [
		"nkg0r11f4ooq3fmAc"
	]
}