Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 4.07 KB

custom-attribute-definition.md

File metadata and controls

38 lines (29 loc) · 4.07 KB
Raw

Custom Attribute Definition

Represents a definition for custom attribute values. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom attribute.

Structure

CustomAttributeDefinition

Fields

Name Type Tags Description
key string | null | undefined Optional The identifier
of the custom attribute definition and its corresponding custom attributes. This value
can be a simple key, which is the key that is provided when the custom attribute definition
is created, or a qualified key, if the requesting
application is not the definition owner. The qualified key consists of the application ID
of the custom attribute definition owner
followed by the simple key that was provided when the definition was created. It has the
format application_id:simple key.

The value for a simple key can contain up to 60 alphanumeric characters, periods (.),
underscores (_), and hyphens (-).

This field can not be changed
after the custom attribute definition is created. This field is required when creating
a definition and must be unique per application, seller, and resource type.
Constraints: Minimum Length: 1, Pattern: ^([a-zA-Z0-9\._-]+:)?[a-zA-Z0-9\._-]{1,60}$
schema Record<string, unknown> | null | undefined Optional The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,
see Custom Attributes Overview. This field is required when creating a definition.
name string | null | undefined Optional The name of the custom attribute definition for API and seller-facing UI purposes. The name must
be unique within the seller and application pair. This field is required if the
visibility field is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.
Constraints: Maximum Length: 255
description string | null | undefined Optional Seller-oriented description of the custom attribute definition, including any constraints
that the seller should observe. May be displayed as a tooltip in Square UIs. This field is
required if the visibility field is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.
Constraints: Maximum Length: 255
visibility string | undefined Optional The level of permission that a seller or other applications requires to
view this custom attribute definition.
The Visibility field controls who can read and write the custom attribute values
and custom attribute definition.
version number | undefined Optional Read only. The current version of the custom attribute definition.
The value is incremented each time the custom attribute definition is updated.
When updating a custom attribute definition, you can provide this field
and specify the current version of the custom attribute definition to enable
optimistic concurrency.

On writes, this field must be set to the latest version. Stale writes are rejected.

This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,
see Custom Attributes Overview.
updatedAt string | undefined Optional The timestamp that indicates when the custom attribute definition was created or most recently updated,
in RFC 3339 format.
createdAt string | undefined Optional The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.

Example (as JSON)

{
  "key": "key8",
  "schema": {
    "key1": "val1",
    "key2": "val2"
  },
  "name": "name8",
  "description": "description2",
  "visibility": "VISIBILITY_READ_WRITE_VALUES"
}