ModelEditor

[POST] /api/models/{id}/draft/validate

Validates draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.

Response

Status Code: 200

Success

ValidationResult

[POST] /api/models/{id}/draft/save

Saves the current draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.

Response

Status Code: 200

Success

[POST] /api/models/{id}/draft/discard

Discards the current draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.

Response

Status Code: 200

Success

[POST] /api/models/{id}/draft/discardonlymemory

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.

Response

Status Code: 200

Success

[POST] /api/models/{id}/draft/publish

Publish the draft and update the model. The version of model will be updated incrementally.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
comment	string	query	The comment added on updating model.

Response

Status Code: 200

Success

[GET] /api/models/{id}/draft/reference

Get names of documents referencing the specified model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.

Response

Status Code: 200

Success

Array<string>

[POST] /api/models/{id}/draft/entities

Add an entity into the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.

Request Schema

NewEntityContract

Response

Status Code: 200

Success

CreateResponse

[GET] /api/models/{id}/draft/entities/{entityId}

Update the specified entity of draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Response

Status Code: 200

Success

EntityContract

[PUT] /api/models/{id}/draft/entities/{entityId}

Add a new entity to the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Request Schema

UpdateEntityContract

Response

Status Code: 200

Success

[DELETE] /api/models/{id}/draft/entities/{entityId}

Delete the specified entity from the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Response

Status Code: 200

Success

[GET] /api/models/{id}/draft/entities/{entityId}/attributes

Get attributes of specified entities from the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Response

Status Code: 200

Success

AttributeContract

[POST] /api/models/{id}/draft/entities/{entityId}/attributes

Add an attribute to a specified entity of the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Request Schema

NewAttributeContract

Response

Status Code: 200

Success

CreateResponse

[GET] /api/models/{id}/draft/entities/{entityId}/attributes/{attributeId}

Get specified attribute from a specified entity of the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
attributeIdRequired	string	path	The attribute id.

Response

Status Code: 200

Success

AttributeContract

[PUT] /api/models/{id}/draft/entities/{entityId}/attributes/{attributeId}

Update the specified attribute belonging to specified entity of the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
attributeIdRequired	string	path	The attribute id.

Request Schema

UpdateAttributeContract

Response

Status Code: 200

Success

[DELETE] /api/models/{id}/draft/entities/{entityId}/attributes/{attributeId}

Delete the specified attribute of specified entity from the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
attributeIdRequired	string	path	The attribute id.

Response

Status Code: 200

Success

[POST] /api/models/{id}/draft/entities/{entityId}/attributes/{attributeId}/regenerate

Regenerates variation attributes for specified attribute of specified entity in the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
attributeIdRequired	string	path	The attribute id.

Response

Status Code: 200

Success

AttributeContract

[GET] /api/models/{id}/draft/entities/{entityId}/relations

Get relations of the specified entity from a draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Response

Status Code: 200

Success

RelationContract

[POST] /api/models/{id}/draft/entities/{entityId}/relations

Creates a relation based on specified entity in a draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Request Schema

NewRelationContract

Response

Status Code: 200

Success

CreateResponse

[GET] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}

Get specified relation on specified entity in the current draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
relationIdRequired	string	path	The relation id.

Response

Status Code: 200

Success

RelationContract

[PUT] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}

Update the specified relation of a specified entity in the current draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
relationIdRequired	string	path	The relation id.

Request Schema

UpdateRelationContract

Response

Status Code: 200

Success

[DELETE] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}

Delete specified relation of specified entity from the current draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
relationIdRequired	string	path	The relation id.

Response

Status Code: 200

Success

[GET] /api/models/{id}/draft/properties

Get the properties of the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.

Response

Status Code: 200

Success

ModelProperties

[PUT] /api/models/{id}/draft/properties

Update the properties of the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.

Request Schema

ModelProperties

Response

Status Code: 200

Success

[GET] /api/models/{id}/draft/entities/{entityId}/columns

Get columns from the specified entity in the current draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Response

Status Code: 200

Success

ColumnContract

[PUT] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}/binding

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
relationIdRequired	string	path	The relation id.

Request Schema

WynSaveRoleBindingRelationContract

Response

Status Code: 200

Success

[PUT] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}/userdefined

Update the specified relation from specified entity in the current draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
relationIdRequired	string	path	The relation id.

