Create new extra attribute
- 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Create new extra attribute
- Updated on 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/extra-attributes/
Operation is used to create new extra attribute. Available from product version 3.0.24.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Body parameters
Extra Attribute to be created
object
dataType
string Required
type of data supported by Extra Attribute. Available types are Text (enum text), Multiple line Text (enum multex), Float (enum float), Integer (enum int), Link (enum link), Read-only (enum read_only). Read-only enum is available from product version 3.2.16 if ordered.
Valid values[ "text", "float", "int", "link", "multex", "read_only" ]
description
string
description of Extra Attribute
identifier
string
Unique identifier of Extra Attribute
name
string Required
Name of Extra Attribute
order
integer
Extra Attribute order in the list of attributes output in UI.
relatedInstanceType
integer Required
Object type id the attribute is bound to.
Responses
201
A created Extra Attribute
object
created
string (date-time)
Creation date and time
dataType
string
type of data supported by Extra Attribute. Available types are Text (enum text), Multiple line Text (enum multex), Float (enum float), Integer (enum int), Link (enum link), Read-only (enum read_only). Read-only enum is available from product version 3.2.16 if ordered.
Valid values[ "text", "float", "int", "link", "multex", "read_only" ]
description
string
description of Extra Attribute
id
integer
Unique id of Extra Attribute
identifier
string
Unique identifier of Extra Attribute
modified
string (date-time)
Creation date and time
name
string
Name of Extra Attribute
order
integer
Extra Attribute order in the list of attributes output in UI.
relatedInstanceType
integer
Object type id the attribute is bound to.
400
There was an error in request. Usually field validation failed.
{
"dataType": [
"This field is required."
],
"name": [
"This field is required."
],
"relatedInstanceType": [
"This field is required."
]
}object
Fields which failed validation
property*
Array of string additionalProperties
List of validation errors for this fieldname
string
Validation error
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
