twigs / core data model / relationship

A relationship between any other top-level constructs


Name Type Description
type ["relationship"] Hardcoded value to indicate what type of construct this is
id string Globally unique identifier for this construct.
revision integer The revision number of this construct. MUST be omitted if this is the first version, otherwise required.
created_at string Time at which this construct was created.
external_ids array <object> A list of external identifiers by which this construct may be known.
source string The source of this ID, i.e. name of an external system.
id string ID itself
link string A link to this construct in the external system
producer_ref string ID to the information source that produced this content
marking_refs array <string> The set of markings to be applied to this construct
structured_markings array <structured-marking> The set of L2 markings to be applied to this construct
controlled_structures array <string> A list of JSONPath statements, rooted at the top-level object that the structured_markings key is contained in, that the marking_refs apply to.
marking_refs array <string> The set of markings applied to the fields selected by the controlled_structures.
value string The type of relationship being described.
source_ref string The id of the source (from node) of the relationship.
target_ref string The id of the target (to node) of the relationship
observed_at array <date-time> A list of times that this relationship was observed.
credibility integer The credibility of this construct, using the Admirality scale