ModelEditor

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

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

ValidationResult

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
comment	query	string

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

Array<string>

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

NewEntityContract

Responses

[200] Success

CreateResponse

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

EntityContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

UpdateEntityContract

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

AttributeContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

NewAttributeContract

Responses

[200] Success

CreateResponse

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
attributeIdRequired	path	string

Responses

[200] Success

AttributeContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
attributeIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

UpdateAttributeContract

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
attributeIdRequired	path	string

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
attributeIdRequired	path	string

Responses

[200] Success

AttributeContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

RelationContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

NewRelationContract

Responses

[200] Success

CreateResponse

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
relationIdRequired	path	string

Responses

[200] Success

RelationContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
relationIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

UpdateRelationContract

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
relationIdRequired	path	string

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

ModelProperties

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ModelProperties

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

ColumnContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

NewEntityContract

Responses

[200] Success

ColumnContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
relationIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

WynSaveRoleBindingRelationContract

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
relationIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

WynSaveRoleRelationsContract

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
path	query	string
type	query

Responses

[200] Success

EntityTreeContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

WynAddAttributeFromRelatedAttributeContract

Responses

[200] Success

Array<string>

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

WynAddAttributeFromDataFieldContract

Responses

[200] Success

uuid

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

WynSaveAttributeFromSQLExpressionContract

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
expression	query	string

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
expression	query	string

Responses

[200] Success

ExpressionResultsetSchemaContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
expression	query	string

Responses

[200] Success

ExpressionResultsetSchemaContract

Type: [text/plain], [application/json], [text/json]

[GET] /api/models/usercontext

Responses

[200] Success

Array<string>

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

EntitySourceContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

Array<string>

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

SecurityFilterInfo

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
removeAll	query	boolean

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

SaveSecurityFilterContract

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

int32

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
bindingRequired	path	string
parameterNameRequired	path	string
path	query	string

Responses

[200] Success

EntityTreeContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
attributeIdRequired	path	string

Responses

[200] Success

ParameterValueContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
canDelete	query	boolean
aggregatesOnly	query	boolean

Responses

[200] Success

AttributeListContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

SharedSecurityFilterInfo

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

SecurityFilterDisplayInfo

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
path	query	string

Responses

[200] Success

EntityRelationshipContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
attributeIdRequired	path	string

Responses

[200] Success

AttributeFormatsContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

EntityProcedureUiParameter

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

RelationEntityDescription

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

NewEntityContract

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

NewEntityContract

Responses

[200] Success

ExpressionResultsetSchemaContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

NewEntityContract

Responses

[200] Success

ExpressionResultsetSchemaContract

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string
relationIdRequired	path	string

Responses

[200] Success

Cardinality

Type: [text/plain], [application/json], [text/json]

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

Parameters

Name	In	Type
idRequired	path	string
attributeIdRequired	path	string
formatRequired	path	string

Responses

[200] Success

Models

Ƭ ValidationResult

Represent a samantic model validation result.

Name	Type	Description
messagesNullable	Array<Message>	Validation messages.
status	ValidationStatus

Ƭ Message

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

Ƭ ValidationStatus

Enum:

• Success

• Warning

• Error

  Represent validation status.

Ƭ MessageType

Enum:

• Message
• Warning
• Error

Ƭ CreateResponse

Represent a create response model.

Name	Type	Description
idNullable	string	Created id.

Ƭ NewEntityContract

Represent a new entity contract.

Name	Type	Description
bindingTypeRequired	TableType
bindingNullable	string	Entity binding.
queryNullable	string	Entity query.
parametersNullable	Array<ParameterContract>	Entity parameters.
nameNullable	string
descriptionNullable	string

Ƭ TableType

Enum:

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

Ƭ ParameterContract

Entity paremater contract.

Name	Type	Description
nameNullable	string	Entity parameter name.
value	ValueContract
promptDescription	PromptContract

Ƭ ValueContract

Represent entity parameter value contract.

Name	Type	Description
stringValueNullable	string	Entity parameter value.
isSpecial	Boolean	Entity parameter sprecial status.

Ƭ PromptContract

Entity parameter prompt contract.

Name	Type	Description
promptNullable	string	Entity parameter prompt.
defaultValue	ParameterValueContract
validValuesDomain	ParameterValidValuesDomain
validValuesNullable	Array<ParameterValueContract>	Entity parameter valied values.
attributeReference	AttributeReferenceContract
allowNull	Boolean	Represent whether the entity allow null.

Ƭ ParameterValueContract

Represent entity parameter value contract.

Name	Type	Description
value	ValueContract
labelNullable	string	Entity parmeter label.

