Entities

patch

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

Describes a class in the system and an associated table ( db object) in the database.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

dbContextId

string

required

length between 1 and 256

The database in which the enttiy resides

entityTypeId

string

required

length between 1 and 450

The type of Entity and the type of data stored in the table associated with the Entity.

entityId

string

required

length between 1 and 450

This is the description

packageId

string

required

length between 1 and 450

The package (namespace) in which the entity classes have been placed.

prompt

string

required

length between 1 and 256

The prompt that a user can refer to the entity as.

comment

string | null

Miscellaneous notes and information for the entry or record.

description

string | null

The Description field in the Entity table is an nvarchar data type with a maximum 512 character length. This field can be used to provide a detailed description of the Entity it is associated with.

baseEntityId

string | null

BaseEntityId is a nvarchar field in the Entity table that stores the unique identifier of an entity object. It has a maximum length of 450 characters.

entityViewId

string | null

The EntityViewID field in the Entity table is an nvarchar data type with a maximum length of 450. It is used to uniquely identify a specific entity type for all views in the entity.

searchFilter

string | null

The SearchFilter field in the Entity table is an nvarchar data type column which can be used to store a keyword or phrase to filter items in the Entity table. The SearchFilter field can be used to find specific information and records in the Entity table.

canTileGrid

boolean

CanTileGrid is a bit field in the Entity table which indicates whether the Entity is able to support tiling with a grid structure. This field will be set to TRUE if the Entity can be tiled, and FALSE if it cannot.

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!