Web API Function Reference

A function is an operation which does not have observable side effects. They typically retrieve data. They may have parameters and they may return values. Functions may be bound to entity types.

이 섹션의 내용

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.

관련 섹션

Web API Query Function Reference

Web API EntityType Reference

Web API Metadata EntityType Reference

Web API Action Reference

Web API EnumType Reference

Web API ComplexType Reference

Microsoft Dynamics CRM 2016 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.