Entity APIs
The FintechOS Entities definitions allow you to perform CRUD (Create, Read, Update, Delete) operations on platform entities. Each entity has its dedicated endpoints which are populated dynamically as the data model changes.
IMPORTANT!
Although the definitions list all the platform entities, the ability to make API calls depends on the access rights the user account was assigned.
All entities are being displayed with a set of generated methods for each. There are three exceptions:
1. All entities ending with _BW or _BWA (these are generated automatically and cannot be created by the user since they contain business workflow specific logic and no CRUD changes should be allowed on them).
2. All system entities.
3. The following deprecated MKT entities:
MKT_Culture
MKT_MarketingList
MKT_MarketingListLog
MKT_MarketingListMember
MKT_MarketingListMemberToken
MKT_Campaign_MKT_MarketingList
MKT_Stats
MKT_NotificationType
MKT_ProviderStatus
MKT_Settings
MKT_Template
MKT_TemplateContent
MKT_TrackerAction
Although the definitions list all the platform entities, the ability to make API calls depends on the access rights the user account was assigned.
All entities are being displayed with a set of generated methods for each. There are three exceptions:
1. All entities ending with _BW or _BWA (these are generated automatically and cannot be created by the user since they contain business workflow specific logic and no CRUD changes should be allowed on them).
2. All system entities.
3. The following deprecated MKT entities:
MKT_Culture
MKT_MarketingList
MKT_MarketingListLog
MKT_MarketingListMember
MKT_MarketingListMemberToken
MKT_Campaign_MKT_MarketingList
MKT_Stats
MKT_NotificationType
MKT_ProviderStatus
MKT_Settings
MKT_Template
MKT_TemplateContent
MKT_TrackerAction
There are 8 dedicated endpoints for every platform entity:
- GET /ftosapi/evolutive-data-model/entities/{entityId}
- DELETE /ftosapi/evolutive-data-model/entities/{entityId}
- PUT /ftosapi/evolutive-data-model/entities/{entityId}
- PATCH /ftosapi/evolutive-data-model/entities/{entityId}
- POST /ftosapi/evolutive-data-model/entities/{entityId}
- POST /ftosapi/evolutive-data-model/changeBusinessStatus/{entityId}
- POST /ftosapi/evolutive-data-model/exportView/{entityId}
- POST /ftosapi/evolutive-data-model/entities/query/account/{entityId}
For instance, an entity called testEnt will have the following endpoints available:
