Developers

  • Introduction to Nimblex JSON API

      Nimblex 5.4 and above include a JSON API. This feature is intended to allow for integration options without direct VendorPanel intervention. The JSON API is a mechanism ...

  • JSON API - Records

      This page defines the API for accessing records within your Nimblex system, including management of record objects as well as relationships between records and documents...

  • JSON API - Record Attachments

    This document defines the API used for managing attachments attached to records. Functions for uploading and downloading attachments are non-conformant with JSON API, as t...

  • JSON API - Basic Reporting

    Record-Rows – filtered record data This function is not strictly conformant with JSON API. GET @apiroot/recordrows/{urlencoded eformtype}?filter={filter}&page%5Boffset%5D=...

  • JSON API - Roles

    This page explains the API functions for the querying and updating of roles within your Nimblex system. Roles are polymorphic, where a role is one of: user, group or guest...

  • JSON API - Role Memberships

    Note that according to http://jsonapi.org/format/#crud-updating-to-many-relationships, to-many relationships are required to have an array as their data object. Get List o...

  • JSON API - Departments

    This page explains the API functions for the querying and updating of departments within your Nimblex system. Note that a 'department' can be any level of organisation uni...

  • Web Events

    This feature was first released as part of Nimblex 5.6. A Web Event is a trigger point that you can set up on your Nimblex system, to trigger a form Custom Event when a HT...

  • External Forms

      The Nimblex platform supports a flavour of basic web integration via a function referred to as ‘External Forms’. This function allows you to embed an HTML version of a f...