doc: Update DataService documentation to current 1.12

_pages/API/v1.11/DataService/02-dataservice.md

@@ -4,7 +4,7 @@ level: 0
 version: 111
 displayVersion: "1.11"
 title: Data Service
-isCurrentVersion: true
+isCurrentVersion: false
 permalink: /dataservice/v1.11/
 sections:
   dataservice:

_pages/API/v1.12/DataService/02-dataservice.md

@@ -4,7 +4,7 @@ level: 0
 version: 112
 displayVersion: "1.12"
 title: Data Service
-isCurrentVersion: false
+isCurrentVersion: true
 permalink: /dataservice/v1.12/
 sections:
   dataservice:

_pages/API/v1.12/DataService/020-dataservice-releasenotes.md

@@ -2,12 +2,11 @@
 
 <p></p>
 
-{% assign version="1.11.0" %}
+{% assign version="1.12.0" %}
 {% capture features %}
     <ul>
-        <li>Added endpoint to fetch the number of parts at a certain path or depth</li>
-        <li>Added endpoint to fetch the number of characteristics at a certain path or depth</li>
-        <li>Added endpoint to subscribe to <a href="/PiWeb-Api/dataservice/v1.11/#ds-events">events</a> of DataService activity</li>
+        <li>Added endpoint <code>/InspectionPlanItems</code> to fetch parts and characteristics in one request, e.g. to fetch complete sub-trees of the inspection plan</li>
+        <li>Added parameter <code>searchCondition</code> to part and characteristic endpoints, which allows filtering the result based on part or characteristic attributes</li>
     </ul>
 {% endcapture %}
 

_pages/API/v1.12/DataService/025-dataservice-inspectionplan.md

@@ -21,7 +21,7 @@ Parameter name                                                                 |
 <nobr><code>ushort</code> depth</nobr><br><i>default:</i> <code>1</code>       | Determines how many levels of the inspection plan tree hierarchy should be fetched. Setting `depth=0` means that only the entity itself should be fetched, `depth=1` means the entity and its direct children should be fetched. Please note that depth is treated relative of the path depth of the provided part.
 <nobr><code>bool</code> withHistory</nobr><br><i>default:</i> <code>false</code>| Determines whether the version history should be fetched or not. This only effects the query if versioning is activated on the server side.
 <nobr><code>All, None, ID list</code> requestedPartAttributes</nobr><br><i>default:</i> <code>All</code>                                                                                            | Restricts the query to the attributes that should be returned for parts, for example `requestedPartAttributes={1001, 1008}`.
-<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. <br> `searchCondition=4>[2012-11-13T00:00:00Z]`<br>`searchCondition=4>[2012-11-13T00:00:00Z]+852=[1]`<br>`searchCondition=10In[3,21,50]`<br>`searchCondition=6Like[%Example string condition%]`<br>`searchCondition=6=[Example string condition]` <br>
+<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. Please note that this endpoint only supports part attributes. <br> `searchCondition=1234>[2012-11-13T00:00:00Z]`<br>`searchCondition=1234>[2012-11-13T00:00:00Z]+1001=[83740.R23]`<br>`searchCondition=1008In[3,21,50]`<br>`searchCondition=1011Like[%Example string condition%]`<br>`searchCondition=1003=[BR_2837]` <br>
 {% endcapture %}
 {{ table | markdownify | replace: '<table>', '<table class="table table-inline">' }}
 
@@ -336,7 +336,7 @@ Parameter name                                                                 |
 <nobr><code>Guid list</code> partUuids<br></nobr>                              | Restricts the query to the parts with these uuids.
 <nobr><code>Path</code> partPath</nobr>                                        | Restricts the query to the part with this path.
 <nobr><code>ushort</code> depth</nobr><br><i>default:</i> <code>1</code>       | Determines how many levels of the inspection plan tree hierarchy should be fetched. Setting `depth=0` means that only the entity itself should be fetched, `depth=1` means the entity and its direct children should be fetched. Please note that depth is treated relative of the path depth of the provided part.
