@c8y/client 1021.22.40 → 1021.22.44
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ Use `client.<endpoint>.list()` to request listed data from the Cumulocity REST A
|
|
|
22
22
|
| Method | Description | Parameters | Return |
|
|
23
23
|
| --- | --- | --- | --- |
|
|
24
24
|
| `detail(entityOrId)` | Request detail data of a specific entity. | `entityOrId: string | number | IIdentified`: An object which contains an id or an id as number or string. | `Promise<IResult<TData>>`: The list as Promise wrapped in an IResult. IResultList contains data and response. |
|
|
25
|
-
| `list(filter)` | Request a list of data with an optional filter. | `filter:object`: (optional) A filter for [paging](https://
|
|
25
|
+
| `list(filter)` | Request a list of data with an optional filter. | `filter:object`: (optional) A filter for [paging](https://cumulocity.com/guides/reference/rest-implementation/#-a-name-paging-a-query-result-paging) or [filtering](https://cumulocity.com/guides/reference/inventory/#query-language) of the list. | `Promise<IResultList<TData>>`: The list as Promise wrapped in an IResultList. IResultList contains data, response and paging. |
|
|
26
26
|
|
|
27
27
|
* Example for receiving details of one managed object of the inventory via `detail`:
|
|
28
28
|
|
package/package.json
CHANGED