Custom directory records
A row of a directory, such as one data provider. The directory and its columns (fields) are defined in custom_directories; this record gives the row, naming the directory in directory_ref and the cell of each field in values, keyed by the external_id of the field. display_value is the text shown for the row in lists and should repeat the value of the display field. Cards point at a row through a custom property of type directory.
A row of the directory dir-providers, which has the fields fld-name and fld-seats:
{
"external_id": "rec-nimbus",
"directory_ref": "dir-providers",
"display_value": "Nimbus Analytics",
"values": { "fld-name": "Nimbus Analytics", "fld-seats": 40 }
}A card picks the row by its external_id in its properties, under the property of type directory (only that field of the card is shown):
{
"external_id": "k-mrr",
"properties": { "cp-provider": "rec-nimbus" }
}A record of this entity needs records of other entities in the package: Custom directories.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "custom_directory_records". An entity can have any number of files. See Bundle format.
[
{
"resource": "custom_directory_records",
"path": "resources/custom_directory_records.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. |
directory_ref | Ref<custom_directories> refers to Custom directories | Yes | The directory the row belongs to. Give the external_id of a custom_directories record. |
display_value | string | Yes | The text shown for the row in lists, for example Nimbus Analytics. Repeat the value of the display field.Constraints: 1–1024 characters. |
author_ref | Ref<users>? refers to Users | No | The user who added the row, by the external_id of a users record, for example u-ava. Leave it out or use null when the author is unknown. |
condition | enum | No | Whether the row is in use: active (the default) or inactive. An inactive row is left out of the list of the directory's rows.Constraints: one of active, inactive. Default: |
created_at | Timestamp | No | When the row was added, with a time zone, for example 2026-01-12T09:30:00Z; the directory's list of rows shows this date.Constraints: RFC 3339 with a time zone. Default: |
values | Map<ExternalId, value> refers to Custom directories or Custom directory records or Custom properties or Users | No | The values of the row by field, for example {"fld-name": "Nimbus Analytics", "fld-seats": 40, "fld-owner": "u-omar"}. Each key is the external_id of a field in the fields of the directory of the row and each value has the shape the type of that field decides: text for string, email, url and phone; true or false for checkbox; a number for number; a date value for date, for example {"precision": "date", "value": "2024-05-01"}; the external_id of an option (an item of options) of the property of the field for select; the external_id of a users record for user; the external_id of a custom_directory_records record of the linked directory for directory_link. A link shows only on the row that has it; to show it in both directories, give it on both rows, each in its own directory_link field. A field of type file takes no value. A field the row has no value for is left out.Rule: The value matches the type of the field. |
References
Referenced by
- Cards:
properties - Custom directory records:
values
Custom directory records
Refers to
author_ref→ Usersdirectory_ref→ Custom directoriesvalues→ Custom directories, Custom directory records, Custom properties, Users
Show on the entity map
Example
A record of this entity:
{
"external_id": "rec-nimbus",
"directory_ref": "dir-providers",
"display_value": "Nimbus Analytics",
"author_ref": "u-ava",
"values": {
"fld-name": "Nimbus Analytics",
"fld-email": "vendor.nimbus@example.com",
"fld-seats": 40,
"fld-since": {
"precision": "date",
"value": "2024-05-01"
},
"fld-tier": "sv-priority-high",
"fld-owner": "u-omar",
"fld-parent": "rec-helios"
}
}Related entities
Custom directories, Custom properties, Users
Check after the import
After the import, the records of this entity can be checked on Custom directory records › Get list of records.
JSON Schema
custom_directory_records.json