Request Schema

WynSaveRoleRelationsContract

Response

Status Code: 200

Success

[GET] /api/models/{id}/draft/entities/{entityId}/attributes/tree

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
path	string	query
type	AttributeTreeType	query

Response

Status Code: 200

Success

EntityTreeContract

[POST] /api/models/{id}/draft/entities/{entityId}/attributes/related

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Request Schema

WynAddAttributeFromRelatedAttributeContract

Response

Status Code: 200

Success

Array<string>

[POST] /api/models/{id}/draft/entities/{entityId}/attributes/datafield

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Request Schema

WynAddAttributeFromDataFieldContract

Response

Status Code: 200

Success

uuid

[PUT] /api/models/{id}/draft/entities/{entityId}/attributes/expression

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Request Schema

WynSaveAttributeFromSQLExpressionContract

Response

Status Code: 200

Success

[GET] /api/models/{id}/draft/entities/{entityId}/attributes/validation

Validate the attributes of the specified entity.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
expression	string	query	The SQL expression.

Response

Status Code: 200

Success

[GET] /api/models/{id}/draft/entities/{entityId}/attributes/schema

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
expression	string	query	The SQL expression.

Response

Status Code: 200

Success

ExpressionResultsetSchemaContract

[GET] /api/models/{id}/draft/entities/{entityId}/attributes/preview

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
expression	string	query	The SQL expression.

Response

Status Code: 200

Success

ExpressionResultsetSchemaContract

[GET] /api/models/usercontext

Response

Status Code: 200

Success

Array<string>

[GET] /api/models/{id}/draft/sources

Parameters

Name	Type	Located In	Description
idRequired	string	path

Response

Status Code: 200

Success

EntitySourceContract

[GET] /api/models/{id}/draft/usercontextkeys

Parameters

Name	Type	Located In	Description
idRequired	string	path

Response

Status Code: 200

Success

Array<string>

[GET] /api/models/{id}/draft/entities/{entityId}/securityfilter

Get the security filters applied on the specified entity in the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Response

Status Code: 200

Success

SecurityFilterInfo

[DELETE] /api/models/{id}/draft/entities/{entityId}/securityfilter

Delete the security filters applied on the specified entity in the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
removeAll	Boolean	query	Remove the security filter.

Response

Status Code: 200

Success

[PUT] /api/models/{id}/draft/entities/{entityId}/securityfilter

Update the security filters applied on the specified entity in the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Request Schema

SaveSecurityFilterContract

Response

Status Code: 200

Success

[GET] /api/models/{id}/draft/entities/{entityId}/securityfilter/refcount

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Response

Status Code: 200

Success

int32

[GET] /api/models/{id}/draft/procedures/{binding}/parameters/{parameterName}/values

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
bindingRequired	string	path	The database object that the attribute represents.
parameterNameRequired	string	path	The parameter name.
path	string	query

Response

Status Code: 200

Success

EntityTreeContract

[GET] /api/models/{id}/draft/attributes/{attributeId}/dbvalues

Parameters

Name	Type	Located In	Description
idRequired	string	path
attributeIdRequired	string	path

Response

Status Code: 200

Success

ParameterValueContract

[GET] /api/models/{id}/draft/entities/{entityId}/attributes/list

Get the list of attributes for the specified entity.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
canDelete	Boolean	query
aggregatesOnly	Boolean	query

Response

Status Code: 200

Success

AttributeListContract

[GET] /api/models/{id}/draft/entities/{entityId}/securityfilter/shareinfo

Parameters

Name	Type	Located In	Description
idRequired	string	path
entityIdRequired	string	path

Response

Status Code: 200

Success

SharedSecurityFilterInfo

[GET] /api/models/{id}/draft/entities/{entityId}/securityfilter/display

Display the security filter for the specified entity in the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.

Response

Status Code: 200

Success

SecurityFilterDisplayInfo

[GET] /api/models/{id}/draft/entities/relationships

List the relationships between the entities.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
path	string	query

Response

Status Code: 200

Success

EntityRelationshipContract

[GET] /api/models/{id}/draft/entities/{entityId}/attributes/{attributeId}/formats

Describes the format for the specified attribute of the entity.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
attributeIdRequired	string	path	The attribute id.

Response

Status Code: 200

Success

AttributeFormatsContract

