Sign in

v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB
Data Model

Update a single resource - Attribute

Replaces the attributes resource.

put/attributes/{id}

Path parameters

idstring required

Resource identifier

Request body

isEditableboolean
isFilterableboolean
isVisibleboolean
isPrimaryboolean
isRequiredboolean

Example request

{
  "name": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  },
  "description": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  },
  "helpText": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  }
}

Response

attributes resource updated

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"
}