-<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. <br> `searchCondition=4>[2012-11-13T00:00:00Z]`<br>`searchCondition=4>[2012-11-13T00:00:00Z]+852=[1]`<br>`searchCondition=10In[3,21,50]`<br>`searchCondition=6Like[%Example string condition%]`<br>`searchCondition=6=[Example string condition]` <br>
+<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. Please note that this endpoint only supports part attributes. <br> `searchCondition=1234>[2012-11-13T00:00:00Z]`<br>`searchCondition=1234>[2012-11-13T00:00:00Z]+1001=[83740.R23]`<br>`searchCondition=1008In[3,21,50]`<br>`searchCondition=1011Like[%Example string condition%]`<br>`searchCondition=1003=[BR_2837]` <br>
 {% endcapture %}
 {{ table | markdownify | replace: '<table>', '<table class="table table-inline">' }}
 
@@ -385,7 +385,7 @@ Parameter name                                                                 |
 <nobr><code>ushort</code> depth</nobr><br><i>default:</i> <code>65.535</code>  | Determines how many levels of the inspection plan tree hierarchy should be fetched. Setting `depth=0` means that only the entity itself should be fetched, `depth=1` means the entity and its direct children should be fetched. Please note that depth is treated relative of the path depth of the provided part or characteristic.
 <nobr><code>bool</code> withHistory</nobr><br><i>default:</i> <code>false</code>| Determines whether the version history should be fetched or not. This only effects the query if versioning is activated on the server side.
 <nobr><code>All, None, ID list</code> requestedCharacteristicAttributes</nobr><br><i>default:</i> <code>All</code>                                                                                  | Restricts the query to the attributes that should be returned for characteristics, for example `requestedCharacteristicAttributes={2001, 2101}`
-<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. <br> `searchCondition=4>[2012-11-13T00:00:00Z]`<br>`searchCondition=4>[2012-11-13T00:00:00Z]+852=[1]`<br>`searchCondition=10In[3,21,50]`<br>`searchCondition=6Like[%Example string condition%]`<br>`searchCondition=6=[Example string condition]` <br>
+<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. Please note that this endpoint only supports characteristic attributes. <br> `searchCondition=2123>[2012-11-13T00:00:00Z]`<br>`searchCondition=2123>[2012-11-13T00:00:00Z]+2006=[1]`<br>`searchCondition=2342In[3,21,50]`<br>`searchCondition=2003Like[%Example string condition%]`<br>`searchCondition=2001=[Example string condition]` <br>
 {% endcapture %}
 {{ table | markdownify | replace: '<table>', '<table class="table table-inline">' }}
 
@@ -652,7 +652,7 @@ Parameter name                                                                 |
 <nobr><code>Guid list</code> charUuids<br></nobr>                              | Restricts the query to the characteristics with these uuids.
 <nobr><code>Path</code> partPath</nobr><br><i>default:</i> <code>/</code>      | Restricts the query to the part with this path. The <code>charUuids</code> parameter takes precedence over this parameter.
 <nobr><code>ushort</code> depth</nobr><br><i>default:</i> <code>65.535</code>  | Determines how many levels of the inspection plan tree hierarchy should be fetched. Setting `depth=0` means that only the entity itself should be fetched, `depth=1` means the entity and its direct children should be fetched. Please note that depth is treated relative of the path depth of the provided part or characteristic.
-<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. <br> `searchCondition=4>[2012-11-13T00:00:00Z]`<br>`searchCondition=4>[2012-11-13T00:00:00Z]+852=[1]`<br>`searchCondition=10In[3,21,50]`<br>`searchCondition=6Like[%Example string condition%]`<br>`searchCondition=6=[Example string condition]` <br>
+<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. Please note that this endpoint only supports characteristic attributes. <br> `searchCondition=2123>[2012-11-13T00:00:00Z]`<br>`searchCondition=2123>[2012-11-13T00:00:00Z]+2006=[1]`<br>`searchCondition=2342In[3,21,50]`<br>`searchCondition=2003Like[%Example string condition%]`<br>`searchCondition=2001=[Example string condition]` <br>
 {% endcapture %}
 {{ table | markdownify | replace: '<table>', '<table class="table table-inline">' }}
 
