본문으로 건너뛰기

RelationTypeCreate

Payload used to create Relation Type. Required fields are name, collection_id, source, target.

nameName (string)필수

lower_snake_case identifier from 1 to 63 characters. It must start with a lowercase letter or underscore and may contain lowercase letters, digits, and underscores. Minimum length: 1. Maximum length: 63.

Possible values: non-empty and <= 63 characters, Value must match regular expression ^[a-z][a-z0-9_]{0,62}(?![\s\S])

alias object
하나 이상(anyOf)
string
type object
하나 이상(anyOf)
string
collection_idCollection Id (string)필수

Parent collection ID (required)

Possible values: non-empty

ontology_id object

Parent Ontology Model ID (required unless a sole legacy model resolves)

하나 이상(anyOf)
string

Possible values: non-empty

folder_id object
하나 이상(anyOf)
string
tags object
하나 이상(anyOf)
  • Array [
    • string
  • ]
    • description object
    하나 이상(anyOf)
    string
    sourceSource (string)필수

    Source entity type ID

    targetTarget (string)필수

    Target entity type ID

    backingBacking (string)

    How the relation is stored. link_table materializes its own table; object has no storage of its own and composes two existing relations through an intermediate entity.

    Possible values: [link_table, foreign_key, object]

    기본값: link_table
    via object

    For backing='object', the two constituent relation type identifiers in order. The intermediate entity is derived from them rather than stored.

    하나 이상(anyOf)
  • Array [
    • string
  • ]
    • source_columns object

    Columns of this relation's rows that carry the source endpoint's identity, in that endpoint's key order. Defined by role, not by table: link_table reads them on the relation's own table, foreign_key on the source entity's table (where they are its identity key). backing says which.

    하나 이상(anyOf)
  • Array [
    • string
  • ]
    • target_columns object

    Columns of this relation's rows that carry the target endpoint's identity. For foreign_key these are the user-chosen FK columns on the source entity's table.

    하나 이상(anyOf)
  • Array [
    • string
  • ]
    • cardinalityCardinality (string)

    Allowed values: many_to_many, many_to_one, one_to_many, one_to_one.

    Possible values: [many_to_many, many_to_one, one_to_many, one_to_one]

    기본값: many_to_many
    schema object

    Relation attribute schema (Arrow JSON)

    하나 이상(anyOf)
    object
    RelationTypeCreate
    {
      "name": "string",
      "alias": "string",
      "type": "string",
      "collection_id": "string",
      "ontology_id": "string",
      "folder_id": "string",
      "tags": [
        "string"
      ],
      "description": "string",
      "source": "string",
      "target": "string",
      "backing": "link_table",
      "via": [
        "string"
      ],
      "source_columns": [
        "string"
      ],
      "target_columns": [
        "string"
      ],
      "cardinality": "many_to_many",
      "schema": {}
    }