[{"data":1,"prerenderedAt":984},["ShallowReactive",2],{"format-page-\u002Fformat\u002Frecords":3},{"id":4,"title":5,"body":6,"description":16,"extension":977,"meta":978,"navigation":979,"path":980,"seo":981,"stem":982,"__hash__":983},"format\u002Fformat\u002Frecords.md","Records",{"type":7,"value":8,"toc":958},"minimark",[9,13,17,20,25,105,109,140,144,148,262,265,268,351,354,357,426,431,434,437,440,443,472,475,481,484,537,540,545,547,601,605,613,617,625,629,636,640,648,652,935,939,954],[10,11,5],"h1",{"id":12},"records",[14,15,16],"p",{},"Draft v0.1",[14,18,19],{},"This page covers the core records used by most PluralPort files. The goal is to keep the model readable, portable, and easy to round-trip between apps.",[21,22,24],"h2",{"id":23},"core-record-types","Core record types",[26,27,28,35,40,45,50,55,60,65,70,75,80,85,90,95,100],"ul",{},[29,30,31],"li",{},[32,33,34],"code",{},"Producer",[29,36,37],{},[32,38,39],{},"Capabilities",[29,41,42],{},[32,43,44],{},"SourceRef",[29,46,47],{},[32,48,49],{},"Privacy",[29,51,52],{},[32,53,54],{},"Warning",[29,56,57],{},[32,58,59],{},"System",[29,61,62],{},[32,63,64],{},"Member",[29,66,67],{},[32,68,69],{},"Group",[29,71,72],{},[32,73,74],{},"GroupMembership",[29,76,77],{},[32,78,79],{},"TaxonomyTerm",[29,81,82],{},[32,83,84],{},"TaxonomyAssignment",[29,86,87],{},[32,88,89],{},"CustomFieldDefinition",[29,91,92],{},[32,93,94],{},"CustomFieldValue",[29,96,97],{},[32,98,99],{},"Note",[29,101,102],{},[32,103,104],{},"Asset",[21,106,108],{"id":107},"shared-conventions","Shared conventions",[26,110,111,114,117,120,127,134],{},[29,112,113],{},"Use JSON objects and arrays.",[29,115,116],{},"Use UTC timestamps in ISO-8601 format.",[29,118,119],{},"Prefer UUIDv7 or ULID for file-local IDs.",[29,121,122,123,126],{},"Preserve original IDs in ",[32,124,125],{},"source_refs",".",[29,128,129,130,133],{},"Put app-specific data in namespaced ",[32,131,132],{},"extensions"," objects.",[29,135,136,137,126],{},"Report dropped or degraded data with ",[32,138,139],{},"warnings",[21,141,143],{"id":142},"envelope-helpers","Envelope helpers",[145,146,34],"h3",{"id":147},"producer",[149,150,155],"pre",{"className":151,"code":152,"language":153,"meta":154,"style":154},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"app\": \"Prism\",\n  \"app_version\": \"3.4.0\",\n  \"exporter_version\": \"0.1.0\",\n  \"app_id\": \"prism\"\n}\n","json","",[32,156,157,166,194,215,236,256],{"__ignoreMap":154},[158,159,162],"span",{"class":160,"line":161},"line",1,[158,163,165],{"class":164},"sMK4o","{\n",[158,167,169,172,176,179,182,185,189,191],{"class":160,"line":168},2,[158,170,171],{"class":164},"  \"",[158,173,175],{"class":174},"spNyl","app",[158,177,178],{"class":164},"\"",[158,180,181],{"class":164},":",[158,183,184],{"class":164}," \"",[158,186,188],{"class":187},"sfazB","Prism",[158,190,178],{"class":164},[158,192,193],{"class":164},",\n",[158,195,197,199,202,204,206,208,211,213],{"class":160,"line":196},3,[158,198,171],{"class":164},[158,200,201],{"class":174},"app_version",[158,203,178],{"class":164},[158,205,181],{"class":164},[158,207,184],{"class":164},[158,209,210],{"class":187},"3.4.0",[158,212,178],{"class":164},[158,214,193],{"class":164},[158,216,218,220,223,225,227,229,232,234],{"class":160,"line":217},4,[158,219,171],{"class":164},[158,221,222],{"class":174},"exporter_version",[158,224,178],{"class":164},[158,226,181],{"class":164},[158,228,184],{"class":164},[158,230,231],{"class":187},"0.1.0",[158,233,178],{"class":164},[158,235,193],{"class":164},[158,237,239,241,244,246,248,250,253],{"class":160,"line":238},5,[158,240,171],{"class":164},[158,242,243],{"class":174},"app_id",[158,245,178],{"class":164},[158,247,181],{"class":164},[158,249,184],{"class":164},[158,251,252],{"class":187},"prism",[158,254,255],{"class":164},"\"\n",[158,257,259],{"class":160,"line":258},6,[158,260,261],{"class":164},"}\n",[14,263,264],{},"A producer object identifies the app that created the file.",[145,266,39],{"id":267},"capabilities",[149,269,271],{"className":151,"code":270,"language":153,"meta":154,"style":154},"{\n  \"modules\": [\"systems\", \"members\", \"groups\", \"taxonomy\", \"notes\", \"assets\"]\n}\n",[32,272,273,277,347],{"__ignoreMap":154},[158,274,275],{"class":160,"line":161},[158,276,165],{"class":164},[158,278,279,281,284,286,288,291,293,296,298,301,303,306,308,310,312,315,317,319,321,324,326,328,330,333,335,337,339,342,344],{"class":160,"line":168},[158,280,171],{"class":164},[158,282,283],{"class":174},"modules",[158,285,178],{"class":164},[158,287,181],{"class":164},[158,289,290],{"class":164}," [",[158,292,178],{"class":164},[158,294,295],{"class":187},"systems",[158,297,178],{"class":164},[158,299,300],{"class":164},",",[158,302,184],{"class":164},[158,304,305],{"class":187},"members",[158,307,178],{"class":164},[158,309,300],{"class":164},[158,311,184],{"class":164},[158,313,314],{"class":187},"groups",[158,316,178],{"class":164},[158,318,300],{"class":164},[158,320,184],{"class":164},[158,322,323],{"class":187},"taxonomy",[158,325,178],{"class":164},[158,327,300],{"class":164},[158,329,184],{"class":164},[158,331,332],{"class":187},"notes",[158,334,178],{"class":164},[158,336,300],{"class":164},[158,338,184],{"class":164},[158,340,341],{"class":187},"assets",[158,343,178],{"class":164},[158,345,346],{"class":164},"]\n",[158,348,349],{"class":160,"line":196},[158,350,261],{"class":164},[14,352,353],{},"This tells importers which sections are meaningful without scanning the whole export.",[145,355,44],{"id":356},"sourceref",[149,358,360],{"className":151,"code":359,"language":153,"meta":154,"style":154},"{\n  \"app\": \"sheaf\",\n  \"collection\": \"members\",\n  \"id\": \"0193...\"\n}\n",[32,361,362,366,385,404,422],{"__ignoreMap":154},[158,363,364],{"class":160,"line":161},[158,365,165],{"class":164},[158,367,368,370,372,374,376,378,381,383],{"class":160,"line":168},[158,369,171],{"class":164},[158,371,175],{"class":174},[158,373,178],{"class":164},[158,375,181],{"class":164},[158,377,184],{"class":164},[158,379,380],{"class":187},"sheaf",[158,382,178],{"class":164},[158,384,193],{"class":164},[158,386,387,389,392,394,396,398,400,402],{"class":160,"line":196},[158,388,171],{"class":164},[158,390,391],{"class":174},"collection",[158,393,178],{"class":164},[158,395,181],{"class":164},[158,397,184],{"class":164},[158,399,305],{"class":187},[158,401,178],{"class":164},[158,403,193],{"class":164},[158,405,406,408,411,413,415,417,420],{"class":160,"line":217},[158,407,171],{"class":164},[158,409,410],{"class":174},"id",[158,412,178],{"class":164},[158,414,181],{"class":164},[158,416,184],{"class":164},[158,418,419],{"class":187},"0193...",[158,421,255],{"class":164},[158,423,424],{"class":160,"line":238},[158,425,261],{"class":164},[14,427,428,430],{},[32,429,125],{}," keeps the original app ID and collection so round-trips can be audited.",[145,432,49],{"id":433},"privacy",[14,435,436],{},"Privacy should be a conservative common model plus any raw source data needed to preserve fidelity.",[145,438,54],{"id":439},"warning",[14,441,442],{},"A warning should include at least:",[26,444,445,461,466],{},[29,446,447,450,451,454,455,457,458],{},[32,448,449],{},"level",": ",[32,452,453],{},"info",", ",[32,456,439],{},", or ",[32,459,460],{},"error",[29,462,463,465],{},[32,464,32],{},": a machine-readable string",[29,467,468,471],{},[32,469,470],{},"message",": a human-readable explanation",[21,473,59],{"id":474},"system",[14,476,477,478,480],{},"A ",[32,479,59],{}," record describes a plurality system or subsystem.",[14,482,483],{},"Common fields:",[26,485,486,490,495,500,505,510,515,520,525,529,533],{},[29,487,488],{},[32,489,410],{},[29,491,492],{},[32,493,494],{},"name",[29,496,497],{},[32,498,499],{},"display_name",[29,501,502],{},[32,503,504],{},"description",[29,506,507],{},[32,508,509],{},"tag",[29,511,512],{},[32,513,514],{},"color",[29,516,517],{},[32,518,519],{},"parent_system_id",[29,521,522],{},[32,523,524],{},"archived",[29,526,527],{},[32,528,433],{},[29,530,531],{},[32,532,125],{},[29,534,535],{},[32,536,132],{},[21,538,64],{"id":539},"member",[14,541,477,542,544],{},[32,543,64],{}," record describes a member, alter, headmate, or custom front.",[14,546,483],{},[26,548,549,553,558,562,566,571,575,580,584,589,593,597],{},[29,550,551],{},[32,552,410],{},[29,554,555],{},[32,556,557],{},"system_id",[29,559,560],{},[32,561,494],{},[29,563,564],{},[32,565,499],{},[29,567,568],{},[32,569,570],{},"pronouns",[29,572,573],{},[32,574,504],{},[29,576,577],{},[32,578,579],{},"birthday",[29,581,582],{},[32,583,514],{},[29,585,586],{},[32,587,588],{},"avatar_asset_id",[29,590,591],{},[32,592,524],{},[29,594,595],{},[32,596,125],{},[29,598,599],{},[32,600,132],{},[21,602,604],{"id":603},"group-and-groupmembership","Group and GroupMembership",[14,606,477,607,609,610,612],{},[32,608,69],{}," record represents a collection or relationship grouping within a system. A ",[32,611,74],{}," ties a member to a group.",[21,614,616],{"id":615},"taxonomy-records","Taxonomy records",[14,618,619,621,622,624],{},[32,620,79],{}," and ",[32,623,84],{}," represent named categories, labels, and assignments such as roles, tags, or custom labels.",[21,626,628],{"id":627},"custom-fields","Custom fields",[14,630,631,621,633,635],{},[32,632,89],{},[32,634,94],{}," persist custom field definitions and the values assigned to records.",[21,637,639],{"id":638},"note-and-asset","Note and Asset",[14,641,642,644,645,647],{},[32,643,99],{}," records are freeform text attached to members, systems, or other objects. ",[32,646,104],{}," records represent images, files, and other media.",[21,649,651],{"id":650},"short-example","Short example",[149,653,655],{"className":151,"code":654,"language":153,"meta":154,"style":154},"{\n  \"systems\": [\n    {\n      \"id\": \"sys_01\",\n      \"name\": \"Example System\",\n      \"archived\": false\n    }\n  ],\n  \"members\": [\n    {\n      \"id\": \"mem_01\",\n      \"system_id\": \"sys_01\",\n      \"name\": \"wren\",\n      \"pronouns\": \"they\u002Fthem\",\n      \"source_refs\": [{ \"app\": \"sheaf\", \"collection\": \"members\", \"id\": \"mem_4482\" }]\n    }\n  ],\n  \"warnings\": []\n}\n",[32,656,657,661,674,679,700,719,732,738,744,757,762,782,801,821,841,906,911,916,930],{"__ignoreMap":154},[158,658,659],{"class":160,"line":161},[158,660,165],{"class":164},[158,662,663,665,667,669,671],{"class":160,"line":168},[158,664,171],{"class":164},[158,666,295],{"class":174},[158,668,178],{"class":164},[158,670,181],{"class":164},[158,672,673],{"class":164}," [\n",[158,675,676],{"class":160,"line":196},[158,677,678],{"class":164},"    {\n",[158,680,681,684,687,689,691,693,696,698],{"class":160,"line":217},[158,682,683],{"class":164},"      \"",[158,685,410],{"class":686},"sBMFI",[158,688,178],{"class":164},[158,690,181],{"class":164},[158,692,184],{"class":164},[158,694,695],{"class":187},"sys_01",[158,697,178],{"class":164},[158,699,193],{"class":164},[158,701,702,704,706,708,710,712,715,717],{"class":160,"line":238},[158,703,683],{"class":164},[158,705,494],{"class":686},[158,707,178],{"class":164},[158,709,181],{"class":164},[158,711,184],{"class":164},[158,713,714],{"class":187},"Example System",[158,716,178],{"class":164},[158,718,193],{"class":164},[158,720,721,723,725,727,729],{"class":160,"line":258},[158,722,683],{"class":164},[158,724,524],{"class":686},[158,726,178],{"class":164},[158,728,181],{"class":164},[158,730,731],{"class":164}," false\n",[158,733,735],{"class":160,"line":734},7,[158,736,737],{"class":164},"    }\n",[158,739,741],{"class":160,"line":740},8,[158,742,743],{"class":164},"  ],\n",[158,745,747,749,751,753,755],{"class":160,"line":746},9,[158,748,171],{"class":164},[158,750,305],{"class":174},[158,752,178],{"class":164},[158,754,181],{"class":164},[158,756,673],{"class":164},[158,758,760],{"class":160,"line":759},10,[158,761,678],{"class":164},[158,763,765,767,769,771,773,775,778,780],{"class":160,"line":764},11,[158,766,683],{"class":164},[158,768,410],{"class":686},[158,770,178],{"class":164},[158,772,181],{"class":164},[158,774,184],{"class":164},[158,776,777],{"class":187},"mem_01",[158,779,178],{"class":164},[158,781,193],{"class":164},[158,783,785,787,789,791,793,795,797,799],{"class":160,"line":784},12,[158,786,683],{"class":164},[158,788,557],{"class":686},[158,790,178],{"class":164},[158,792,181],{"class":164},[158,794,184],{"class":164},[158,796,695],{"class":187},[158,798,178],{"class":164},[158,800,193],{"class":164},[158,802,804,806,808,810,812,814,817,819],{"class":160,"line":803},13,[158,805,683],{"class":164},[158,807,494],{"class":686},[158,809,178],{"class":164},[158,811,181],{"class":164},[158,813,184],{"class":164},[158,815,816],{"class":187},"wren",[158,818,178],{"class":164},[158,820,193],{"class":164},[158,822,824,826,828,830,832,834,837,839],{"class":160,"line":823},14,[158,825,683],{"class":164},[158,827,570],{"class":686},[158,829,178],{"class":164},[158,831,181],{"class":164},[158,833,184],{"class":164},[158,835,836],{"class":187},"they\u002Fthem",[158,838,178],{"class":164},[158,840,193],{"class":164},[158,842,844,846,848,850,852,855,857,860,862,864,866,868,870,872,874,876,878,880,882,884,886,888,890,892,894,896,898,901,903],{"class":160,"line":843},15,[158,845,683],{"class":164},[158,847,125],{"class":686},[158,849,178],{"class":164},[158,851,181],{"class":164},[158,853,854],{"class":164}," [{",[158,856,184],{"class":164},[158,858,175],{"class":859},"sbssI",[158,861,178],{"class":164},[158,863,181],{"class":164},[158,865,184],{"class":164},[158,867,380],{"class":187},[158,869,178],{"class":164},[158,871,300],{"class":164},[158,873,184],{"class":164},[158,875,391],{"class":859},[158,877,178],{"class":164},[158,879,181],{"class":164},[158,881,184],{"class":164},[158,883,305],{"class":187},[158,885,178],{"class":164},[158,887,300],{"class":164},[158,889,184],{"class":164},[158,891,410],{"class":859},[158,893,178],{"class":164},[158,895,181],{"class":164},[158,897,184],{"class":164},[158,899,900],{"class":187},"mem_4482",[158,902,178],{"class":164},[158,904,905],{"class":164}," }]\n",[158,907,909],{"class":160,"line":908},16,[158,910,737],{"class":164},[158,912,914],{"class":160,"line":913},17,[158,915,743],{"class":164},[158,917,919,921,923,925,927],{"class":160,"line":918},18,[158,920,171],{"class":164},[158,922,139],{"class":174},[158,924,178],{"class":164},[158,926,181],{"class":164},[158,928,929],{"class":164}," []\n",[158,931,933],{"class":160,"line":932},19,[158,934,261],{"class":164},[21,936,938],{"id":937},"related-pages","Related pages",[26,940,941,948],{},[29,942,943],{},[944,945,947],"a",{"href":946},"\u002Fformat\u002Ffronting","Fronting",[29,949,950],{},[944,951,953],{"href":952},"\u002Fformat\u002Fmodules","Modules and contract",[955,956,957],"style",{},"html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":154,"searchDepth":168,"depth":168,"links":959},[960,961,962,969,970,971,972,973,974,975,976],{"id":23,"depth":168,"text":24},{"id":107,"depth":168,"text":108},{"id":142,"depth":168,"text":143,"children":963},[964,965,966,967,968],{"id":147,"depth":196,"text":34},{"id":267,"depth":196,"text":39},{"id":356,"depth":196,"text":44},{"id":433,"depth":196,"text":49},{"id":439,"depth":196,"text":54},{"id":474,"depth":168,"text":59},{"id":539,"depth":168,"text":64},{"id":603,"depth":168,"text":604},{"id":615,"depth":168,"text":616},{"id":627,"depth":168,"text":628},{"id":638,"depth":168,"text":639},{"id":650,"depth":168,"text":651},{"id":937,"depth":168,"text":938},"md",{},true,"\u002Fformat\u002Frecords",{"title":5,"description":16},"format\u002Frecords","uiZ-SAJ7fEQYk3aIQ6FiDkxbFem7LbNytmTm8PTx980",1792272242712]