Rest Documentation

Sub Type Property: "#{type-subtype-property}" : "#{type-subtype-name}"

Type

Name

Description

Optional

Default Value

#{template-fields}

Name

Description

#{template-values}

Sub Type

Description

Sub Type Property: "_type"

SearchByPlainkeyQueryDTO

QueryDTO to execute a search by plainkey.

PLAINKEY

SearchByPksQueryDTO

QueryDTO to search entries with the given entity name and pks.

PK

SearchByLinkQueryDTO

QueryDTO to execute the given search link.

LINK

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.

DEPENDENT_WS

LoadEntriesQueryDTO

QueryDTO to access the WorkSpace with the given Id to retrieve the entries with the given pks.

LOAD

LuceneResultQueryDTO

QueryDTO to extract the results of a single entity from an existing lucene result.

LUCENE

ExtendedSearchQueryDTO

QueryDTO to execute a search by its JSON representation.

SEARCH

GetElementsQueryDTO

QueryDTO to get elements from the WorkSpace with the given Id.