Skip to content

API Release Notes

FT 8.2 API Release Update

To be released on: September 17th, 2024

With the FieldTwin 8.2 release the following support has been added to the FieldTwin API 1.10

  • Link local and external sub projects with a project (POST+PATCH)
  • Support added for POST+PATCH batch requests for subproject resources
  • New endpoint to extract portions of a connection that are floating on surface:
    • https://api.fieldtwin.com/#api-Connections-GetSegmentsAboveSurface
  • GET “users” response now lists the accounts the requesting user is member of
  • GET https://api.fieldtwin.com/#api-Accounts-GetProjects response now have:
    • Linked local and external sub projects for each project
    • Version of linked local sub project of each project
  • List of linkable external sub projects
    • https://api.fieldtwin.com/#api-Projects-GetProject response now have:
    • Linked local and external sub projects for each project
    • Version of linked local sub project of each project

Annotations API support added for GET, POST, PATCH, DELETE in batch for a sub project.

  • GET all annotations inside a sub project - https://api.fieldtwin.com/#api-SubProjects-GetSubProject
  • POST in batch - https://api.fieldtwin.com/#api-subProjectBatchResources-PostBatchResources
  • PATCH in batch - https://api.fieldtwin.com/#api-subProjectBatchResources-PatchBatchResources
  • DELETE in batch - https://api.fieldtwin.com/#api-subProjectBatchResources-DeleteBatchResources

Updated:

  • GET account response includes the dashboard tree view folders defined for the account - https://api.fieldtwin.com/#api-Accounts-GetProjects
  • POST/PATCH a project with folder ID for where to create or import a project.
  • POST/PATCH a sub project with folder ID for where to create or import sub project.

FieldTwin API 2.0

We plan on releasing version 2.0 of FT API Q4/25. More information on when that will be available will be forthcoming early next year. You can access the online API documentation here: https://api.fieldtwin.com

Developer Portal

For the most updated developer information for FieldTwin, please visit our developer portal where you will find code samples, tips & tricks and much more:
https://developer.fieldtwin.com

Release 1.10 Update

Released on: October 31st, 2024

With the FieldTwin 8.1 release the following support has been added to the FieldTwin API 1.10

  • Generate schematics
  • PATCH - metadata link, metadata group link (patching the order)
  • GET, PUT, PATCH, DELETE - Documents for account
  • GET connection types - connection definition, connection categories
  • GET resource by ID - connectionSegmentTypes, wellBoreTypes, layerTypes, connectors, shapeTypes, wellTypes, wellBoreSegmentTypes
  • Shapes - Support for POST and PATCH commands
  • Connection Types - Support for POST, PATCH & DELETE commands
  • Tasks – Support for POST and PATCH commands for category in task & categoryTree in template
  • TAGS – Create, Read, Update and Delete support for Account Tags
  • Workflow - Create, Read, Update and Delete support for; workflow template, template columns, Default Account, project workflow template, task comments, and attach documents to task
  • Workflow - Create, Read, Update and Delete support for; task templates, task group templates, task link and group link to object

Important Information

  • API v1.9 has been discontinued

Release 1.10

Released on: January 31st, 2024

Important Information

  • API v1.9 and v1.10 are available in FieldTwin 8.0
  • New code should use v1.10, which is compatible with v1.9
  • FieldTwin 8.x tenants should use v1.10
  • FieldTwin 7.1 tenants cannot access v1.10

New in this release

  • Generate schematic as a SVG file

  • PATCH metadata link, metadata group link - patching the order

  • GET, PUT, PATCH, DELETE - Documents for account

  • GET connection types - connection definition, connection categories
  • GET resource by ID – connectionSegmentTypes, wellBoreTypes, layerTypes, connectors, shapeTypes, wellTypes, wellBoreSegmentTypes