> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-pro/system-or-attribute-definitions.md).

# System | Attribute Definitions

## GET /v1/system/attribute-definitions

> Retrieve a list of Attribute Definitions

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"tags":[{"name":"System | Attribute Definitions"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"AttributeDefinitionList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AttributeDefinition"}},"total":{"type":"integer","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"AttributeDefinition":{"required":["self"],"type":"object","properties":{"description":{"type":"string","description":"A further description of the attribute","nullable":true},"knownValues":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueReference"},"description":"Values that already have been defined for this definition.\nYou can add new values to the definition any time.","nullable":true},"id":{"type":"integer","description":"The identifier of the attribute definition.","format":"int32"},"name":{"type":"string","description":"The name of the attribute.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"AttributeValueReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute value.","format":"int32"},"displayValue":{"type":"string","description":"The value for the attribute to be displayed.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/attribute-definitions":{"get":{"tags":["System | Attribute Definitions"],"summary":"Retrieve a list of Attribute Definitions","responses":{"200":{"description":"OK: Attribute definition list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeDefinitionList"}}}},"400":{"description":"Bad request: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key or expired access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /v1/system/attribute-definitions

> Create a new attribute definition

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"tags":[{"name":"System | Attribute Definitions"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"AttributeDefinitionCreate":{"required":["name"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueCreate"},"description":"Create expected values for the attribute definition. You can add further values later at any time.","nullable":true},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The name of the attribute."},"description":{"maxLength":500,"minLength":0,"type":"string","description":"A further description of the attribute.","nullable":true}},"additionalProperties":false},"AttributeValueCreate":{"required":["displayValue"],"type":"object","properties":{"displayValue":{"maxLength":50,"minLength":0,"type":"string","description":"The value for the attribute to be displayed."}},"additionalProperties":false},"AttributeDefinition":{"required":["self"],"type":"object","properties":{"description":{"type":"string","description":"A further description of the attribute","nullable":true},"knownValues":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueReference"},"description":"Values that already have been defined for this definition.\nYou can add new values to the definition any time.","nullable":true},"id":{"type":"integer","description":"The identifier of the attribute definition.","format":"int32"},"name":{"type":"string","description":"The name of the attribute.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"AttributeValueReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute value.","format":"int32"},"displayValue":{"type":"string","description":"The value for the attribute to be displayed.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/attribute-definitions":{"post":{"tags":["System | Attribute Definitions"],"summary":"Create a new attribute definition","requestBody":{"description":"Information of the attribute definition to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeDefinitionCreate"}}}},"responses":{"201":{"description":"Created: The created attribute definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeDefinition"}}}},"400":{"description":"Bad request: Body validation failed. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## GET /v1/system/attribute-definitions/{definitionId}

> Retrieve a single attribute definition by its ID

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"tags":[{"name":"System | Attribute Definitions"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"AttributeDefinition":{"required":["self"],"type":"object","properties":{"description":{"type":"string","description":"A further description of the attribute","nullable":true},"knownValues":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueReference"},"description":"Values that already have been defined for this definition.\nYou can add new values to the definition any time.","nullable":true},"id":{"type":"integer","description":"The identifier of the attribute definition.","format":"int32"},"name":{"type":"string","description":"The name of the attribute.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"AttributeValueReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute value.","format":"int32"},"displayValue":{"type":"string","description":"The value for the attribute to be displayed.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/attribute-definitions/{definitionId}":{"get":{"tags":["System | Attribute Definitions"],"summary":"Retrieve a single attribute definition by its ID","parameters":[{"name":"definitionId","in":"path","description":"The identifier of the attribute definition.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK: The requested attribute definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeDefinition"}}}},"400":{"description":"Bad request: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid API key or expired access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: Requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## DELETE /v1/system/attribute-definitions/{definitionId}

> Delete an existing attribute definition

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"tags":[{"name":"System | Attribute Definitions"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/attribute-definitions/{definitionId}":{"delete":{"tags":["System | Attribute Definitions"],"summary":"Delete an existing attribute definition","parameters":[{"name":"definitionId","in":"path","description":"The identifier of the attribute definition to be deleted.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"NoContent: Delete successfully."},"400":{"description":"Bad request: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: Requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## PATCH /v1/system/attribute-definitions/{definitionId}

> Partially update an existing attribute definition

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"tags":[{"name":"System | Attribute Definitions"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"Operation":{"type":"object","properties":{"value":{"nullable":true},"path":{"type":"string","nullable":true},"op":{"type":"string","nullable":true},"from":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/attribute-definitions/{definitionId}":{"patch":{"tags":["System | Attribute Definitions"],"summary":"Partially update an existing attribute definition","parameters":[{"name":"definitionId","in":"path","description":"The identifier of the attribute definition.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Information of the attribute definition to be updated.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}}}}},"responses":{"204":{"description":"NoContent: Update successful."},"400":{"description":"Bad request: Body validation failed. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: Requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /v1/system/attribute-definitions/{definitionId}/values

> Create a new attribute value for a definition

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"tags":[{"name":"System | Attribute Definitions"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"AttributeValueCreate":{"required":["displayValue"],"type":"object","properties":{"displayValue":{"maxLength":50,"minLength":0,"type":"string","description":"The value for the attribute to be displayed."}},"additionalProperties":false},"AttributeValueReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute value.","format":"int32"},"displayValue":{"type":"string","description":"The value for the attribute to be displayed.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/system/attribute-definitions/{definitionId}/values":{"post":{"tags":["System | Attribute Definitions"],"summary":"Create a new attribute value for a definition","parameters":[{"name":"definitionId","in":"path","description":"Information for which attribute definition the value should be created.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Information of the attribute value to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeValueCreate"}}}},"responses":{"201":{"description":"Created: The created attribute value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeValueReference"}}}},"400":{"description":"Bad request: Body validation failed. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://hub.equipme.io/development/api-reference-pro/system-or-attribute-definitions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.