---
title: "/api/v{version}/attributes/{attributeType}"
slug: "apivversionattributesattributetype-5"
updated: 2025-08-20T01:02:48Z
published: 2026-03-20T12:47:08Z
canonical: "docs.grassfish.com/apivversionattributesattributetype-5"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.grassfish.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /api/v{version}/attributes/{attributeType}

Post/api/v{version}/attributes/{attributeType}

SecurityOAuth

Authorization using OAuth2 with Client Credentials

FlowClient Credentials Authorization URLhttps://identity.eu01.grassfish.com/connect/authorize
Token URLhttps://identity.eu01.grassfish.com/connect/token
		

Header parametersx-correlationTokenstring
x-clientIdstringMin length0Max length128
x-onBehalfOfstringMin length0Max length24
api-versionstring

Path parametersattributeTypestringRequiredValid values[
  "None",
  "Item",
  "POSItem",
  "ClientLocationPlayer",
  "Offer",
  "Assortment",
  "Record",
  "AssortmentItem",
  "TreeSchemaLevel"
]
versionstringRequired

Body parameters<select class='api-response-data' aria-label='Media type'><option value='c1dbcb30-6325-4acc-8987-001071add8f9'>application/json</option>
<option value='fa62bca0-f884-431a-a31e-e8b3fd3084eb'>text/json</option>
<option value='a27b742a-3e25-49cf-a23c-b13c35daf71c'>application/*+json</option>
</select>Expand Allobject  attributes Array of object (Contracts.Connect.Parameters.ModifySingleAttribute)  | null  object  codestring   | null  Min length0Max length24
idstring   | null  Min length0Max length128
namestring   | null  Min length0Max length50
descriptionstring   | null  Min length0Max length256
orderNinteger  (int32)    
readOnlyboolean   | null  
flagsstring    Valid values[
  "None",
  "Mandatory",
  "Default",
  "Share",
  "ValidityPeriod",
  "Options",
  "Fixed",
  "Multi",
  "ShowAsListColumn"
]
valueTypestring    Valid values[
  "String",
  "Currency",
  "Day",
  "DateTime",
  "Int",
  "Float",
  "Media",
  "DatePeriod",
  "Record",
  "Bool",
  "Slider"
]
maxLengthinteger  (int32)    
mediaLibrarystring    Valid values[
  "None",
  "BookingMedia",
  "Logos",
  "OfferMedia",
  "ItemImages",
  "HtmlTemplates",
  "HousingAds",
  "BookingCommentFiles",
  "Maps",
  "PlayerScreenShots",
  "ADinQ",
  "Facebook",
  "PlayoutEntities",
  "Instagram",
  "WebPages",
  "Unsplash",
  "Documents",
  "FallbackMedia",
  "OfferSigns",
  "HtmlTemplateSystemFiles",
  "ImportDocuments"
]
options Array of string  | null  string    
attributes Array of object (Contracts.Connect.Parameters.ModifySingleAttribute)  | null  object Recursive  
placeholderstring   | null  

Expand Allobject  attributes Array of object (Contracts.Connect.Parameters.ModifySingleAttribute)  | null  object  codestring   | null  Min length0Max length24
idstring   | null  Min length0Max length128
namestring   | null  Min length0Max length50
descriptionstring   | null  Min length0Max length256
orderNinteger  (int32)    
readOnlyboolean   | null  
flagsstring    Valid values[
  "None",
  "Mandatory",
  "Default",
  "Share",
  "ValidityPeriod",
  "Options",
  "Fixed",
  "Multi",
  "ShowAsListColumn"
]
valueTypestring    Valid values[
  "String",
  "Currency",
  "Day",
  "DateTime",
  "Int",
  "Float",
  "Media",
  "DatePeriod",
  "Record",
  "Bool",
  "Slider"
]
maxLengthinteger  (int32)    
mediaLibrarystring    Valid values[
  "None",
  "BookingMedia",
  "Logos",
  "OfferMedia",
  "ItemImages",
  "HtmlTemplates",
  "HousingAds",
  "BookingCommentFiles",
  "Maps",
  "PlayerScreenShots",
  "ADinQ",
  "Facebook",
  "PlayoutEntities",
  "Instagram",
  "WebPages",
  "Unsplash",
  "Documents",
  "FallbackMedia",
  "OfferSigns",
  "HtmlTemplateSystemFiles",
  "ImportDocuments"
]
options Array of string  | null  string    
attributes Array of object (Contracts.Connect.Parameters.ModifySingleAttribute)  | null  object Recursive  
placeholderstring   | null  

Expand Allobject  attributes Array of object (Contracts.Connect.Parameters.ModifySingleAttribute)  | null  object  codestring   | null  Min length0Max length24
idstring   | null  Min length0Max length128
namestring   | null  Min length0Max length50
descriptionstring   | null  Min length0Max length256
orderNinteger  (int32)    
readOnlyboolean   | null  
flagsstring    Valid values[
  "None",
  "Mandatory",
  "Default",
  "Share",
  "ValidityPeriod",
  "Options",
  "Fixed",
  "Multi",
  "ShowAsListColumn"
]
valueTypestring    Valid values[
  "String",
  "Currency",
  "Day",
  "DateTime",
  "Int",
  "Float",
  "Media",
  "DatePeriod",
  "Record",
  "Bool",
  "Slider"
]
maxLengthinteger  (int32)    
mediaLibrarystring    Valid values[
  "None",
  "BookingMedia",
  "Logos",
  "OfferMedia",
  "ItemImages",
  "HtmlTemplates",
  "HousingAds",
  "BookingCommentFiles",
  "Maps",
  "PlayerScreenShots",
  "ADinQ",
  "Facebook",
  "PlayoutEntities",
  "Instagram",
  "WebPages",
  "Unsplash",
  "Documents",
  "FallbackMedia",
  "OfferSigns",
  "HtmlTemplateSystemFiles",
  "ImportDocuments"
]
options Array of string  | null  string    
attributes Array of object (Contracts.Connect.Parameters.ModifySingleAttribute)  | null  object Recursive  
placeholderstring   | null  

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='e117c509-2e32-4024-8290-31b57428d2f2'>text/plain</option>
<option value='6dd2ed87-ab33-492f-8bb1-40b0cefe8d87'>application/json</option>
<option value='15cbee66-5c78-4110-b95e-3531587cfd32'>text/json</option>
</select>Expand Allobject  successobject (Contracts.Common.Jsons.Common.SuccessJson)  okboolean    
messagestring   | null  
unauthorizedAccessboolean   | null  
notFoundboolean   | null  
correlationTokenstring   | null  
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError)  | null  object  messagestring   | null  
idstring    Valid values[
  "InvalidDatePeriodEndDateBeforeStartDate",
  "NameAlreadyTaken",
  "ExternalIdAlreadyTaken",
  "CodeAlreadyTaken"
]
fieldNamestring   | null  
isRequiredboolean   | null  
isOutOfRangeboolean   | null  
isTakenboolean   | null  
errorCodestring   | null  
defaultDisplayMessagestring   | null  

errorCodestring   | null  
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson)  messagestring   | null  
defaultDisplayMessagestring   | null  

Expand Allobject  successobject (Contracts.Common.Jsons.Common.SuccessJson)  okboolean    
messagestring   | null  
unauthorizedAccessboolean   | null  
notFoundboolean   | null  
correlationTokenstring   | null  
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError)  | null  object  messagestring   | null  
idstring    Valid values[
  "InvalidDatePeriodEndDateBeforeStartDate",
  "NameAlreadyTaken",
  "ExternalIdAlreadyTaken",
  "CodeAlreadyTaken"
]
fieldNamestring   | null  
isRequiredboolean   | null  
isOutOfRangeboolean   | null  
isTakenboolean   | null  
errorCodestring   | null  
defaultDisplayMessagestring   | null  

errorCodestring   | null  
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson)  messagestring   | null  
defaultDisplayMessagestring   | null  

Expand Allobject  successobject (Contracts.Common.Jsons.Common.SuccessJson)  okboolean    
messagestring   | null  
unauthorizedAccessboolean   | null  
notFoundboolean   | null  
correlationTokenstring   | null  
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError)  | null  object  messagestring   | null  
idstring    Valid values[
  "InvalidDatePeriodEndDateBeforeStartDate",
  "NameAlreadyTaken",
  "ExternalIdAlreadyTaken",
  "CodeAlreadyTaken"
]
fieldNamestring   | null  
isRequiredboolean   | null  
isOutOfRangeboolean   | null  
isTakenboolean   | null  
errorCodestring   | null  
defaultDisplayMessagestring   | null  

errorCodestring   | null  
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson)  messagestring   | null  
defaultDisplayMessagestring   | null  

400

Bad Request

<select class='api-response-data' aria-label='Media type'><option value='3defd711-7e36-427a-aa63-fc413ebf389c'>text/plain</option>
<option value='661d5c26-fbd0-43a9-be78-6f8c1ddf8de6'>application/json</option>
<option value='d0ab4d27-ead6-4ac6-897f-a06da8e3bff0'>text/json</option>
</select>object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

401

Unauthorized

403

Forbidden

<select class='api-response-data' aria-label='Media type'><option value='1d736f26-4b03-438e-a70b-6bdec3380b8f'>text/plain</option>
<option value='128a287e-49a1-48f7-ad4a-77fe67ce6ed3'>application/json</option>
<option value='44c2a42f-04d6-440c-b927-824f6250486e'>text/json</option>
</select>object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

object  typestring   | null  
titlestring   | null  
statusinteger  (int32)   | null  
detailstring   | null  
instancestring   | null  
property*

500

Internal Server Error