Get a reader group via group id
- 26 Sep 2023
- 3 Minutes to read
- Contributors
- Print
- DarkLight
Get a reader group via group id
- Updated on 26 Sep 2023
- 3 Minutes to read
- Contributors
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
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
stringRequired
The ID of the reader group
Query parameters
offSet
integer (int32)
Specify the pagination to be retrieved. Each pagination retrieves 5000 readers. The default value is 1.
Default"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": []
}object
result
object (ReaderGroupCustomerV2)
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.
string
associated_invited_sso_users
Array of string
List of reader invitation IDs. Applicable only for SSO readers.
string
access_scope
object (AccessScopeCustomerV2)
access_level
integer (int32)
This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage
Valid values[0,1,2,3,4,5,6]
categories
Array of object (CategorySummaryCustomerV2)
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.
string
languages
Array of object (LanguageSummaryCustomer)
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 (ExtensionDataObject)
success
boolean
Status indication for customer API response
errors
Array of object (BaseError)
Errors in the customer API response
object
extension_data
object (ExtensionDataObject)
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 (BaseWarning)
Warning in the customer API response
object
extension_data
object (ExtensionDataObject)
description
string
Warning description
warning_code
string
warning code for customer Api base response
information
Array of object (BaseInformation)
Information passed by the customer API response
object
extension_data
object (ExtensionDataObject)
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
}object
result
object (ReaderGroupCustomerV2)
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.
string
associated_invited_sso_users
Array of string
List of reader invitation IDs. Applicable only for SSO readers.
string
access_scope
object (AccessScopeCustomerV2)
access_level
integer (int32)
This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage
Valid values[0,1,2,3,4,5,6]
categories
Array of object (CategorySummaryCustomerV2)
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.
string
languages
Array of object (LanguageSummaryCustomer)
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 (ExtensionDataObject)
success
boolean
Status indication for customer API response
errors
Array of object (BaseError)
Errors in the customer API response
object
extension_data
object (ExtensionDataObject)
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 (BaseWarning)
Warning in the customer API response
object
extension_data
object (ExtensionDataObject)
description
string
Warning description
warning_code
string
warning code for customer Api base response
information
Array of object (BaseInformation)
Information passed by the customer API response
object
extension_data
object (ExtensionDataObject)
description
string
status description for customer Api response information
Was this article helpful?