Card links
A link shown in the Links block of a card: a page in another system (url), another card of the package (linked_card_ref) or a document of the package (linked_document_ref). Write one record per link on a card; give exactly one of the three. Only http and https addresses are accepted. description is the caption shown to users.
A record of this entity needs records of other entities in the package: Cards.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "card_links". An entity can have any number of files. See Bundle format.
[
{
"resource": "card_links",
"path": "resources/card_links.json"
}
]Fields
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string (ExternalId) | Yes | Your own identifier of the record, for example k-mrr, unique within the resource across all of its files and case sensitive. Other records refer to this one by it.Constraints: 1–512 characters. |
card_ref | Ref<cards> refers to Cards | Yes | The card that shows the link. Give the external_id of a cards record. |
linked_card_ref | Ref<cards> refers to Cards | When url and linked_document_ref are absent | Another card of the package that the link opens. It differs from card_ref, and its external_id contains only latin letters, digits, _ and -. Give the external_id of a cards record.Rule: Exactly one of url, linked_card_ref and linked_document_ref. |
linked_document_ref | Ref<documents> refers to Documents | When url and linked_card_ref are absent | A document of the package that the link opens. Give the external_id of a documents record.Rule: Exactly one of url, linked_card_ref and linked_document_ref. |
url | string | When linked_card_ref and linked_document_ref are absent | The address of a page outside the package, for example https://dashboards.example.com/mrr. Only http and https; up to 16384 characters.Constraints: at most 16384 characters; pattern ^https?://; format uri. Rule: Exactly one of url, linked_card_ref and linked_document_ref. |
description | string? | No | The caption shown for the link, for example Live MRR dashboard. |
References
Show on the entity map
Example
A record of this entity:
{
"external_id": "xla-mrr-dashboard",
"card_ref": "k-mrr",
"url": "https://dashboards.example.com/mrr",
"description": "Live MRR dashboard"
}Rules
- exactly one of url, linked_card_ref and linked_document_ref.
- The combination of card_ref, url must be unique.
- The combination of card_ref, linked_card_ref must be unique.
- The combination of card_ref, linked_document_ref must be unique.
- card_ref and linked_card_ref must differ.
Related entities
Cards, Documents
Check after the import
After the import, the records of this entity can be checked on Card external links › Retrieve card external links.
JSON Schema
card_links.json
