[{"data":1,"prerenderedAt":2007},["ShallowReactive",2],{"/api/concepts/properties":3,"/api/concepts/properties-surround":2001},{"id":4,"title":5,"body":6,"description":1992,"extension":1993,"links":1994,"meta":1995,"navigation":1996,"path":1997,"seo":1998,"stem":1999,"__hash__":2000},"docs/api/2.concepts/properties.md","Properties",{"type":7,"value":8,"toc":1973},"minimark",[9,24,35,146,151,163,428,447,457,461,615,626,630,640,692,716,822,828,853,856,881,890,893,909,1009,1025,1029,1045,1059,1063,1068,1135,1144,1148,1160,1264,1305,1311,1314,1329,1335,1346,1603,1606,1645,1660,1663,1677,1776,1781,1784,1806,1897,1942,1946,1955,1969],[10,11,12,13,18,19,23],"p",{},"Each ",[14,15,17],"a",{"href":16},"/api/concepts/structures","structure"," has ",[20,21,22],"strong",{},"property definitions"," — the fields available on objects of that type (title, tags, dates, custom fields, and so on).",[10,25,26,27,34],{},"Load definitions once per session from ",[14,28,30],{"href":29},"/api/reference",[31,32,33],"code",{},"GET /space/structures",". Each entry contains:",[36,37,38,51],"table",{},[39,40,41],"thead",{},[42,43,44,48],"tr",{},[45,46,47],"th",{},"Field",[45,49,50],{},"Description",[52,53,54,73,83,93,107,129],"tbody",{},[42,55,56,62],{},[57,58,59],"td",{},[31,60,61],{},"id",[57,63,64,65,68,69,72],{},"Stable key used in object ",[31,66,67],{},"properties"," maps (e.g. ",[31,70,71],{},"title",", or a UUID for custom fields)",[42,74,75,80],{},[57,76,77],{},[31,78,79],{},"name",[57,81,82],{},"Display name in the Capacities UI",[42,84,85,90],{},[57,86,87],{},[31,88,89],{},"type",[57,91,92],{},"Public API value type (see table below)",[42,94,95,100],{},[57,96,97],{},[31,98,99],{},"writable",[57,101,102,103,106],{},"Whether ",[31,104,105],{},"PATCH /object"," (and create) may set this field",[42,108,109,114],{},[57,110,111],{},[31,112,113],{},"multiple",[57,115,116,117,120,121,124,125,128],{},"For ",[31,118,119],{},"type: \"label\""," only — ",[31,122,123],{},"false"," = single-select, ",[31,126,127],{},"true"," = multi-select",[42,130,131,136],{},[57,132,133],{},[31,134,135],{},"labelSet",[57,137,116,138,140,141,145],{},[31,139,119],{}," only — fixed options you may select (see ",[14,142,144],{"href":143},"#labels","Labels",")",[147,148,150],"h2",{"id":149},"property-value-shape","Property value shape",[10,152,153,154,159,160,162],{},"On ",[14,155,156],{"href":29},[31,157,158],{},"GET /object",", each property is a typed object: a ",[31,161,89],{}," field plus a nested payload with the same name. Example:",[164,165,170],"pre",{"className":166,"code":167,"language":168,"meta":169,"style":169},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"title\": {\n    \"type\": \"title\",\n    \"title\": { \"value\": \"My page\" }\n  },\n  \"tags\": {\n    \"type\": \"entity\",\n    \"entity\": [{ \"id\": \"a793dc41-a1c1-4f38-836e-6527e5a8c016\" }]\n  },\n  \"status\": {\n    \"type\": \"label\",\n    \"label\": [{ \"id\": \"opt-1\", \"name\": \"In progress\" }]\n  }\n}\n","json","",[31,171,172,181,199,223,257,263,277,297,329,334,348,368,416,422],{"__ignoreMap":169},[173,174,177],"span",{"class":175,"line":176},"line",1,[173,178,180],{"class":179},"sMK4o","{\n",[173,182,184,187,190,193,196],{"class":175,"line":183},2,[173,185,186],{"class":179},"  \"",[173,188,71],{"class":189},"spNyl",[173,191,192],{"class":179},"\"",[173,194,195],{"class":179},":",[173,197,198],{"class":179}," {\n",[173,200,202,205,208,210,212,215,218,220],{"class":175,"line":201},3,[173,203,204],{"class":179},"    \"",[173,206,89],{"class":207},"sBMFI",[173,209,192],{"class":179},[173,211,195],{"class":179},[173,213,214],{"class":179}," \"",[173,216,71],{"class":217},"sfazB",[173,219,192],{"class":179},[173,221,222],{"class":179},",\n",[173,224,226,228,230,232,234,237,239,243,245,247,249,252,254],{"class":175,"line":225},4,[173,227,204],{"class":179},[173,229,71],{"class":207},[173,231,192],{"class":179},[173,233,195],{"class":179},[173,235,236],{"class":179}," {",[173,238,214],{"class":179},[173,240,242],{"class":241},"sbssI","value",[173,244,192],{"class":179},[173,246,195],{"class":179},[173,248,214],{"class":179},[173,250,251],{"class":217},"My page",[173,253,192],{"class":179},[173,255,256],{"class":179}," }\n",[173,258,260],{"class":175,"line":259},5,[173,261,262],{"class":179},"  },\n",[173,264,266,268,271,273,275],{"class":175,"line":265},6,[173,267,186],{"class":179},[173,269,270],{"class":189},"tags",[173,272,192],{"class":179},[173,274,195],{"class":179},[173,276,198],{"class":179},[173,278,280,282,284,286,288,290,293,295],{"class":175,"line":279},7,[173,281,204],{"class":179},[173,283,89],{"class":207},[173,285,192],{"class":179},[173,287,195],{"class":179},[173,289,214],{"class":179},[173,291,292],{"class":217},"entity",[173,294,192],{"class":179},[173,296,222],{"class":179},[173,298,300,302,304,306,308,311,313,315,317,319,321,324,326],{"class":175,"line":299},8,[173,301,204],{"class":179},[173,303,292],{"class":207},[173,305,192],{"class":179},[173,307,195],{"class":179},[173,309,310],{"class":179}," [{",[173,312,214],{"class":179},[173,314,61],{"class":241},[173,316,192],{"class":179},[173,318,195],{"class":179},[173,320,214],{"class":179},[173,322,323],{"class":217},"a793dc41-a1c1-4f38-836e-6527e5a8c016",[173,325,192],{"class":179},[173,327,328],{"class":179}," }]\n",[173,330,332],{"class":175,"line":331},9,[173,333,262],{"class":179},[173,335,337,339,342,344,346],{"class":175,"line":336},10,[173,338,186],{"class":179},[173,340,341],{"class":189},"status",[173,343,192],{"class":179},[173,345,195],{"class":179},[173,347,198],{"class":179},[173,349,351,353,355,357,359,361,364,366],{"class":175,"line":350},11,[173,352,204],{"class":179},[173,354,89],{"class":207},[173,356,192],{"class":179},[173,358,195],{"class":179},[173,360,214],{"class":179},[173,362,363],{"class":217},"label",[173,365,192],{"class":179},[173,367,222],{"class":179},[173,369,371,373,375,377,379,381,383,385,387,389,391,394,396,399,401,403,405,407,409,412,414],{"class":175,"line":370},12,[173,372,204],{"class":179},[173,374,363],{"class":207},[173,376,192],{"class":179},[173,378,195],{"class":179},[173,380,310],{"class":179},[173,382,214],{"class":179},[173,384,61],{"class":241},[173,386,192],{"class":179},[173,388,195],{"class":179},[173,390,214],{"class":179},[173,392,393],{"class":217},"opt-1",[173,395,192],{"class":179},[173,397,398],{"class":179},",",[173,400,214],{"class":179},[173,402,79],{"class":241},[173,404,192],{"class":179},[173,406,195],{"class":179},[173,408,214],{"class":179},[173,410,411],{"class":217},"In progress",[173,413,192],{"class":179},[173,415,328],{"class":179},[173,417,419],{"class":175,"line":418},13,[173,420,421],{"class":179},"  }\n",[173,423,425],{"class":175,"line":424},14,[173,426,427],{"class":179},"}\n",[10,429,430,431,433,434,437,438,440,441,443,444,446],{},"The ",[31,432,270],{}," field links to tag objects (",[31,435,436],{},"RootTag",") and uses the ",[31,439,292],{}," type. The ",[31,442,341],{}," field is a ",[20,445,363],{}," property (fixed options on the structure, such as on tasks).",[10,448,449,450,453,454,456],{},"When writing (",[31,451,452],{},"POST /object",", ",[31,455,105],{},"), use the same shape for fields you set. Only include keys you want to change on patch.",[147,458,460],{"id":459},"supported-value-types","Supported value types",[36,462,463,474],{},[39,464,465],{},[42,466,467,471],{},[45,468,469],{},[31,470,89],{},[45,472,473],{},"Meaning",[52,475,476,485,495,505,515,525,546,564,576,586,596],{},[42,477,478,482],{},[57,479,480],{},[31,481,71],{},[57,483,484],{},"Object title (plain text)",[42,486,487,492],{},[57,488,489],{},[31,490,491],{},"text",[57,493,494],{},"Plain-text field",[42,496,497,502],{},[57,498,499],{},[31,500,501],{},"number",[57,503,504],{},"Numeric field",[42,506,507,512],{},[57,508,509],{},[31,510,511],{},"boolean",[57,513,514],{},"Checkbox",[42,516,517,522],{},[57,518,519],{},[31,520,521],{},"url",[57,523,524],{},"URL string",[42,526,527,532],{},[57,528,529],{},[31,530,531],{},"date",[57,533,534,535,538,539,542,543,145],{},"Date or date range (",[31,536,537],{},"dateResolution",": ",[31,540,541],{},"day"," or ",[31,544,545],{},"time",[42,547,548,552],{},[57,549,550],{},[31,551,363],{},[57,553,554,555,453,557,559,560,563],{},"Single or multi select from a fixed option set (",[31,556,61],{},[31,558,79],{},", optional ",[31,561,562],{},"color",") — e.g. task status",[42,565,566,570],{},[57,567,568],{},[31,569,292],{},[57,571,572,573,575],{},"Links to other objects by id — e.g. the ",[31,574,270],{}," property (tag objects), relations, mentions",[42,577,578,583],{},[57,579,580],{},[31,581,582],{},"createdAt",[57,584,585],{},"Creation timestamp (read-only in practice; writable only where allowed)",[42,587,588,593],{},[57,589,590],{},[31,591,592],{},"lastUpdatedAt",[57,594,595],{},"Last-updated timestamp (read-only)",[42,597,598,603],{},[57,599,600],{},[31,601,602],{},"richText",[57,604,605,606,610,611,614],{},"Inline ",[14,607,609],{"href":608},"/api/concepts/text-tokens","text tokens"," (same model as ",[31,612,613],{},"TextBlock"," content)",[10,616,617,618,621,622,625],{},"Fields not listed in ",[31,619,620],{},"propertyDefinitions"," for a structure, or with ",[31,623,624],{},"writable: false",", cannot be set via the API.",[147,627,629],{"id":628},"dates","Dates",[10,631,632,633,636,637,639],{},"Date properties use ",[31,634,635],{},"type: \"date\""," with a nested ",[31,638,531],{}," object:",[36,641,642,650],{},[39,643,644],{},[42,645,646,648],{},[45,647,47],{},[45,649,50],{},[52,651,652,668,682],{},[42,653,654,658],{},[57,655,656],{},[31,657,537],{},[57,659,660,663,664,667],{},[31,661,662],{},"\"day\""," for calendar dates, ",[31,665,666],{},"\"time\""," when values include time-of-day. Always present on read; may be omitted on write (the property definition default applies).",[42,669,670,675],{},[57,671,672],{},[31,673,674],{},"start",[57,676,677,678,681],{},"ISO 8601 start date/time (",[31,679,680],{},"null"," on read when unset).",[42,683,684,689],{},[57,685,686],{},[31,687,688],{},"end",[57,690,691],{},"Optional ISO 8601 end for ranges.",[10,693,116,694,697,698,701,702,705,706,708,709,711,712,715],{},[31,695,696],{},"dateResolution: \"day\"",", use ",[20,699,700],{},"UTC midnight"," ISO strings (e.g. ",[31,703,704],{},"2025-05-19T00:00:00.000Z",") for ",[31,707,674],{}," and ",[31,710,688],{},". Other values are rejected with ",[31,713,714],{},"cap_invalid_input"," and a message showing the expected canonical form.",[164,717,719],{"className":166,"code":718,"language":168,"meta":169,"style":169},"\"dueDate\": {\n  \"type\": \"date\",\n  \"date\": {\n    \"dateResolution\": \"day\",\n    \"start\": \"2025-05-19T00:00:00.000Z\",\n    \"end\": null\n  }\n}\n",[31,720,721,735,753,765,783,801,814,818],{"__ignoreMap":169},[173,722,723,725,728,730,733],{"class":175,"line":176},[173,724,192],{"class":179},[173,726,727],{"class":217},"dueDate",[173,729,192],{"class":179},[173,731,538],{"class":732},"sTEyZ",[173,734,180],{"class":179},[173,736,737,739,741,743,745,747,749,751],{"class":175,"line":183},[173,738,186],{"class":179},[173,740,89],{"class":189},[173,742,192],{"class":179},[173,744,195],{"class":179},[173,746,214],{"class":179},[173,748,531],{"class":217},[173,750,192],{"class":179},[173,752,222],{"class":179},[173,754,755,757,759,761,763],{"class":175,"line":201},[173,756,186],{"class":179},[173,758,531],{"class":189},[173,760,192],{"class":179},[173,762,195],{"class":179},[173,764,198],{"class":179},[173,766,767,769,771,773,775,777,779,781],{"class":175,"line":225},[173,768,204],{"class":179},[173,770,537],{"class":207},[173,772,192],{"class":179},[173,774,195],{"class":179},[173,776,214],{"class":179},[173,778,541],{"class":217},[173,780,192],{"class":179},[173,782,222],{"class":179},[173,784,785,787,789,791,793,795,797,799],{"class":175,"line":259},[173,786,204],{"class":179},[173,788,674],{"class":207},[173,790,192],{"class":179},[173,792,195],{"class":179},[173,794,214],{"class":179},[173,796,704],{"class":217},[173,798,192],{"class":179},[173,800,222],{"class":179},[173,802,803,805,807,809,811],{"class":175,"line":265},[173,804,204],{"class":179},[173,806,688],{"class":207},[173,808,192],{"class":179},[173,810,195],{"class":179},[173,812,813],{"class":179}," null\n",[173,815,816],{"class":175,"line":279},[173,817,421],{"class":179},[173,819,820],{"class":175,"line":299},[173,821,427],{"class":179},[147,823,825,826,145],{"id":824},"tags-and-object-select-entity","Tags and object select (",[31,827,292],{},[10,829,830,833,834,837,838,840,841,844,845,848,849,852],{},[20,831,832],{},"Entity"," properties link an object to other objects in the same space — by reference, not by copying their data. In the API they always use ",[31,835,836],{},"type: \"entity\""," and an ",[31,839,292],{}," array of ",[31,842,843],{},"{ \"id\": \"…\" }"," objects. The API does ",[20,846,847],{},"not"," use ",[31,850,851],{},"{ id, structureId }"," pairs in property payloads; only the target object id is required.",[10,854,855],{},"This covers:",[857,858,859,872],"ul",{},[860,861,862,865,866,868,869,871],"li",{},[20,863,864],{},"Tags"," — the built-in ",[31,867,270],{}," field on pages, tasks, media, and many other types (",[31,870,836],{}," in the API).",[860,873,874,877,878,880],{},[20,875,876],{},"Object select"," — custom relation fields on object types you define in Capacities (internal type ",[31,879,292],{},"), for example “Related pages” or “Author”.",[10,882,883,884,886,887,889],{},"These are different from ",[20,885,363],{}," properties (",[14,888,144],{"href":143},"), which pick from a fixed option list on the structure, not from separate objects.",[891,892,864],"h3",{"id":270},[10,894,895,896,900,901,904,905,908],{},"On most structures, the property id is ",[20,897,898],{},[31,899,270],{},". Each entry points at a ",[20,902,903],{},"tag object"," (",[31,906,907],{},"structureId: \"RootTag\"","). Tags are normal objects: they have a title and can be created, read, and updated like pages or tasks.",[164,910,912],{"className":166,"code":911,"language":168,"meta":169,"style":169},"\"tags\": {\n  \"type\": \"entity\",\n  \"entity\": [\n    { \"id\": \"a793dc41-a1c1-4f38-836e-6527e5a8c016\" },\n    { \"id\": \"b804ed52-b2d2-4f49-947f-7638e6b9d127\" }\n  ]\n}\n",[31,913,914,926,944,957,979,1000,1005],{"__ignoreMap":169},[173,915,916,918,920,922,924],{"class":175,"line":176},[173,917,192],{"class":179},[173,919,270],{"class":217},[173,921,192],{"class":179},[173,923,538],{"class":732},[173,925,180],{"class":179},[173,927,928,930,932,934,936,938,940,942],{"class":175,"line":183},[173,929,186],{"class":179},[173,931,89],{"class":189},[173,933,192],{"class":179},[173,935,195],{"class":179},[173,937,214],{"class":179},[173,939,292],{"class":217},[173,941,192],{"class":179},[173,943,222],{"class":179},[173,945,946,948,950,952,954],{"class":175,"line":201},[173,947,186],{"class":179},[173,949,292],{"class":189},[173,951,192],{"class":179},[173,953,195],{"class":179},[173,955,956],{"class":179}," [\n",[173,958,959,962,964,966,968,970,972,974,976],{"class":175,"line":225},[173,960,961],{"class":179},"    {",[173,963,214],{"class":179},[173,965,61],{"class":207},[173,967,192],{"class":179},[173,969,195],{"class":179},[173,971,214],{"class":179},[173,973,323],{"class":217},[173,975,192],{"class":179},[173,977,978],{"class":179}," },\n",[173,980,981,983,985,987,989,991,993,996,998],{"class":175,"line":259},[173,982,961],{"class":179},[173,984,214],{"class":179},[173,986,61],{"class":207},[173,988,192],{"class":179},[173,990,195],{"class":179},[173,992,214],{"class":179},[173,994,995],{"class":217},"b804ed52-b2d2-4f49-947f-7638e6b9d127",[173,997,192],{"class":179},[173,999,256],{"class":179},[173,1001,1002],{"class":175,"line":265},[173,1003,1004],{"class":179},"  ]\n",[173,1006,1007],{"class":175,"line":279},[173,1008,427],{"class":179},[10,1010,1011,1012,708,1016,1018,1019,1021,1022,1024],{},"To use a tag that does not exist yet, create it first with ",[14,1013,1014],{"href":29},[31,1015,452],{},[31,1017,907],{},", then reference its ",[31,1020,61],{}," when setting ",[31,1023,270],{}," on another object.",[891,1026,1028],{"id":1027},"object-select-custom-relations","Object select (custom relations)",[10,1030,1031,1032,1035,1036,1038,1039,1041,1042,1044],{},"Custom object types can define ",[20,1033,1034],{},"object select"," properties (shown as ",[31,1037,836],{}," on ",[31,1040,33],{},"). Each field only accepts targets whose structure is allowed for that property in the Capacities app — for example pages only, or a specific custom type. If you pass an id for the wrong type or from another space, the API returns ",[31,1043,714],{},".",[10,1046,1047,1048,1052,1053,1055,1056,1058],{},"Use the property definition ",[20,1049,1050],{},[31,1051,61],{}," from ",[31,1054,33],{}," as the key in ",[31,1057,67],{},", the same as for tags.",[891,1060,1062],{"id":1061},"reading-values-on-objects","Reading values on objects",[10,1064,153,1065,1067],{},[31,1066,158],{},", entity properties return only linked object ids (no titles or types inlined):",[164,1069,1071],{"className":166,"code":1070,"language":168,"meta":169,"style":169},"\"tags\": {\n  \"type\": \"entity\",\n  \"entity\": [{ \"id\": \"a793dc41-a1c1-4f38-836e-6527e5a8c016\" }]\n}\n",[31,1072,1073,1085,1103,1131],{"__ignoreMap":169},[173,1074,1075,1077,1079,1081,1083],{"class":175,"line":176},[173,1076,192],{"class":179},[173,1078,270],{"class":217},[173,1080,192],{"class":179},[173,1082,538],{"class":732},[173,1084,180],{"class":179},[173,1086,1087,1089,1091,1093,1095,1097,1099,1101],{"class":175,"line":183},[173,1088,186],{"class":179},[173,1090,89],{"class":189},[173,1092,192],{"class":179},[173,1094,195],{"class":179},[173,1096,214],{"class":179},[173,1098,292],{"class":217},[173,1100,192],{"class":179},[173,1102,222],{"class":179},[173,1104,1105,1107,1109,1111,1113,1115,1117,1119,1121,1123,1125,1127,1129],{"class":175,"line":201},[173,1106,186],{"class":179},[173,1108,292],{"class":189},[173,1110,192],{"class":179},[173,1112,195],{"class":179},[173,1114,310],{"class":179},[173,1116,214],{"class":179},[173,1118,61],{"class":207},[173,1120,192],{"class":179},[173,1122,195],{"class":179},[173,1124,214],{"class":179},[173,1126,323],{"class":217},[173,1128,192],{"class":179},[173,1130,328],{"class":179},[173,1132,1133],{"class":175,"line":225},[173,1134,427],{"class":179},[10,1136,1137,1138,1140,1141,1143],{},"An empty ",[31,1139,292],{}," array means no links are set. Fetch linked objects with separate ",[31,1142,158],{}," calls if you need titles or other fields.",[891,1145,1147],{"id":1146},"writing-values","Writing values",[10,1149,1150,1151,542,1153,1155,1156,1159],{},"Set or replace links on ",[31,1152,452],{},[31,1154,105],{}," with the same shape. The list you send ",[20,1157,1158],{},"replaces"," the current links for that property (it is not merged).",[164,1161,1163],{"className":166,"code":1162,"language":168,"meta":169,"style":169},"{\n  \"properties\": {\n    \"tags\": {\n      \"type\": \"entity\",\n      \"entity\": [\n        { \"id\": \"a793dc41-a1c1-4f38-836e-6527e5a8c016\" }\n      ]\n    }\n  }\n}\n",[31,1164,1165,1169,1181,1193,1212,1224,1246,1251,1256,1260],{"__ignoreMap":169},[173,1166,1167],{"class":175,"line":176},[173,1168,180],{"class":179},[173,1170,1171,1173,1175,1177,1179],{"class":175,"line":183},[173,1172,186],{"class":179},[173,1174,67],{"class":189},[173,1176,192],{"class":179},[173,1178,195],{"class":179},[173,1180,198],{"class":179},[173,1182,1183,1185,1187,1189,1191],{"class":175,"line":201},[173,1184,204],{"class":179},[173,1186,270],{"class":207},[173,1188,192],{"class":179},[173,1190,195],{"class":179},[173,1192,198],{"class":179},[173,1194,1195,1198,1200,1202,1204,1206,1208,1210],{"class":175,"line":225},[173,1196,1197],{"class":179},"      \"",[173,1199,89],{"class":241},[173,1201,192],{"class":179},[173,1203,195],{"class":179},[173,1205,214],{"class":179},[173,1207,292],{"class":217},[173,1209,192],{"class":179},[173,1211,222],{"class":179},[173,1213,1214,1216,1218,1220,1222],{"class":175,"line":259},[173,1215,1197],{"class":179},[173,1217,292],{"class":241},[173,1219,192],{"class":179},[173,1221,195],{"class":179},[173,1223,956],{"class":179},[173,1225,1226,1229,1231,1234,1236,1238,1240,1242,1244],{"class":175,"line":265},[173,1227,1228],{"class":179},"        {",[173,1230,214],{"class":179},[173,1232,61],{"class":1233},"swJcz",[173,1235,192],{"class":179},[173,1237,195],{"class":179},[173,1239,214],{"class":179},[173,1241,323],{"class":217},[173,1243,192],{"class":179},[173,1245,256],{"class":179},[173,1247,1248],{"class":175,"line":279},[173,1249,1250],{"class":179},"      ]\n",[173,1252,1253],{"class":175,"line":299},[173,1254,1255],{"class":179},"    }\n",[173,1257,1258],{"class":175,"line":331},[173,1259,421],{"class":179},[173,1261,1262],{"class":175,"line":336},[173,1263,427],{"class":179},[857,1265,1266,1276,1293,1300],{},[860,1267,1268,1269,1271,1272,1275],{},"Every ",[31,1270,61],{}," must refer to an object that ",[20,1273,1274],{},"exists"," in the token’s space.",[860,1277,1278,1279,1282,1283,1286,1287,1289,1290,1292],{},"Each target’s ",[31,1280,1281],{},"structureId"," must be ",[20,1284,1285],{},"allowed"," for that property (for ",[31,1288,270],{},", only ",[31,1291,436],{},").",[860,1294,1295,1296,1299],{},"Pass ",[31,1297,1298],{},"\"entity\": []"," to remove all links.",[860,1301,1302,1303,1044],{},"Unknown ids, wrong structure, or objects in another space return ",[31,1304,714],{},[10,1306,1307,1308,1310],{},"On patch, include only property keys you want to change; omit ",[31,1309,270],{}," (or other entity fields) to leave them unchanged.",[147,1312,144],{"id":1313},"labels",[10,1315,1316,1317,1320,1321,904,1323,1325,1326,1328],{},"Label properties are single- or multi-select fields with a ",[20,1318,1319],{},"fixed option list"," defined on the structure (for example task status, or a custom “Priority” field on an object type). They are not the same as ",[20,1322,270],{},[31,1324,292],{}," / ",[31,1327,436],{}," links).",[891,1330,1332,1333,145],{"id":1331},"option-catalog-labelset","Option catalog (",[31,1334,135],{},[10,1336,153,1337,1339,1340,1342,1343,1345],{},[31,1338,33],{},", every property with ",[31,1341,119],{}," includes a ",[31,1344,135],{}," array:",[164,1347,1349],{"className":166,"code":1348,"language":168,"meta":169,"style":169},"{\n  \"id\": \"status\",\n  \"name\": \"Status\",\n  \"type\": \"label\",\n  \"writable\": true,\n  \"multiple\": false,\n  \"labelSet\": [\n    { \"id\": \"not-started\", \"name\": \"Not started\" },\n    { \"id\": \"in-progress\", \"name\": \"In progress\", \"color\": \"blue\" },\n    { \"id\": \"done\", \"name\": \"Done\", \"color\": \"green\" }\n  ]\n}\n",[31,1350,1351,1355,1373,1392,1410,1423,1436,1448,1486,1540,1595,1599],{"__ignoreMap":169},[173,1352,1353],{"class":175,"line":176},[173,1354,180],{"class":179},[173,1356,1357,1359,1361,1363,1365,1367,1369,1371],{"class":175,"line":183},[173,1358,186],{"class":179},[173,1360,61],{"class":189},[173,1362,192],{"class":179},[173,1364,195],{"class":179},[173,1366,214],{"class":179},[173,1368,341],{"class":217},[173,1370,192],{"class":179},[173,1372,222],{"class":179},[173,1374,1375,1377,1379,1381,1383,1385,1388,1390],{"class":175,"line":201},[173,1376,186],{"class":179},[173,1378,79],{"class":189},[173,1380,192],{"class":179},[173,1382,195],{"class":179},[173,1384,214],{"class":179},[173,1386,1387],{"class":217},"Status",[173,1389,192],{"class":179},[173,1391,222],{"class":179},[173,1393,1394,1396,1398,1400,1402,1404,1406,1408],{"class":175,"line":225},[173,1395,186],{"class":179},[173,1397,89],{"class":189},[173,1399,192],{"class":179},[173,1401,195],{"class":179},[173,1403,214],{"class":179},[173,1405,363],{"class":217},[173,1407,192],{"class":179},[173,1409,222],{"class":179},[173,1411,1412,1414,1416,1418,1420],{"class":175,"line":259},[173,1413,186],{"class":179},[173,1415,99],{"class":189},[173,1417,192],{"class":179},[173,1419,195],{"class":179},[173,1421,1422],{"class":179}," true,\n",[173,1424,1425,1427,1429,1431,1433],{"class":175,"line":265},[173,1426,186],{"class":179},[173,1428,113],{"class":189},[173,1430,192],{"class":179},[173,1432,195],{"class":179},[173,1434,1435],{"class":179}," false,\n",[173,1437,1438,1440,1442,1444,1446],{"class":175,"line":279},[173,1439,186],{"class":179},[173,1441,135],{"class":189},[173,1443,192],{"class":179},[173,1445,195],{"class":179},[173,1447,956],{"class":179},[173,1449,1450,1452,1454,1456,1458,1460,1462,1465,1467,1469,1471,1473,1475,1477,1479,1482,1484],{"class":175,"line":299},[173,1451,961],{"class":179},[173,1453,214],{"class":179},[173,1455,61],{"class":207},[173,1457,192],{"class":179},[173,1459,195],{"class":179},[173,1461,214],{"class":179},[173,1463,1464],{"class":217},"not-started",[173,1466,192],{"class":179},[173,1468,398],{"class":179},[173,1470,214],{"class":179},[173,1472,79],{"class":207},[173,1474,192],{"class":179},[173,1476,195],{"class":179},[173,1478,214],{"class":179},[173,1480,1481],{"class":217},"Not started",[173,1483,192],{"class":179},[173,1485,978],{"class":179},[173,1487,1488,1490,1492,1494,1496,1498,1500,1503,1505,1507,1509,1511,1513,1515,1517,1519,1521,1523,1525,1527,1529,1531,1533,1536,1538],{"class":175,"line":331},[173,1489,961],{"class":179},[173,1491,214],{"class":179},[173,1493,61],{"class":207},[173,1495,192],{"class":179},[173,1497,195],{"class":179},[173,1499,214],{"class":179},[173,1501,1502],{"class":217},"in-progress",[173,1504,192],{"class":179},[173,1506,398],{"class":179},[173,1508,214],{"class":179},[173,1510,79],{"class":207},[173,1512,192],{"class":179},[173,1514,195],{"class":179},[173,1516,214],{"class":179},[173,1518,411],{"class":217},[173,1520,192],{"class":179},[173,1522,398],{"class":179},[173,1524,214],{"class":179},[173,1526,562],{"class":207},[173,1528,192],{"class":179},[173,1530,195],{"class":179},[173,1532,214],{"class":179},[173,1534,1535],{"class":217},"blue",[173,1537,192],{"class":179},[173,1539,978],{"class":179},[173,1541,1542,1544,1546,1548,1550,1552,1554,1557,1559,1561,1563,1565,1567,1569,1571,1574,1576,1578,1580,1582,1584,1586,1588,1591,1593],{"class":175,"line":336},[173,1543,961],{"class":179},[173,1545,214],{"class":179},[173,1547,61],{"class":207},[173,1549,192],{"class":179},[173,1551,195],{"class":179},[173,1553,214],{"class":179},[173,1555,1556],{"class":217},"done",[173,1558,192],{"class":179},[173,1560,398],{"class":179},[173,1562,214],{"class":179},[173,1564,79],{"class":207},[173,1566,192],{"class":179},[173,1568,195],{"class":179},[173,1570,214],{"class":179},[173,1572,1573],{"class":217},"Done",[173,1575,192],{"class":179},[173,1577,398],{"class":179},[173,1579,214],{"class":179},[173,1581,562],{"class":207},[173,1583,192],{"class":179},[173,1585,195],{"class":179},[173,1587,214],{"class":179},[173,1589,1590],{"class":217},"green",[173,1592,192],{"class":179},[173,1594,256],{"class":179},[173,1596,1597],{"class":175,"line":350},[173,1598,1004],{"class":179},[173,1600,1601],{"class":175,"line":370},[173,1602,427],{"class":179},[10,1604,1605],{},"Each entry has:",[36,1607,1608,1616],{},[39,1609,1610],{},[42,1611,1612,1614],{},[45,1613,47],{},[45,1615,50],{},[52,1617,1618,1627,1636],{},[42,1619,1620,1624],{},[57,1621,1622],{},[31,1623,61],{},[57,1625,1626],{},"Stable option id — use this when writing values",[42,1628,1629,1633],{},[57,1630,1631],{},[31,1632,79],{},[57,1634,1635],{},"Display label in the Capacities UI",[42,1637,1638,1642],{},[57,1639,1640],{},[31,1641,562],{},[57,1643,1644],{},"Optional theme color key for the option",[10,1646,116,1647,904,1650,1653,1654,1656,1657,1659],{},[20,1648,1649],{},"task status",[31,1651,1652],{},"RootTask",", property id ",[31,1655,341],{},"), ",[31,1658,135],{}," reflects your space’s customized status labels when configured; otherwise you get the default task statuses.",[891,1661,1062],{"id":1662},"reading-values-on-objects-1",[10,1664,153,1665,1667,1668,1325,1670,1325,1672,1674,1675,1345],{},[31,1666,158],{},", selected options use the same ",[31,1669,61],{},[31,1671,79],{},[31,1673,562],{}," shape inside a ",[31,1676,363],{},[164,1678,1680],{"className":166,"code":1679,"language":168,"meta":169,"style":169},"\"status\": {\n  \"type\": \"label\",\n  \"label\": [{ \"id\": \"in-progress\", \"name\": \"In progress\", \"color\": \"blue\" }]\n}\n",[31,1681,1682,1694,1712,1772],{"__ignoreMap":169},[173,1683,1684,1686,1688,1690,1692],{"class":175,"line":176},[173,1685,192],{"class":179},[173,1687,341],{"class":217},[173,1689,192],{"class":179},[173,1691,538],{"class":732},[173,1693,180],{"class":179},[173,1695,1696,1698,1700,1702,1704,1706,1708,1710],{"class":175,"line":183},[173,1697,186],{"class":179},[173,1699,89],{"class":189},[173,1701,192],{"class":179},[173,1703,195],{"class":179},[173,1705,214],{"class":179},[173,1707,363],{"class":217},[173,1709,192],{"class":179},[173,1711,222],{"class":179},[173,1713,1714,1716,1718,1720,1722,1724,1726,1728,1730,1732,1734,1736,1738,1740,1742,1744,1746,1748,1750,1752,1754,1756,1758,1760,1762,1764,1766,1768,1770],{"class":175,"line":201},[173,1715,186],{"class":179},[173,1717,363],{"class":189},[173,1719,192],{"class":179},[173,1721,195],{"class":179},[173,1723,310],{"class":179},[173,1725,214],{"class":179},[173,1727,61],{"class":207},[173,1729,192],{"class":179},[173,1731,195],{"class":179},[173,1733,214],{"class":179},[173,1735,1502],{"class":217},[173,1737,192],{"class":179},[173,1739,398],{"class":179},[173,1741,214],{"class":179},[173,1743,79],{"class":207},[173,1745,192],{"class":179},[173,1747,195],{"class":179},[173,1749,214],{"class":179},[173,1751,411],{"class":217},[173,1753,192],{"class":179},[173,1755,398],{"class":179},[173,1757,214],{"class":179},[173,1759,562],{"class":207},[173,1761,192],{"class":179},[173,1763,195],{"class":179},[173,1765,214],{"class":179},[173,1767,1535],{"class":217},[173,1769,192],{"class":179},[173,1771,328],{"class":179},[173,1773,1774],{"class":175,"line":225},[173,1775,427],{"class":179},[10,1777,1137,1778,1780],{},[31,1779,363],{}," array means nothing is selected.",[891,1782,1147],{"id":1783},"writing-values-1",[10,1785,1047,1786,1788,1789,1794,1795,1797,1798,1800,1801,708,1803,1805],{},[31,1787,61],{}," as the key and reference options by ",[20,1790,1791,1793],{},[31,1792,61],{}," only"," (from ",[31,1796,135],{}," or from a prior ",[31,1799,158],{},"). ",[31,1802,79],{},[31,1804,562],{}," on write are ignored.",[164,1807,1809],{"className":166,"code":1808,"language":168,"meta":169,"style":169},"{\n  \"properties\": {\n    \"status\": {\n      \"type\": \"label\",\n      \"label\": [{ \"id\": \"in-progress\" }]\n    }\n  }\n}\n",[31,1810,1811,1815,1827,1839,1857,1885,1889,1893],{"__ignoreMap":169},[173,1812,1813],{"class":175,"line":176},[173,1814,180],{"class":179},[173,1816,1817,1819,1821,1823,1825],{"class":175,"line":183},[173,1818,186],{"class":179},[173,1820,67],{"class":189},[173,1822,192],{"class":179},[173,1824,195],{"class":179},[173,1826,198],{"class":179},[173,1828,1829,1831,1833,1835,1837],{"class":175,"line":201},[173,1830,204],{"class":179},[173,1832,341],{"class":207},[173,1834,192],{"class":179},[173,1836,195],{"class":179},[173,1838,198],{"class":179},[173,1840,1841,1843,1845,1847,1849,1851,1853,1855],{"class":175,"line":225},[173,1842,1197],{"class":179},[173,1844,89],{"class":241},[173,1846,192],{"class":179},[173,1848,195],{"class":179},[173,1850,214],{"class":179},[173,1852,363],{"class":217},[173,1854,192],{"class":179},[173,1856,222],{"class":179},[173,1858,1859,1861,1863,1865,1867,1869,1871,1873,1875,1877,1879,1881,1883],{"class":175,"line":259},[173,1860,1197],{"class":179},[173,1862,363],{"class":241},[173,1864,192],{"class":179},[173,1866,195],{"class":179},[173,1868,310],{"class":179},[173,1870,214],{"class":179},[173,1872,61],{"class":1233},[173,1874,192],{"class":179},[173,1876,195],{"class":179},[173,1878,214],{"class":179},[173,1880,1502],{"class":217},[173,1882,192],{"class":179},[173,1884,328],{"class":179},[173,1886,1887],{"class":175,"line":265},[173,1888,1255],{"class":179},[173,1890,1891],{"class":175,"line":279},[173,1892,421],{"class":179},[173,1894,1895],{"class":175,"line":299},[173,1896,427],{"class":179},[857,1898,1899,1917,1931,1937],{},[860,1900,1901,1902,1904,1905,1907,1908,1911,1912,1914,1915,1044],{},"Check ",[31,1903,113],{}," on the property definition: when ",[31,1906,123],{},", pass ",[20,1909,1910],{},"at most one"," option in ",[31,1913,363],{},"; more than one returns ",[31,1916,714],{},[860,1918,1919,1920,1922,1923,1907,1925,1928,1929,1044],{},"When ",[31,1921,113],{}," is ",[31,1924,127],{},[20,1926,1927],{},"several"," ids in ",[31,1930,363],{},[860,1932,1295,1933,1936],{},[31,1934,1935],{},"\"label\": []"," to clear the field.",[860,1938,1939,1940,1044],{},"Unknown option ids return ",[31,1941,714],{},[147,1943,1945],{"id":1944},"caching-definitions","Caching definitions",[1947,1948,1949],"tip",{},[10,1950,1951,1952,1954],{},"Call ",[31,1953,33],{}," once per session and cache the result. Re-fetch when you encounter an unknown property id or after the user changes space settings.",[10,1956,1957,1958,1962,1963,708,1966,1044],{},"See ",[14,1959,1961],{"href":1960},"/api/concepts/objects","Objects"," for how properties fit into full object responses together with ",[31,1964,1965],{},"collections",[31,1967,1968],{},"blocks",[1970,1971,1972],"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 .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}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 .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}",{"title":169,"searchDepth":176,"depth":183,"links":1974},[1975,1976,1977,1978,1985,1991],{"id":149,"depth":183,"text":150},{"id":459,"depth":183,"text":460},{"id":628,"depth":183,"text":629},{"id":824,"depth":183,"text":1979,"children":1980},"Tags and object select (entity)",[1981,1982,1983,1984],{"id":270,"depth":201,"text":864},{"id":1027,"depth":201,"text":1028},{"id":1061,"depth":201,"text":1062},{"id":1146,"depth":201,"text":1147},{"id":1313,"depth":183,"text":144,"children":1986},[1987,1989,1990],{"id":1331,"depth":201,"text":1988},"Option catalog (labelSet)",{"id":1662,"depth":201,"text":1062},{"id":1783,"depth":201,"text":1147},{"id":1944,"depth":183,"text":1945},"How property definitions and typed property values work on objects in the Capacities API.","md",null,{},true,"/api/concepts/properties",{"title":5,"description":1992},"api/2.concepts/properties","j7z0E1tOcayxiY883fli0CpEekiEUrf2ehE62hMyso8",[2002,2004],{"title":1961,"path":1960,"stem":2003,"children":-1},"api/2.concepts/objects",{"title":2005,"path":16,"stem":2006,"children":-1},"Structures","api/2.concepts/structures",1781012285462]