You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/README.md
+29-28Lines changed: 29 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,6 +31,7 @@ Browser-compiled script and type definitions can be found in a v2 [dist](https:/
31
31
-**Abort Signal and Abort Controller** (Browser and Node.js 15+). Abort requests when they are no longer need to be completed.
32
32
-**Node.js and a Browser** support.
33
33
-**Proxy Configuration** support.
34
+
-**Background Operations** support. `v2.3.0+`
34
35
- Works with **Microsoft Power Pages** (aka Microsoft Portal). `v2.1.0+`
35
36
36
37
***
@@ -2198,6 +2199,9 @@ _Examples below follow Microsoft's official documenation._
2198
2199
> [!NOTE]
2199
2200
> All request properties are `camelCase`, even though in Dataverse Search API v2.0 they are lowercase.
2200
2201
2202
+
> [!TIP]
2203
+
> All objects in requests and responses are automatically converted and encoded as necessary (per official documentation), simplifying developer's work to construct the request and process the response.
2204
+
2201
2205
### Query
2202
2206
2203
2207
The following table describes all parameters for a `query` request:
@@ -2299,9 +2303,6 @@ if (!error && value.length) {
2299
2303
}
2300
2304
```
2301
2305
2302
-
As you can see all objects are automatically converted and encoded as per official documentation, simplifying developer's
2303
-
work to construct the request and to process the response.
2304
-
2305
2306
### Suggest
2306
2307
2307
2308
The following table describes all parameters for a `suggest` request:
@@ -2397,12 +2398,12 @@ fuzzy | `boolean` | Use fuzzy search to aid with misspellings. The default is fa
2397
2398
```ts
2398
2399
let result = await dynamicsWebApi.autocomplete({
2399
2400
query: {
2400
-
search: "mar"
2401
+
search: "Con"
2401
2402
}
2402
2403
});
2403
2404
2404
2405
//it's similar to:
2405
-
result = await dynamicsWebApi.autocomplete("mar");
2406
+
result = await dynamicsWebApi.autocomplete("Con");
2406
2407
2407
2408
//all data for v2 is returned inside the "response" property
- [X] Getallpagesrequests, suchas:countAll, retrieveMultipleAll, fetchXmlAlland etc. `Implemented in v.1.2.5`
2819
+
- [X] Getallpagesrequests, suchas:countAll, retrieveMultipleAll, fetchXmlAlland etc. `Implemented in v1.2.5`
2819
2820
- [X] WebAPIrequeststhathavelongURL (morethan 2000 characters) should be automatically converted to batch requests.
2820
-
Feature is very convenient for big Fetch XMLs. `Implemented in v.1.2.8`
2821
+
Feature is very convenient for big Fetch XMLs. `Implemented in v1.2.8`
2821
2822
- [X] "Formatted" values in responses. For instance: Web API splits information about lookup fields into separate properties,
2822
2823
the config option "formatted" will enable developers to retrieve all information about such fields in a single requests and access it through DynamicsWebApi custom response objects.
2823
-
- [X] Simplified names for "Formatted" properties. `Implemented in v.1.3.0`
2824
-
- [X] RUD operations using Alternate Keys. `Implemented in v.1.3.4`
2825
-
- [X] Duplicate Detection for Web API v.9.0. `Implemented in v.1.3.4`
2826
-
- [X] Ability to use entity names instead of collection names. `Implemented in v.1.4.0`
2827
-
- [X] Entity and Attribute Metadata helpers. `Implemented in v.1.4.3`
2828
-
- [X] Entity Relationships and Global Option Sets helpers. `Implemented in v.1.4.6`
2829
-
- [X] Batch requests. `Implemented in v.1.5.0`
2830
-
- [X] TypeScript declaration files `d.ts` `Added in v.1.5.3`
2831
-
- [X] Implement `Content-ID` header to reference a request in a Change Set in a batch operation `Added in v.1.5.6`
2832
-
- [X] Change Tracking `Added in v.1.5.11`
2824
+
- [X] Simplified names for "Formatted" properties. `Implemented in v1.3.0`
2825
+
- [X] RUD operations using Alternate Keys. `Implemented in v1.3.4`
2826
+
- [X] Duplicate Detection for Web API v.9.0. `Implemented in v1.3.4`
2827
+
- [X] Ability to use entity names instead of collection names. `Implemented in v1.4.0`
2828
+
- [X] Entity and Attribute Metadata helpers. `Implemented in v1.4.3`
2829
+
- [X] Entity Relationships and Global Option Sets helpers. `Implemented in v1.4.6`
2830
+
- [X] Batch requests. `Implemented in v1.5.0`
2831
+
- [X] TypeScript declaration files `d.ts` `Added in v1.5.3`
2832
+
- [X] Implement `Content-ID` header to reference a request in a Change Set in a batch operation `Added in v1.5.6`
2833
+
- [X] Change Tracking `Added in v1.5.11`
2833
2834
- [X] Support for Aggregate and Grouping results `Added in v1.6.4`
2834
2835
- [X] Support for Timeout option in the configuration `Added in v1.6.10`
2835
-
- [X] Impersonate a user based on their Azure Active Directory (AAD) object id. `Added in v.1.6.12`
2836
-
- [X] File upload/download/delete for a File Field. `Added in v.1.7.0`
2837
-
- [X] Full proxy support. `Added in v.1.7.2`
2838
-
- [X] Refactoring and conversion to TypeScript. `Added in v.2.0.0`
2839
-
- [X] Implement [Dataverse Search API 1.0](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/search/legacy). `Added in v.2.0.0`
2840
-
- [X] Allowcustomheaderstobepassedtotherequest [#151](https://github.com/AleksandrRogov/DynamicsWebApi/issues/151). `Added in v.2.1.0`
2841
-
- [X] SupportMicrosoftPowerPages. `Added in v.2.1.0`
2842
-
- [X] BackgroundOperationsforcustomactions. `Added in v.2.3.0`
2843
-
- [X] SupportSearchAPI2.0 [#174](https://github.com/AleksandrRogov/DynamicsWebApi/issues/174). `Added in v.2.3.0`
2844
-
- [ ] Supportforthe [sessiontoken](https://learn.microsoft.com/en-ca/power-apps/developer/data-platform/use-elastic-tables?tabs=webapi#work-with-the-session-token). `Coming in v.2.3.1`
2836
+
- [X] Impersonate a user based on their Azure Active Directory (AAD) object id. `Added in v1.6.12`
2837
+
- [X] File upload/download/delete for a File Field. `Added in v1.7.0`
2838
+
- [X] Full proxy support. `Added in v1.7.2`
2839
+
- [X] Refactoring and conversion to TypeScript. `Added in v2.0.0`
2840
+
- [X] Implement [Dataverse Search API 1.0](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/search/legacy). `Added in v2.0.0`
2841
+
- [X] Allowcustomheaderstobepassedtotherequest [#151](https://github.com/AleksandrRogov/DynamicsWebApi/issues/151). `Added in v2.1.0`
2842
+
- [X] SupportMicrosoftPowerPages. `Added in v2.1.0`
2843
+
- [X] BackgroundOperationsforcustomactions. `Added in v2.3.0`
2844
+
- [X] SupportSearchAPI2.0 [#174](https://github.com/AleksandrRogov/DynamicsWebApi/issues/174). `Added in v2.3.0`
2845
+
- [ ] [Sessiontoken](https://learn.microsoft.com/en-ca/power-apps/developer/data-platform/use-elastic-tables?tabs=webapi#work-with-the-session-token) support. `Coming in v2.3.1`
0 commit comments