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.

In This Section

Name Description
CalculateRollupField Calculates the value of a rollup attribute.
CheckIncomingEmail Check whether the incoming email message is relevant to the Microsoft Dynamics 365 system.
CheckPromoteEmail Contains the data that is needed to check whether the incoming email message should be promoted to the Microsoft Dynamics 365 system.
DownloadReportDefinition Downloads a report definition.
ExpandCalendar Converts the calendar rules to an array of available time blocks for the specified period.
ExportFieldTranslation Exports localizable fields values to a compressed file.
FetchXmlToQueryExpression Converts a query in FetchXML to a QueryExpression.
FormatAddress Builds the full address according to country/regional format specific requirements.
GetAllTimeZonesWithDisplayName Retrieves all the time zone definitions for the specified locale and to return only the display name attribute.
GetDistinctValuesImportFile Retrieves distinct values from the parse table for a column in the source file that contains list values.
GetHeaderColumnsImportFile Retrieves the source-file column headings; or retrieve the system-generated column headings if the source file does not contain column headings.
GetReportHistoryLimit Retrieves the history limit for a report.
GetTimeZoneCodeByLocalizedName Retrieves the time zone code for the specified localized time zone name.
GetValidManyToMany Retrieves a list of all the entities that can participate in a Many-to-Many entity relationship.
GetValidReferencedEntities 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 Retrieves the set of entities that are valid as the related entity (many) to the specified entity in a one-to-many relationship.
IncrementKnowledgeArticleViewCount Increments the per day view count of a knowledge article record.
InitializeFrom Initializes a new record from an existing record.
IsComponentCustomizable Determines whether a solution component is customizable.
IsDataEncryptionActive Determines whether data encryption is currently running (active or inactive).
IsValidStateTransition Validates the state transition.
QuerySchedule Searches the specified resource for an available time block that matches the specified parameters.
RetrieveAbsoluteAndSiteCollectionUrl Retrieves the absolute URL and the site collection URL for a SharePoint location record in Microsoft Dynamics 365.
RetrieveActivePath Retrieves a collection of stages currently in the active path for a business process flow instance.
RetrieveAllChildUsersSystemUser Retrieves the collection of users that report to the specified system user (user).
RetrieveAllCompositeDataSources API responsible for retrieving all composite environment variables starting from a root variable.
RetrieveAllEntities Retrieves metadata information about all the entities.
RetrieveApplicationRibbon Retrieve the data that defines the content and behavior of the application ribbon.
RetrieveAttributeChangeHistory retrieve all metadata changes to a specific attribute.
RetrieveAuditDetails Retrieve the full audit details from an Audit record.
RetrieveAuditPartitionList Retrieves the list of database partitions that are used to store audited history data.
RetrieveAvailableLanguages Retrieves the list of language packs that are installed and enabled on the server.
RetrieveBusinessHierarchyBusinessUnit Retrieves all business units from the business unit hierarchy.
RetrieveByTopIncidentSubjectKbArticle Retrieves the top-ten articles about a specified subject from the knowledge base of articles for your organization.
RetrieveCompositeDataSource API responsible for retrieving a composite environment variable.
RetrieveCurrentOrganization Retrieve information about the current organization.
RetrieveDataEncryptionKey Retrieves the data encryption key value.
RetrieveDependenciesForDelete Retrieves a collection of dependency records that describe any solution components that would prevent a solution component from being deleted.
RetrieveDependenciesForUninstall Retrieves a list of the solution component dependencies that can prevent you from uninstalling a managed solution.
RetrieveDependentComponents Retrieves a list dependencies for solution components that directly depend on a solution component.
RetrieveDeploymentLicenseType Retrieves the type of license for a deployment of Microsoft Dynamics 365.
RetrieveDeprovisionedLanguages Retrieves a list of language packs that are installed on the server that have been disabled.
RetrieveDuplicates Detects and retrieves duplicates for a specified record.
RetrieveEntity Retrieves entity metadata.
RetrieveEntityRibbon Retrieves ribbon definitions for an entity.
RetrieveEnvironmentVariables API responsible for retrieving all environment variables based on a given criteria.
RetrieveEnvironmentVariableValue API responsible for retrieving the corresponding value of an environment variable.
RetrieveExchangeAppointments Retrieves the appointments for the current user for a specific date range from the exchange web service.
RetrieveExchangeRate Retrieves the exchange rate.
RetrieveFilteredForms Retrieves the entity forms that are available for a specified user.
RetrieveFormattedImportJobResults Retrieves the formatted results from an import job.
RetrieveInstalledLanguagePacks Retrieves the list of language packs that are installed on the server.
RetrieveInstalledLanguagePackVersion Retrieves the version of an installed language pack.
RetrieveLicenseInfo Retrieves the number of used and available licenses for a deployment of Microsoft Dynamics 365.
RetrieveLocLabels Retrieves localized labels for a limited set of entity attributes.
RetrieveMailboxTrackingFolders Retrieves folder-level tracking rules for a mailbox.
RetrieveMetadataChanges Retrieves a collection of metadata records that satisfy the specified criteria.
RetrieveMissingComponents Retrieves a list of missing components in the target organization.
RetrieveMissingDependencies Retrieves any required solution components that are not included in the solution.
RetrieveOrganizationInfo Retrieves information about an organization such as the instance type and solutions available in the organization.
RetrieveOrganizationResources Retrieves the resources that are used by an organization.
RetrieveParsedDataImportFile Retrieves the data from the parse table.
RetrievePersonalWall Retrieves pages of posts, including comments for each post, for all records that the calling user is following.
RetrievePrincipalAccess Retrieves the access rights of the specified security principal (team or user) to the specified record.
RetrievePrincipalAttributePrivileges Retrieves all the secured attribute privileges a user or team has through direct or indirect (through team membership) associations with the FieldSecurityProfile entity.
RetrievePrincipalSyncAttributeMappings For internal use only.
RetrievePrivilegeSet Retrieves the set of privileges defined in the system.
RetrieveProcessInstances Retrieves all the business process flow instances for an entity record across all business process flow definitions.
RetrieveProvisionedLanguagePackVersion Retrieves the version of a provisioned language pack.
RetrieveProvisionedLanguages Retrieves the list of provisioned languages.
RetrieveRecordChangeHistory Retrieve all attribute data changes for a specific entity.
RetrieveRecordWall Retrieves pages of posts, including comments for each post, for a specified record.
RetrieveRequiredComponents Retrieves a collection of solution components that are required for a solution component.
RetrieveRolePrivilegesRole Retrieves the privileges that are assigned to the specified role.
RetrieveSetting This API can be used to retrieve a particular setting along with its final computed value.
RetrieveSharedPrincipalsAndAccess Retrieves all security principals (users or teams) that have access to, and access rights for, the specified record.
RetrieveTeamPrivileges Retrieves the privileges for a team.
RetrieveTimestamp Retrieves a time stamp for the metadata.
RetrieveTotalRecordCount Returns data on the total number of records for specific entities. The data retrieved will be from a snapshot within last 24 hours.
RetrieveUnpublishedMultiple Retrieves a collection of unpublished organization-owned records that satisfy the specified query criteria.
RetrieveUserLicenseInfo Retrieves the license information for the specified system user (user).
RetrieveUserPrivileges Retrieves the privileges a system user (user) has through his or her roles in the specified business unit.
RetrieveUserQueues Retrieves all private queues of a specified user and optionally all public queues.
RetrieveVersion Retrieves the version number of the Microsoft Dynamics 365 Server.
Rollup Retrieves all the entity records that are related to the specified record.
Search Searches for available time slots that fulfill the specified appointment request.
SearchByBodyKbArticle Searches for knowledge base articles that contain the specified body text.
SearchByKeywordsKbArticle Searches for knowledge base articles that contain the specified keywords.
SearchByTitleKbArticle Searches for knowledge base articles that contain the specified title.
ValidateRecurrenceRule Validates a rule for a recurring appointment.
WhoAmI Retrieves the system user ID for the currently logged on user or the user under whose context the code is running.

See also