Property

Property definition: a named, typed attribute of a table, the user schema or a user profile schema

type Property implements AdminSharedAttributesInterface {
  attribute_type: PropertyTypeEnum!
  belongs_to: String
  created_at: JSONDate!
  default_value: String
  id: ID!
  manually_managed: Boolean
  metadata: HashObject
  name: String!
  options: HashObject
  physical_file_path: String
  target_id: ID!
  target_type: String!
  updated_at: JSONDate!
}

Fields

attribute_type (PropertyTypeEnum)

Type of the property

belongs_to (String)

Name of the table (or user) the property refers to, defining a relationship. Used when importing and exporting data

created_at (JSONDate)

Timestamp of when the object was created, set automatically by the system

default_value (String)

Default value stored with the definition. It is not applied to new records automatically

id (ID)

Unique identifier of the object

manually_managed (Boolean)

When true, the resource is managed outside of files: pos-cli deploy and sync never overwrite or delete it

metadata (HashObject)

Free-form data attached to the resource with the metadata key of its file (or the metadata argument of an admin mutation)

name (String)

Name of the property

options (HashObject)

Settings of an upload property, for example access control, size limits and image versions; empty for other types

physical_file_path (String)

Path of the file the resource comes from, relative to the app directory, for
example views/pages/index.liquid or
modules/my_module/public/views/partials/header.liquid. Identifies the resource
in deploy, sync and admin mutations

target_id (ID)

Id of the schema the property belongs to

target_type (String)

Kind of schema the property belongs to: CustomModelType (a table), UserType
(the user schema) or InstanceProfileType (a user profile schema)

updated_at (JSONDate)

Timestamp of when the object was last updated, set automatically by the system

Interfaces

AdminSharedAttributesInterface

Attributes shared by resources that can be deployed from files with pos-cli
(pages, partials, layouts, notifications, authorization policies, schemas, assets etc.)