Web API Function Reference
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 |
|---|---|
Calculates the value of a rollup attribute. |
|
Calculates the total time, in minutes, that you used while you worked on an incident (case). |
|
Check whether the incoming email message is relevant to the Microsoft Dynamics 365 system. |
|
Contains the data that is needed to check whether the incoming email message should be promoted to the Microsoft Dynamics 365 system. |
|
Downloads a report definition. |
|
Converts the calendar rules to an array of available time blocks for the specified period. |
|
Exports localizable fields values to a compressed file. |
|
Converts a query in FetchXML to a QueryExpression. |
|
Finds a parent resource group (scheduling group) for the specified resource groups (scheduling groups). |
|
Retrieves all the time zone definitions for the specified locale and to return only the display name attribute. |
|
Retrieves the default price level (price list) for the current user based on the user’s territory relationship with the price level. |
|
Retrieves distinct values from the parse table for a column in the source file that contains list values. |
|
Retrieves the source-file column headings; or retrieve the system-generated column headings if the source file does not contain column headings. |
|
Gets the quantity decimal value of a product for the specified entity in the target. |
|
Retrieves the history limit for a report. |
|
Retrieves the time zone code for the specified localized time zone name. |
|
Retrieves a list of all the entities that can participate in a Many-to-Many entity relationship. |
|
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. |
|
Retrieves the set of entities that are valid as the related entity (many) to the specified entity in a one-to-many relationship. |
|
Increments the per day view count of a knowledge article record. |
|
Initializes a new record from an existing record. |
|
Determines whether a solution component is customizable. |
|
Determines whether data encryption is currently running (active or inactive). |
|
Validates the state transition. |
|
Searches multiple resources for available time block that matches the specified parameters. |
|
Searches the specified resource for an available time block that matches the specified parameters. |
|
Retrieves the absolute URL and the site collection URL for a SharePoint location record in Microsoft Dynamics 365. |
|
TODO: RetrieveActivePath Function Description |
|
Retrieves the collection of users that report to the specified system user (user). |
|
Retrieves metadata information about all the entities. |
|
Retrieve the data that defines the content and behavior of the application ribbon. |
|
Retrieves the list of database partitions that are used to store audited history data. |
|
Retrieves the list of language packs that are installed and enabled on the server. |
|
Retrieves all business units from the business unit hierarchy. |
|
Retrieves all resources that are related to the specified resource group |
|
Retrieves the resource groups (scheduling groups) that contain the specified resource. |
|
Retrieve the collection of services that are related to the specified set of resources. |
|
Retrieves the top-ten articles about a specified product from the knowledge base of articles for the organization |
|
Retrieves the top-ten articles about a specified subject from the knowledge base of articles for your organization. |
|
Retrieve information about the current organization. |
|
Retrieves the data encryption key value. |
|
Retrieves a collection of dependency records that describe any solution components that would prevent a solution component from being deleted. |
|
Retrieves a list of the solution component dependencies that can prevent you from uninstalling a managed solution. |
|
Retrieves a list dependencies for solution components that directly depend on a solution component. |
|
Retrieves the type of license for a deployment of Microsoft Dynamics 365. |
|
Retrieves a list of language packs that are installed on the server that have been disabled. |
|
Detects and retrieves duplicates for a specified record. |
|
Retrieve the changes for an entity. |
|
Retrieves ribbon definitions for an entity. |
|
Retrieves the appointments for the current user for a specific date range from the exchange web service. |
|
Retrieves the exchange rate. |
|
Retrieves the entity forms that are available for a specified user. |
|
Retrieves the formatted results from an import job. |
|
Retrieves the list of language packs that are installed on the server. |
|
Retrieves the version of an installed language pack. |
|
Retrieves the number of used and available licenses for a deployment of Microsoft Dynamics 365. |
|
Retrieves localized labels for a limited set of entity attributes. |
|
Retrieves folder-level tracking rules for a mailbox. |
|
Retrieves the members of a bulk operation. |
|
Retrieves a list of missing components in the target organization. |
|
Retrieves any required solution components that are not included in the solution. |
|
Retrieves the resources that are used by an organization. |
|
Retrieves the collection of the parent resource groups of the specified resource group (scheduling group). |
|
Retrieves the data from the parse table. |
|
Retrieves pages of posts, including comments for each post, for all records that the calling user is following. |
|
Retrieves the access rights of the specified security principal (team or user) to the specified record. |
|
Retrieves all the secured attribute privileges a user or team has through direct or indirect (through team membership) associations with the FieldSecurityProfile entity. |
|
For internal use only. |
|
Retrieves the set of privileges defined in the system. |
|
TODO: RetrieveProcessInstances Function Description |
|
Retrieve all the property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice. |
|
Retrieves the version of a provisioned language pack. |
|
Retrieves the list of provisioned languages. |
|
Retrieves pages of posts, including comments for each post, for a specified record. |
|
Retrieves a collection of solution components that are required for a solution component. |
|
Retrieves the privileges that are assigned to the specified role. |
|
Retrieves the collection of child resource groups from the specified resource group. |
|
Retrieves the privileges for a team. |
|
Retrieves a time stamp for the metadata. |
|
Retrieves a collection of unpublished organization-owned records that satisfy the specified query criteria. |
|
Retrieves the privileges a system user (user) has through his or her roles in the specified business unit. |
|
Retrieves all private queues of a specified user and optionally all public queues. |
|
Retrieves the version number of the Microsoft Dynamics 365 Server. |
|
Retrieves all the entity records that are related to the specified record. |
|
Searches for available time slots that fulfill the specified appointment request. |
|
Searches for knowledge base articles that contain the specified body text. |
|
Searches for knowledge base articles that contain the specified keywords. |
|
Searches for knowledge base articles that contain the specified title. |
|
Validates a rule for a recurring appointment. |
|
Retrieves the system user ID for the currently logged on user or the user under whose context the code is running. |
Related Sections
Web API Query Function Reference
Web API Metadata EntityType Reference
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright