Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
protogrid:json_api_database_views [2021-12-21 22:57] druprotogrid:json_api_database_views [2022-05-14 00:48] – [Overall Views With Filtering/Sorting] dru
Line 198: Line 198:
  
 === by_sortstring_and_id === === by_sortstring_and_id ===
- 
-=== by_search_term_and_sortstring_and_id === 
-This view contains Cards for a certain search term by id. The key is composed of the search term, the Card sorting string and the Card key. Search term means a specific string, for which you want to find all Cards containing this string. You may not find Cards having this string only in the labels of the fields. Example: 
-<code javascript > 
-["behavior", "ScriptLibrary:Server ScriptLibrary Next Steps", "1475e62a-47d7-4a29-98c2-c89f50edd497"] 
-</code> 
-The value is null. 
- 
-**Be aware**: The search only goes over values stored in this Card. This may differ from the visual representation Card. For example when Card A references another Card, you see the Shortname of the referenced Card (say "wishes an offer") in the corresponding relation field. Nevertheless, the Card only stores the Card key of the related Card (say "c18bc1c2-5499-49cc-90e0-f06b4af1474f"), therefore you will not find Card A when searching for Cards containing "wishes". 
- 
-Example request to find all cards containing the word "behavior": 
-<code> 
-https://example.protogrid.com/api/v2/apps/produktekatalog/views/by_search_term_and_sortstring_and_id?start_key=["behavior",null,null]&end_key=["behavior",{},{}] 
-</code> 
- 
-Example response: 
-<code javascript > 
-{ 
-    "errors": [], 
-    "result": { 
-        "next_card_key": [ 
-            "behavior", 
-            "ScriptLibrary:Server ScriptLibrary Products", 
-            "ba9859e1-68ad-4004-b8e0-c4f0812edf20" 
-        ], 
-        "rows": [ 
-            { 
-                "key": [ 
-                    "behavior", 
-                    "ScriptLibrary:Server ScriptLibrary Next Steps", 
-                    "1475e62a-47d7-4a29-98c2-c89f50edd497" 
-                ], 
-                "value": null 
-            }, 
-            { 
-                "key": [ 
-                    "behavior", 
-                    "ScriptLibrary:Server ScriptLibrary Next Steps", 
-                    "1475e62a-47d7-4a29-98c2-c89f50edd497" 
-                ], 
-                "value": null 
-            }, 
-            { 
-                "key": [ 
-                    "behavior", 
-                    "ScriptLibrary:Server ScriptLibrary Products", 
-                    "ba9859e1-68ad-4004-b8e0-c4f0812edf20" 
-                ], 
-                "value": null 
-            }, 
-            ... 
-        ] 
-    } 
-} 
-</code> 
- 
-You might have duplicates in the code due to several occurrences of the same search term on the same Card. 
  
 === by_design_element_and_sortstring_and_id === === by_design_element_and_sortstring_and_id ===
Print/export