Put
/v1/Readers

Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Body parameters

Details of the reader to add

Expand All

object

reader_id
string   Required 

The ID of the reader to update

Min length1
associated_reader_groups
Array of string

List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.


access_scope
object  Required 

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Expand All

object

reader_id
string   Required 

The ID of the reader to update

Min length1
associated_reader_groups
Array of string

List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.


access_scope
object  Required 

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Expand All

object

reader_id
string   Required 

The ID of the reader to update

Min length1
associated_reader_groups
Array of string

List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.


access_scope
object  Required 

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Expand All

object

reader_id
string   Required 

The ID of the reader to update

Min length1
associated_reader_groups
Array of string

List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.


access_scope
object  Required 

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Responses
200

Success

Readers - Success Response for update reader

This is an example for 200 status, success response.

{
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": null,
  "information": null
}
Expand All

object

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 Id and perform the operation again. This seems to be an error while finding the reader, find your reader Id from /v2/Readers.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The reader id is invalid.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": null,
  "information": null
}
Readers - Required Access Scope

Here you should add access_scope within request body parameter. This may consist of access_level, categories, project_versions, languages.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The reader id is invalid.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": null,
  "information": null
}
Readers - Required associated reader groups

Here you should add associated reader groups within request body parameter.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The AssociatedReaderGroups field is required.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": null,
  "information": null
}
Expand All

object

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