Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| protogrid:json_api_database_views [2021-12-02 13:52] – [Views of Dedicated Search Dialog Boxes] dru | protogrid:json_api_database_views [2023-01-10 23:16] (current) – [Standard Views Decommissioned With Version 2.6.0] dru | ||
|---|---|---|---|
| Line 6: | Line 6: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| Line 55: | Line 54: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| Line 87: | Line 85: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| Line 201: | 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 in the values. You may not find Cards having this string only in the labels of the fields. Example: | ||
| - | <code javascript > | ||
| - | [" | ||
| - | </ | ||
| - | 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 " | ||
| - | |||
| - | Example request to find all cards containing the word " | ||
| - | < | ||
| - | https:// | ||
| - | </ | ||
| - | |||
| - | Example response: | ||
| - | <code javascript > | ||
| - | { | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | ], | ||
| - | " | ||
| - | { | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | ], | ||
| - | " | ||
| - | }, | ||
| - | { | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | ], | ||
| - | " | ||
| - | }, | ||
| - | { | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | ], | ||
| - | " | ||
| - | }, | ||
| - | ... | ||
| - | ] | ||
| - | } | ||
| - | } | ||
| - | </ | ||
| - | |||
| - | 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 === | ||
| Line 271: | Line 210: | ||
| Example request to get all Cards, where the name (in my example having with fieldkey " | Example request to get all Cards, where the name (in my example having with fieldkey " | ||
| < | < | ||
| - | https:// | + | https:// |
| </ | </ | ||
| Line 278: | Line 217: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| Line 311: | Line 249: | ||
| Example Request to get all Cards belonging to the Proto with key " | Example Request to get all Cards belonging to the Proto with key " | ||
| < | < | ||
| - | https:// | + | https:// |
| </ | </ | ||
| Line 320: | Line 258: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| Line 336: | Line 273: | ||
| } | } | ||
| </ | </ | ||
| - | |||
| - | === by_proto_and_search_term_and_sortstring_and_id === | ||
| - | This view contains all non-deleted and non-hidden Cards by proto and searchterm (see also [[# | ||
| - | < | ||
| - | [" | ||
| - | </ | ||
| - | |||
| - | Example Request to get all Cards of Proto " | ||
| - | < | ||
| - | https:// | ||
| - | </ | ||
| - | |||
| - | Example response: | ||
| - | <code javascript > | ||
| - | { | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | { | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | ], | ||
| - | " | ||
| - | }, | ||
| - | ... | ||
| - | ] | ||
| - | } | ||
| - | } | ||
| - | </ | ||
| - | |||
| === by_proto_and_design_element_and_sortstring_and_id === | === by_proto_and_design_element_and_sortstring_and_id === | ||
| Line 382: | Line 285: | ||
| Example Request to find all Cards based on Proto " | Example Request to find all Cards based on Proto " | ||
| < | < | ||
| - | https:// | + | https:// |
| </ | </ | ||
| Line 389: | Line 292: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| Line 421: | Line 323: | ||
| === deleted_by_sortstring_and_id === | === deleted_by_sortstring_and_id === | ||
| This view contains the IDs of all the deleted Cards as keys. The value is null. The request and response are analog to view [[# | This view contains the IDs of all the deleted Cards as keys. The value is null. The request and response are analog to view [[# | ||
| - | |||
| - | === deleted_by_search_term_and_sortstring_and_id === | ||
| - | This view contains all deleted Cards for a certain search term by id. The value is null. The request and response are analog to view [[# | ||
| === deleted_by_design_element_and_sortstring_and_id === | === deleted_by_design_element_and_sortstring_and_id === | ||
| Line 445: | Line 344: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| Line 501: | Line 399: | ||
| Example request to find all Cards relating to the (Related) Card with key " | Example request to find all Cards relating to the (Related) Card with key " | ||
| < | < | ||
| - | https:// | + | https:// |
| </ | </ | ||
| Line 508: | Line 406: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| Line 565: | Line 462: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| Line 611: | Line 507: | ||
| } | } | ||
| </ | </ | ||
| - | |||
| === shortname_objects_by_id === | === shortname_objects_by_id === | ||
| Line 625: | Line 520: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| Line 642: | Line 536: | ||
| </ | </ | ||
| + | ===== Views of Dedicated Search Dialog Boxes ===== | ||
| + | It is also possible to access the views of dedicated [[protogrid: | ||
| + | |||
| + | Hint: For straight forward API usage in most cases it is recommended to use Search Dialog Boxes in " | ||
| + | |||
| + | Please note that Datetime Fields in Dedicated Search Boxes are indexed slightly differently than in normal views: If the date-time value is configured as a fixed filter field, the time component will always be set to 0 (example: " | ||
| + | |||
| + | Example Request: | ||
| + | < | ||
| + | https:// | ||
| + | </ | ||
| + | |||
| + | The key depends on the individually configured Filter Fields for the acessed Search Dialog Box. | ||
| + | |||
| + | ===== Change Log ===== | ||
| ==== Standard Views Decommissioned With Version 2.1.5 ==== | ==== Standard Views Decommissioned With Version 2.1.5 ==== | ||
| * by_id_and_value | * by_id_and_value | ||
| Line 682: | Line 591: | ||
| * all_connectors_by_url_name | * all_connectors_by_url_name | ||
| + | ==== Adjustments to Views With Version 2.2.2 ==== | ||
| + | - All views: If a view is requested with the " | ||
| + | - All views: All string values as well as sortstrings are now cut off after 300 characters. | ||
| + | - All views: The separator between human readable values and keys is now " | ||
| + | - All views: The second last column " | ||
| + | - Dedicated Search Boxes: Now all filters must be set. An empty filter field in a Search Dialog Boxes now means a filter for those Cards where the target field is also empty. | ||
| + | - Dedicated Search Boxes: Datetime Fields in Dedicated Search Boxes are now indexed slightly differently than in normal views: If the date-time value is configured as a fixed filter field, the time component will always be set to 0 (example: “2021-11-11T00: | ||
| + | - Dedicated Search Boxes with " | ||
| + | * For Relation/ | ||
| + | * For other field values: "< | ||
| + | * Note: It is anyway recommended to use Search Dialog Boxes with display mode “Simple Keys in JSON API only” (i. e. non-sortable). | ||
| + | - In views " | ||
| + | * For Relation/ | ||
| + | * For other field values: "< | ||
| + | * Note: If you don't explicitly need sorting by design element value is anyway recommended to use the views " | ||
| + | - In views " | ||
| + | * View columns of " | ||
| + | * View columns of by_design_element_and_sortstring_and_id"" | ||
| - | ===== Views of Dedicated Search Dialog Boxes ===== | + | ==== Standard |
| - | It is also possible to access the views of dedicated [[protogrid: | + | * by_search_term_and_sortstring_and_id |
| - | + | * by_proto_and_search_term_and_sortstring_and_id | |
| - | Hint: For straight forward API usage in most cases it is recommended to use Search Dialog Boxes in " | + | * deleted_by_search_term_and_sortstring_and_id |
| - | + | * navroot_candidates_by_sortstring_and_id | |
| - | Please note that Datetime Fields in Dedicated Search Boxes are indexed slightly differently than in normal views: If the date-time value is configured as a filter field, the time component will always be set to 0 (example: " | + | * navroot_candidates_by_search_term_and_sortstring_and_id |
| - | + | * data_protos_by_sortstring_and_id | |
| - | Example Request: | + | * data_protos_by_search_term_and_sortstring_and_id |
| - | < | + | |
| - | https:// | + | |
| - | </ | + | |
| - | + | ||
| - | The key depends on the individually configured Filter Fields for the acessed Search Dialog Box. | + | |