[GET] /api/models/{id}/draft/entities/{entityId}/parameters

Parameters

Name	Type	Located In	Description
idRequired	string	path
entityIdRequired	string	path

Response

Status Code: 200

Success

EntityProcedureUiParameter

[GET] /api/models/{id}/draft/entities/{entityId}/relationentities

Parameters

Name	Type	Located In	Description
idRequired	string	path
entityIdRequired	string	path

Response

Status Code: 200

Success

RelationEntityDescription

[POST] /api/models/{id}/draft/entities/validation

Validate the entities in the darft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.

Request Schema

NewEntityContract

Response

Status Code: 200

Success

[POST] /api/models/{id}/draft/entities/schema

Get the database schema for the entities in the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.

Request Schema

NewEntityContract

Response

Status Code: 200

Success

ExpressionResultsetSchemaContract

[POST] /api/models/{id}/draft/entities/preview

Preview the entities in the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.

Request Schema

NewEntityContract

Response

Status Code: 200

Success

ExpressionResultsetSchemaContract

[GET] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}/cardinalities

Gte the cardinality for the specified relationship of an entity.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
entityIdRequired	string	path	The entity id.
relationIdRequired	string	path	The relation id.

Response

Status Code: 200

Success

Cardinality

[GET] /api/models/{id}/draft/attributes/{attributeId}/verify/{format}

Verify the format of the specified attribute.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The model document id.
attributeIdRequired	string	path	The attribute id.
formatRequired	string	path	The attribute format.

Response

Status Code: 200

Success

Models

Ƭ ValidationResult

Name	Type	Description	Example
messagesNullable	Message
status	ValidationStatus

Ƭ Message

Name	Type	Description	Example
textNullable	string
codeNullable	string
messageType	MessageType
dataNullable	Array<string>

Ƭ ValidationStatus

Enum:

• Success
• Warning
• Error

Ƭ MessageType

Enum:

• Message
• Warning
• Error

Ƭ CreateResponse

Name	Type	Description	Example
idNullable	string

Ƭ NewEntityContract

Name	Type	Description	Example
bindingType	TableType
bindingNullable	string
queryNullable	string
parametersNullable	ParameterContract
nameNullable	string
descriptionNullable	string

Ƭ TableType

Enum:

• Table
• View
• Query
• SystemTable
• SystemView
• Function
• StoredProcedure

Ƭ ParameterContract

Name	Type	Description	Example
nameNullable	string
value	ValueContract
promptDescription	PromptContract

Ƭ ValueContract

Name	Type	Description	Example
stringValueNullable	string
isSpecial	Boolean

Ƭ PromptContract

Name	Type	Description	Example
promptNullable	string
defaultValue	ParameterValueContract
validValuesDomain	ParameterValidValuesDomain
validValuesNullable	ParameterValueContract
attributeReference	AttributeReferenceContract
allowNull	Boolean

Ƭ ParameterValueContract

Name	Type	Description	Example
value	ValueContract
labelNullable	string

Ƭ ParameterValidValuesDomain

Enum:

• AnyValue
• FromTheDatabase
• FromAList

Ƭ AttributeReferenceContract

Name	Type	Description	Example
pathNullable	string

Ƭ EntityContract

Name	Type	Description	Example
id	string
bindingNullable	string
collectionNameNullable	string
queryNullable	string
hidden	Boolean
collapseInRelations	Boolean
securityFilter	SecurityFilterContract
defaultAggregateAttributesNullable	Array<string>
defaultDetailAttributesNullable	Array<string>
identifyingAttributesNullable	Array<string>
nameNullable	string
descriptionNullable	string

Ƭ SecurityFilterContract

Name	Type	Description	Example
id	string
filterNameNullable	string
existingFilterPathNullable	string
attributePathNullable	string
expressionNullable	string
operationNullable	string

Ƭ UpdateEntityContract

Name	Type	Description	Example
collectionNameNullable	string
hidden	Boolean
collapseInRelations	Boolean
securityFilter	UpdateSecurityFilterContract
defaultAggregateAttributesNullable	Array<string>
defaultDetailAttributesNullable	Array<string>
identifyingAttributesNullable	Array<string>
parametersNullable	ParameterContract
nameNullable	string
descriptionNullable	string

Ƭ UpdateSecurityFilterContract

