[{"data":1,"prerenderedAt":509},["ShallowReactive",2],{"\u002Ftools\u002Fid_manager\u002Fdocs\u002Fgroupsendpoints\u002F":3},{"id":4,"title":5,"body":6,"description":82,"extension":497,"isRevision":498,"lastUpdated":499,"meta":500,"navigation":501,"path":502,"revision":503,"seo":504,"slug":505,"stem":506,"subtitle":507,"__hash__":508},"docs\u002Fdocs\u002Fid_manager\u002Fgroupsendpoints\u002Findex.md","ID Management Service",{"type":7,"value":8,"toc":490},"minimark",[9,14,18,23,26,37,45,51,57,62,70,76,105,113,119,124,361,365,376,383,391,397,401,406,409,415,423,427,433,440,444,447,450,456,463,468,472,475,480,486],[10,11,13],"h2",{"id":12},"api-groups","API - Groups",[15,16,17],"p",{},"Allows for bulk actions to be taken on links tagged with a particular group_id, as well as providing a list of currently entered group identifiers in the system.",[19,20,22],"h3",{"id":21},"get-all-groups","Get All Groups",[15,24,25],{},"This will get the entire list of all groups registered in the system. This request may take a considerable amount of time on a large system. This is of use only for administrative purposes and will not be of use outside of that.",[15,27,28,32,33],{},[29,30,31],"strong",{},"URL"," : ",[34,35,36],"code",{},"\u002Fgroups\u002F",[15,38,39,32,42],{},[29,40,41],{},"Method",[34,43,44],{},"GET",[15,46,47,50],{},[29,48,49],{},"Auth required"," : No",[15,52,53,56],{},[29,54,55],{},"HTML\u002FJSON"," : JSON",[58,59,61],"h4",{"id":60},"success-responses","Success Responses",[15,63,64,32,67],{},[29,65,66],{},"Code",[34,68,69],{},"200 OK",[15,71,72,75],{},[29,73,74],{},"Content example"," : Returns a simple JSON response that lists all of the group identifiers in the system.",[77,78,83],"pre",{"className":79,"code":80,"language":81,"meta":82,"style":82},"language-json5 shiki shiki-themes github-light github-dark","{ \n  \"groups\": ['groupid1', 'groupid2', ..., 'testdatagroup', 'rosetta:\u002FIE12345']\n}\n","json5","",[34,84,85,93,99],{"__ignoreMap":82},[86,87,90],"span",{"class":88,"line":89},"line",1,[86,91,92],{},"{ \n",[86,94,96],{"class":88,"line":95},2,[86,97,98],{},"  \"groups\": ['groupid1', 'groupid2', ..., 'testdatagroup', 'rosetta:\u002FIE12345']\n",[86,100,102],{"class":88,"line":101},3,[86,103,104],{},"}\n",[58,106,108,109],{"id":107},"get-groups","GET \u002Fgroups\u002F",[110,111],"binding",{"value":112},"group_id",[15,114,115,116,118],{},"This endpoint acts and response in highly similar manner to the GET \u002Flinks\u002F endpoint mentioned above, but the AnnotationCollection response generated will be filtered to only contain links that are tagged with the matching ",[34,117,112],{},". eg looking for iiif_canvas_of relationships in the 'testdata' group (random link data can be generated and will be tagged with this group id):",[15,120,121],{},[34,122,123],{},"GET \u002Fgroups\u002Ftestdata?motivation=https:\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fmotivations\u002Fiiif_canvas_of",[77,125,127],{"className":79,"code":126,"language":81,"meta":82,"style":82},"  {\n    \"@context\": \"http:\u002F\u002Fwww.w3.org\u002Fns\u002Fanno.jsonld\",\n    \"first\": {\n        \"id\": \"http:\u002F\u002Flocalhost:5001\u002Fid-management\u002Fgroups\u002Ftestdata\u002Fpage\u002F1?group_id=testdata&motivation=https%3A\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fmotivations\u002Fiiif_canvas_of\",\n        \"items\": [\n            {\n                \"body\": {\n                    \"generator\": \"https:\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fgenerators\u002Fotmm\",\n                    \"id\": \"a}AEQ?vB:@b',g!A?B|$vJo[NWMs\u002FIB+Hx3j{B0DbAL+0M\",\n                    \"format\": None\n                },\n                \"created\": \"2020-10-29T23:23:53\",\n                \"id\": \"http:\u002F\u002Flocalhost:5001\u002Fid-management\u002Flinks\u002F73c247dc-53c6-4818-b41a-a99520d4d2e2\",\n                \"label\": \"testdata\",\n                \"dcterms:title\": \"Test Title\",\n                \"dcterms:alternative\": \"Test Reverse Title\",\n                \"modified\": \"2020-10-29T23:23:53\",\n                \"creator\": {\n                  \"name\": \"Test User\"\n                },\n                \"motivation\": \"https:\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fmotivations\u002Fiiif_canvas_of\",\n                \"target\": {\n                    \"generator\": \"https:\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fgenerators\u002Fotmm\",\n                    \"id\": \"J,$|!-BuO9\"\n                },\n                \"type\": \"Annotation\"\n            },\n            {\n            \u002F\u002F RESPONSE ITEMS OMITTED\n            }\n        ],\n        \"startIndex\": 0,\n        \"type\": \"AnnotationPage\"\n    },\n    \"id\": \"http:\u002F\u002Flocalhost:5001\u002Fid-management\u002Fgroups\u002Ftestdata\u002F?group_id=testdata&motivation=https%3A\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fmotivations\u002Fiiif_canvas_of\",\n    \"label\": \"Collection of Link Annotations for [[('group_id', 'testdata'), ('motivation', 'https:\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fmotivations\u002Fiiif_canvas_of')]]\",\n    \"last\": \"http:\u002F\u002Flocalhost:5001\u002Fid-management\u002Fgroups\u002Ftestdata\u002Fpage\u002F1?group_id=testdata&motivation=https%3A\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fmotivations\u002Fiiif_canvas_of\",\n    \"total\": 15,\n    \"type\": \"AnnotationCollection\"\n}\n",[34,128,129,134,139,144,150,156,162,168,174,180,186,192,198,204,210,216,222,228,234,240,245,251,257,262,268,273,279,285,290,296,302,308,314,320,326,332,338,344,350,356],{"__ignoreMap":82},[86,130,131],{"class":88,"line":89},[86,132,133],{},"  {\n",[86,135,136],{"class":88,"line":95},[86,137,138],{},"    \"@context\": \"http:\u002F\u002Fwww.w3.org\u002Fns\u002Fanno.jsonld\",\n",[86,140,141],{"class":88,"line":101},[86,142,143],{},"    \"first\": {\n",[86,145,147],{"class":88,"line":146},4,[86,148,149],{},"        \"id\": \"http:\u002F\u002Flocalhost:5001\u002Fid-management\u002Fgroups\u002Ftestdata\u002Fpage\u002F1?group_id=testdata&motivation=https%3A\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fmotivations\u002Fiiif_canvas_of\",\n",[86,151,153],{"class":88,"line":152},5,[86,154,155],{},"        \"items\": [\n",[86,157,159],{"class":88,"line":158},6,[86,160,161],{},"            {\n",[86,163,165],{"class":88,"line":164},7,[86,166,167],{},"                \"body\": {\n",[86,169,171],{"class":88,"line":170},8,[86,172,173],{},"                    \"generator\": \"https:\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fgenerators\u002Fotmm\",\n",[86,175,177],{"class":88,"line":176},9,[86,178,179],{},"                    \"id\": \"a}AEQ?vB:@b',g!A?B|$vJo[NWMs\u002FIB+Hx3j{B0DbAL+0M\",\n",[86,181,183],{"class":88,"line":182},10,[86,184,185],{},"                    \"format\": None\n",[86,187,189],{"class":88,"line":188},11,[86,190,191],{},"                },\n",[86,193,195],{"class":88,"line":194},12,[86,196,197],{},"                \"created\": \"2020-10-29T23:23:53\",\n",[86,199,201],{"class":88,"line":200},13,[86,202,203],{},"                \"id\": \"http:\u002F\u002Flocalhost:5001\u002Fid-management\u002Flinks\u002F73c247dc-53c6-4818-b41a-a99520d4d2e2\",\n",[86,205,207],{"class":88,"line":206},14,[86,208,209],{},"                \"label\": \"testdata\",\n",[86,211,213],{"class":88,"line":212},15,[86,214,215],{},"                \"dcterms:title\": \"Test Title\",\n",[86,217,219],{"class":88,"line":218},16,[86,220,221],{},"                \"dcterms:alternative\": \"Test Reverse Title\",\n",[86,223,225],{"class":88,"line":224},17,[86,226,227],{},"                \"modified\": \"2020-10-29T23:23:53\",\n",[86,229,231],{"class":88,"line":230},18,[86,232,233],{},"                \"creator\": {\n",[86,235,237],{"class":88,"line":236},19,[86,238,239],{},"                  \"name\": \"Test User\"\n",[86,241,243],{"class":88,"line":242},20,[86,244,191],{},[86,246,248],{"class":88,"line":247},21,[86,249,250],{},"                \"motivation\": \"https:\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fmotivations\u002Fiiif_canvas_of\",\n",[86,252,254],{"class":88,"line":253},22,[86,255,256],{},"                \"target\": {\n",[86,258,260],{"class":88,"line":259},23,[86,261,173],{},[86,263,265],{"class":88,"line":264},24,[86,266,267],{},"                    \"id\": \"J,$|!-BuO9\"\n",[86,269,271],{"class":88,"line":270},25,[86,272,191],{},[86,274,276],{"class":88,"line":275},26,[86,277,278],{},"                \"type\": \"Annotation\"\n",[86,280,282],{"class":88,"line":281},27,[86,283,284],{},"            },\n",[86,286,288],{"class":88,"line":287},28,[86,289,161],{},[86,291,293],{"class":88,"line":292},29,[86,294,295],{},"            \u002F\u002F RESPONSE ITEMS OMITTED\n",[86,297,299],{"class":88,"line":298},30,[86,300,301],{},"            }\n",[86,303,305],{"class":88,"line":304},31,[86,306,307],{},"        ],\n",[86,309,311],{"class":88,"line":310},32,[86,312,313],{},"        \"startIndex\": 0,\n",[86,315,317],{"class":88,"line":316},33,[86,318,319],{},"        \"type\": \"AnnotationPage\"\n",[86,321,323],{"class":88,"line":322},34,[86,324,325],{},"    },\n",[86,327,329],{"class":88,"line":328},35,[86,330,331],{},"    \"id\": \"http:\u002F\u002Flocalhost:5001\u002Fid-management\u002Fgroups\u002Ftestdata\u002F?group_id=testdata&motivation=https%3A\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fmotivations\u002Fiiif_canvas_of\",\n",[86,333,335],{"class":88,"line":334},36,[86,336,337],{},"    \"label\": \"Collection of Link Annotations for [[('group_id', 'testdata'), ('motivation', 'https:\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fmotivations\u002Fiiif_canvas_of')]]\",\n",[86,339,341],{"class":88,"line":340},37,[86,342,343],{},"    \"last\": \"http:\u002F\u002Flocalhost:5001\u002Fid-management\u002Fgroups\u002Ftestdata\u002Fpage\u002F1?group_id=testdata&motivation=https%3A\u002F\u002Fdata.getty.edu\u002Flocal\u002Fthesaurus\u002Fmotivations\u002Fiiif_canvas_of\",\n",[86,345,347],{"class":88,"line":346},38,[86,348,349],{},"    \"total\": 15,\n",[86,351,353],{"class":88,"line":352},39,[86,354,355],{},"    \"type\": \"AnnotationCollection\"\n",[86,357,359],{"class":88,"line":358},40,[86,360,104],{},[19,362,364],{"id":363},"get-all-links-for-a-group","Get All links for a group",[15,366,367,368,373,374,118],{},"This endpoint acts and response in a similar manner to the ",[369,370,372],"a",{"href":371},"\u002Ftools\u002Fid_manager\u002Fdocs\u002Flinksendpoints\u002F#query-for-a-set-of-links-get-params","query links endpoint",", but the AnnotationCollection response generated will be filtered to only contain links that are tagged with the matching ",[34,375,112],{},[15,377,378,32,380],{},[29,379,31],{},[34,381,382],{},"\u002Fgroups\u002F{group_id}",[15,384,385,32,387,390],{},[29,386,31],{},[34,388,389],{},"\u002Fgroups\u002F{group_id}\u002Fpage\u002F{page_number}","    (for pagination of results)",[15,392,393,32,395],{},[29,394,41],{},[34,396,44],{},[15,398,399,50],{},[29,400,49],{},[15,402,403,405],{},[29,404,55],{}," : Both",[58,407,61],{"id":408},"success-responses-1",[15,410,411,32,413],{},[29,412,66],{},[34,414,69],{},[15,416,417,418,422],{},"Please see the ",[369,419,421],{"href":420},"\u002Ftools\u002Fid_manager\u002Fdocs\u002Flinksendpoints\u002F#success-response_1","query links output format documentation"," for details.",[58,424,426],{"id":425},"error-response","Error Response",[15,428,429,432],{},[29,430,431],{},"Condition"," : If there is no such group.",[15,434,435,32,437],{},[29,436,66],{},[34,438,439],{},"404 Not Found",[19,441,443],{"id":442},"delete-all-links-in-a-group","Delete all links in a group",[15,445,446],{},"This is a powerful feature and will delete any link that matches the provided group_id. This requires authentication and while extremely useful and quick compared to deleting links individually, there is no undo short of a database recovery from backup.",[15,448,449],{},"This is a good way to 'update' a set of links created by a process when you do not have or want to have a record of the links created the previous time the process was run. Deleting the group and readding a freshly created list of links to 'replace' the group is a common pattern.",[15,451,452,32,454],{},[29,453,31],{},[34,455,382],{},[15,457,458,32,460],{},[29,459,41],{},[34,461,462],{},"DELETE",[15,464,465,467],{},[29,466,49],{}," : YES",[15,469,470,56],{},[29,471,55],{},[58,473,61],{"id":474},"success-responses-2",[15,476,477,479],{},[29,478,431],{}," : Group ID exists and User is Authenticated.",[15,481,482,32,484],{},[29,483,66],{},[34,485,69],{},[487,488,489],"style",{},"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);}",{"title":82,"searchDepth":95,"depth":95,"links":491},[492],{"id":12,"depth":95,"text":13,"children":493},[494,495,496],{"id":21,"depth":101,"text":22},{"id":363,"depth":101,"text":364},{"id":442,"depth":101,"text":443},"md",false,"2026-03-30",{},true,"\u002Fdocs\u002Fid_manager\u002Fgroupsendpoints","\u002Ftools\u002Fid_manager\u002Fdocs\u002Frevision\u002F",{"title":5,"description":82},"\u002Ftools\u002Fid_manager\u002Fdocs\u002Fgroupsendpoints\u002F","docs\u002Fid_manager\u002Fgroupsendpoints\u002Findex","Service for creating, updating and managing links between identifiers.","xva6TYKN8Q414qCvfY-UkOIfV1OY-moz3zyzLz_Z65k",1782833580523]