API Reference

Support : API Reference
Retrieve Data

All server interaction is done using the CoreTRM API which utilizes the dynamic Data Model to provide simple and efficient data retrieval tailored for each tenant.

A typical GET call is formatted as follows:

GET: api/{tenantid}/dataobjectdata/{objectid}?itemrefs={comma delimited list of item references}

For example the following will retrieve Contract rows with the Contract Seq Num and Contract Reference items.

GET: api/{tenantid}/dataobjectdata/core_contract?itemrefs=contractseqnum,contractreference

Simple API Call

See the Item Refs article for more information about item refs.

Using the relationships that have been defined in the Data Model we can also include items from parent objects without having to make multiple calls:

GET: api/{tenantid}/dataobjectdata/core_contract?itemrefs=contractseqnum,contractreference,contract.core_book.bookname,contract.core_counterparty.counterpartyname,spottermtype.dm_dataobject_item_lookup.itemdescription

API Call with Parent Items

The API also supports filtering, sorting and summarizing:

GET: api/master/dataobjectdata/core_valuation?itemrefs=transactionseqnum,valuation.core_fee_type.feetypename,valuationpayorreceivetype.dm_dataobject_item_lookup.itemdescription,effectiveamount,effectiveamountcurrencycode,effectiveamountunitcode,effectivequantity,effectivequantityunitcode,profitandlossvaluetodate,valuecurrencycode,valuationdate,feeseqnum,matchgroupseqnum,latestforfeeseqnumind&summaryitemrefs=profitandlossvaluetodate,valuecurrencycode&sortitemrefs=transactionseqnum&filter=matchgroupseqnum.eq.5004;latestforfeeseqnumind.eq.True

API Call with Filtering and Sorting