Entity Properties

patch

https://app.financekey.com/OData/EntityProperties({key})

Defines a property value on an entity.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

entityId

string | null

The entity to which the property is associated with.

name

string | null

The name of the property on the Entity.

nullable

boolean

Checked if the property is a nullable property.

mandatory

boolean

Checked if the property needs to be populated or not.

defaultExpression

string | null

DefaultExpression is an nvarchar field in the EntityProperty table that stores a string value representing a default expression encoded as a string. It is used to address situations where a property value is not known or unavailable and a default value needs to be generated.

description

string | null

The EntityProperty table contains a field called Description of data type nvarchar. This field stores text data in characters of any length that are automatically stored as Unicode characters. This data can be used to define a property or attribute of an entity in the EntityProperty table.

comment

string | null

Miscellaneous notes and information for the entry or record.

dataTypeId

string | null

DataTypeId is an nvarchar field within the EntityProperty table, used to store the type of data for the associated entity property value. The data type for this field is limited to 450 characters in length.

audit

boolean

Checked if modifications in this column generate a new audit record.

approve

boolean

Checked if modifications on this property generate an approval request.

dbAttributeId

string

required

length between 1 and 450

The attribute that should be placed on the column in the database. Select 'None' if none of the available attributes are applicable.

length

string | null

The total data length of the property. -1 indicates that length is not limited.

precision

int32

Where applicable, allows the number of decimals to be specified for the property

caption

string | null

The caption to be used in the label for the control

boolean

Search is a field of data type bit in the EntityProperty table. It is a boolean field that indicates whether the entity associated with the table row is searchable or not. A value of 1 indicates that the associated entity is searchable, while a value of 0 indicates that it is not searchable.

boProperty

boolean

The BOProperty field in the EntityProperty table is a bit data type indicating whether an entity has a property or not. A value of '1' means the entity has the property, while a value of '0' means the entity does not have the property.

sequence

int32

The Sequence field of type int in the EntityProperty table is used to denote the order in which certain entities should be presented or processed. This field allows for manual ordering within the system and can be modified when necessary.

display

boolean

The Display field of data type bit in the EntityProperty table is a Boolean field that is used to indicate whether the associated property should be displayed or not. This is used to control the display of specific properties for certain entities in select (foreign key) controls and collection controls.

inputMask

string | null

InputMask is an nvarchar field in the EntityProperty table of a maximum length of 250 characters. It is used to store a string representing a formatted mask string which is used to help users enter information in a consistent and valid format.

architectureLayerId

string

required

length between 1 and 450

ArchitectureLayerId is an nvarchar data type field with a maximum length of 450 characters, located in the EntityProperty table. This field is used to identify the layer of the architectural entity model in order to store both structural and functional data of the entire system.

readOnly

boolean

The ReadOnly field of the EntityProperty table is a bit datatype which marks whether or not a property can be changed. If ReadOnly is set to 1, then the property cannot be changed, if it is 0, then it can be edited.

boolean

The AI field in the EntityProperty table stores a bit value indicating whether or not the entity has artificial intelligence capabilities. This data type allows for the efficient storage of binary data, making it ideal for tracking the presence of AI within a given entity. With this field, users can easily query and filter entities based on their AI status, providing valuable insights into the capabilities of their data. Whether an entity is classified as AI or not can greatly impact its role and function within the larger dataset, making the AI bit field a vital component in managing and analyzing data.

aiPrompt

string | null

The AIPrompt field in the EntityProperty table is a data type of nvarchar and is used to store prompts generated by artificial intelligence algorithms. These prompts are suggestions or recommendations for the user regarding the properties of the entity currently being worked on. This field is designed to enhance the user experience by providing helpful prompts and suggestions based on the data in the table.

noViewColumn

boolean

Check this box if the Entity Property Should not appear on the View. The generator will exclude it form the column list, and it will not be possible for a user to view this as a standalone column. It will be available for a Disaply Property as part of a bundle.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!