Web API Function Reference

Dynamics CRM 2016
 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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.

In This Section

Name

Description

CalculateRollupField Function

Calculates the value of a rollup attribute.

CalculateTotalTimeIncident Function

Calculates the total time, in minutes, that you used while you worked on an incident (case).

CheckIncomingEmail Function

Check whether the incoming email message is relevant to the Microsoft Dynamics 365 system.

CheckPromoteEmail Function

Contains the data that is needed to check whether the incoming email message should be promoted to the Microsoft Dynamics 365 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.

FetchXmlToQueryExpression Function

Converts a query in FetchXML to a QueryExpression.

FindParentResourceGroup Function

Finds a parent resource group (scheduling group) for the specified resource groups (scheduling groups).

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.

GetQuantityDecimal Function

Gets the quantity decimal value of a product for the specified entity in the target.

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.

IncrementKnowledgeArticleViewCount Function

Increments the per day view count of a knowledge article record.

InitializeFrom Function

Initializes a new record from an existing record.

IsComponentCustomizable Function

Determines whether a solution component is customizable.

IsDataEncryptionActive Function

Determines whether data encryption is currently running (active or inactive).

IsValidStateTransition Function

Validates the state transition.

QueryMultipleSchedules Function

Searches multiple resources for available time block that matches the specified parameters.

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 365.

RetrieveActivePath Function

TODO: RetrieveActivePath Function Description

RetrieveAllChildUsersSystemUser Function

Retrieves the collection of users that report to the specified system user (user).

RetrieveAllEntities Function

Retrieves metadata information about all the entities.

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.

RetrieveByResourcesService Function

Retrieve the collection of services that are related to the specified set of resources.

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 365.

RetrieveDeprovisionedLanguages Function

Retrieves a list of language packs that are installed on the server that have been disabled.

RetrieveDuplicates Function

Detects and retrieves duplicates for a specified record.

RetrieveEntityChanges Function

Retrieve the changes for an entity.

RetrieveEntityRibbon Function

Retrieves ribbon definitions for an entity.

RetrieveExchangeAppointments Function

Retrieves the appointments for the current user for a specific date range from the exchange web service.

RetrieveExchangeRate Function

Retrieves the exchange rate.

RetrieveFilteredForms Function

Retrieves the entity forms that are available for a specified user.

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 365.

RetrieveLocLabels Function

Retrieves localized labels for a limited set of entity attributes.

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.

RetrievePrincipalAccess Function

Retrieves the access rights of the specified security principal (team or user) to the specified record.

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.

RetrieveProcessInstances Function

TODO: RetrieveProcessInstances Function Description

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.

RetrieveRecordWall Function

Retrieves pages of posts, including comments for each post, for a specified record.

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.

RetrieveUnpublishedMultiple Function

Retrieves a collection of unpublished organization-owned records that satisfy the specified query criteria.

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 365 Server.

Rollup Function

Retrieves all the entity records that are related to the specified record.

Search Function

Searches for available time slots that fulfill the specified appointment request.

SearchByBodyKbArticle Function

Searches for knowledge base articles that contain the specified body text.

SearchByKeywordsKbArticle Function

Searches for knowledge base articles that contain the specified keywords.

SearchByTitleKbArticle Function

Searches for knowledge base articles that contain the specified title.

ValidateRecurrenceRule Function

Validates a rule for a recurring appointment.

WhoAmI Function

Retrieves the system user ID for the currently logged on user or the user under whose context the code is running.

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Show: