Add Attribute to Schema

post

https://{hostname}/api/ai-governance/v1/schema-attributes

Use this API to add an attribute to a specific schema.

🗒
Things to Know

This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).

AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.

Query Params

schemaName

string

required

Name of the schema where the attribute will be created

Body Params

fieldName

string

required

length between 0 and 200

Field name used to uniquely identify the attribute

name

string

required

length between 1 and 255

Attribute name

nameKey

string

length between 0 and 200

Attribute name key used for translation

description

string

length ≤ 1000

Attribute description

descriptionKey

string

length between 0 and 200

Attribute description key used for translation

required

boolean

Defaults to false

Indicates if this attribute is required

allowOther

boolean

Defaults to false

Indicates if user-specified values are allowed

responseType

string

enum

required

Response type for the attribute

optionType

string

enum

length between 0 and 200

Defaults to None

Source for attribute options

Allowed:

options

array of objects

List of options for the attribute (applicable for SingleSelect and MultiSelect)

options

referenceCategoryIds

array of uuids

List of category IDs associated with the attribute

referenceCategoryIds

formula

string

length between 0 and 8000

Formula expression for calculated attributes

context

object

Attribute context data

source

string

length ≤ 50

Source of the attribute

responseSubType

string

enum

Response sub type for the attribute

Allowed:

associatedAttributeRequest

object

Associated attribute request information

maxMultiSelectAllowedOptionValues

int32

1 to 100

Maximum number of option values allowed for MultiSelect attributes

encrypted

boolean

Defaults to false

Indicates if this attribute should be encrypted

metadata

string

Metadata about the attribute in JSON format

intakeQuestion

object

Attribute intake question details

validationRuleId

string

length ≤ 255

ID of the validation rule to associate with the attribute

abacBasicAssignmentInfo

array of objects

GUID, name and the objectType of the linked assignment

abacBasicAssignmentInfo

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

201Created

429Too Many Requests. For more information, see API Rate Limits.