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: README.md
+18-8Lines changed: 18 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ Any suggestions are welcome!
45
45
### DynamicsWebApi as a Dynamics 365 web resource
46
46
In order to use DynamicsWebApi inside Dynamics 365 you need to download a browser version of the library, it can be found in [dist](/dist/) folder.
47
47
48
-
Upload a script as a JavaScript Web Resource, place on the entity or refer to it in your HTML Web Resource and then initialize the main object:
48
+
Upload a script as a JavaScript Web Resource, place on the entity form or refer to it in your HTML Web Resource and then initialize the main object:
49
49
50
50
```js
51
51
//DynamicsWebApi makes calls to Web API v8.0 if a configuration not set
@@ -153,15 +153,15 @@ returnRepresentation | Boolean | Defaults Prefer header with value "return=repre
153
153
webApiUrl | String | A complete URL string to Web API. Example of the URL: "https:/myorg.api.crm.dynamics.com/api/data/v8.2/". If it is specified then webApiVersion property will not be used even if it is not empty.
154
154
webApiVersion | String | Version of the Web API. Default version is "8.0".
155
155
156
-
Configuration property `webApiVersion` is required only when DynamicsWebApi used inside of CRM.
156
+
Configuration property `webApiVersion` is required only when DynamicsWebApi used inside CRM.
157
157
Property `webApiUrl` is required when DynamicsWebApi used externally.
158
-
If both configuration properties set `webApiUrl` will have the highest priority than `webApiVersion`, so the last one will be skipped.
158
+
If both configuration properties set then `webApiUrl` will have a higher priority than `webApiVersion`, so the last one will be skipped.
159
159
160
160
## Request Examples
161
161
162
-
DynamicsWebApi supports __Basic__ and __Advanced__ calls to Web API.
162
+
DynamicsWebApi supports __Basic__ and __Advanced__ calls to Web API.
163
163
164
-
Basic calls can be made by using functions with most commonly used input parameters. They are most convenient for simple operations as they do
164
+
Basic calls can be made by using functions with the most common input parameters. They are convenient for simple operations as they do
165
165
not provide all possible ways of interaction with CRM Web API (for example, [conditional retrievals](https://msdn.microsoft.com/en-us/library/mt607711.aspx#bkmk_DetectIfChanged)
166
166
are not supported in basic functions).
167
167
@@ -214,6 +214,9 @@ As well as multi-level expands are not implemented yet. This situation may be ch
214
214
215
215
For complex requests to Web API with multi-level expands use `executeFetchXml` function.
216
216
217
+
Starting from version 1.2.8, all requests to Web API that have long URLs (more than 2000 characters) are automatically converted to a Batch Request.
218
+
This feature is very convenient if you are trying to make a call using big Fetch XMLs. No special parameters needed to do a convertation.
-[X] get all pages requests, such as: countAll, retrieveMultipleAll, fetchXmlAll and etc. Implemented in v.1.2.5.
865
-
-[ ] overloaded functions with rich request options for all Web API operations.
866
-
-[ ] "formatted" values in responses. For instance: Web API splits information about lookup fields into separate properties, 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.
867
+
-[X] Overloaded functions with rich request options for all Web API operations.
868
+
-[X] Get all pages requests, such as: countAll, retrieveMultipleAll, fetchXmlAll and etc. Implemented in v.1.2.5.
869
+
-[X] Web API requests that have long URL (more than 2000 characters) should be automatically converted to batch requests.
870
+
Feature is very convenient for big Fetch XMLs. Implemented in v.1.2.8.
871
+
-[ ] Web API Authentication for On-Premise instances.
867
872
-[ ] Intellisense for request objects.
873
+
-[ ] "Formatted" values in responses. For instance: Web API splits information about lookup fields into separate properties,
874
+
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.
875
+
-[ ] Batch requests.
876
+
-[ ] Use entity names instead of collection names. I have not done an investigation about it but if you, by any chance, know how to do that,
877
+
I will be very grateful for an advice! Quick guess, does it work like in English language?
0 commit comments