Hierarchical Value Service API  future
api index

Link Object

since: 0.6
This object contains the metadata of a symbolic link to a table. Client can query a table via a link that is currently pointing to it. One link can only be pointing to a single table at a given point of time. Multiple links can point to the same table at a given time. Any modifications to the table or deletion of the table are not allowed via link. When query via a link, if the destination table does not exist, response will return NOT_FOUND status.

Fields

id
0.6required
string
The system-defined internal object ID (in UUID canonical string format).

example value

0a4fa51c-c040-46a0-a3d0-63ca0e9ae699
name
0.6required
string
The name used to identify the link to external systems. It must be unique among tables and link.

The length constraints are applied to the Unicode Character Representations of the name string.

0.6 min length: 1
0.6 max length: 128
tableID
0.6required
string
The ID of the table this link is pointing to. It is in UUID canonical string format.

example value

0c4ea51a-c040-46a0-a3d0-63ca0e9ae699

Related API Resources

Example - Example Link Definition

  {
    "id"       : "c689acc7-ee13-3482-aa7b-c6a13419431c",
    "name"     : "link 1",
    "tableID"  : "abcdef00-1234-5678-9012-34567890abcd"
  }