@@ -700,7 +700,7 @@ Parameter name                                                                 |
 <nobr><code>All, None, ID list</code> requestedCharacteristicAttributes</nobr><br><i>default:</i> <code>All</code>  | Restricts the query to the attributes that should be returned for characteristics, for example `requestedCharacteristicAttributes={2001, 2101}`.
 <nobr><code>bool</code> withHistory</nobr><br><i>default:</i> <code>false</code>| Determines whether the version history should be fetched or not. This only effects the query if versioning is activated on the server side.
 <code>Part, Characteristic, CharacteristicWithoutIntermediateParts, None</code> restrictToEntity<br><i>default:</i> <code>None</code>| Determine whether the inspection plan search should be limited to parts, characteristics, or not.
-<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. <br> `searchCondition=4>[2012-11-13T00:00:00Z]`<br>`searchCondition=4>[2012-11-13T00:00:00Z]+852=[1]`<br>`searchCondition=10In[3,21,50]`<br>`searchCondition=6Like[%Example string condition%]`<br>`searchCondition=6=[Example string condition]` <br><br>`restrictToEntity` has to be set for the search condition to work. If `restrictToEntity` is not set the value `Part` is assumed. This means you can filter only by one kind of attributes, either `Part` or `Characteristic`. 
+<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. <br> `searchCondition=1234>[2012-11-13T00:00:00Z]`<br>`searchCondition=1234>[2012-11-13T00:00:00Z]+1001=[83740.R23]`<br>`searchCondition=1008In[3,21,50]`<br>`searchCondition=1011Like[%Example string condition%]`<br>`searchCondition=1003=[BR_2837]` <br><br>`restrictToEntity` has to be set for the search condition to work. If `restrictToEntity` is not set the value `Part` is assumed. This means you can filter only by one kind of attributes, either `Part` or `Characteristic`. 
 
 {% endcapture %}
 {{ table | markdownify | replace: '<table>', '<table class="table table-inline">' }}
@@ -765,7 +765,7 @@ Parameter name                                                                 |
 <nobr><code>Guid list</code> parentUuids<br></nobr>                            | Restricts the query to children of items with these uuids. This parameter is only valid if <code>paths</code> parameter is null or empty.
 <nobr><code>Guid list</code> itemUuids<br></nobr>                              | Restricts the query to the inspection plan items (parts or characteristics) with these uuids.
 <code>Part, Characteristic, CharacteristicWithoutIntermediateParts, None</code> restrictToEntity<br><i>default:</i> <code>None</code>| Determine whether the inspection plan search should be limited to parts, characteristics, or not.
-<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. <br> `searchCondition=4>[2012-11-13T00:00:00Z]`<br>`searchCondition=4>[2012-11-13T00:00:00Z]+852=[1]`<br>`searchCondition=10In[3,21,50]`<br>`searchCondition=6Like[%Example string condition%]`<br>`searchCondition=6=[Example string condition]` <br><br>`restrictToEntity` has to be set for the search condition to work. If `restrictToEntity` is not set the value `Part` is assumed. This means you can filter only by one kind of attributes, either `Part` or `Characteristic`.
+<nobr><code>Condition</code> searchCondition </nobr>                              | The query will only return items matching all conditions. A simple condition consists of the attribute key, followed by an operator and the value to match enclosed in brackets. Possible operators are: >, <, >=, <=, =, <>, In, NotIn, Like. <br> You can combine multiple conditions with '+'. It can be necessary to encode '+' as '%2B'. The format for date/time has to be “yyyy-mm-ddThh:mm:ssZ”. All values need to be surrounded by [ and ], multiple values are separated by a comma. <br> `searchCondition=1234>[2012-11-13T00:00:00Z]`<br>`searchCondition=1234>[2012-11-13T00:00:00Z]+1001=[83740.R23]`<br>`searchCondition=1008In[3,21,50]`<br>`searchCondition=1011Like[%Example string condition%]`<br>`searchCondition=1003=[BR_2837]` <br><br>`restrictToEntity` has to be set for the search condition to work. If `restrictToEntity` is not set the value `Part` is assumed. This means you can filter only by one kind of attributes, either `Part` or `Characteristic`.
 {% endcapture %}
 {{ table | markdownify | replace: '<table>', '<table class="table table-inline">' }}