Dynamics CRM 2016 Web API 消息列表

Posted 2022-12-19 Jeff Xiong

Function

Name	Description
CalculateTotalTimeIncident Function	Calculates the total time, in minutes, that you used while you worked on an incident (case).
CheckPromoteEmail Function	Contains the data that is needed to check whether the incoming email message should be promoted to the Microsoft Dynamics CRM system.
DownloadReportDefinition Function	Downloads a report definition.
ExpandCalendar Function	Converts the calendar rules to an array of available time blocks for the specified period.
ExportFieldTranslation Function	Exports localizable fields values to a compressed file.
GetAllTimeZonesWithDisplayName Function	Retrieves all the time zone definitions for the specified locale and to return only the display name attribute.
GetDefaultPriceLevel Function	Retrieves the default price level (price list) for the current user based on the user’s territory relationship with the price level.
GetDistinctValuesImportFile Function	Retrieves distinct values from the parse table for a column in the source file that contains list values.
GetHeaderColumnsImportFile Function	Retrieves the source-file column headings; or retrieve the system-generated column headings if the source file does not contain column headings.
GetReportHistoryLimit Function	Retrieves the history limit for a report.
GetTimeZoneCodeByLocalizedName Function	Retrieves the time zone code for the specified localized time zone name.
GetValidManyToMany Function	Retrieves a list of all the entities that can participate in a Many-to-Many entity relationship.
GetValidReferencedEntities Function	Retrieves a list of entity logical names that are valid as the primary entity (one) from the specified entity in a one-to-many relationship.
GetValidReferencingEntities Function	Retrieves the set of entities that are valid as the related entity (many) to the specified entity in a one-to-many relationship.
IsComponentCustomizable Function	Determines whether a solution component is customizable.
IsDataEncryptionActive Function	Determines whether data encryption is currently running (active or inactive).
QuerySchedule Function	Searches the specified resource for an available time block that matches the specified parameters.
RetrieveAbsoluteAndSiteCollectionUrl Function	Retrieves the absolute URL and the site collection URL for a SharePoint location record in Microsoft Dynamics CRM.
RetrieveAllChildUsersSystemUser Function	Retrieves the collection of users that report to the specified system user (user).
RetrieveApplicationRibbon Function	Retrieve the data that defines the content and behavior of the application ribbon.
RetrieveAuditPartitionList Function	Retrieves the list of database partitions that are used to store audited history data.
RetrieveAvailableLanguages Function	Retrieves the list of language packs that are installed and enabled on the server.
RetrieveBusinessHierarchyBusinessUnit Function	Retrieves all business units from the business unit hierarchy.
RetrieveByGroupResource Function	Retrieves all resources that are related to the specified resource group
RetrieveByResourceResourceGroup Function	Retrieves the resource groups (scheduling groups) that contain the specified resource.
RetrieveByTopIncidentProductKbArticle Function	Retrieves the top-ten articles about a specified product from the knowledge base of articles for the organization
RetrieveByTopIncidentSubjectKbArticle Function	Retrieves the top-ten articles about a specified subject from the knowledge base of articles for your organization.
RetrieveCurrentOrganization Function	Retrieve information about the current organization.
RetrieveDataEncryptionKey Function	Retrieves the data encryption key value.
RetrieveDependenciesForDelete Function	Retrieves a collection of dependency records that describe any solution components that would prevent a solution component from being deleted.
RetrieveDependenciesForUninstall Function	Retrieves a list of the solution component dependencies that can prevent you from uninstalling a managed solution.
RetrieveDependentComponents Function	Retrieves a list dependencies for solution components that directly depend on a solution component.
RetrieveDeploymentLicenseType Function	Retrieves the type of license for a deployment of Microsoft Dynamics CRM.
RetrieveDeprovisionedLanguages Function	Retrieves a list of language packs that are installed on the server that have been disabled.
RetrieveEntityRibbon Function	Retrieves ribbon definitions for an entity.
RetrieveExchangeRate Function	Retrieves the exchange rate.
RetrieveFormattedImportJobResults Function	Retrieves the formatted results from an import job.
RetrieveInstalledLanguagePacks Function	Retrieves the list of language packs that are installed on the server.
RetrieveInstalledLanguagePackVersion Function	Retrieves the version of an installed language pack.
RetrieveLicenseInfo Function	Retrieves the number of used and available licenses for a deployment of Microsoft Dynamics CRM.
RetrieveMailboxTrackingFolders Function	Retrieves folder-level tracking rules for a mailbox.
RetrieveMembersBulkOperation Function	Retrieves the members of a bulk operation.
RetrieveMissingComponents Function	Retrieves a list of missing components in the target organization.
RetrieveMissingDependencies Function	Retrieves any required solution components that are not included in the solution.
RetrieveOrganizationResources Function	Retrieves the resources that are used by an organization.
RetrieveParentGroupsResourceGroup Function	Retrieves the collection of the parent resource groups of the specified resource group (scheduling group).
RetrieveParsedDataImportFile Function	Retrieves the data from the parse table.
RetrievePersonalWall Function	Retrieves pages of posts, including comments for each post, for all records that the calling user is following.
RetrievePrincipalAttributePrivileges Function	Retrieves all the secured attribute privileges a user or team has through direct or indirect (through team membership) associations with the FieldSecurityProfile entity.
RetrievePrincipalSyncAttributeMappings Function	For internal use only.
RetrievePrivilegeSet Function	Retrieves the set of privileges defined in the system.
RetrieveProductProperties Function	Retrieve all the property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice.
RetrieveProvisionedLanguagePackVersion Function	Retrieves the version of a provisioned language pack.
RetrieveProvisionedLanguages Function	Retrieves the list of provisioned languages.
RetrieveRequiredComponents Function	Retrieves a collection of solution components that are required for a solution component.
RetrieveRolePrivilegesRole Function	Retrieves the privileges that are assigned to the specified role.
RetrieveSubGroupsResourceGroup Function	Retrieves the collection of child resource groups from the specified resource group.
RetrieveTeamPrivileges Function	Retrieves the privileges for a team.
RetrieveTimestamp Function	Retrieves a time stamp for the metadata.
RetrieveUserPrivileges Function	Retrieves the privileges a system user (user) has through his or her roles in the specified business unit.
RetrieveUserQueues Function	Retrieves all private queues of a specified user and optionally all public queues.
RetrieveVersion Function	Retrieves the version number of the Microsoft Dynamics CRM Server.
Search Function	Searches for available time slots that fulfill the specified appointment request.
WhoAmI Function	Retrieves the system user ID for the currently logged on user or the user under whose context the code is running.

