Skip to content

Commit 09eef06

Browse files
changes to table of contents
1 parent 1f686f2 commit 09eef06

File tree

1 file changed

+34
-30
lines changed

1 file changed

+34
-30
lines changed

.github/README.md

Lines changed: 34 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -73,32 +73,36 @@ v2 breaking changes are [here](/.github/BREAKING_CHANGES_V2.md). List of new fea
7373
* [Fetch All records](#fetch-all-records)
7474
* [Execute Web API functions](#execute-web-api-functions)
7575
* [Execute Web API actions](#execute-web-api-actions)
76-
* [Execute Batch Operations](#execute-batch-operations)
77-
* [Work with Table Definitions (Entity Metadata)](#work-with-table-definitions-entity-metadata)
78-
* Tables
79-
* [Create a new Table Definition](#create-a-new-table-definition)
80-
* [Retrieve Table Definitions](#retrieve-table-definitions)
81-
* [Update Table Definitions](#update-table-definitions)
82-
* [Retrieve Multiple Table Definitions](#retrieve-multiple-table-definitions)
83-
* Columns
84-
* [Create Columns](#create-columns)
85-
* [Retrieve Columns](#retrieve-columns)
86-
* [Update Columns](#update-columns)
87-
* [Retrieve Multiple Columns](#retrieve-multiple-columns)
88-
* [Use requests to query Table and Column definitions](#use-requests-to-query-table-and-column-definitions)
89-
* Relationships
90-
* [Create Relationship](#create-relationship)
91-
* [Update Relationship](#update-relationship)
92-
* [Delete Relationship](#delete-relationship)
93-
* [Retrieve Relationship](#retrieve-relationship)
94-
* [Retrieve Multiple Relationships](#retrieve-multiple-relationships)
95-
* [Use multi-table lookup columns (Polymorfic Lookup Attributes)](#use-multi-table-lookup-columns-polymorfic-lookup-attributes)
96-
* Global Option Sets (Choices)
97-
* [Create Global Option Set](#create-global-option-set)
98-
* [Update Global Option Set](#update-global-option-set)
99-
* [Delete Global Option Set](#delete-global-option-set)
100-
* [Retrieve Global Option Set](#retrieve-global-option-set)
101-
* [Retrieve Multiple Global Option Sets](#retrieve-multiple-global-option-sets)
76+
* [Batch Operations](#batch-operations)
77+
* [Content-ID to reference requests in a Change Set](#use-content-id-to-reference-requests-in-a-change-set)
78+
* [Content-ID inside a request payload](#use-content-id-inside-a-request-payload)
79+
* [Controlling Change Sets](#controlling-change-sets)
80+
* [Limitations](#batch-operation-limitations)
81+
* [Work with Table Definitions (Entity Metadata)](#work-with-table-definitions-entity-metadata)
82+
* Tables
83+
* [Create a new Table Definition](#create-a-new-table-definition)
84+
* [Retrieve Table Definitions](#retrieve-table-definitions)
85+
* [Update Table Definitions](#update-table-definitions)
86+
* [Retrieve Multiple Table Definitions](#retrieve-multiple-table-definitions)
87+
* Columns
88+
* [Create Columns](#create-columns)
89+
* [Retrieve Columns](#retrieve-columns)
90+
* [Update Columns](#update-columns)
91+
* [Retrieve Multiple Columns](#retrieve-multiple-columns)
92+
* [Use requests to query Table and Column definitions](#use-requests-to-query-table-and-column-definitions)
93+
* Relationships
94+
* [Create Relationship](#create-relationship)
95+
* [Update Relationship](#update-relationship)
96+
* [Delete Relationship](#delete-relationship)
97+
* [Retrieve Relationship](#retrieve-relationship)
98+
* [Retrieve Multiple Relationships](#retrieve-multiple-relationships)
99+
* [Use multi-table lookup columns (Polymorfic Lookup Attributes)](#use-multi-table-lookup-columns-polymorfic-lookup-attributes)
100+
* Global Option Sets (Choices)
101+
* [Create Global Option Set](#create-global-option-set)
102+
* [Update Global Option Set](#update-global-option-set)
103+
* [Delete Global Option Set](#delete-global-option-set)
104+
* [Retrieve Global Option Set](#retrieve-global-option-set)
105+
* [Retrieve Multiple Global Option Sets](#retrieve-multiple-global-option-sets)
102106
* [Retrieve CSDL $metadata document](#retrieve-csdl-metadata-document)
103107
* [Formatted Values and Lookup Columns](#formatted-values-and-lookup-columns)
104108
* [Using Alternate Keys](#using-alternate-keys)
@@ -974,15 +978,15 @@ const actionRequest: DynamicsWebApi.UnboundActionRequest<WinOpportunityAction> =
974978
await dynamicsWebApi.callAction(actionRequest);
975979
```
976980
977-
## Execute Batch Operations
981+
## Batch Operations
978982
979-
Batch requests bundle multiple operations into a single one and have the following advantages:
983+
Batch Operations bundle multiple requests into a single one and have the following advantages:
980984
981985
* Reduces a number of requests sent to the Web API server. `Each user is allowed up to 60,000 API requests, per organization instance, within five minute sliding interval.` [More Info](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/api-limits)
982986
* Provides a way to run multiple operations in a single transaction. If any operation that changes data (within a single changeset) fails all completed ones will be rolled back.
983987
* All operations within a batch request run consequently (FIFO).
984988
985-
DynamicsWebApi provides a straightforward way to execute Batch operations which may not always be simple to compose.
989+
DynamicsWebApi provides a straightforward way to execute Batch Operations which may not always be simple to compose.
986990
987991
**Please Note!** By default, all operations that modify data, such as: CREATE, UPDATE, UPSERT, PUT and DELETE - are automatically made atomic (combined in Change Sets). You can change this behaviour by setting `inChangeSet` to `false`. [More Info](#controlling-change-sets)
988992
@@ -1197,7 +1201,7 @@ const responses = await dynamicsWebApi.executeBatch();
11971201
11981202
The first two requests will be atomic (included in a Change Set) and the last one will be executed separately. So, if for some reason, there was an error during creation of an Email record, the whole operation won't be rolled back and the Contact and Order records will be created in the system.
11991203
1200-
**Be extra careful** with an order of requests in a Batch Operation, especially if it has a combination of atomic and non-atomic operations in it. For example, if in an example above we move the creation of an Email record above Order it will create 2 separate change sets for the Contact and for the Order records.
1204+
**Be extra careful** with an order of requests in a Batch Operation, especially if it has a combination of atomic and non-atomic operations in it. For example, if in an example above we move the creation of an Email record above Order - it will create 2 separate change sets for the Contact and for the Order records.
12011205
12021206
```ts
12031207
dynamicsWebApi.startBatch();

0 commit comments

Comments
 (0)