How to Add a Custom Attribute to a Group Using the Bold BI REST API

This article explains how to add a custom attribute to a specific group using the Bold BI REST API.

Authorization

To perform this operation, include a valid access token in the request header. For information on generating an access token, refer to the following article: Generate Access Token.

Authorization: bearer <token>

End Points

Self-Hosted Server

https://{yourdomain}/bi/api/site/<site_identifier>/v6.0/attribute/group

Bold BI Cloud Server

https://{yourdomain}/bi/api/v6.0/attribute/group

Request Type

• POST: Used to create a new attribute for a specific group.

Steps to Add an Attribute for a Specific Group via the Bold BI REST API

1. Configure the Endpoint
   Configure a POST request using the appropriate endpoint based on your deployment type.

https://{yourdomain}/bi/api/site/<site_identifier>/v6.0/attribute/group

2. Add the Authorization Header
   Include the access token in the request headers:

Authorization: bearer <token> 

• In the Body tab, select raw and set the format to JSON. Provide the details in the following structure

{
 "Name": "string",
 "Value": "string",
 "Description": "string",
 "CanEncrypt": true,
 "GroupId": 0
}

• The request body must contain the required fields:

  • Name (required): Specifies the name of the attribute.
  • Value (required): Specifies the value of the attribute
  • Description (optional): Specifies the description of the attribute
  • CanEncrypt (optional): A Boolean indicating whether the attribute value should be encrypted.
  • GroupId (required): Specifies the target group ID. To retrieve the available group IDs, refer to the following article: Get the List of Group Details.

• Example JSON Data

{
 "Name": "groupattribute1",
 "Value": "groupattribute1_value",
 "Description": "string",
 "CanEncrypt": true,
 "GroupId": 2
}

4. Send the request
   Click Send to execute the request. If the operation is successful, the API returns:

Responses

• 200 - Attribute created successfully.
• 400 - The request body is missing required fields.
• 405 - Invalid HTTP method. Only POST is supported.
• 406 - Invalid request payload.
• 409 - An attribute with the specified name already exists.
• 417 - Failed to create attribute details.

Additional References

• REST API - Attributes