Action

Name	Description
AddChannelAccessProfilePrivileges Action	Adds entity privileges to a channel access profile.
AddItemCampaign Action	Adds an item to a campaign.
AddItemCampaignActivity Action	Adds an item to a campaign activity.
AddListMembersList Action	Adds members to a list.
AddMemberList Action	Adds a member to a list (marketing list).
AddMembersTeam Action	Adds members to a team.
AddPrincipalToQueue Action	Adds the specified principal to the list of queue members.
AddPrivilegesRole Action	Adds a set of existing privileges to an existing role.
AddRecurrence Action	Adds recurrence information to an existing appointment.
AddSolutionComponent Action	Adds a solution component to an unmanaged solution.
AddToQueue Action	Moves an entity record from a source queue to a destination queue.
AddUserToRecordTeam Action	Adds a user to the auto created access team for the specified record.
ApplyRecordCreationAndUpdateRule Action	Applies record creation and update rules to activities in CRM created as a result of the integration with external applications.
ApplyRoutingRule Action	Applies the active routing rule to an incident.
AutoMapEntity Action	Generates a new set of attribute mappings based on the metadata.
CalculateActualValueOpportunity Action	Calculates the value of an opportunity that is in the "Won" state.
CalculatePrice Action	Calculates price in an opportunity, quote, order, and invoice.
CanBeReferenced Action	Checks whether the specified entity can be the primary entity (one) in a one-to-many relationship.
CanBeReferencing Action	Checkes whether an entity can be the referencing entity in a one-to-many relationship.
CancelContract Action	Cancels a contract.
CancelSalesOrder Action	Cancels a sales order.
CanManyToMany Action	Checks whether an entity can participate in a many-to-many relationship.
CloneAsPatch Action	Creates a solution patch from a managed or unmanaged solution.
CloneAsSolution Action	Creates a new copy of an unmanaged solution that contains the original solution plus all of its patches.
CloneContract Action	Copies an existing contract and its line items.
CloneProduct Action	Copies an existing product family, product, or bundle under the same parent record.
CloseIncident Action	Closes an incident (case).
CloseQuote Action	Closes a quote.
CompoundUpdateDuplicateDetectionRule Action	Updates a duplicate rule (duplicate detection rule) and its related duplicate rule conditions.
ConvertOwnerTeamToAccessTeam Action	Converts a team of type owner to a team of type access.
ConvertProductToKit Action	Converts a product to a kit.
ConvertQuoteToSalesOrder Action	Converts a quote to a sales order.
ConvertSalesOrderToInvoice Action	Converts a sales order to an invoice.
CopyCampaign Action	Copies a campaign.
CopyCampaignResponse Action	Creates a copy of a campaign response
CopyDynamicListToStatic Action	Creates a static list from the specified dynamic list and add the members that satisfy the dynamic list query criteria to the static list.
CopyMembersList Action	Copies the members from the source list to the target list without creating duplicates.
CopySystemForm Action	Creates a new entity form that is based on an existing entity form.
CreateActivitiesList Action	Creates a quick campaign to distribute an activity to members of a list (marketing list).
CreateException Action	Creates an exception for the recurring appointment instance.
CreateInstance Action	Creates future unexpanded instances for the recurring appointment master.
CreateKnowledgeArticleTranslation Action	Creates translation of a knowledge article instance.
CreateKnowledgeArticleVersion Action	Creates a major or minor version of a knowledge article instance.
CreateWorkflowFromTemplate Action	Creates a workflow (process) from a workflow template.
DeleteAndPromote Action	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 Action	Deletes all audit data records up until a specified end date.
DeleteOpenInstances Action	Deletes instances of a recurring appointment master that have an “Open” state.
DeleteOptionValue Action	Deletes an option value in a global or local option set.
DeliverIncomingEmail Action	Creates an email activity record from an incoming email message.
DeliverPromoteEmail Action	Creates an email activity record from the specified email message
DeprovisionLanguage Action	Deprovisions a language.
DistributeCampaignActivity Action	Creates a bulk operation that distributes a campaign activity.
ExportMappingsImportMap Action	Exports a data map as an XML formatted data.
ExportSolution Action	Exports a solution.
ExportTranslation Action	Exports all translations for a specific solution to a compressed file.
FulfillSalesOrder Action	Fulfills a sales order.
GenerateInvoiceFromOpportunity Action	Generates an invoice from an opportunity.
GenerateQuoteFromOpportunity Action	Generates a quote from an opportunity.
GenerateSalesOrderFromOpportunity Action	Generates a sales order (order) from an opportunity.
GenerateSocialProfile Action	Returns an existing social profile record if one exists, otherwise generates a new one and returns it.
GetInvoiceProductsFromOpportunity Action	Retrieves the products from an opportunity and copy them to the invoice.
GetQuoteProductsFromOpportunity Action	Retrieves the products from an opportunity and copy them to the quote.
GetSalesOrderProductsFromOpportunity Action	Retrieves the products from an opportunity and copy them to the sales order.
GetTrackingTokenEmail Action	Returns a tracking token that can then be passed as a parameter to the SendEmailRequest message.
ImportFieldTranslation Action	Imports translations from a compressed file.
ImportMappingsImportMap Action	Imports the XML representation of a data map and create an import map (data map) based on this data.
ImportRecordsImport Action	Submits an asynchronous job that uploads the transformed data into Microsoft Dynamics CRM.
ImportSolution Action	Imports a solution.
ImportTranslation Action	Imports translations from a compressed file.
InsertOptionValue Action	Inserts a new option value for a global or local option set.
InsertStatusValue Action	Inserts a new option into a StatusAttributeMetadata attribute.
InstallSampleData Action	Installs the sample data.
InstantiateFilters Action	Instantiates a set of filters for Dynamics CRM for Outlook for the specified user.
InstantiateTemplate Action	Creates an email message from a template (email template).
LockInvoicePricing Action	Locks the total price of products and services that are specified in the invoice.
LockSalesOrderPricing Action	Locks the total price of products and services that are specified in the sales order (order).
LoseOpportunity Action	Sets the state of an opportunity to Lost.
Merge Action	Merges the information from two entity records of the same type.
OrderOption Action	Sets the order for an option set.
ParseImport Action	Submits an asynchronous job that parses all import files that are associated with the specified import (data import).
PickFromQueue Action	Assigns a queue item to a user and optionally remove the queue item from the queue.
ProcessInboundEmail Action	Processes the email responses from a marketing campaign.
ProvisionLanguage Action	Provisions a new language.
PublishAllXml Action	Publishes all changes to solution components.
PublishDuplicateRule Action	Submits an asynchronous job to publish a duplicate rule.
PublishProductHierarchy Action	Publishes a product family record and all its child records.
PublishTheme Action	Publishes a theme and set it as the current theme.
PublishXml Action	Publishes specified solution components.
QualifyMemberList Action	Qualifies the specified list and either override the list members or remove them according to the specified option.
ReassignObjectsOwner Action	Reassigns all records that are owned by the security principal (user or team) to another security principal (user or team).
ReassignObjectsSystemUser Action	Reassigns all records that are owned by a specified user to another security principal (user or team).
Recalculate Action	Recalculate system-computed values for rollup fields in the goal hierarchy.
ReleaseToQueue Action	Assigns a queue item back to the queue owner so others can pick it.
RemoveFromQueue Action	Removes a queue item from a queue.
RemoveMembersTeam Action	Removes members from a team.
RemoveParent Action	Removes the parent for a system user (user) record.
RemovePrivilegeRole Action	Removes a privilege from an existing role.
RemoveSolutionComponent Action	Removes a component from an unmanaged solution.
RemoveUserFromRecordTeam Action	Removes a user from the auto created access team for the specified record.
RenewContract Action	Renews a contract and create the contract details for a new contract.
RenewEntitlement Action	Renews an entitlement.
ReplacePrivilegesRole Action	Replaces the privilege set of an existing role.
ResetUserFilters Action	Resets the offline data filters for the calling user to the default filters for the organization.
RevertProduct Action	Reverts changes done to properties of a product family, product, or bundle record, and set it back to its last published (active) state.
ReviseQuote Action	Sets the state of a quote to Draft.
RevokeAccess Action	Replaces the access rights on the target record for the specified security principal (user or team).
RouteTo Action	Routes a queue item to a queue, a user, or a team.
SendEmail Action	Sends an e-mail message.
SendEmailFromTemplate Action	Sends an e-mail message to a recipient using an e-mail template.
SendFax Action	Sends a fax.
SendTemplate Action	Sends a bulk email message that is created from a template.
SetBusinessEquipment Action	Assigns equipment (facility/equipment) to a specific business unit.
SetBusinessSystemUser Action	Moves a system user (user) to a different business unit.
SetDataEncryptionKey Action	Sets or restore the data encryption key.
SetLocLabels Action	Sets localized labels for a limited set of entity attributes.
SetParentSystemUser Action	Sets a new parent system user (user) for the specified user.
SetProcess Action	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 Action	Links an instance of a report entity to related entities.
TransformImport Action	Submits an asynchronous job that transforms the parsed data.
TriggerServiceEndpointCheck Action	Validates the configuration of a Microsoft Azure Service Bus solution’s service endpoint.
UninstallSampleData Action	Uninstalls the sample data.
UnlockInvoicePricing Action	Unlocks pricing for an invoice.
UnlockSalesOrderPricing Action	Unlocks pricing for a sales order (order).
UnpublishDuplicateRule Action	Submits an asynchronous job to unpublish a duplicate rule.
UpdateOptionValue Action	Updates an option value in a global or local option set.
UpdateProductProperties Action	Updates values of the property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice.
UpdateSolutionComponent Action	Updates a component in an unmanaged solution.
UpdateStateValue Action	Updates an option set value in for a StateAttributeMetadata attribute.
Validate Action	Verifies that an appointment or service appointment (service activity) has valid available resources for the activity, duration, and site, as appropriate.
ValidateSavedQuery Action	Validates a saved query.
WinOpportunity Action	Sets the state of an opportunity to Won.
WinQuote Action	Sets the state of a quote to Won.

