Checklists

A named checklist on a card, such as "Metric definition checklist". It holds no items itself: its items are checklist_items. Each checklist belongs to one card; a card can have several, shown in the order of their records.
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": "checklists". An entity can have any number of files. See Bundle format.
[
  {
    "resource": "checklists",
    "path": "resources/checklists.json"
  }
]
Fields
FieldTypeRequiredDescription
external_idstring (ExternalId)YesYour 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_refRef<cards>

refers to Cards

YesThe card the checklist is on, by the external_id of a cards record.
namestringYesThe checklist's name, for example Metric definition checklist.

Constraints: 1–1024 characters.

References

Referenced by

Checklists

Refers to

Show on the entity map
Example
A record of this entity:
{
  "external_id": "cl-definition",
  "card_ref": "k-mrr",
  "name": "Metric definition checklist"
}
Related entities
Cards, Checklist items
Check after the import
After the import, the records of this entity can be checked on Card checklists › Retrieve card checklist.
JSON Schema
checklists.json
logo
Kaiten
If you have any questions or need help with integration feel free to write us at support@kaiten.ru