FAIR Data Services Version 1.38.0

Summary

This release contains two significant new features, FAIR Collections and the Dataset Administration Tab. In addition to these there updates to the cohort builder, bug fixes and some minor backend updates.

Dataset Administration Tab

The Dataset Administration Tab groups together all of the existing administration functions for a dataset in one place, making it easier for Data Owners to manage their datasets. This feature also introduced some API changes which are detailed below.

Dataset Collections

FAIR Datasets is a new feature which allows Data Stewards to group related datasets into collections. Full details on how to use this feature are available in our Knowledge Base.

New Endpoint: Cohorts

/cohorts/{code}/permissions

Retrieves authenticated users permissions on a given cohort

Changes to Serialisation

• settings has been moved from below the query → dataset to the top level, they still refer to the dataset settings, but removes duplication when there are multiple queries
• workflow_key has been removed from to top level as now available in settings
• dataset_cohort_visibility_settings has been removed in favour of using the top level settings
• visibility at the top level is the visibility of the cohort, visibility in the settings is the visibility of the dataset. This will likely change in the near future to promote clarity.

{
  code: 'my-cohort',
  status: {
    request_enabled: {
      reasons: [],
      supported: true
    }
  },
  access: {
    query_access: true,
    dataset_access: true
  },
  settings: {
    allow_clear: true,
    allow_dataset_update_subscriptions: true,
    allow_internal_cohorts: false,
    allow_private_cohorts: true,
    allow_pseudonymised: true,
    dataset_actions: [],
    expose_cohort_counts: true,
    expose_cohort_visualisations: true,
    visibility: 'private',
    workflow_key: 'basic_access_request',
    catalogue_definition_code: 'standard-catalogue'
  },
  name: 'My Cohort',
  description: '',
  visibility: 'private',

New Endpoint: Searches

/searches/{code}/permissions

Retrieves authenticated users permissions on a given cohort

Requests

Only datasets that have a valid transfer format (allow_clear, allow_pseudonymised) will be requestable, this has been added to the request_enabled status. Applies to datasets and cohorts and to the requestable filter.

Changes to Serialisation

• Since requests return a serialised cohort, the changes to cohort above cascade through to the request cohort object

Workflows

allow_clear and allow_psedonymised have been moved to the dataset and can no longer be set or retrieved on the workflow.

Released features