- V2
-
V1
- Account
- Admin
- AdminUpload
- Analysis
- ApiResource
- ApiScope
- Assets
- AuditLog
- Auth
- AuthToken
- Avatar
- BatchDownloadDocuments
- CacheMeta
- Caching
- CheckUpdate
- ClaimMapping
- Client
- Collections
- Config
- CustomizeProperties
- Dashboard
- DashboardView
- DataMonitoring
- DataProvider
- DataSource
- DataSourceAPI
- DataSourceFile
- DataSourcePreview
- Dataset
- DatasetExport
- DatasetPreview
- Design
- DesignApi
- DesignTemplates
- DocumentBinder
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- LocalDeployment
- ModelDrafts
-
ModelEditor
- Node
- Notification
- Permission
- Pivot
- PluginAssets
- Preview
- PushDataset
- QueryEndpoint
- QueueMonitor
- ReferenceResolving
- Reports
- Resource
- Resources
- Role
- RoleDocumentColumns
- SceneView
- Schedule
- ScheduleTemplate
- SchedulesApi
- SecurityProvider
- Semantic
- Session
- Settings
- SharedResources
- StreamingDatasetApi
- SystemConfig
- SystemConfigs
- Tenant
- TenantModification
- Theme
- ThemeFiles
- Token
- Upload
- UploadTheme
- User
- UserFunctions
- View
- VisualSandbox
- WebPages
- WorkerJob
- WorkersRegistrar
- overview
ModelEditor
ModelEditor
[POST] /api/models/{id}/draft/validate
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
[POST] /api/models/{id}/draft/save
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
[POST] /api/models/{id}/draft/discard
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
[POST] /api/models/{id}/draft/discardonlymemory
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
[POST] /api/models/{id}/draft/publish
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
comment | string | query |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/reference
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
Array<string>
[POST] /api/models/{id}/draft/entities
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
[PUT] /api/models/{id}/draft/entities/{entityId}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[DELETE] /api/models/{id}/draft/entities/{entityId}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/attributes
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
[POST] /api/models/{id}/draft/entities/{entityId}/attributes
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/attributes/{attributeId}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
attributeIdRequired | string | path |
Response
Status Code: 200
Success
[PUT] /api/models/{id}/draft/entities/{entityId}/attributes/{attributeId}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
attributeIdRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[DELETE] /api/models/{id}/draft/entities/{entityId}/attributes/{attributeId}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
attributeIdRequired | string | path |
Response
Status Code: 200
Success
[POST] /api/models/{id}/draft/entities/{entityId}/attributes/{attributeId}/regenerate
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
attributeIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/relations
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
[POST] /api/models/{id}/draft/entities/{entityId}/relations
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
relationIdRequired | string | path |
Response
Status Code: 200
Success
[PUT] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
relationIdRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[DELETE] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
relationIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/properties
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
[PUT] /api/models/{id}/draft/properties
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/columns
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
[POST] /api/models/{id}/draft/entities/{entityId}/table_columns
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[PUT] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}/binding
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
relationIdRequired | string | path |
Request Schema
WynSaveRoleBindingRelationContract
Response
Status Code: 200
Success
[PUT] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}/userdefined
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
relationIdRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/attributes/tree
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
path | string | query |
type | AttributeTreeType | query |
Response
Status Code: 200
Success
[POST] /api/models/{id}/draft/entities/{entityId}/attributes/related
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Request Schema
WynAddAttributeFromRelatedAttributeContract
Response
Status Code: 200
Success
Array<string>
[POST] /api/models/{id}/draft/entities/{entityId}/attributes/datafield
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Request Schema
WynAddAttributeFromDataFieldContract
Response
Status Code: 200
Success
uuid
[PUT] /api/models/{id}/draft/entities/{entityId}/attributes/expression
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Request Schema
WynSaveAttributeFromSQLExpressionContract
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/attributes/validation
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
expression | string | query |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/attributes/schema
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
expression | string | query |
Response
Status Code: 200
Success
ExpressionResultsetSchemaContract
[GET] /api/models/{id}/draft/entities/{entityId}/attributes/preview
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
expression | string | query |
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 |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/usercontextkeys
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
Array<string>
[GET] /api/models/{id}/draft/entities/{entityId}/securityfilter
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
[DELETE] /api/models/{id}/draft/entities/{entityId}/securityfilter
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
removeAll | Boolean | query |
Response
Status Code: 200
Success
[PUT] /api/models/{id}/draft/entities/{entityId}/securityfilter
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/securityfilter/refcount
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
int32
[GET] /api/models/{id}/draft/procedures/{binding}/parameters/{parameterName}/values
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
bindingRequired | string | path |
parameterNameRequired | string | path |
path | string | query |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/attributes/{attributeId}/dbvalues
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
attributeIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/attributes/list
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
canDelete | Boolean | query |
aggregatesOnly | Boolean | query |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/securityfilter/shareinfo
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/securityfilter/display
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/relationships
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
path | string | query |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/attributes/{attributeId}/formats
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
attributeIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/parameters
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/entities/{entityId}/relationentities
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
[POST] /api/models/{id}/draft/entities/validation
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[POST] /api/models/{id}/draft/entities/schema
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Request Schema
Response
Status Code: 200
Success
ExpressionResultsetSchemaContract
[POST] /api/models/{id}/draft/entities/preview
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Request Schema
Response
Status Code: 200
Success
ExpressionResultsetSchemaContract
[GET] /api/models/{id}/draft/entities/{entityId}/relations/{relationId}/cardinalities
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
relationIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/models/{id}/draft/attributes/{attributeId}/verify/{format}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
attributeIdRequired | string | path |
formatRequired | string | path |
Response
Status Code: 200
Success
Models
Ƭ ValidationResult
Represent a samantic model validation result.
Name | Type | Description | Example |
---|---|---|---|
messagesNullable | Message | Validation messages. | |
status | ValidationStatus |
Ƭ Message
Name | Type | Description | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
idNullable | string | Created id. |
Ƭ NewEntityContract
Represent a new entity contract.
Name | Type | Description | Example |
---|---|---|---|
bindingType | TableType | ||
bindingNullable | string | Entity binding. | |
queryNullable | string | Entity query. | |
parametersNullable | ParameterContract | Entity parameters. | |
nameNullable | string | ||
descriptionNullable | string |
Ƭ TableType
Enum:
Table
View
Query
SystemTable
SystemView
Function
StoredProcedure
Ƭ ParameterContract
Entity paremater contract.
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | Entity parameter name. | |
value | ValueContract | ||
promptDescription | PromptContract |
Ƭ ValueContract
Represent entity parameter value contract.
Name | Type | Description | Example |
---|---|---|---|
stringValueNullable | string | Entity parameter value. | |
isSpecial | Boolean | Entity parameter sprecial status. |
Ƭ PromptContract
Entity parameter prompt contract.
Name | Type | Description | Example |
---|---|---|---|
promptNullable | string | Entity parameter prompt. | |
defaultValue | ParameterValueContract | ||
validValuesDomain | ParameterValidValuesDomain | ||
validValuesNullable | ParameterValueContract | Entity parameter valied values. | |
attributeReference | AttributeReferenceContract | ||
allowNull | Boolean | Represent whether the entity allow null. |
Ƭ ParameterValueContract
Represent entity parameter value contract.
Name | Type | Description | Example |
---|---|---|---|
value | ValueContract | ||
labelNullable | string | Entity parmeter label. |
Ƭ ParameterValidValuesDomain
Enum:
AnyValue
FromTheDatabase
FromAList
Ƭ AttributeReferenceContract
Represent arrribute rederence contract.
Name | Type | Description | Example |
---|---|---|---|
pathNullable | string | Arrribute reference path. |
Ƭ EntityContract
Represent entity contract.
Name | Type | Description | Example |
---|---|---|---|
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 | Description | Example |
---|---|---|---|
id | string | ||
filterNameNullable | string | ||
existingFilterPathNullable | string | ||
attributePathNullable | string | ||
expressionNullable | string | ||
operationNullable | string |
Ƭ UpdateEntityContract
Represent update entity contract.
Name | Type | Description | Example |
---|---|---|---|
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 | ParameterContract | Entity parameters. | |
nameNullable | string | ||
descriptionNullable | string |
Ƭ UpdateSecurityFilterContract
Represent update security filter contract.
Name | Type | Description | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
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 | 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 | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
formatNullable | string | Attribute format. | |
valueSelection | 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. | |
expressionText | string | Attribute expression text. | |
logicalDataType | LogicalDataType | ||
nameNullable | string | ||
descriptionNullable | string |
Ƭ RelationContract
Represent realtion contract.
Name | Type | Description | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
binding | string | Relation binding. | |
sourceColumns | Array<string> |
Relation source columns. | |
targetEntityId | string | Relation target entity id. | |
targetColumns | Array<string> |
Relation target columns. | |
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
Represent model properties.
Name | Type | Description | Example |
---|---|---|---|
connectionString | string | Model connection string. | |
commandTimeoutNullable | int32 | Model command timeout. |
Ƭ ColumnContract
Specifies information about column to publish via the data source.
Name | Type | Description | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
bindingNullable | string | Relation binding. | |
targetEntityId | string | Relation target entity id. | |
nameNullable | string | ||
descriptionNullable | string |
Ƭ WynSaveRoleRelationsContract
Represent wyn save role relations contract.
Name | Type | Description | Example |
---|---|---|---|
sourceColumns | Array<string> |
Relation source columns. | |
targetEntityId | string | Relation target entity id. | |
targetColumns | Array<string> |
Relation targrt columns. | |
nameNullable | string | ||
descriptionNullable | string |
Ƭ AttributeTreeType
Enum:
AllAttributes
SecurityFilterAvailableAttributes
ExistingSecurityFilters
Ƭ EntityTreeContract
Represent entity tree contract.
Name | Type | Description | Example |
---|---|---|---|
itemsNullable | EntityTreeElement | Entity tree element list. |
Ƭ EntityTreeElement
Represent entity tree element.
Name | Type | Description | Example |
---|---|---|---|
dataNullable | string | Entity tree element data. | |
stateNullable | string | entity tree element state. | |
attribute | EntityTreeElementAttribute | ||
childrenNullable | EntityTreeElement | Entity Tree element children. |
Ƭ EntityTreeElementAttribute
Represent entity tree element attribute.
Name | Type | Description | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
bindingsPath | string | Attribute bindings path. | |
name | string | Attribute name. | |
descriptionNullable | string | Attribute description. |
Ƭ WynAddAttributeFromDataFieldContract
Represent wyn add attribute from data field contract.
Name | Type | Description | Example |
---|---|---|---|
name | string | Attribute name. | |
descriptionNullable | string | Attribute description. | |
expression | string | Attribute expression. |
Ƭ WynSaveAttributeFromSQLExpressionContract
Represent wyn save attribute from sql expression contract.
Name | Type | Description | Example |
---|---|---|---|
attributeId | string | Attribute id. | |
name | string | Attribute name. | |
descriptionNullable | string | Attribute description. | |
expression | string | Attributr expression. |
Ƭ ExpressionResultsetSchemaContract
Represent entity data schema.
Name | Type | Description | Example |
---|---|---|---|
headRow | ExpressionResultsetSchemaHeadRow | ||
dataRowsNullable | ExpressionResultsetSchemaDataRow | Table content rows. |
Ƭ ExpressionResultsetSchemaHeadRow
Table head row.
Name | Type | Description | Example |
---|---|---|---|
headCellsNullable | Array<string> |
Table head cells. |
Ƭ ExpressionResultsetSchemaDataRow
Table content row.
Name | Type | Description | Example |
---|---|---|---|
valueCellsNullable | Array<string> |
Table content cells. |
Ƭ EntitySourceContract
Represent entity source contract.
Name | Type | Description | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
filterName | string | Security filter name. | |
attributeId | string | Security filter attribute id. | |
functionName | string | Security filter fuction name. | |
userContextKey | string | Security filter user context key. |
Ƭ AttributeListContract
Represent attribute list contract.
Name | Type | Description | Example |
---|---|---|---|
entriesNullable | 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 | Example |
---|---|---|---|
id | string | Attribute id. | |
nameNullable | string | Attribute name. | |
withVariations | Boolean | Represent this attribute can have variations. | |
variationsNullable | 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 | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
baseEntityId | string | Base entity id. | |
relatedEntitiesNullable | EntityRelationshipNode | Entity relationship node list. |
Ƭ EntityRelationshipNode
Entity relation ship node.
Name | Type | Description | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
isFixedFormat | Boolean | Indicates that requested attribute's format is fixed and not editable | |
availableFormatsNullable | AttributeFormatMapping | Contains only one entry if 'IsFixedFormat' is true |
Ƭ AttributeFormatMapping
Represent attribute format mapping.
Name | Type | Description | Example |
---|---|---|---|
displayStringNullable | string | Mapping display string. | |
formatStringNullable | string | Mapping format string. |
Ƭ EntityProcedureUiParameter
Represent entity procedure UI parameter.
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | Parameter name. | |
isSpecial | Boolean | Parameter sprecial status. | |
valueNullable | string | Parameter value. | |
promptNullable | string | Parameter promt. | |
defaultValue | EntityProcedureUiParameterValue | ||
validValuesDomain | EntityProcedureUiParameterValidValuesDomain | ||
validValuesNullable | EntityProcedureUiParameterValue | Parameter valid values. | |
attributeReference | EntityProcedureUiAtributeReference | ||
allowNull | Boolean | Entity allow null. |
Ƭ EntityProcedureUiParameterValue
Represent entity procedure UI parameter value.
Name | Type | Description | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
nameNullable | string | Attribute name. | |
pathNullable | string | Attribute path. | |
valuesNullable | EntityProcedureUiParameterValue | Entity procedure UI attribute reference values. |
Ƭ RelationEntityDescription
Represent relation entity description.
Name | Type | Description | Example |
---|---|---|---|
bindingNullable | string | Entity binding. | |
entityNullable | string | Entity name. | |
entityId | string | Entity id. | |
actAsNullable | string | Entity act as. | |
descriptionNullable | string | Entity description. |