Collaboration - Custom APIs - Associate Collaboration Map

Service:

Collaboration Controls

API Version:

0.11.0

Associates a collaborative entity to a collaboration session.
The association of a collaborative entity creates a collaboration map and is required to keep track of all collaborative actions linked to a session which links to a business entity.

POST https://<org-id>.<crm-region>.dynamics.com/api/data/v9.0/m365_associatecollaborationmap

Request 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.
collaborationMapMetadata	MetadataModelRequest[]	(Optional) A list of metadata key/value pairs that can be provided as additional data to the mapping.
collaborationRootId	string	The collaboration session unique identifier to map to a collaborative entity.

Responses

Name	Type	Description
200 OK	PostAssociateCollaborationMapResponse	OK. Collaboration map added to the collaboration session.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

Authorization

The Dataverse JWT authentication token.

Type: apiKey
In: header

Definitions

Name	Description
ErrorModel
ErrorResponse
MetadataModelRequest
PostAssociateCollaborationMapRequest
PostAssociateCollaborationMapResponse

ErrorModel

Name	Type	Description
code	string	A unique identifier for the error code.
message	string	The error description details.

ErrorResponse

Name	Type	Description
error	ErrorModel	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.

PostAssociateCollaborationMapRequest

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.
collaborationMapMetadata	MetadataModelRequest[]	(Optional) A list of metadata key/value pairs that can be provided as additional data to the mapping.
collaborationRootId	string	The collaboration session unique identifier to map to a collaborative entity.

PostAssociateCollaborationMapResponse

Name	Type	Description
@odata.context	string	The Dynamics 365 type name resource.
collaborationMapId	string	A unique identifier for the collaboration map.