API related changes in the Workbooks Spring/Summer release

API related changes in the Workbooks Spring/Summer release

There is nothing here that we would expect to cause a problem, but to ensure that your external API client can still connect to the Workbooks service, please attempt a connection to our beta service.  If you get a valid response from the service, then your client is compatible.  If you have problems connecting, please contact Workbooks Support.

You can access Beta here: https://beta.workbooks.com using your usual login details.  Please note, your database(s) will have been archived on the Beta system so when you first login there will be a delay while the database is retrieved.  The length of time this will take depends on the size of the database(s) being retrieved.

Whilst we don’t anticipate our changes to impact on your usage of Workbooks, if you do encounter problems please contact support@workbooks.com to log them with us.

• The MailChimp service was incorrectly spelled ‘Mail Chimp’ in a number of endpoints in the API documentation.
• The dotMailer service was incorrectly spelled ‘Dotmailer’ in a number of endpoints in the API documentation.
• The API documentation now includes the queue_users association in the Related Models section of each of the Queue endpoints.
• Reports (Private::Reporting::Report), Report Views (Private::Reporting::DataView) and Deshboards (Private::Dashboard) now have an object_ref attribute.
• Picklist Entries (Private::PicklistEntry)
  • The title of the display_order attribute was incorrect (‘Name’) – it has been changed to ‘Position’.
• Meetings (Private::Activity::Meeting)
  • Two new attributes have been added: due_date and end_date.  These attributes are to be used when dealing with all-day Meetings in the API.  They are analogous to the existing due_datetime and end_datetime attributes, but don’t including the time, and therefore are not subject to the complexities of timezones.
• Tasks (Private::Activity::Task)
  • The due_date attribute is now nullable.
• Report Views (Private::Reporting::DataView)
  • The instances_described_by metadata attribute has changed from ‘name’ to ‘descriptor’ – i.e. if you want to present a Report View in a user interface using information from the API, you should now use the descriptor attribute rather than the name attribute.
• Custom Fields (Private::CustomField)
  • The titles of various attributes have changed slightly to clarify their meaning, correct spelling, or to match them with their equivalent fields on the Custom Field dialog in the desktop.
  • The picklist_id and tagarray_id attributes now have the correct picklist information to help in selecting appropriate values.
  • We have added a default_value_data_view_linked_item attribute that can be used to set a default value for a DLI custom field.
  • We have added a party_relationship_type_value attribute that can be used to select a Party Relationship Type (Private::Crm::PartyRelationshipType) to specify the relationship type to create when a DLI connects to two parties.
• Configured DLIs
  • The API documentation now includes the path to use to get values from all DLIs.
  • In the future it will be possible to configure the API to apply auto-populate mappings.  The metadata exposes a field_auto_populate_field_mappings Hash attribute with this information, and it is exposed in the API documentation as “Auto populate mappings”.
  • DLIs can be scoped with additional dynamic filters.  The metadata exposes a picklist_dynamic_filter_mappings Hash attribute with this information, and it is exposed in the API documentation as “Constrain results mappings”.
• Web Processes (Private::Automation::WebAction)
  • The metadata for the authenticated_run_as and web_anonymous_run_as attributes now have the correct picklist information to help in selecting appropriate values.
• Scripts (Private::Automation::Script)
  • The instances_described_by metadata attribute has changed from ’name’ to ‘descriptor’ – i.e. if you want to present a Script in a user interface using information from the API, you should now use the descriptor attribute rather than the name attribute.
• API Data (Private::Automation::ApiData)
  • API Data is now importable, so a boolean attribute named ‘imported’ has been added – set to true if the record was imported.