Get base erd

Get the erd of a base

GET /base/{baseId}/erd

cURL

cURL

curl --request GET \
  --url https://sheets.vn/api/base/%7BbaseId%7D/erd \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

200

{
  "baseId": "<string>",
  "nodes": [
    {
      "id": "<string>",
      "name": "<string>",
      "fields": [
        {
          "id": "<string>",
          "name": "Tags",
          "type": "singleSelect",
          "isLookup": true,
          "isConditionalLookup": true,
          "isPrimary": true
        }
      ],
      "icon": "<string>",
      "crossBaseId": "<string>",
      "crossBaseName": "<string>"
    }
  ],
  "edges": [
    {
      "source": {
        "tableId": "<string>",
        "tableName": "<string>",
        "fieldId": "<string>",
        "fieldName": "<string>"
      },
      "target": {
        "tableId": "<string>",
        "tableName": "<string>",
        "fieldId": "<string>",
        "fieldName": "<string>"
      },
      "isOneWay": true
    }
  ]
}

Ủy quyền

Authorization · string · header · bắt buộc

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Tham số đường dẫn

baseId · string · bắt buộc

Phản hồi

200 - application/json

Returns the erd of a base.

baseId · string · bắt buộc

nodes · object[] · bắt buộc

Show child attributes

edges · object[] · bắt buộc

Show child attributes