associate_records
Links a record to a related record through a validated Dataverse navigation property, handling single-valued lookups and collection membership with optional dry-run preview and ETag controls.
Instructions
Associate records using a validated native navigation property. Single-valued lookup uses conditional PATCH; collection membership uses $ref and requires explicit allow_unprotected_write because parent ETags do not guarantee membership concurrency.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| dryRun | No | Compatibility alias for dry_run. Conflicting aliases are rejected. | |
| dry_run | No | Read-only preview of environment, target, changes and write blockers. Default false; sensitive fields are masked. | |
| ifMatch | No | Compatibility alias for if_match. Conflicting aliases are rejected. | |
| if_match | No | Specific ETag from a prior read/preview. Without it, reads the current record ETag when the table supports concurrency. | |
| relatedId | No | Compatibility alias for related_id. Conflicting aliases are rejected. | |
| related_id | No | ||
| collectionName | No | Compatibility alias for collection_name. Conflicting aliases are rejected. | |
| collection_name | No | Native EntitySetName, such as accounts. Validated against table metadata. | |
| navigationProperty | No | Compatibility alias for navigation_property. Conflicting aliases are rejected. | |
| navigation_property | No | Native navigation property, resolved from relationship metadata to the specified related table. | |
| allowUnprotectedWrite | No | Compatibility alias for allow_unprotected_write. Conflicting aliases are rejected. | |
| relatedCollectionName | No | Compatibility alias for related_collection_name. Conflicting aliases are rejected. | |
| allow_unprotected_write | No | Default false. Explicitly allow an unprotected write if table concurrency is unconfirmed, or for collection relationship membership. Does not bypass a supplied ETag conflict. | |
| related_collection_name | No |