Name	Type	Description	Example
filterNameNullable	string
existingFilterPathNullable	string
attributePathNullable	string
expressionNullable	string
operationNullable	string

Ƭ AttributeContract

Name	Type	Description	Example
id	string
bindingNullable	string
dataType	DataType
logicalDataType	LogicalDataType
formatNullable	string
discourageGrouping	Boolean
hidden	Boolean
isAggregate	Boolean
nullable	Boolean
supportsBlank	Boolean
supportsNull	Boolean
valueSelection	ValueSelection
variationOfNullable	string
expressionNullable	string
variationsNullable	AttributeContract
expressionTextNullable	string
nameNullable	string
descriptionNullable	string

Ƭ DataType

Enum:

• Null
• DateTime
• Float
• Decimal
• Integer
• Boolean
• String
• Binary
• All
• EntityKey

Ƭ LogicalDataType

Enum:

• Null
• DateTime
• Date

Ƭ ValueSelection

Enum:

• None
• Dropdown
• List

Ƭ NewAttributeContract

Name	Type	Description	Example
expressionNullable	string
attributeType	AttributeType
nameNullable	string
descriptionNullable	string

Ƭ AttributeType

Enum:

• DatabaseColumn
• RelatedEntity
• Expression

Ƭ UpdateAttributeContract

Name	Type	Description	Example
formatNullable	string
valueSelection	ValueSelection
discourageGroupingNullable	Boolean
hiddenNullable	Boolean
isAggregateNullable	Boolean
nullableNullable	Boolean
supportsNullNullable	Boolean
supportsBlankNullable	Boolean
expressionTextNullable	string
logicalDataType	LogicalDataType
nameNullable	string
descriptionNullable	string

Ƭ RelationContract

Name	Type	Description	Example
id	string
bindingNullable	string
cardinality	Cardinality
isLogical	Boolean
hidden	Boolean
recursive	Boolean
includeSelf	Boolean
hiddenFieldsNullable	Array<string>
sourceEntityId	string
sourceColumnsNullable	Array<string>
targetEntityId	string
targetColumnsNullable	Array<string>
nameNullable	string
descriptionNullable	string

Ƭ Cardinality

Enum:

• One
• Many
• OptionalOne
• OptionalMany

Ƭ NewRelationContract

Name	Type	Description	Example
bindingNullable	string
sourceColumnsNullable	Array<string>
targetEntityIdNullable	string
targetColumnsNullable	Array<string>
nameNullable	string
descriptionNullable	string

Ƭ UpdateRelationContract

Name	Type	Description	Example
cardinality	Cardinality
hiddenNullable	Boolean
recursiveNullable	Boolean
includeSelfNullable	Boolean
hiddenFieldsNullable	Array<string>
nameNullable	string
descriptionNullable	string

Ƭ ModelProperties

Name	Type	Description	Example
connectionStringNullable	string
commandTimeoutNullable	int32

Ƭ ColumnContract

Name	Type	Description	Example
nameNullable	string
dbNameNullable	string
isExpression	Boolean

Ƭ WynSaveRoleBindingRelationContract

Name	Type	Description	Example
bindingNullable	string
targetEntityId	string
nameNullable	string
descriptionNullable	string

Ƭ WynSaveRoleRelationsContract

Name	Type	Description	Example
sourceColumnsNullable	Array<string>
targetEntityId	string
targetColumnsNullable	Array<string>
nameNullable	string
descriptionNullable	string

Ƭ AttributeTreeType

Enum:

• AllAttributes
• SecurityFilterAvailableAttributes
• ExistingSecurityFilters

Ƭ EntityTreeContract

Name	Type	Description	Example
itemsNullable	EntityTreeElement

Ƭ EntityTreeElement

Name	Type	Description	Example
dataNullable	string
stateNullable	string
attribute	EntityTreeElementAttribute
childrenNullable	EntityTreeElement

Ƭ EntityTreeElementAttribute

Name	Type	Description	Example
typeNullable	string
idNullable	string
pathNullable	string
nameNullable	string
cssClassNullable	string

Ƭ WynAddAttributeFromRelatedAttributeContract

Name	Type	Description	Example
bindingsPathNullable	string
nameNullable	string
descriptionNullable	string

Ƭ WynAddAttributeFromDataFieldContract

Name	Type	Description	Example
nameNullable	string
descriptionNullable	string
expressionNullable	string

