Data Model

Provide a single resource - Attribute

Retrieves a attributes resource.

get/attributes/{id}

Request

  • Base URL
    https://{instance_name}.quable.com/api
  • URL
    https://{instance_name}.quable.com/api/attributes/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

Resource identifier

Response

attributes resource

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

Changes

No recorded changes to this operation across all 1 revision of this API.