Associations

patch

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

Describes the association between two entities.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

parentEntityId

string

required

length between 1 and 450

The parent entity in the association. If this is a foreign key, then it is the master entity.

childEntityId

string

required

length between 1 and 450

The Child Entity in the relationship. For Foreign Keys this is the Foreign Table.

associationTypeId

string

required

length between 1 and 450

The type of association.

composite

boolean

The Composite field in the Association table is a bit type field, which is a single bit data type representing a Boolean value of either 0 or 1, either False or True. This field is used to represent a single combination or composite of two or more entities that can be defined in the table and is generally used to represent an association between the entities and determine if they are related or not.

referenceId

int32

The name of the field that is referenced. In a Foreign Key association, this is the name of the field that the parent table uses to reference the child/foreign table. For a Collection, this is the name of the field that references the parent table.

name

string

required

length ≥ 1

The name by which the association should be referred to. The name will be used on the Entity definition to refer to the collection or Foreign Key

displayId

int32 | null

The name of the field that should be displayed inside the drop down list.

filter

string | null

A filter expression that should be applied to the list before items are displayed.

foreignKeyAssociationId

int32 | null

When the collection is part of a many to many association, use this field to specify the '3rd' table in the relationship.

viewId

int32 | null

The ViewId field in the Association table is an integer data type that represents the unique identification number associated with each view or page related to the association.

foreignKeyPanel

boolean

When the association is a collection that is part of a many to many association, this box will determine if the panel opened is from the collection or the panel of the foreign entity referenced by the collecction. For example: In the many to many association association Issue->IssueFollower->SystemAccount. Tick if we want to display the System Account panel when clicking a row in the IssueFoller collection.

copy

boolean

The Copy of data type bit field in the Association table is intended to store a copy of the data from a different field, as a binary value. This data type can only have a value of either 1 or 0, representing 'true' or 'false'. The field is usually used alone or in conjunction with other fields to provide additional information about a particular Association record.

comment

string | null

Miscellaneous notes and information for the entry or record.

oDataFilter

string | null

The ODataFilter field is an nvarchar type column in the Association table that stores filter expressions formatted according to the OData protocol. It is designed to facilitate dynamic querying and data retrieval by allowing users to specify conditions for filtering data based on various properties of associated records. The field can accommodate a wide range of filter criteria, enabling efficient data access and manipulation in applications that utilize OData service interfaces.

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!