Get Extra Value details
- 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Get Extra Value details
- 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
Get
/extra-values/{id}/
Operation is used to retrieve full details of given Extra Value by id. Available from product version 3.0.24.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of Extra Value
Responses
200
Extra Value
object
Extra Value
created
string (date-time)
Creation date and time
extraAttribute
object (ExtraAttribute)
Extra Attribute
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
object (ObjectType)
id
integer
Primary key
identifier
string
Object type readable identifier
instanceAPIUrl
string (url)
Object type instances API endpoint URL.
name
string
Object type translated name. Not searchable.
objectTypesUrl
string (url)
Url to fetch all object types.
extraValue
string
Value of Attribute. Format is defined by related Extra Attribute data type
id
integer
Unique id of Extra Value
modified
string (date-time)
Creation date and time
relatedInstanceId
integer
Id of related object instance
relatedInstanceUrl
string (url)
Url of related object instance in the API
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
404
Object was not found
{
"details": "Not found."
}object
details
string
Detailed description of error
Was this article helpful?
