Class: Perka::Model::EntityAnnotation

Inherits:

Object
Flatpack::Core::BaseHasUuid
BaseEntityGlobal
Perka::Model::EntityAnnotation

show all

Defined in:: lib/perka/model/entity_annotation.rb

Overview

Allows integrators to associate an arbitrary JSON object with a persistent entity. Any instance of an EntityAnnotation is specific to a particular IntegratorUser and multiple integrators may annotate the same entity. <p> When a request is made to the API server by an integrator or by any other user that is managed by an integrator, any EntityAnnotations associated with objects in the returned payload will be included as extra data.

Constant Summary collapse

PROPERTY_NAMES =

[

  # The target entity for the annotation.
  :entity,

  # The custom data which may be any JSON value.
  :annotation
]

TYPE_MAP =

{
  :entity => Perka::Model::BaseEntityGlobal
}