# Attributes

{% openapi src="/files/FoLR1rYzP0lGDEGi6FAf" path="/attributes" method="get" %}
[api.yaml](https://3609403033-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZJAMIKVcqchSDbt4A7DE%2Fuploads%2FEmr27BR19sscc7oesVcd%2Fapi.yaml?alt=media\&token=de60465d-cb32-47e9-89b2-80e44a1e95e2)
{% endopenapi %}

{% openapi src="<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>" path="/attributes" method="post" %}
<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>
{% endopenapi %}

{% openapi src="<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>" path="/attributes" method="put" %}
<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>
{% endopenapi %}

{% openapi src="<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>" path="/attributes/{uid}" method="get" %}
<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>
{% endopenapi %}

{% openapi src="<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>" path="/attributes/{uid}/references" method="get" %}
<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>
{% endopenapi %}

{% openapi src="<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>" path="/attributes/batch" method="post" %}
<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>
{% endopenapi %}

{% hint style="info" %}
This model is an abstract type and can attain any of the below concrete models. The AttributeType property is used to define the actual model type.
{% endhint %}

<details>

<summary>AttributeReferenceAttribute</summary>

| Property name          | Data type | Description                                                                                                                                                           |
| ---------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| AllowMultipleValues    | boolean   | Indicates whether users can select more than one attribute                                                                                                            |
| AllowedAttributeScopes | array     | Attribute scopes from which attributes can be selected                                                                                                                |
| AllowedAttributeTypes  | array     | The attribute types that is allowed to be referenced                                                                                                                  |
| UnfoldComplexTypes     | boolean   | Indicates whether user can select sub attributes of complex attributes                                                                                                |
| Uid                    | string    | Unique id of attribute                                                                                                                                                |
| Alias                  | string    | Unique alias of attribute. Max length is 50 characters and can only consist of letters a-z/A-Z and numbers 0-9 (but cannot start with a number)                       |
| BackofficeName         | string    | The name of the attribute displayed to the editor in the PIM backoffice                                                                                               |
| BackofficeDescription  | string    | The description of the attribute displayed to the editor in the PIM backoffice                                                                                        |
| Name                   | object    | The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)                     |
| Description            | object    | The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value) |
| AttributeGroupId       | integer   | The id of the attribute group this attribute is placed within                                                                                                         |
| AttributeScope         | string    | Unique id of the attribute scope this attribute is placed within                                                                                                      |
| AttributeScopes        | array     | Unique ids of the attribute scopes this attribute is placed within                                                                                                    |
| Localized              | boolean   | Indicates whether values of this attribute are localized                                                                                                              |
| FallbackLanguage       | integer   | Indicates a fallback language in case attribute is localized and no value is added to a specific language                                                             |
| DimensionUid           | string    | Unique id of Dimension to segment values of this attribute on                                                                                                         |
| FallbackSegment        | string    | Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension                                           |
| ReadOnly               | boolean   | Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.                                     |
| Mandatory              | boolean   | Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.                                    |
| Unchangeable           | boolean   | Indicates whether this attribute cannot change its value, once it has a value assigned. NOTE: Only applied when attribute is a sub attribute of a complex attribute.  |
| AttributeType          | string    | Type of attribute                                                                                                                                                     |
| DisableRevisionLogging | boolean   | Disable all revision logging for this attribute                                                                                                                       |
| DisableIndexing        | boolean   | Disable indexing for this attribute                                                                                                                                   |

</details>

<details>

<summary>BooleanAttribute</summary>

<table data-full-width="true"><thead><tr><th>Property name</th><th>Data type</th><th>Description</th></tr></thead><tbody><tr><td>Uid</td><td>string</td><td>Unique id of attribute</td></tr><tr><td>Alias</td><td>string</td><td>Unique alias of attribute. Max length is 50 characters and can only consist of letters a-z/A-Z and numbers 0-9 (but cannot start with a number)</td></tr><tr><td>BackofficeName</td><td>string</td><td>The name of the attribute displayed to the editor in the PIM backoffice</td></tr><tr><td>BackofficeDescription</td><td>string</td><td>The description of the attribute displayed to the editor in the PIM backoffice</td></tr><tr><td>Name</td><td>object</td><td>The localized name of the attribute usable for displaying the attribute name in ex. a webshop (Dictionary of ISO culturecode and localized value)</td></tr><tr><td>Description</td><td>object</td><td>The localized description of the attribute usable for displaying a description for the attribute on ex. a webshop (Dictionary of ISO culturecode and localized value)</td></tr><tr><td>AttributeGroupId</td><td>integer</td><td>The id of the attribute group this attribute is placed within</td></tr><tr><td>AttributeScope</td><td>string</td><td>Unique id of the attribute scope this attribute is placed within</td></tr><tr><td>AttributeScopes</td><td>array</td><td>Unique ids of the attribute scopes this attribute is placed within</td></tr><tr><td>Localized</td><td>boolean</td><td>Indicates whether values of this attribute are localized</td></tr><tr><td>FallbackLanguage</td><td>integer</td><td>Indicates a fallback language in case attribute is localized and no value is added to a specific language</td></tr><tr><td>DimensionUid</td><td>string</td><td>Unique id of Dimension to segment values of this attribute on</td></tr><tr><td>FallbackSegment</td><td>string</td><td>Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension</td></tr><tr><td>ReadOnly</td><td>boolean</td><td>Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.</td></tr><tr><td>Mandatory</td><td>boolean</td><td>Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.</td></tr><tr><td>Unchangeable</td><td>boolean</td><td>Indicates whether this attribute cannot change its value, once it has a value assigned. NOTE: Only applied when attribute is a sub attribute of a complex attribute.</td></tr><tr><td>AttributeType</td><td>string</td><td>Type of attribute</td></tr><tr><td>DisableRevisionLogging</td><td>boolean</td><td>Disable all revision logging for this attribute</td></tr><tr><td>DisableIndexing</td><td>boolean</td><td>Disable indexing for this attribute</td></tr></tbody></table>

</details>

{% openapi src="<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>" path="/attributes/batch/references" method="post" %}
<https://api.easycatalogue-dev.cloudtest13.structpim.com/swagger/docs/Struct%20PIM%20v3>
{% endopenapi %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.struct.com/pim3/api-reference/attributes.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.