Common Data Service (current environment)

Enables interaction with the Common Data Service in current environment.

This connector is available in the following products and regions:

Service Class Regions
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Connector Metadata
Publisher Microsoft

Actions

Create a new record

This operation creates a new record of an entity

Delete a record

This operation deletes a record from an entity collection

Executes a changeset request

Executes a changeset request

Get a record

This operation retrieves the specified record for an entity

Get file or image content

Get file or image content

List records

List records for an entity

Perform a bound action

Bound actions target a single entity or a set of records for a single entity.

Perform an unbound action

Unbound actions aren’t bound to an entity type and are called as static operations.

Predict

Use AI Builder models. With the predict action you can use your custom AI Builder Models of Form Processing, Object Detection, Text Classification or use the prebuilt Business Card Reader, Key phrase extraction, Language detection, Text recognition – OCR and Sentiment Analysis.

Relate records

The relate function links two records that have a one-to-many or many-to-many relationship in the Common Data Service.

Unrelate records

The unrelate function removes the link between two records that have a one-to-many or many-to-many relationship in the Common Data Service.

Update a record

This operation updates an existing record for an entity.

Upload file or image content

Upload file or image content

Create a new record

This operation creates a new record of an entity

Parameters

Name Key Required Type Description
Entity name
entityName True string

Choose an option or add your own

Returns

response
object

Delete a record

This operation deletes a record from an entity collection

Parameters

Name Key Required Type Description
Entity name
entityName True string

Choose an option or add your own

Item ID
recordId True string

Enter a globally unique identifier (GUID)

Executes a changeset request

Executes a changeset request

Get a record

This operation retrieves the specified record for an entity

Parameters

Name Key Required Type Description
Entity name
entityName True string

Choose an option or add your own

Item ID
recordId True string

Enter a globally unique identifier (GUID)

Select Query
$select string

Limit the properties returned while retrieving data.

Expand Query
$expand string

Related entries to include with requested entries (default = none).

Returns

response
object

Get file or image content

Get file or image content

Parameters

Name Key Required Type Description
Entity name
entityName True string

Choose an option or add your own

Item ID
recordId True string

Enter a globally unique identifier (GUID)

Field name
fileImageFieldName True string

Choose an option or add your own

Image size
size string

Get thumbnail or enter full for entire image, if enabled

Returns

The content of the file or image

File or image content
binary

List records

List records for an entity

Parameters

Name Key Required Type Description
Entity name
entityName True string

Choose an option or add your own

Select Query
$select string

Limit the properties returned while retrieving data.

Filter Query
$filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Expand Query
$expand string

Related entries to include with requested entries (default = none).

Fetch Xml Query
fetchXml string

Fetch Xml query

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip token
$skiptoken string

The skip token.

Returns

List of entities

Perform a bound action

Bound actions target a single entity or a set of records for a single entity.

Parameters

Name Key Required Type Description
Entity name
entityName True string

Choose an option or add your own

Action Name
actionName True string

Choose an option or add your own

Item ID
recordId True string

Enter a globally unique identifier (GUID)

Returns

response
object

Perform an unbound action

Unbound actions aren’t bound to an entity type and are called as static operations.

Parameters

Name Key Required Type Description
Action Name
actionName True string

Choose an option or add your own

Returns

response
object

Predict

Use AI Builder models. With the predict action you can use your custom AI Builder Models of Form Processing, Object Detection, Text Classification or use the prebuilt Business Card Reader, Key phrase extraction, Language detection, Text recognition – OCR and Sentiment Analysis.

Parameters

Name Key Required Type Description
Model
recordId True string

Choose an option or add your own

Returns

response
object

Relate records

The relate function links two records that have a one-to-many or many-to-many relationship in the Common Data Service.

Parameters

Name Key Required Type Description
Entity name
entityName True string

Choose an option or add your own

Item ID
recordId True string

Enter a globally unique identifier (GUID)

Relationship
associationEntityRelationship True string

Choose an option or add your own

URL
@odata.id True string

Enter the full resource address

