Sign in

v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB
Data Model

Provide a paginated list of AttributeSets

Retrieves the collection of AttributeSet resources.

get/attribute-sets

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

paginationboolean

Enable or disable pagination

idstring
id[]string[]
documentType.idstring
documentType.id[]string[]
searchstring
namestring
language'fr-FR' | 'de-DE' | 'en-US' | 'es-ES' | 'it-IT' | 'nl-NL' | 'pl-PL' | 'ro-RO' | 'ru-RU' | 'zh-CN' | 'ja-JP'

Any language

language[]Language[]
order[name]'asc' | 'desc'
order[id]'asc' | 'desc'
order[documentType.id]'asc' | 'desc'

Response

AttributeSet collection

legacyIdinteger
idstring required

This is the unique identifier of the resource

documentTypeCodestring required

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

dateModifiedstring date-time nullable

This is an ISO datetime

dateCreatedstring date-time nullable

This is an ISO datetime

Example response

[
  {
    "attributes": {
      "id": "attribute_example",
      "position": 1
    },
    "id": "identifier_example",
    "documentTypeCode": "document_type_example",
    "description": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "name": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    }
  }
]