Ƭ ParameterValidValuesDomain

Enum:

• AnyValue
• FromTheDatabase
• FromAList

Ƭ AttributeReferenceContract

Represent arrribute rederence contract.

Name	Type	Description
pathNullable	string	Arrribute reference path.

Ƭ EntityContract

Represent entity contract.

Name	Type	Description
id	string	Entity id.
bindingNullable	string	Entity binding.
collectionNameNullable	string	Entity collection name.
queryNullable	string	Entity query.
hidden	Boolean	Entity is hidden.
collapseInRelations	Boolean	Entity is collapse in relations.
securityFilter	SecurityFilterContract
defaultAggregateAttributesNullable	Array<string>	Entity default aggregate attributes.
defaultDetailAttributesNullable	Array<string>	Entity default detail attributes.
identifyingAttributesNullable	Array<string>	Entity identifying attributes.
nameNullable	string
descriptionNullable	string

Ƭ SecurityFilterContract

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

Ƭ UpdateEntityContract

Represent update entity contract.

Name	Type	Description
collectionNameNullable	string	Entity collection name.
hidden	Boolean	Entity is hidden.
collapseInRelations	Boolean	Entity is collapse in relations.
securityFilter	UpdateSecurityFilterContract
defaultAggregateAttributesNullable	Array<string>	Entity default aggregate attributes.
defaultDetailAttributesNullable	Array<string>	Entity default detail attributes.
identifyingAttributesNullable	Array<string>	Entity identifying attributes.
parametersNullable	Array<ParameterContract>	Entity parameters.
nameNullable	string
descriptionNullable	string

Ƭ UpdateSecurityFilterContract

Represent update security filter contract.

Name	Type	Description
filterNameNullable	string	Filter name.
existingFilterPathNullable	string	Existing filter path.
attributePathNullable	string	Attribute path.
expressionNullable	string	Expression.
operationNullable	string	Operation

Ƭ AttributeContract

Represent attribute contract.

Name	Type	Description
id	string	Attribute id.
bindingNullable	string	Attribute binding.
dataType	DataType
logicalDataType	LogicalDataType
formatNullable	string	Attribute format.
discourageGrouping	Boolean	Attribute discourage grouping.
hidden	Boolean	Attribute hidden.
isAggregate	Boolean	Attribute isAggregate.
nullable	Boolean	Attribute is nullable.
supportsBlank	Boolean	Attribute is supports blank.
supportsNull	Boolean	Attribute is supports null.
valueSelection	ValueSelection
variationOfNullable	string	Attribute variation of.
expressionNullable	string	Attribute expression.
variationsNullable	Array<AttributeContract>	Attribute variations.
expressionTextNullable	string	Attribute expression text.
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

Represent new attribute contract.

Name	Type	Description
expressionNullable	string	Attribute expression.
attributeType	AttributeType
nameNullable	string
descriptionNullable	string

Ƭ AttributeType

Enum:

• DatabaseColumn

• RelatedEntity

• Expression

  Represent attribute type.

Ƭ UpdateAttributeContract

Represent update attribute contract.

Name	Type	Description
formatNullable	string	Attribute format.
valueSelectionRequired	ValueSelection
discourageGroupingNullable	Boolean	Attribute discourage grouping.
hiddenNullable	Boolean	Attribute is hidden.
isAggregateNullable	Boolean	Attribute is aggregate.
nullableNullable	Boolean	Attribute is nullable.
supportsNullNullable	Boolean	Attribute is supports null.
supportsBlankNullable	Boolean	Attribute is supports blank.
expressionTextRequired	string	Attribute expression text.
logicalDataType	LogicalDataType
nameNullable	string
descriptionNullable	string

Ƭ RelationContract

Represent realtion contract.

Name	Type	Description
id	string	Relation id.
bindingNullable	string	Relation binding.
cardinality	Cardinality
isLogical	Boolean	Relation is logical.
hidden	Boolean	Relation is hidden.
recursive	Boolean	Relation is recursive
includeSelf	Boolean	Relation is included by self.
hiddenFieldsNullable	Array<string>	Relation hidden fields.
sourceEntityId	string	Relation source entity id.
sourceColumnsNullable	Array<string>	Relation source columns.
targetEntityId	string	Relation target entity id.
targetColumnsNullable	Array<string>	Relation taeget columns.
nameNullable	string
descriptionNullable	string

Ƭ Cardinality

Enum:

• One
• Many
• OptionalOne
• OptionalMany

Ƭ NewRelationContract

Represent new relation contact.

