From ce6a7c982ddf53e08a56213a7a2e93e86a42bce4 Mon Sep 17 00:00:00 2001 From: Gabryel Reyes Date: Wed, 17 Jul 2024 14:28:41 +0200 Subject: [PATCH] Added documentation on working with documents --- doc/commands/search.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/commands/search.md b/doc/commands/search.md index 57e0b6e..0405aa6 100644 --- a/doc/commands/search.md +++ b/doc/commands/search.md @@ -11,3 +11,18 @@ pyPolarionCli --user my_username --password my_password --server my_server searc ``` Try the search command by executing the [batch file](/examples/search/search.bat). + +## FAQ + +### Working with Documents + +The JSON output of the queries does not include much information on the documents in which the Work items are found. There are a couple of ways to use the queries and existing data to achieve your goals: + +1. `location` field: This field provides an URI to the location in which the Work Item is found. If you know the structure and names of the spaces and their documents, you can extract the information from this string. + - Get the location: `--field location` + +2. `document.title`: It is possible to make queries for the key `document.title`, eventhough it does not belong to the Work Items. For example: + - Work items without a document: `-q "NOT HAS_VALUE:document.title"` + - Work items in a specific document : `-q "document.title:DOCUMENT_TITLE"` + +The underlying library for Polarion in Python provides more possibilities for [working with documents](https://python-polarion.readthedocs.io/en/latest/document.html), and these can be implemented in pyPolarionCli if the feature is requested in an [Issue](https://github.com/NewTec-GmbH/pyPolarionCli/issues).