Changelog for October 15, 2021
New API Features:
- New endpoint: Support for a Deal Approvals API endpoint
- New endpoint: Support for a Deal Tasks API endpoint
- New endpoint: Support for a Global Tenants API endpoint ([see details below] (#global-tenants-api-endpoint))
- Add ability to filter API response data using a
filter[updated_since]filter parameter (see details below)
API Updates:
- Deal Terms API and Lease Terms API endpoints: added a
downtimeattribute - Deal Terms API endpoint: added
relationshipslinks tospacesandproposal - Financials API endpoint: added
relationshipslinks to `deal term' IDs for 'commissions', 'rent escalations', and 'remaining lease obligation' objects - Tenant Contacts API endpoint: added
relationshipslinks to 'tenant' ID
Global Tenants API endpoint
The 'Global Tenants' endpoint enables API access to the new VTS tenant linking feature. This feature anchors tenant entities to a standard tenant entity across your portfolio, regardless of how those tenant names are inputted into a lease or deal in the VTS database. This also allows a user to understand the hierarchy of their tenant entities via an Ultimate Parent ID relationship
The 'Tenants' endpoint contains a relationships.global_tenant_id attribute, which links to the tenant's Global Tenant ID.
Additional notes on the fields in this new endpoint:
| Attribute | Description |
|---|---|
| attributes.name | This is the cleansed, global name of the tenant |
| attributes.industry | This is the tenant’s Global Tenant industry, which may come from the client’s accounting system OR from CapIQ Note that this could be different from this tenant’s industry in the 'Tenants' endpoint, which is the industry as reported by or pulled from your accounting system. |
| attributes.cap_iq_id | This is the CapIQ company ID. You may only find value from this field if you have a separate CapIQ datafeed that you need to relate to your data from VTS. |
| relationships.data.ultimate_parent.id | This is the Global Tenant's 'Ultimate Parent Global Tenant' ID |
New Feature: Filter API calls by Updated Date
You can now filter the result set for your API requests to return only data that has been created or modified since a given date. You can filter by date or timestamp. Value should be provided in ISO8601 format.
All times are interpreted in the UTC time zone.
How to use:
For any endpoint with a 'Last Updated' field, append this clause to the API call:
?filter[updated_since]=YYYY-MM-DD HH:MM:SS
Additional Notes:
- The
YYYY-MM-DDis required, butHH:MM:SSis optional - The parameter value should be formatted in ISO8601 format (it may still parse in other date formats, but may produce unexpected results; however, it is guaranteed to work when given a valid ISO8601 date)
- The time zone is always interpreted as UTC (unless a timezone offset is explicitly mentioned)
curl -X GET -u "<api_key>:<api_secret>" "https://api.vts.com/api/v1/assets?filter[updated_since]=2021-10-12"