Sign in

v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB
Data Model

This endpoint provides a paginated list of Attributes

Retrieves the collection of attributes resources.

get/attributes

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

paginationboolean

Enable or disable pagination

catalogs.idstring
catalogs.id[]string[]
order[id]'asc' | 'desc'
naturestring
nature[]string[]
idstring
id[]string[]
documentTypeIdstring
type'date' | 'decimal' | 'html_text' | 'integer' | 'json' | 'localized_text' | 'multi_select' | 'multiline_text' | 'simple_select' | 'switch' | 'time' | 'unlocalized_text'
type[]string[]
hasAttributeSetboolean
attributeSetstring
attributeSet[]string[]
usedInFormulastring
isFilterableboolean
isPrimaryboolean

Response

attributes collection

type'date' | 'decimal' | 'html_text' | 'integer' | 'json' | 'localized_text' | 'multi_select' | 'multiline_text' | 'simple_select' | 'switch' | 'time' | 'unlocalized_text'
isVisibleboolean
isEditableboolean
isFilterableboolean
isPrimaryboolean
isRequiredboolean
isAIEnabledboolean
isComputedboolean
dateCreatedstring date-time nullable

This is an ISO datetime

dateModifiedstring date-time nullable

This is an ISO datetime

documentTypestring iri-reference
aiTemplatestring iri-reference nullable
idstring

This is the unique identifier of the resource

documentTypeCodestring

This is the unique identifier of the document type that the resource should be apply to

legacyIdinteger
AITemplatestring iri-reference nullable

Example response

[
  {
    "type": "date",
    "helpText": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "id": "identifier_example",
    "description": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "name": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "documentTypeCode": "document_type_example"
  }
]