Contents x
Get a reader group via group ID
  • 16 Mar 2023
  • 3 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Get a reader group via group ID

  • Updated on 16 Mar 2023
  • 3 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Get
/v2/Readers/groups/{groupId}
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Path parameters
groupId
string Required

The ID of the reader group

Query parameters
offSet
integer

Specify the pagination to be retrieved. Each pagination retrieves 5000 readers. The default value is 1.

Responses
200

Success

Readers - Success Response for update reader

This is an example for 200 status, success response.

{
  "result": {
    "reader_group_id": "1c8e9f29-33e8-4301-af1d-dbf3c15a2782",
    "title": "ReadersGroupTitle",
    "description": "This is the Readers Group Description.",
    "associated_readers": [],
    "associated_invited_sso_users": [],
    "access_scope": {
      "access_level": 3,
      "categories": [],
      "project_versions": [],
      "languages": []
    }
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
result
object
reader_group_id
string

The ID of the reader group.

title
string

The name of the reader group.

description
string

Description of the reader group.

associated_readers
Array of string

List of reader IDs to be associated with this reader group.

associated_invited_sso_users
Array of string

List of reader invitation IDs. Applicable only for SSO readers.

access_scope
object
access_level
integer
Valid values[0,1,2,3,4,5]
categories
Array of object

List of category scope objects.

object
category_id
string

The category ID to which the user should be given access.

project_version_id
string

The project version ID to which the category belongs.

language_code
string

The language to which the user should be given access.

project_versions
Array of string

List of project version IDs the reader has access to.

languages
Array of object

List of language scope objects.

object
project_version_id
string

The project version ID to which the user should be given access.

language_code
string

The language to which the user should be given access.

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

400

Bad Request

Readers - Invalid reader ID

Kindly verify your readers group Id and perform the operation again. This seems to be an error while finding the reader group Id, to find your readers group Id from /v2/Readers/groups.

{
  "result": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The reader group Id does not exist.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": null,
  "information": null
}
Expand All
object
result
object
reader_group_id
string

The ID of the reader group.

title
string

The name of the reader group.

description
string

Description of the reader group.

associated_readers
Array of string

List of reader IDs to be associated with this reader group.

associated_invited_sso_users
Array of string

List of reader invitation IDs. Applicable only for SSO readers.

access_scope
object
access_level
integer
Valid values[0,1,2,3,4,5]
categories
Array of object

List of category scope objects.

object
category_id
string

The category ID to which the user should be given access.

project_version_id
string

The project version ID to which the category belongs.

language_code
string

The language to which the user should be given access.

project_versions
Array of string

List of project version IDs the reader has access to.

languages
Array of object

List of language scope objects.

object
project_version_id
string

The project version ID to which the user should be given access.

language_code
string

The language to which the user should be given access.

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

Was this article helpful?
What's Next