Unrelate records

The unrelate function removes the link between two records that have a one-to-many or many-to-many relationship in the Common Data Service.

Parameters

Name Key Required Type Description
Entity name
entityName True string

Choose an option or add your own

Item ID
recordId True string

Enter a globally unique identifier (GUID)

Relationship
associationEntityRelationship True string

Choose an option or add your own

URL
$id True string

Enter the full resource address

Update a record

This operation updates an existing record for an entity.

Parameters

Name Key Required Type Description
Entity name
entityName True string

Choose an option or add your own

Item ID
recordId True string

Enter a globally unique identifier (GUID)

Returns

response
object

Upload file or image content

Upload file or image content

Parameters

Name Key Required Type Description
Entity name
entityName True string

Choose an option or add your own

Item ID
recordId True string

Enter a globally unique identifier (GUID)

Field name
fileImageFieldName True string

Choose an option or add your own

Content
item True binary

Add file or image content

Content name
x-ms-file-name True string

Enter a name for the file or image

Triggers

When a flow step is executed

Triggers a flow when a flow step is executed from business process flow context. (Available only for Power Automate.)

When a record is created, updated or deleted

Triggers a flow when a record is created, updated, or deleted in Dynamics 365.

When a flow step is executed

Triggers a flow when a flow step is executed from business process flow context. (Available only for Power Automate.)

Returns

Name Path Type Description
Flows Workflow Log Id
entity.FlowsWorkflowLogId string

Flow workflow log id.

BPF Instance Id
entity.BPFInstanceId string

Business process flow instance id.

BPF Instance Entity Name
entity.BPFInstanceEntityName string

Business process flow instance entity name.

BPF Definition Id
entity.BPFDefinitionId string

Business process flow definition id.

BPF Definition Entity Name
entity.BPFDefinitionEntityName string

Business process flow definition entity name.

Step Id
entity.StepId string

Business process flow step id.

BPF Definition Name
entity.BPFDefinitionName string

Business process flow definition name.

BPF Instance Name
entity.BPFInstanceName string

Business process flow instance name.

BPF Flow Stage Localized Name
entity.BPFFlowStageLocalizedName string

Business process flow stage localized name.

BPF Flow Stage Entity Name
entity.BPFFlowStageEntityName string

Business process flow stage entity name.

BPF Flow Stage Entity Collection Name
entity.BPFFlowStageEntityCollectionName string

Business process flow stage entity collection name.

BPF Flow Stage Entity Record Id
entity.BPFFlowStageEntityRecordId string

Business process flow stage entity record id.

BPF Active Stage Id
entity.BPFActiveStageId string

Business process flow active stage id.

BPF Active Stage Entity Name
entity.BPFActiveStageEntityName string

Business process flow active stage entity name.

BPF Active Stage Localized Name
entity.BPFActiveStageLocalizedName string

Business process flow active stage localized name.

When a record is created, updated or deleted

Triggers a flow when a record is created, updated, or deleted in Dynamics 365.

Parameters

Name Key Required Type Description
Trigger condition
message True integer

Choose an option or add your own

The entity name
entityname True string

Choose an option or add your own

Scope
scope True integer

Choose an option or add your own

Filtering attributes
filteringattributes string

Comma-separated list of attributes. The trigger fires if at least one of these attributes is modified.

Filter expression
filterexpression string

Odata style filter expression. The trigger fires if the filter expression evaluates to true.

Postpone until
postponeuntil string

Datetime offset for which the notification should be delayed.

Run as
runas integer

User whose context the Flow will run as (only applies if invoker connection is specified)

Returns

An Entity item

Definitions

EntityItemList

List of entities

Name Path Type Description
value
value array of EntityItem

List of Items

Next link
@odata.nextLink string

The url to fetch next page data.

EntityItem

An Entity item

Name Path Type Description
dynamicProperties
dynamicProperties object

Object

WebhookNotificationContent

An Entity item

Name Path Type Description
schema
schema Object

object

This is the type 'object'.

binary

This is the basic data type 'binary'.