Name	Type	Description
bindingRequired	string	Relation binding.
sourceColumnsRequired	Array<string>	Relation source columns.
targetEntityIdRequired	string	Relation target entity id.
targetColumnsRequired	Array<string>	Relation target columns.
nameNullable	string
descriptionNullable	string

Ƭ UpdateRelationContract

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

Ƭ ModelProperties

Represent model properties.

Name	Type	Description
connectionStringRequired	string	Model connection string.
commandTimeoutNullable	int32	Model command timeout.

Ƭ ColumnContract

Specifies information about column to publish via the data source.

Name	Type	Description
nameNullable	string	Gets or sets a column name.
dbNameNullable	string	Gets or sets a DB column name.
isExpression	Boolean	Returns true if column is a custom expression.

Ƭ WynSaveRoleBindingRelationContract

Represent wyn save role binding relations contract.

Name	Type	Description
bindingNullable	string	Relation binding.
targetEntityId	string	Relation target entity id.
nameNullable	string
descriptionNullable	string

Ƭ WynSaveRoleRelationsContract

Represent wyn save role relations contract.

Name	Type	Description
sourceColumnsRequired	Array<string>	Relation source columns.
targetEntityIdRequired	string	Relation target entity id.
targetColumnsRequired	Array<string>	Relation targrt columns.
nameNullable	string
descriptionNullable	string

Ƭ AttributeTreeType

Enum:

• AllAttributes
• SecurityFilterAvailableAttributes
• ExistingSecurityFilters

Ƭ EntityTreeContract

Represent entity tree contract.

Name	Type	Description
itemsNullable	Array<EntityTreeElement>	Entity tree element list.

Ƭ EntityTreeElement

Represent entity tree element.

Name	Type	Description
dataNullable	string	Entity tree element data.
stateNullable	string	entity tree element state.
attribute	EntityTreeElementAttribute
childrenNullable	Array<EntityTreeElement>	Entity Tree element children.

Ƭ EntityTreeElementAttribute

Represent entity tree element attribute.

Name	Type	Description
typeNullable	string	Attribute type.
idNullable	string	Attribute id.
pathNullable	string	Attributr path.
nameNullable	string	Attribute name.
cssClassNullable	string	Attributr css class.

Ƭ WynAddAttributeFromRelatedAttributeContract

Represent wyn add attribute from related attribute contract.

Name	Type	Description
bindingsPathRequired	string	Attribute bindings path.
nameRequired	string	Attribute name.
descriptionNullable	string	Attribute description.

Ƭ WynAddAttributeFromDataFieldContract

Represent wyn add attribute from data field contract.

Name	Type	Description
nameRequired	string	Attribute name.
descriptionNullable	string	Attribute description.
expressionRequired	string	Attribute expression.

Ƭ WynSaveAttributeFromSQLExpressionContract

Represent wyn save attribute from sql expression contract.

Name	Type	Description
attributeId	string	Attribute id.
nameRequired	string	Attribute name.
descriptionNullable	string	Attribute description.
expressionRequired	string	Attributr expression.

Ƭ ExpressionResultsetSchemaContract

Represent entity data schema.

Name	Type	Description
headRow	ExpressionResultsetSchemaHeadRow
dataRowsNullable	Array<ExpressionResultsetSchemaDataRow>	Table content rows.

Ƭ ExpressionResultsetSchemaHeadRow

Table head row.

Name	Type	Description
headCellsNullable	Array<string>	Table head cells.

Ƭ ExpressionResultsetSchemaDataRow

Table content row.

Name	Type	Description
valueCellsNullable	Array<string>	Table content cells.

Ƭ EntitySourceContract

Represent entity source contract.

Name	Type	Description
friendlyNameNullable	string	Entity source friendly name.
bindingNullable	string	Entity source binding.
type	TableType
descriptionNullable	string	Entity source description.
isRestricted	Boolean	Entity source is restricted.

Ƭ SecurityFilterInfo

Represent security filter info.

Name	Type	Description
filterNameNullable	string	Filter name.
attributeIdNullable	string	Attribute id.
attributeNameNullable	string	Attributr name.
existingAttributeIdNullable	string	Existing attribute id.
existingAttributeNameNullable	string	Existing attribute name.
functionNameNullable	string	Function name.
userContextKeyNullable	string	user context key.
refCounterMessageNullable	string	Ref counter message.
isNewFilter	Boolean	Is new filter.

Ƭ SaveSecurityFilterContract

Represent save security filter contract.

Name	Type	Description
filterNameRequired	string	Security filter name.
attributeIdRequired	string	Security filter attribute id.
functionNameRequired	string	Security filter fuction name.
userContextKeyRequired	string	Security filter user context key.

Ƭ AttributeListContract

Represent attribute list contract.

