File tree Expand file tree Collapse file tree 1 file changed +23
-1
lines changed Expand file tree Collapse file tree 1 file changed +23
-1
lines changed Original file line number Diff line number Diff line change @@ -33,7 +33,8 @@ WebApiClient.Create(request)
3333```
3434
3535### Retrieve
36- The client supports retrieving of records by Id or also retrieve multiple.
36+ The client supports retrieving of records by Id, by alternate key and retrieve multiple.
37+ For retrieving by alternate key, pass an array of objects that each have a property and a value property.
3738You have to pass at least the entity logical name.
3839You can always pass query parameters which will be appended to your retrieve requests.
3940
@@ -54,6 +55,27 @@ WebApiClient.Retrieve(request)
5455 });
5556```
5657
58+ Retrieve by alternate key:
59+
60+ ``` JavaScript
61+ var request = {
62+ entityName: " contact" ,
63+ alternateKey:
64+ [
65+ { property: " firstname" , value: " Joe" },
66+ { property
: " emailaddress1" , value
: " [email protected] " }
67+ ]
68+ };
69+
70+ WebApiClient .Retrieve (request)
71+ .then (function (response ){
72+ // Process response
73+ })
74+ .catch (function (error ) {
75+ // Handle error
76+ });
77+ ```
78+
5779Retrieve Multiple:
5880
5981``` JavaScript
You can’t perform that action at this time.
0 commit comments