Web API Action Reference

Actions represent operations which may have observable side effects, such as creating or updating records. An Action may require parameters and may return a value. Actions may be bound to entity types.

In This Section

Name Description
AddAppComponents
AddMembersTeam Adds members to a team.
AddPrincipalToQueue Adds the specified principal to the list of queue members.
AddPrivilegesRole Adds a set of existing privileges to an existing role.
AddRecurrence Adds recurrence information to an existing appointment.
AddSolutionComponent Adds a solution component to an unmanaged solution.
AddToQueue Moves an entity record from a source queue to a destination queue.
AddUserToRecordTeam Adds a user to the auto created access team for the specified record.
AlmHandler
Analyze
AnalyzeSentiment
ApplyRecordCreationAndUpdateRule Applies record creation and update rules to activities in 365 created as a result of the integration with external applications.
AutoMapEntity Generates a new set of attribute mappings based on the metadata.
BackgroundSendEmail Send email messages asynchronously.
BatchGetFlowMachineStatus
BatchPrediction
Book Schedules or "books" an appointment, recurring appointment, or service appointment (service activity).
BulkDelete Submits a bulk delete job that deletes selected records in bulk. This job runs asynchronously in the background without blocking other activities.
BulkDetectDuplicates Submits an asynchronous system job that detects and logs multiple duplicate records.
CalculatePrice Calculates price in an opportunity, quote, order, and invoice.
CanBeReferenced Checks whether the specified entity can be the primary entity (one) in a one-to-many relationship.
CanBeReferencing Checkes whether an entity can be the referencing entity in a one-to-many relationship.
CancelTraining
CanManyToMany Checks whether an entity can participate in a many-to-many relationship.
CategorizeText
CloneAsPatch Creates a solution patch from a managed or unmanaged solution.
CloneAsSolution Creates a new copy of an unmanged solution that contains the original solution plus all of its patches.
CloneMobileOfflineProfile For internal use only.
CommitAnnotationBlocksUpload
CommitAttachmentBlocksUpload
CommitFileBlocksUpload
CompoundUpdateDuplicateDetectionRule Updates a duplicate rule (duplicate detection rule) and its related duplicate rule conditions.
ConvertOwnerTeamToAccessTeam Converts a team of type owner to a team of type access.
CopySystemForm Creates a new entity form that is based on an existing entity form.
CreateAsyncJobToRevokeInheritedAccess
CreateCustomerRelationships Creates a new customer lookup attribute, and optionally, to add it to a specified unmanaged solution.
CreateException Creates an exception for the recurring appointment instance.
CreateInstance Creates future unexpanded instances for the recurring appointment master.
CreateKnowledgeArticleTranslation Creates translation of a knowledge article instance.
CreateKnowledgeArticleVersion Creates a major or minor version of a knowledge article instance.
CreatePolymorphicLookupAttribute
CreateWorkflowFromTemplate Creates a workflow (process) from a workflow template.
DeleteAndPromote Replaces managed solution (A) plus all of its patches with managed solution (B) that is the clone of (A) and all of its patches.
DeleteAuditData Deletes all audit data records up until a specified end date.
DeleteFile
DeleteOpenInstances Deletes instances of a recurring appointment master that have an “Open” state.
DeleteOptionValue Deletes an option value in a global or local option set.
DeleteRecordChangeHistory Deletes all audit change history records for a particular record.
DeliverImmediatePromoteEmail
DeliverIncomingEmail Creates an email activity record from an incoming email message.
DeliverPromoteEmail Creates an email activity record from the specified email message
DeprovisionLanguage Deprovisions a language.
DetectLanguage
DownloadBlock
DownloadSolutionExportData Download the exported solution data.
ExecuteWorkflow Executes a workflow.
ExportMappingsImportMap Exports a data map as an XML formatted data.
ExportSolution Exports a solution.
ExportSolutionAsync Exports a solution using an asynchronous job.
ExportTranslation Exports all translations for a specific solution to a compressed file.
ExtractKeyPhrases
ExtractTextEntities
FullTextSearchKnowledgeArticle Performs a full-text search on knowledge articles in Dynamics 365 using the specified search text.
GenerateSocialProfile Returns an existing social profile record if one exists, otherwise generates a new one and returns it.
GetAutoNumberSeed
GetJobStatus
GetNextAutoNumberValue
GetPublicKey
GetTrackingTokenEmail Returns a tracking token that can then be passed as a parameter to the SendEmailRequest message.
GrantAccess Grants a security principal (user or team) access to the specified record.
ImmediateBook
ImportCardTypeSchema
ImportFieldTranslation Imports translations from a compressed file.
ImportMappingsImportMap Imports the XML representation of a data map and create an import map (data map) based on this data.
ImportRecordsImport Submits an asynchronous job that uploads the transformed data into Microsoft Dynamics 365.
ImportSolution Imports a solution.
ImportSolutionAsync Imports a solution using an asynchronous join.
ImportSolutions
ImportTranslation Imports translations from a compressed file.
Ingest
InitializeAnnotationBlocksDownload
InitializeAnnotationBlocksUpload
InitializeAttachmentBlocksDownload
InitializeAttachmentBlocksUpload
InitializeFileBlocksDownload
InitializeFileBlocksUpload
InitializeModernFlowFromAsyncWorkflow
InsertOptionValue Inserts a new option value for a global or local option set.
InsertStatusValue Inserts a new option into a StatusAttributeMetadata attribute.
install
InstallSampleData Installs the sample data.
InstantiateFilters Instantiates a set of filters for Dynamics 365 for Outlook for the specified user.
InstantiateTemplate Creates an email message from a template (email template).
IsPaiEnabled
IsPmEnabled
LeaveGroup
Merge Merges the information from two entity records of the same type.
ModifyAccess Replaces the access rights on the target record for the specified security principal (user or team).
msdyn_ActivateProcesses
msdyn_ActivateSdkMessageProcessingSteps
msdyn_CheckForCustomizedOptionSet
msdyn_CheckForCustomizedSitemap
msdyn_CheckForCustomizedWebResources
msdyn_CheckForDeletedProcess
msdyn_CheckForDeletedSDKMessageProcessingSteps
msdyn_CheckForDeletedWebResources
msdyn_CheckForPendingProcesses
msdyn_CheckIfProcessesAreActive
msdyn_CheckIfProcessesOwnedByDisabledUsers
msdyn_CheckIfSDKMessageProcessingStepsAreActive
msdyn_ConditionXmlConversion
msdyn_CreateActionFlow
msdyn_CreateNewAnalysisJob
msdyn_CreateNewAnalysisJobForRuleSet
msdyn_DeleteCalendar
msdyn_GetKAObjectFromTemplate
msdyn_ManageSLAInstances
msdyn_MigrateSlaProactiveRun
msdyn_ModelAppDiagnosis
msdyn_ModelAppRepair
msdyn_RegisterSolutionHealthRule
msdyn_ResolveSolutionHealthRuleFailure
msdyn_RetrieveKnowledgeSearchFilters
msdyn_RetrieveKnowledgeSearchModifiers
msdyn_RetrieveKnowledgeSuggestions
msdyn_RetrievePersonalizationFilters
msdyn_RetrieveSearchProviders
msdyn_RunSolutionCheckerRules
msdyn_SaveCalendar
msdyn_SendEmailFromTemplate
msdyn_SiteMapDiagnosis
msdyn_SiteMapRepair
OnExternalCreated
OnExternalDeleted
OnExternalUpdated
OrderOption Sets the order for an option set.
ParseImport Submits an asynchronous job that parses all import files that are associated with the specified import (data import).
PickFromQueue Assigns a queue item to a user and optionally remove the queue item from the queue.
PowerAutomateProxy
Predict
PredictByReference
PredictionSchema
ProvisionLanguage Provisions a new language.
ProvisionLanguageAsync
PublishAIConfiguration
PublishAllXml Publishes all changes to solution components.
PublishDuplicateRule Submits an asynchronous job to publish a duplicate rule.
PublishTheme Publishes a theme and set it as the current theme.
PublishXml Publishes specified solution components.
PvaAuthorize
PvaCreateBotComponents
PvaCreateContentSnapshot
PvaDeleteBot
PvaGetDirectLineEndpoint
PvaGetFeatureControlSet
PvaGetUserBots
PvaPublish
PvaStartConversation
QueryExpressionToFetchXml Converts a QueryExpression query to its equivalent FetchXML query
QueueUpdateRibbonClientMetadata
QuickTest
ReactivateEntityKey Submit a new asynchronous system job to create the index for the key.
ReassignObjectsOwner Reassigns all records that are owned by the security principal (user or team) to another security principal (user or team).
ReassignObjectsSystemUser Reassigns all records that are owned by a specified user to another security principal (user or team).
Recalculate Recalculate system-computed values for rollup fields in the goal hierarchy.
RecognizeText
RegisterFlowMachine
ReleaseToQueue Assigns a queue item back to the queue owner so others can pick it.
RemoveAppComponents
RemoveFromQueue Removes a queue item from a queue.
RemoveMembersTeam Removes members from a team.
RemoveParent Removes the parent for a system user (user) record.
RemovePrivilegeRole Removes a privilege from an existing role.
RemoveSolutionComponent Removes a component from an unmanaged solution.
RemoveUserFromRecordTeam Removes a user from the auto created access team for the specified record.
ReplacePrivilegesRole Replaces the privilege set of an existing role.
Reschedule Reschedules an appointment, recurring appointment, or service appointment (service activity).
ResetUserFilters Resets the offline data filters for the calling user to the default filters for the organization.
RevokeAccess Replaces the access rights on the target record for the specified security principal (user or team).
RouteTo Routes a queue item to a queue, a user, or a team.
SaveSettingValue Creates or updates app/organization level override.
SchedulePrediction
ScheduleRetrain
ScheduleTraining
SendBulkMail Sends bulk email messages.
SendEmail Sends an e-mail message.
SendEmailFromTemplate Sends an e-mail message to a recipient using an e-mail template.
SendFax Sends a fax.
SendTemplate Sends a bulk email message that is created from a template.
SetAutoNumberSeed
SetBusinessSystemUser Moves a system user (user) to a different business unit.
SetDataEncryptionKey Sets or restore the data encryption key.
SetFeatureStatus internal
SetLocLabels Sets localized labels for a limited set of entity attributes.
SetParentSystemUser Sets a new parent system user (user) for the specified user.
SetProcess Sets the process that associates with a given target entity. The user can set to another business process or specify null to clear out the current process.
SetReportRelated Links an instance of a report entity to related entities.
Share
StageAndUpgrade
StageSolution Stage the solution for upgrade.
SyncBulkOperation
Train
TransformImport Submits an asynchronous job that transforms the parsed data.
TriggerServiceEndpointCheck Validates the configuration of a Microsoft Azure Service Bus solution’s service endpoint.
UninstallSampleData Uninstalls the sample data.
UnpublishAIConfiguration
UnpublishDuplicateRule Submits an asynchronous job to unpublish a duplicate rule.
UnschedulePrediction
UnscheduleTraining
UpdateFeatureConfig internal
UpdateOptionValue Updates an option value in a global or local option set.
UpdateRibbonClientMetadata
UpdateSolutionComponent Updates a component in an unmanaged solution.
UpdateStateValue Updates an option set value in for a StateAttributeMetadata attribute.
UploadBlock
UpsertCompositeDataSource API responsible for creating or updating a composite environment variable.
UpsertEnvironmentVariable API responsible for creating or updating an environment variable.
Validate Verifies that an appointment or service appointment (service activity) has valid available resources for the activity, duration, and site, as appropriate.
ValidateAIConfiguration
ValidateSavedQuery Validates a saved query.
ValidateUnpublished

See also