Ƭ WynSaveAttributeFromSQLExpressionContract

Name	Type	Description	Example
attributeId	string
nameNullable	string
descriptionNullable	string
expressionNullable	string

Ƭ ExpressionResultsetSchemaContract

Name	Type	Description	Example
headRow	ExpressionResultsetSchemaHeadRow
dataRowsNullable	ExpressionResultsetSchemaDataRow

Ƭ ExpressionResultsetSchemaHeadRow

Name	Type	Description	Example
headCellsNullable	Array<string>

Ƭ ExpressionResultsetSchemaDataRow

Name	Type	Description	Example
valueCellsNullable	Array<string>

Ƭ EntitySourceContract

Name	Type	Description	Example
friendlyNameNullable	string
bindingNullable	string
type	TableType
descriptionNullable	string
isRestricted	Boolean

Ƭ SecurityFilterInfo

Name	Type	Description	Example
filterNameNullable	string
attributeIdNullable	string
attributeNameNullable	string
existingAttributeIdNullable	string
existingAttributeNameNullable	string
functionNameNullable	string
userContextKeyNullable	string
refCounterMessageNullable	string
isNewFilter	Boolean

Ƭ SaveSecurityFilterContract

Name	Type	Description	Example
filterNameNullable	string
attributeIdNullable	string
functionNameNullable	string
userContextKeyNullable	string

Ƭ AttributeListContract

Name	Type	Description	Example
entriesNullable	AttributeListEntry
isDeletePermitted	Boolean
isAggregatesOnly	Boolean

Ƭ AttributeListEntry

Name	Type	Description	Example
id	string
nameNullable	string
withVariations	Boolean
variationsNullable	AttributeListEntryVariation
dataTypeNullable	string
typeNullable	string
isLogicalColumn	Boolean
isHidden	Boolean
isSelectable	Boolean
errorDescriptionNullable	string

Ƭ AttributeListEntryVariation

Name	Type	Description	Example
id	string
nameNullable	string
dataTypeNullable	string
typeNullable	string
isSelectable	Boolean
isHidden	Boolean

Ƭ SharedSecurityFilterInfo

Name	Type	Description	Example
mode	SharedSecurityFilterMode
referencedEntityNamesNullable	Array<string>

Ƭ SharedSecurityFilterMode

Enum:

• NoRefs
• WithRefs

Ƭ SecurityFilterDisplayInfo

Name	Type	Description	Example
sourceEntityId	string
sourceEntityNameNullable	string
sourceSecurityFilterId	string
sourceSecurityFilterDisplayTextNullable	string
isForeignSecurityFilter	Boolean

Ƭ EntityRelationshipContract

Name	Type	Description	Example
baseEntityId	string
relatedEntitiesNullable	EntityRelationshipNode

Ƭ EntityRelationshipNode

Name	Type	Description	Example
entityId	string
isAggregatesOnly	Boolean
textNullable	string
pathNullable	string
isHidden	Boolean
hasManyChildren	Boolean

Ƭ AttributeFormatsContract

Name	Type	Description	Example
isFixedFormat	Boolean
availableFormatsNullable	AttributeFormatMapping

Ƭ AttributeFormatMapping

Name	Type	Description	Example
displayStringNullable	string
formatStringNullable	string

Ƭ EntityProcedureUiParameter

Name	Type	Description	Example
nameNullable	string
isSpecial	Boolean
valueNullable	string
promptNullable	string
defaultValue	EntityProcedureUiParameterValue
validValuesDomain	EntityProcedureUiParameterValidValuesDomain
validValuesNullable	EntityProcedureUiParameterValue
attributeReference	EntityProcedureUiAtributeReference
allowNull	Boolean

Ƭ EntityProcedureUiParameterValue

Name	Type	Description	Example
valueNullable	string
labelNullable	string
isSpecial	Boolean

Ƭ EntityProcedureUiParameterValidValuesDomain

Enum:

• AnyValue
• FromTheDatabase
• FromAList

Ƭ EntityProcedureUiAtributeReference

Name	Type	Description	Example
nameNullable	string
pathNullable	string
valuesNullable	EntityProcedureUiParameterValue

Ƭ RelationEntityDescription

Name	Type	Description	Example
bindingNullable	string
entityNullable	string
entityId	string
actAsNullable	string
descriptionNullable	string