Name	Type	Description
entriesNullable	Array<AttributeListEntry>	Attribute list entry list.
isDeletePermitted	Boolean	Attribute list is delete permitted.
isAggregatesOnly	Boolean	Attribute list is aggregates only.

Ƭ AttributeListEntry

Represent attribute list entry.

Name	Type	Description
id	string	Attribute id.
nameNullable	string	Attribute name.
withVariations	Boolean	Represent this attribute can have variations.
variationsNullable	Array<AttributeListEntryVariation>	Represent current variations.
dataTypeNullable	string	Attribute datatype.
typeNullable	string	Attribute type.
isLogicalColumn	Boolean	Attribute is logical column.
isHidden	Boolean	Attribute is hidden.
isSelectable	Boolean	Attribute is selectable.
errorDescriptionNullable	string	Attribute error description.

Ƭ AttributeListEntryVariation

Represent attribute list entry variation.

Name	Type	Description
id	string	Variation attribute id.
nameNullable	string	Variation attribute name.
dataTypeNullable	string	Variation attribute data type.
typeNullable	string	Variation attribute type.
isSelectable	Boolean	Variation attribute is selectable.
isHidden	Boolean	Variation attribute is hidden.

Ƭ SharedSecurityFilterInfo

Represent shared security filter info.

Name	Type	Description
mode	SharedSecurityFilterMode
referencedEntityNamesNullable	Array<string>	Shared security filter referenced entity names.

Ƭ SharedSecurityFilterMode

Enum:

• NoRefs

• WithRefs

  Represent shared security filter mode.

Ƭ SecurityFilterDisplayInfo

Represent security filter display info.

Name	Type	Description
sourceEntityId	string	Filter source entity id.
sourceEntityNameNullable	string	Filter source entity name.
sourceSecurityFilterId	string	Source security filter id.
sourceSecurityFilterDisplayTextNullable	string	Source security filter display text.
isForeignSecurityFilter	Boolean	Filter is foreign security filter.

Ƭ EntityRelationshipContract

Represent entity relationship contract.

Name	Type	Description
baseEntityId	string	Base entity id.
relatedEntitiesNullable	Array<EntityRelationshipNode>	Entity relationship node list.

Ƭ EntityRelationshipNode

Entity relation ship node.

Name	Type	Description
entityId	string	Entity id.
isAggregatesOnly	Boolean	Relationship is aggregates only.
textNullable	string	Relationship text.
pathNullable	string	Relationship path.
isHidden	Boolean	Relationship is hidden.
hasManyChildren	Boolean	Relationship has many children.

Ƭ AttributeFormatsContract

Represent attribute formats contract.

Name	Type	Description
isFixedFormat	Boolean	Indicates that requested attribute's format is fixed and not editable
availableFormatsNullable	Array<AttributeFormatMapping>	Contains only one entry if 'IsFixedFormat' is true

Ƭ AttributeFormatMapping

Represent attribute format mapping.

Name	Type	Description
displayStringNullable	string	Mapping display string.
formatStringNullable	string	Mapping format string.

Ƭ EntityProcedureUiParameter

Represent entity procedure UI parameter.

Name	Type	Description
nameNullable	string	Parameter name.
isSpecial	Boolean	Parameter sprecial status.
valueNullable	string	Parameter value.
promptNullable	string	Parameter promt.
defaultValue	EntityProcedureUiParameterValue
validValuesDomain	EntityProcedureUiParameterValidValuesDomain
validValuesNullable	Array<EntityProcedureUiParameterValue>	Parameter valid values.
attributeReference	EntityProcedureUiAtributeReference
allowNull	Boolean	Entity allow null.

Ƭ EntityProcedureUiParameterValue

Represent entity procedure UI parameter value.

Name	Type	Description
valueNullable	string	Entity procedure UI prameter value.
labelNullable	string	Entity procedure UI prameter label.
isSpecial	Boolean	Entity procedure UI prameter is special.

Ƭ EntityProcedureUiParameterValidValuesDomain

Enum:

• AnyValue

• FromTheDatabase

• FromAList

  Represent entity procedure UI parameter valid values domain.

Ƭ EntityProcedureUiAtributeReference

Represent entity procedure UI attribute reference.

Name	Type	Description
nameNullable	string	Attribute name.
pathNullable	string	Attribute path.
valuesNullable	Array<EntityProcedureUiParameterValue>	Entity procedure UI attribute reference values.

Ƭ RelationEntityDescription

Represent relation entity description.

Name	Type	Description
bindingNullable	string	Entity binding.
entityNullable	string	Entity name.
entityId	string	Entity id.
actAsNullable	string	Entity act as.
descriptionNullable	string	Entity description.