Query for createTraitDefinition

Balaram Barada · 2025-05-05T19:19:05+00:00

There was an error rendering this rich post.

Hi All ,

Can some one help me to understand the createTraitDefinition attribute properties.

Is attribute properties are fixed or Can we add a custom property to attribute i.e like the below examples custom1,custom2, custom3 ?

Swagger API : https://developer.opentext.com/services/products/content-metadata-service/apis/content-metadata#Trait/createTraitDefinition

Example :

"attributes": [
{
"default_value": "",
"data_type": "string",
"read_only": false,
"repeating": false,
"required": false,
"searchable": true,
"sortable": false,
"visible": true,
"unique": false,
"presentation_type": "TextArea",
"custom1":"",
"custom2":"",
"custom":[],
"flow": "new",
"display_name": "bbtarea4",
"display_name_multilingual": {
"en": "bbtarea4"
},
"id": null,
"name": "bbtarea4",
"size": 2000,
"custom_sequence": 1,
"localizable": true,
"url": "/trait-definitions/bbt4/attributes",
"validators": [
{
"type": "length_validator",
"operation": "Create",
"params": [
{
"name": "min",
"value": "1"
}
]
}
]
}
]

Find more posts tagged with

Note:

If there are Accepted Answers, those will be shown by default. You can switch to 'All Replies' by selecting the tab below.

Accepted answers

All comments

LazarescuA

Hello,

Yes, you can create a new trait using the API or using the VS Code extensions (Thrust Studio: https://developer.opentext.com/cloud-platform/documentation/build-with-our-vs-code-extension ). We strongly recommend to use the VS Code extensions to manage and create new definitions (Type, Trait, Workflow, etc.).

If you need to create a Trait definition using the API, in the Swagger example, the attributes node will contain as many attributes you want to add to your trait definition, each object in the array will be one custom attribute. For example, the array below would create a trait with 3 attributes:

. . .
"attributes": [
  {
    "name": "custom1",
    "display_name": "Custom Field 1",
    "data_type": "string",
    "size": 1000
  },
  {
    "name": "custom2",
    "display_name": "Custom Field 2",
    "data_type": "string",
    "size": 256
  },
  {
    "name": "custom",
    "display_name": "Custom Array",
    "data_type": "string",
    "repeating": true,
    "size": 100
  }
],
. . .

The mandatory fields are name, display_name, and data_type. The rest of the properties are optional and control the attribute validation, search, etc.

If you want to see which properties are mandatory, in the swagger example, switch to the schema view:

Balaram Barada

Hi @LazarescuA ,

Thanks for your update .

Regarding attributes with the data type "string," is it possible to include custom field properties beyond the standard ones? In the provided example of a single attribute, can we extend it to include fields such as "additionalprop1" and "additionalprop2"? Furthermore, are the attribute properties restricted to a predefined set, or can we consider them an open JSON object allowing arbitrary properties?

Is the below JSON attribute allowed for single attribute

{    "name": "custom1",    "display_name": "Custom Field 1",    "data_type": "string",    "size": 1000 ,"additionalprop1":"", "additionalprop2":"" }

LazarescuA

I am not sure about the use case here. The attribute of the trait is a property that you can set or get on different instances of the trait. Even if you add other additional properties to the attribute, how would you expect to use those? These properties control how the attribute is filled (for example unique, repeating, size, validators, etc.). If you can describe the use case, it would help understand how you plan on using it.