adding support for Content-ID in associate and associateSingleValued requests. fixes #190

Author: AleksandrRogov

.github/README.md

@@ -364,7 +364,7 @@ async | `boolean` | All | **XHR requests only!** Indicates whether the requests
 backgroundOperationCallbackUrl | `string` | `callAction` | `v2.3.0+` Background operation callback URL. [More Info](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/background-operations?tabs=webapi#request-a-callback)
 bypassCustomPluginExecution | `boolean` | `create`, `update`, `upsert`, `delete` | If set to true, the request bypasses custom business logic, all synchronous plug-ins and real-time workflows are disabled. Check for special exceptions in Microsft Docs. [More Info](https://docs.microsoft.com/en-us/powerapps/developer/data-platform/bypass-custom-business-logic)
 collection | `string` | All | Entity Collection name.
-contentId | `string` | `create`, `update`, `upsert`, `deleteRecord` | **BATCH REQUESTS ONLY!** Sets Content-ID header or references request in a Change Set. [More Info](https://www.odata.org/documentation/odata-version-3-0/batch-processing/)
+contentId | `string` | `create`, `update`, `upsert`, `deleteRecord`, `associate`, `associateSingleValued` | **BATCH REQUESTS ONLY!** Sets Content-ID header or references request in a Change Set. [More Info](https://www.odata.org/documentation/odata-version-3-0/batch-processing/)
 continueOnError | `boolean` | `executeBatch` | **BATCH REQUESTS ONLY!** Sets Prefer header to `odata.continue-on-error` that allows more requests be processed when errors occur. The batch request will return `200 OK` and individual response errors will be returned in the batch response body. [More Info](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/execute-batch-operations-using-web-api#handling-errors)
 count | `boolean` | `retrieveMultiple`, `retrieveAll` | Boolean that sets the $count system query option with a value of true to include a count of entities that match the filter criteria up to 5000 (per page). Do not use $top with $count!
 data | `Object` or `ArrayBuffer` / `Buffer` (for node.js) | `create`, `update`, `upsert`, `uploadFile` | A JavaScript object that represents Dynamics 365 entity, action, metadata and etc. 
@@ -2862,7 +2862,7 @@ the config option "formatted" will enable developers to retrieve all information
 - [X] Support Microsoft Power Pages. `Added in v2.1.0`
 - [X] Background Operations for custom actions. `Added in v2.3.0`
 - [X] Support Search API 2.0 [#174](https://github.com/AleksandrRogov/DynamicsWebApi/issues/174). `Added in v2.3.0`
-- [ ] [Session token](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`
+- [ ] [Session token](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.2`
 - [ ] Custom requests.
 
 Many more features to come!

dist/browser/esm/dynamics-web-api.js

@@ -1,4 +1,4 @@
-/*! dynamics-web-api v2.3.0 (c) 2025 Aleksandr Rogov. License: MIT */
+/*! dynamics-web-api v2.3.1 (c) 2025 Aleksandr Rogov. License: MIT */
 /**
  * Microsoft Dataverse Web API helper library for Node.js and Browser.
  * It is compatible with: Dataverse, Dynamics 365 (online), Dynamics 365 (on-premise), Dynamics CRM 2016, Dynamics CRM Online.
@@ -463,7 +463,10 @@ export interface Request extends BaseRequest {
     collection?: string;
 }
 export interface CRUDRequest extends Request {
-    /**A String representing collection record's Primary Key (GUID) or Alternate Key(s). */
+    /**
+     * A String representing collection record's Primary Key (GUID) or Alternate Key(s).
+     * Can be ommitted in a Batch request when contentId is set.
+     */
     key?: string;
 }
 export interface CountRequest extends Request {
@@ -637,24 +640,40 @@ export interface RetrieveMultipleRequest extends Request {
     partitionId?: string;
 }
 export interface AssociateRequest extends Request {
-    /**Primary entity record id/key. */
-    primaryKey: string;
+    /**
+     * Primary entity record id/key.
+     * Can be ommitted in a Batch request when contentId is set.
+     */
+    primaryKey?: string;
     /**Relationship name. */
     relationshipName: string;
-    /**Related name of the Entity Collection or Entity Logical name. */
-    relatedCollection: string;
-    /**Related entity record id/key. */
+    /**
+     * Related name of the Entity Collection or Entity Logical name.
+     * Can be omitted in a Batch request when relatedKey is set to a ContentId.
+     */
+    relatedCollection?: string;
+    /**Related entity record id/key or a ContentId in a Batch request (e.g. $2). */
     relatedKey: string;
+    /**v2.3.1+ BATCH REQUESTS ONLY! Sets Content-ID header or references request in a Change Set. */
+    contentId?: string;
 }
 export interface AssociateSingleValuedRequest extends Request {
-    /**Primary entity record id/key. */
-    primaryKey: string;
+    /**
+     * Primary entity record id/key.
+     * Can be ommitted in a Batch request when contentId is set.
+     */
+    primaryKey?: string;
     /**Navigation property name. */
     navigationProperty: string;
-    /**Related name of the Entity Collection or Entity Logical name. */
-    relatedCollection: string;
-    /**Related entity record id/key. */
+    /**
+     * Related name of the Entity Collection or Entity Logical name.
+     * Can be omitted in a Batch request when relatedKey is set to a ContentId.
+     */
+    relatedCollection?: string;
+    /**Related entity record id/key or a ContentId in a Batch request (e.g. $2). */
     relatedKey: string;
+    /**v2.3.1+ BATCH REQUESTS ONLY! Sets Content-ID header or references request in a Change Set. */
+    contentId?: string;
 }
 export interface DisassociateRequest extends Request {
     /**Primary entity record id/key. */