RelationTypeResponse

Data returned for Relation Type. Required fields are id, name, category, source, target, item.

idId (string)필수

Server-assigned unique identifier

nameName (string)필수

Resource name

alias object

Display name shown to users.

하나 이상(anyOf)

• string
• null

string

categoryCategory (string)필수

Resource type tag

type object

Subtype within category

하나 이상(anyOf)

• string
• null

string

collection_id object

Parent collection ID

하나 이상(anyOf)

• string
• null

string

folder_id object

Identifier of the containing folder.

하나 이상(anyOf)

• string
• null

string

tags object

Classification labels

하나 이상(anyOf)

• string[]
• null

Array [

string

]

description object

Resource description

하나 이상(anyOf)

• string
• null

string

markingsstring[]

Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

기본값: []

created_at object

Creation timestamp (Unix ms)

하나 이상(anyOf)

• integer
• null

integer

updated_at object

Last update timestamp (Unix ms)

하나 이상(anyOf)

• integer
• null

integer

owners object[]

Users and groups that own the resource.

Array [

idId (string)필수

"user." | "group." | "public.all"

typeType (string)필수

Possible values: [user, group, public]

display_nameDisplay Name (string)필수

avatar_url object

하나 이상(anyOf)

• string
• null

string

avatar_config object

하나 이상(anyOf)

• object
• null

object

email object

하나 이상(anyOf)

• string<email>
• null

string<email>

]

my_share_scope object

How the current caller received access to the resource.

하나 이상(anyOf)

• string
• null

string

Possible values: [owner, grant, admin]

ontology_id object

Owning Ontology Model ID

하나 이상(anyOf)

• string
• null

string

sourceSource (string)필수

Source entity type ID

targetTarget (string)필수

Target entity type ID

backingBacking (string)

Relation storage strategy

Possible values: [link_table, foreign_key, object]

기본값: link_table

via object

Constituent relation IDs for backing='object'

하나 이상(anyOf)

• string[]
• null

Array [

string

]

source_columns object

Columns carrying the source endpoint's identity in this relation's rows. backing says which table.

하나 이상(anyOf)

• string[]
• null

Array [

string

]

target_columns object

Columns carrying the target endpoint's identity. For backing='foreign_key' these are the FK columns that the legacy source_fk_columns named.

하나 이상(anyOf)

• string[]
• null

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
• null

object

itemItem (string)필수사용 중단

RelationTypeResponse

{
  "id": "string",
  "name": "string",
  "alias": "string",
  "category": "string",
  "type": "string",
  "collection_id": "string",
  "folder_id": "string",
  "tags": [
    "string"
  ],
  "description": "string",
  "markings": [
    "string"
  ],
  "created_at": 0,
  "updated_at": 0,
  "owners": [
    {
      "id": "string",
      "type": "user",
      "display_name": "string",
      "avatar_url": "string",
      "avatar_config": {},
      "email": "user@example.com"
    }
  ],
  "my_share_scope": "owner",
  "ontology_id": "string",
  "source": "string",
  "target": "string",
  "backing": "link_table",
  "via": [
    "string"
  ],
  "source_columns": [
    "string"
  ],
  "target_columns": [
    "string"
  ],
  "cardinality": "many_to_many",
  "schema": {}
}