Collaboration - Custom APIs - Update Collaboration Map Custom Api
Updates a collaboration map record and its metadata if provided.
POST https://<org-id>.<crm-region>.dynamics.com/api/data/v9.0/m365_updatecollaborationmapRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True |
string |
The Dataverse JWT authentication token. |
Request Body
| Name | Type | Description |
|---|---|---|
| collaborationMapEntityId |
string |
The collaborative entity Id to map. This value must be empty if the external Id is provided. |
| collaborationMapEntityName |
string |
The collaborative entity type name to map. |
| collaborationMapExternalId |
string |
The external collaborative resource Id to map. This value must be empty if the entity Id is provided. |
| collaborationMapId |
string |
The collaboration map unique identifier to update. |
| createMetadata |
(Optional) A list of metadata key/value pairs that will be added to the existing map. |
|
| deleteMetadata |
(Optional) A list of metadata objects containing the keys that will be removed from the existing map. |
|
| updateMetadata |
(Optional) A list of metadata key/value pairs that will be updated on the existing map. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK. Collaboration map added to the collaboration session. |
|
| Other Status Codes |
Error response describing why the operation failed. |
Security
Authorization
The Dataverse JWT authentication token.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Error |
|
|
Error |
|
|
Metadata |
|
|
Post |
|
|
Post |
ErrorModel
| Name | Type | Description |
|---|---|---|
| code |
string |
A unique identifier for the error code. |
| message |
string |
The error description details. |
ErrorResponse
| Name | Type | Description |
|---|---|---|
| error |
The error details object. |
MetadataModelRequest
| Name | Type | Description |
|---|---|---|
| @odata.type |
string |
The Dynamics 365 type name resource. |
| m365_key |
string |
The metadata key. |
| m365_value |
string |
The metadata value. |
PostAssociateCollaborationMapResponse
| Name | Type | Description |
|---|---|---|
| @odata.context |
string |
The Dynamics 365 type name resource. |
| collaborationMapId |
string |
A unique identifier for the collaboration map. |
PostUpdateCollaborationMapRequest
| Name | Type | Description |
|---|---|---|
| collaborationMapEntityId |
string |
The collaborative entity Id to map. This value must be empty if the external Id is provided. |
| collaborationMapEntityName |
string |
The collaborative entity type name to map. |
| collaborationMapExternalId |
string |
The external collaborative resource Id to map. This value must be empty if the entity Id is provided. |
| collaborationMapId |
string |
The collaboration map unique identifier to update. |
| createMetadata |
(Optional) A list of metadata key/value pairs that will be added to the existing map. |
|
| deleteMetadata |
(Optional) A list of metadata objects containing the keys that will be removed from the existing map. |
|
| updateMetadata |
(Optional) A list of metadata key/value pairs that will be updated on the existing map. |