Add reader group
  • 16 Nov 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Add reader group

  • Dark
    Light

POST/readers/groups

Adds a reader group to the project.


Parameter Type Description
api_token string REST API key you can obtain from Settings > Advanced > API tokens.

Body Parameters

Parameters highlighted in bold are mandatory

Parameter Type Description
title string The name of the reader group.
description string Description of the reader group.
associated_readers string[] List of reader IDs to be associated with this reader group.
access_scope object Access scope of this reader group.

Body Parameters > access_scope

Parameter Type Description
access_level number The access level for the reader group. 1-Category, 2-Version, 3-Project.
categories string[] List of category IDs the reader group has access to. Mandatory when access_level is 1-Category.
project_versions string[] List of project version IDs the reader group has access to. Mandatory when access_level is 2-Version.

Sample Request

Providing access to particular categories.

{
  "title": "Students",
  "description": "Reader group for students",
  "associated_readers": [
    "9951f2e4-4fe3-47b9-b099-1aab99e1de76",
    "d7c9a42c-a1c8-40ed-bcaa-02110227b758"
  ],
  "access_scope": {
    "access_level": 1,
    "categories": [
      "31dde13b-b944-4e3e-a325-2d004636bf5f",
      "e5f38015-bf19-413d-b76c-133388b9c3de"
    ],    
  }
}

Sample Response

{
  "data": {
    "id": "4c311d36-ca1e-43d4-a78b-82a3f7687a97"
  },
  "extension_data": null,
  "context": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Response Data

Parameter Type Description
id string ID of the newly added reader group.

Was this article helpful?