Skip to content

Commit cfc24ce

Browse files
authored
Merge pull request #4902 from MicrosoftDocs/webapi-doc-updates
Updating links to the samples
2 parents 4a8ccf9 + 8f8db3d commit cfc24ce

6 files changed

+29
-25
lines changed

powerapps-docs/developer/data-platform/webapi/samples/basic-operations-client-side-javascript.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ This sample demonstrates how to perform basic CRUD (create, retrieve, update, an
3636

3737
To run this sample, the following is required:
3838

39-
- Access to Microsoft Dataverse online or on-premises version 8.0 or higher.
39+
- Access to Microsoft Dataverse environment.
4040

4141
- A user account with privileges to import solutions and perform CRUD operations, typically a system administrator or system customizer security role.
4242

4343
<a name="bkmk_runsample"></a>
4444

4545
## Run this sample
4646

47-
To run this sample, download the solution package here [Microsoft CRM Web API Basic Operations Sample (Client-side JavaScript)](/samples/browse/). Download the Microsoft CRM Web API Basic Operations Sample (Client-side JavaScript).zip file and extract the contents. Locate the WebAPIBasicOperations_1_0_0_1_managed.zip solution and import it into your Dataverse organization and run the sample. For instructions on how to import the sample solution, see [Web API Samples (Client-side JavaScript)](../web-api-samples-client-side-javascript.md).
47+
To run this sample, download the solution package from [here](https://github.com/microsoft/PowerApps-Samples/tree/master/cds/webapi/JS/WebAPIBasicOperations) and extract the contents. Locate the `WebAPIBasicOperations_1_0_0_1_managed.zip` solution and import it into your Dataverse environment and run the sample. For instructions on how to import the sample solution, see [Web API Samples (Client-side JavaScript)](../web-api-samples-client-side-javascript.md).
4848

4949
<a name="bkmk_codesample"></a>
5050

@@ -868,9 +868,9 @@ Sdk.deleteSampleData = function () {
868868
### See also
869869

870870
[Use the Dataverse Web API](../overview.md)<br />
871-
[Create an entity using the Web API](../create-entity-web-api.md)<br />
872-
[Retrieve an entity using the Web API](../retrieve-entity-using-web-api.md)<br />
873-
[Update and delete entities using the Web API](../update-delete-entities-using-web-api.md)<br />
871+
[Create a table using the Web API](../create-entity-web-api.md)<br />
872+
[Retrieve a table using the Web API](../retrieve-entity-using-web-api.md)<br />
873+
[Update and delete tables using the Web API](../update-delete-entities-using-web-api.md)<br />
874874
[Web API Samples](../web-api-samples.md)<br />
875875
[Web API Basic Operations Sample](../web-api-basic-operations-sample.md)<br />
876876
[Web API Basic Operations Sample (C#)](cdswebapiservice-basic-operations.md)<br />

powerapps-docs/developer/data-platform/webapi/samples/conditional-operations-client-side-javascript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ This sample demonstrates how to perform conditional operations using Microsoft D
3636

3737
To run this sample, the following is required:
3838

39-
- Access to Dataverse online version 8.0 or higher.
39+
- Access to Dataverse environment.
4040

4141
- A user account with privileges to import solutions and perform CRUD operations, typically a system administrator or system customizer security role.
4242

4343
<a name="bkmk_runsample"></a>
4444

4545
## Run this sample
4646

47-
To run this sample, go to [Microsoft CRM Web API Conditional Operations Sample (Client-side JavaScript)](/samples/browse/) and download the Microsoft CRM Web API Conditional Operations Sample (Client-side JavaScript).zip sample file. Extract the contents and locate the WebAPIConditionalOperations_1_0_0_0_managed.zip managed solution. Import the managed solution into your Dataverse organization and view the solution configuration page to run the sample. For instructions on how to import the sample solution, see [Web API Samples (Client-side JavaScript)](../web-api-samples-client-side-javascript.md).
47+
To run this sample, download the solution package from [here](https://github.com/microsoft/PowerApps-Samples/tree/master/cds/webapi/JS/WebAPIConditionalOperations), extract the contents, and locate the `WebAPIConditionalOperations_1_0_0_0_managed.zip` managed solution. Import the managed solution into your Dataverse environment and view the solution configuration page to run the sample. For instructions on how to import the sample solution, see [Web API Samples (Client-side JavaScript)](../web-api-samples-client-side-javascript.md).
4848

4949
<a name="bkmk_sampleCode"></a>
5050

powerapps-docs/developer/data-platform/webapi/samples/functions-actions-client-side-javascript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ This sample demonstrates how to perform bound and unbound functions and actions,
4141

4242
To run this sample, the following is required:
4343

44-
- Access to Dataverse online or on-premises version 8.0 or higher.
44+
- Access to Dataverse environment.
4545
- A user account with privileges to import solutions and perform CRUD operations, typically a system administrator or system customizer security role.
4646

4747
<a name="bkmk_runsample"></a>
4848

4949
## Run this sample
5050

51-
To run this sample, go to [Microsoft CRM Web API Functions and Actions Sample (Client-side JavaScript)](/samples/browse/) and download the Microsoft CRM Web API Functions and Actions Sample (Client-side JavaScript).zip sample file. Extract the contents and locate the WebAPIFunctionsandActions_1_0_0_0_managed.zip managed solution file. Import the managed solution into your Dataverse organization and view the configuration page of the solution to run the sample. For instructions on how to import the sample solution, see [Web API Samples (Client-side JavaScript)](../web-api-samples-client-side-javascript.md).
51+
To run this sample, download the solution package from [here](https://github.com/microsoft/PowerApps-Samples/tree/master/cds/webapi/JS/WebAPIFunctionsAndActions), extract the contents, and locate the `WebAPIFunctionsandActions_1_0_0_0_managed.zip` managed solution file. Import the managed solution into your Dataverse organization and view the configuration page of the solution to run the sample. For instructions on how to import the sample solution, see [Web API Samples (Client-side JavaScript)](../web-api-samples-client-side-javascript.md).
5252

5353
<a name="bkmk_codeSample"></a>
5454

powerapps-docs/developer/data-platform/webapi/samples/query-data-client-side-javascript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This sample demonstrates how to perform basic query requests using the Microsoft
4343

4444
## Run this sample
4545

46-
To run this sample, go to [Microsoft CRM Web API Query Data Sample (Client-side JavaScript)](/samples/browse/) and download the sample archive file: Microsoft CRM Web API Query Data Sample (Client-side JavaScript).zip. Extract the contents of the sample archieve and locate the WebAPIQueryData_1_0_0_0_managed.zip managed solution file. Import the managed solution into your Dataverse organization and run the sample. For instructions on how to import the sample solution, see [Web API Samples (Client-side JavaScript)](../web-api-samples-client-side-javascript.md).
46+
To run this sample,download the solution package from [here](https://github.com/microsoft/PowerApps-Samples/tree/master/cds/webapi/JS/WebAPIQueryData). Extract the contents of the sample and locate the `WebAPIQueryData_1_0_0_0_managed.zip` managed solution file. Import the managed solution into your Dataverse organization and run the sample. For instructions on how to import the sample solution, see [Web API Samples (Client-side JavaScript)](../web-api-samples-client-side-javascript.md).
4747

4848
<a name="bkmk_codeSample"></a>
4949

powerapps-docs/developer/data-platform/webapi/samples/toc.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@
3434
href: ../web-api-samples-client-side-javascript.md
3535
- name: Basic Operations
3636
href: basic-operations-client-side-javascript.md
37-
- name: Query Data
38-
href: query-data-client-side-javascript.md
3937
- name: Conditional Operations
4038
href: conditional-operations-client-side-javascript.md
4139
- name: Functions and Actions
42-
href: functions-actions-client-side-javascript.md
40+
href: functions-actions-client-side-javascript.md
41+
- name: Query Data
42+
href: query-data-client-side-javascript.md

powerapps-docs/developer/data-platform/webapi/web-api-samples-client-side-javascript.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "Web API Data operations Samples (Client-side JavaScript) (Microsoft Dataverse)| Microsoft Docs"
3-
description: "This topic provides a description of various Web API samples that are implemented using Client-side JavaScript"
3+
description: "This article provides a description of various Web API samples that are implemented using Client-side JavaScript"
44
ms.custom: ""
5-
ms.date: 10/31/2018
5+
ms.date: 07/09/2021
66
ms.service: powerapps
77
ms.suite: ""
88
ms.tgt_pltfrm: ""
@@ -26,7 +26,7 @@ search.app:
2626

2727
[!INCLUDE[cc-data-platform-banner](../../../includes/cc-data-platform-banner.md)]
2828

29-
This topic provides common understanding about Web API samples using client-side JavaScript. While each sample focuses on a different aspect of Microsoft Dataverse Web API, they all follow similar process and structure described in this topic.
29+
This article provides common understanding about Web API samples using client-side JavaScript. While each sample focuses on a different aspect of Microsoft Dataverse Web API, they all follow similar process and structure described in this topic.
3030

3131
<a name="bkmk_listOfSamples"></a>
3232
## Web API Samples using client-side JavaScript
@@ -40,16 +40,20 @@ This topic provides common understanding about Web API samples using client-side
4040
|[Web API Functions and Actions Sample (Client-side JavaScript)](samples/functions-actions-client-side-javascript.md)|[Web API Functions and Actions Sample](web-api-functions-actions-sample.md)|Demonstrates how to use bound and unbound functions and actions, including custom actions.|
4141

4242
<a name="bkmk_howToDownload"></a>
43+
4344
## How to download the source code for the sample.
44-
The source code for each sample is available on [MSDN Code Gallery](https://code.msdn.microsoft.com/site/search?f%5b0%5d.type=user&f%5b0%5d.value=microsoft%20dynamics%20crm%20sdk%20documentation%20team). The link to download each sample is included in the individual page for that sample.
45+
46+
The source code for each sample is available on [GitHub](https://github.com/microsoft/PowerApps-Samples/tree/master/cds/webapi/JS). The link to download each sample is included in the individual page for that sample.
4547

46-
After you download the sample, extract the compressed file. Find the Microsoft Visual Studio 2015 solution for each sample within the C# folder because the project is an empty ASP.NET web application project. A Dataverse solution is also provided in the download that you can import and run.
48+
After you download the sample, extract the compressed file. Find the solution for each sample within the C# folder because the project is an empty ASP.NET web application project. A Dataverse solution is also provided in the download that you can import and run.
4749

4850
> [!NOTE]
49-
> Neither Visual Studio or ASP.NET is required to develop client-side JavaScript for Dataverse, however the MSDN Code Gallery site requires files be included in a Visual Studio as a container. However, Visual Studio does provide a good experience for writing JavaScript.
51+
> Neither Visual Studio or ASP.NET is required to develop client-side JavaScript for Dataverse. However, Visual Studio does provide a good experience for writing JavaScript.
5052
5153
<a name="bkmk_HowToImport"></a>
54+
5255
## How to import the Dataverse solution that contains the sample.
56+
5357
Within each project you will find a Dataverse managed solution file. The name of this file will depend on the sample's project name, but the file name will end with `_managed.zip`.
5458

5559
To import the Dataverse solution to your Dataverse server, do the following:
@@ -58,27 +62,27 @@ This topic provides common understanding about Web API samples using client-side
5862

5963
2. In the Dataverse UI, go to **Settings > Solutions**. This page lists all solutions on your Dataverse server. After you finished importing this solution, the solution name for that sample will appear in this list (e.g.: **Web API Basics Operations**).
6064

61-
3. Click **Import** and follow the instructions on the import dialog to complete this action.
65+
3. Select **Import** and follow the instructions on the import dialog to complete this action.
6266

6367
<a name="bkmk_howToRunSample"></a>
6468
## How to run the sample to see the script in action
6569
The sample program runs as a web resource within Dataverse. The imported solution provides a configuration page that gives you an option to keep or delete sample data and a button to start the sample program.
6670

6771
To run the sample, do the following:
6872

69-
1. From the **All Solutions** page in Dataverse, click the solution name (e.g.: **Web API Basics Operations** link). This will open the solution's properties in a new window.
73+
1. From the **All Solutions** page in Dataverse, select the solution name (e.g.: **Web API Basics Operations** link). This will open the solution's properties in a new window.
7074

71-
2. From the left navigation menu, click **Configuration**.
75+
2. From the left navigation menu, select **Configuration**.
7276

73-
3. Click **Start Sample** button to execute the sample code.
77+
3. Select **Start Sample** button to execute the sample code.
7478

7579
<a name="bkmk_commonElements"></a>
7680
## Common elements found in each sample
7781
The following list highlights some common elements found in each of these samples.
7882

79-
- The `Sdk.startSample` function is called when a user clicks the **Start Sample** button from the HTML page. The `Sdk.startSample` function initializes global variables and kicks off the first operation in the chain.
83+
- The `Sdk.startSample` function is called when a user selects the **Start Sample** button from the HTML page. The `Sdk.startSample` function initializes global variables and kicks off the first operation in the chain.
8084

81-
- Program output and error messages are sent to the browser’s debugger console. To see these output, open the console window first before running the sample. Press F12 to access the developer tools, including the console window, in the Internet Explorer and Microsoft Edge browsers.
85+
- Program output and error messages are sent to the browser’s debugger console. To see these output, open the console window first before running the sample. Press F12 to access the developer tools, including the console window, in Microsoft Edge browser.
8286

8387
- These samples use the browser native [ES6-Promise](https://msdn.microsoft.com/library/dn802826\(v=vs.94\).aspx) implementation for modern browsers that support it. For Internet Explorer, this sample uses the [ES6-Promise polyfill](https://github.com/stefanpenner/es6-promise) because Internet Explorer is the only browser supported by Dataverse which does not have native support for this feature.
8488

0 commit comments

Comments
 (0)