Long item object representation

The longitem object representation and fields are described below.

longitem was introduced in API version V1

longitem has not been marked for deprecation

Usages

Description

Representation of a long integer item

Example create representation

{
  "name" : "population_of_earth",
  "sortOrder" : 0,
  "value" : 8300000000,
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  }
}

Example response representation

{
  "urn" : "475972cf-00cd-4ec3-beee-ab546d011cca",
  "name" : "population_of_earth",
  "sortOrder" : 0,
  "value" : 8300000000,
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  },
  "url" : "/n/v1/longitem/475972cf-00cd-4ec3-beee-ab546d011cca"
}

Fields

NameTypeDescriptionConstraints
urnString representation of a Unique Resource Name. Typically a UUID with 36 characters.Minimum length: 36. Maximum length: 36.
nameField name, typically used in content items. Typically use conventions around html ID expectations.Name for the field e.g. population. Field names can be arbitrary but suggest using Javascript friendly / html ID friendly namesRequired on create. Maximum length: 1024.
sortOrderSigned int32Field sorting order for field orderingRequired on create.
valueSigned int64A long (64bit) integer valueRequired on create. Minimum: -9223372036854775808. Maximum: 9223372036854775807.
entityentityThe entity this long integer item is associated with.Required on create.
urlURL represented as a stringEndpoint URL for this text item