Query

Name	Description
Above Function	Query function that evaluates whether the entity is above the referenced entity in the hierarchy.
AboveOrEqual Function	Query function that evaluates whether the entity is above or equal to the referenced entity in the hierarchy.
Between Function	Query function that evaluates whether the entity is between the referenced entities in the hierarchy.
Contains Function	Query function that evaluates whether the string contains the specified string.
EqualBusinessId Function	Query function that evaluates whether the value is equal to the specified business ID.
EqualUserId Function	Query function that evaluates whether the value is equal to the ID of the user.
EqualUserLanguage Function	Query function that evaluates whether the value is equal to the language for the user.
EqualUserOrUserHierarchy Function	Query function that evaluates whether the entity equals current user or their reporting hierarchy.
EqualUserOrUserHierarchyAndTeams Function	Query function that evaluates whether the entity equals current user or their reporting hierarchy and teams.
EqualUserOrUserTeams Function	Query function that evaluates whether the entity equals current user or user teams.
EqualUserTeams Function	Query function that evaluates whether the entity equals current user teams.
In Function	Query function that evaluates whether the value exists in a list of values.
InFiscalPeriod Function	Query function that evaluates whether the value is within the specified fiscal period.
InFiscalPeriodAndYear Function	Query function that evaluates whether the value is within the specified fiscal period and year.
InFiscalYear Function	Query function that evaluates whether the value is within the specified fiscal year.
InOrAfterFiscalPeriodAndYear Function	Query function that evaluates whether the value is within or after the specified fiscal period and year.
InOrBeforeFiscalPeriodAndYear Function	Query function that evaluates whether the value is within or before the specified fiscal period and year.
Last7Days Function	Query function to evaluate whether the value is within the last seven days including today.
LastFiscalPeriod Function	Query function to evaluate whether the value is within the last fiscal period.
LastFiscalYear Function	Query function to evaluate whether the value is within the last fiscal year.
LastMonth Function	Query function to evaluate whether the value is within the last fiscal year.
LastWeek Function	Query function to evaluate whether the value is within the last week.
LastXDays Function	Query function to evaluate whether the value is within the last X days.
LastXFiscalPeriods Function	Query function to evaluate whether the value is within the last X fiscal periods.
LastXFiscalYears Function	Query function to evaluate whether the value is within the last X fiscal years.
LastXHours Function	Query function to evaluate whether the value is within the last X hours
LastXMonths Function	Query function to evaluate whether the value is within the last X months.
LastXWeeks Function	Query function to evaluate whether the value is within the last X weeks.
LastXYears Function	Query function to evaluate whether the value is within the last X years.
LastYear Function	Query function to evaluate whether the value is within the last year.
Next7Days Function	Query function to evaluate whether the value is within the next 7 days.
NextFiscalPeriod Function	Query function to evaluate whether the value is in the next fiscal period.
NextFiscalYear Function	Query function to evaluate whether the value is in the next fiscal year.
NextMonth Function	Query function to evaluate whether the value is in the next month.
NextWeek Function	Query function to evaluate whether the value is in the next week.
NextXDays Function	Query function to evaluate whether the value is in the next X days.
NextXFiscalPeriods Function	Query function to evaluate whether the value is in the next X fiscal periods.
NextXFiscalYears Function	Query function to evaluate whether the value is in the next X fiscal years.
NextXHours Function	Query function to evaluate whether the value is in the next X hours.
NextXMonths Function	Query function to evaluate whether the value is in the next X months.
NextXWeeks Function	Query function to evaluate whether the value is in the next X weeks.
NextXYears Function	Query function to evaluate whether the value is in the next X years.
NextYear Function	Query function to evaluate whether the value is in the next X year.
NotBetween Function	Query function to evaluate whether the value is not between two values.
NotEqualBusinessId Function	Query function that evaluate whether value is not equal to the specified business ID.
NotEqualUserId Function	Query function that evaluate whether value is not equal to the specified user ID.
NotIn Function	Query function to evaluate whether the value is not matched to a value in a subquery or a list.
NotUnder Function	Query function that evaluates whether the specified is not below the referenced record in the hierarchy.
OlderThanXDays Function	Query function to evaluate whether the value is older than the specified amount of days.
OlderThanXHours Function	Query function to evaluate whether the value is older than the specified amount of hours.
OlderThanXMinutes Function	Query function to evaluate whether the value is older than the specified amount of minutes.
OlderThanXMonths Function	Query function to evaluate whether the value is older than the specified amount of months.
OlderThanXWeeks Function	Query function to evaluate whether the value is older than the specified amount of weeks.
OlderThanXYears Function	Query function to evaluate whether the value is older than the specified amount of years.
On Function	Query function to evaluate whether the value is on the specified date.
OnOrAfter Function	Query function to evaluate whether the value is on or after the specified date.
OnOrBefore Function	Query function to evaluate whether the value is on or before the specified date.
ThisFiscalPeriod Function	Query function that evaluates whether the value is within the current fiscal period.
ThisFiscalYear Function	Query function that evaluates whether the value is within the current fiscal year.
ThisMonth Function	Query function that evaluates whether the value is within the current month.
ThisWeek Function	Query function that evaluates whether the value is within the current week.
ThisYear Function	Query function that evaluates whether the value is within the current year.
Today Function	Query function that evaluates whether the value equals today’s date.
Tomorrow Function	Query function that evaluates whether the value equals tomorrow’s date.
Under Function	Query function that evaluates whether the entity is below the referenced record in the hierarchy.
UnderOrEqual Function	Query function that evaluates whether the entity is under or equal to the referenced entity in the hierarchy.
Yesterday Function	Query function that evaluates whether the entity is under or equal to the referenced entity in the hierarchy.