Microsoft.Crm.Sdk.Proxy The business inherits all inheritance values. Value = 0x3ff. The business inherits competitors from its parent business. Value = 8. The business inherits email templates from its parent business. Value = 2. The business does not inherit from its parent business. Value = 0. All child business units inherit process templates from this business. Value = 1. All child business units inherit referral sources from this business. Value = 4. The business inherits sale processes from its parent business. Value = 0x10. The business inherits competitors from its parent business. Value = 0x100. All child business units inherit email templates from this business. Value = 0x40. The business inherits process templates from its parent business. Value = 0x20. All child business units inherit referral sources from this business. Value = 0x80. The business inherits sale processes from its parent business. Value = 0x200. The recurrence duration determines the shadowing of that rule. Use this value to indicate working hours and a full day 24-hour shadow. Value = 1. Only the rule duration is shadowed. Use this value to indicate time off. For example, 4 hours of time off allow working hours to appear before and after. Value = 2. No shadowing of calendar rules. All rules are displayed even if they are shadowed or preceded by other rules. Value = 0. A list of accounts. Value = 1. A list of contacts. Value = 2. A list of leads. Value = 4. Displays the fiscal year based on the end date of the fiscal year. Value = 2. Displays the fiscal year based on the start date of the fiscal year. Value = 1. An address book filter. Value = 512. An advanced search. Value = 1. A custom view. Value = 16384. Specifies a view on the , , and entities that can be used to filter out the entities for which labels will be exported using the message. Value = 65536. A view for a dialog (workflow process). Value = 4096. A lookup view. Value = 64. Specifies the main application view. Value = 0. Specifies the main application view without a subject. Value = 1024. An offline filter for Dynamics 365 for Outlook. Value = 16. An offline template for Dynamics 365 for Outlook. Value = 8192. A filter for Dynamics 365 for Outlook. Value = 256. A template for Dynamics 365 for Outlook. Value = 131072. A quick find query, which defines the columns searched using the Search field in a list view. Value = 4. A reporting query. Value = 8. A saved query used for workflow templates and email templates. Value = 2048. Specifies the service management appointment book view. Value = 128. A subgrid query. Value = 2. The message is available on both connected and disconnected from the server. Value = 2. The message is available only on the client. Value = 1. The message is available only on the server. Value = 0. The message is available on both connected and disconnected from the server. Value = 2. The message is available only on the client. Value = 1. The message is available only on the server. Value = 0. For internal use only. For internal use only. For internal use only. Bulk delete has completed. Value = 2. Bulk delete has completed, but failures occurred. Value = 3. Bulk delete failed. Value = 4. Bulk duplicate detection has completed. Value = 1. Import has completed. Value = 5. Import has failed. Value = 6. An address book filter. Value = 512. An advanced search. Value = 1. A custom view. Value = 16384. A view for a dialog (workflow process). Value = 4096. A lookup view. Value = 64. The main application view. Value = 0. The main application view without a subject. Value = 1024. An offline filter for Dynamics 365 for Outlook. Value = 16. A filter for Dynamics 365 for Outlook. Value = 256. A quick find query, which defines the columns searched using the Search field in a list view. Value = 4. A reporting query. Value = 8. A saved query used for workflow templates and e-mail templates. Value = 2048. The service management appointment book view. Value = 128. A sub-grid query. Value = 2. Show the detailed version of advanced find at startup. Value = 2. Show the simple version of advanced find at startup. Value = 1. Show the day by default. Value = 0. Show the month by default. Value = 2. Show the week by default. Value = 1. Show the first and last name. Value = 1. Show the first name, middle initial and last name. Value = 3. Show the first, middle and last names. Value = 5. Show the last name and then the first name. Value = 0. Show the last name first, then the first name and the middle name. Value = 4. Show the last name first, then the first name and the middle initial. Value = 2. Show the last name and then the first name, with no space separating the names. Value = 7. Show the last name and then the first name, with a space separating the names. Value = 6. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Deprecated. Use the class and its members. Deprecated. Use the class and its associated response class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class setting the start, end, site ID, site name, and proposal parties. Type: Nullable<DateTime>. The proposed appointment start date and time. Type: Nullable<DateTime>. The proposed appointment end date and time. Type: Guid. The ID of the site for the proposed appointment. Type: String. The name of the site for the proposed appointment. Type: []. An array of parties needed for the proposed appointment. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class setting the appointments and resource ID. Type: Guid[]. The array of IDs of appointments to ignore. Type: Guid. The resource for which appointments are to be ignored. Initializes a new instance of the class. Initializes a new instance of the class. Deprecated. Use the class and its members. Deprecated. Use the class and its associated response class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Adds an object to the collection. An object that contains change details. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the Class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the . The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Type: Int32 Type: Guid. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the CloneAsPatchRequest class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Deprecated. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class that sets the object ID, constraint type, and constraints. Type: Guid. The ID of the calendar rule. Type: String. The constraint type. Must be "Resource Selection". Type: String. The set of constraints. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class Initializes a new instance of the class Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class Deprecated.Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class setting the error code and resource list. Type: String. The reason for a scheduling failure. Type: []. The array of information about a resource that has a scheduling problem for an appointment. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Deprecated. Deprecated. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Localize product property values Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. For internal use only. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the T:Microsoft.Crm.Sdk.Messages.ImportTranslationResponse class Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Adds an input argument object to the collection. Type: String. A key that uniquely identifies the input argument in the collection. Type: Object. The input argument. Checks if a key exists in the collection. Type: String. The key to check for. Type: BooleanReturns if the key exists; otherwise, . Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Deprecated. Deprecated. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Deprecated. Deprecated. Deprecated. Deprecated. Deprecated. Deprecated. Deprecated. Deprecated. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Type: Guid. The ID of the resource specification. Type: String. The search strategy to use in the appointment request. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class that sets the resource and resource specification IDs, the display and entity names, and the required effort, as measured by percentage of time. Type: Guid. The ID of the resource that is represented by this party. Type: Guid. The ID of the resource specification that is represented by this party. Type: String. The display name for the party. Type: String. The logical name of the type of entity that is represented by this party. Type: Double. The percentage of time that is required to perform the service. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Deprecated. Use the entity. Deprecated. Use the entity. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class setting the resource and resource specification IDs. Type: Guid. The ID of the required resource. Type: Guid. The ID of the required resource specification. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class that sets the ID, entity name, and display name. Type: Guid. The ID of the record that has a scheduling problem. Type: String. The logical name of the entity. Type: String. The display name for the resource. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Deprecated. Deprecated. Use the class and its associated response class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Deprecated. Use the class and its members. Deprecated. Use the class and its associated response class. Deprecated. Use the class and its members. Deprecated. Use the class and its associated response class. Initializes a new instance of the class. Initializes a new instance of the class. Deprecated. Use the class and its members. Deprecated. Use the class and its associated response class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Deprecated. Use the class and its members. Deprecated. Use the class and its associated response class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class by setting the depth, privilege ID, and business unit ID. Type: . The depth of the privilege. Type: Guid. The ID of the privilege. Type: Guid. The ID of the business unit. Initializes a new instance of the class by setting the depth and the privilege ID. Type: Int32. The depth of the privilege. Type: Guid. The ID of the privilege. Initializes a new instance of the class by setting the depth (as an integer), the privilege ID, and the business unit ID. Type: Int32. The depth of the privilege. Type: Guid. The ID of the privilege. Type: Guid. The ID of the business unit. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class setting the proposals and trace info properties. The set of proposed appointments that meet the appointment request criteria. The results of the search. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Type: []. The list of error information for the scheduling operation. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Deprecated. Use the class and its members. Deprecated. Use the class and its associated response class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class, setting the , and properties. Type: Boolean. The value that indicates whether the appointment or service appointment was validated successfully. Type: . The reasons for any scheduling failures. Type: Guid. The ID of the validated activity. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Initializes a new instance of the class. The default constructor initializes any fields to their default values. Type: Guid Type: Gets or sets the ID of the campaign activity. Required. Type: GuidThe ID of the campaign activity. The property corresponds to the attribute, which is the primary key for the entity. Gets or sets the name of the entity type that is used in the operation. Required. Type: StringThe name of the entity type that is used in the operation. This property must be assigned the entity logical name that corresponds to the specified record type in the property. The valid entity names for this property are and . CampaignActivityItem intersect entity metadata Gets or sets the ID of the item to be added to the campaign activity. Required. Type: GuidThe ID of the item to be added to the campaign activity. The valid values for this property are , which is the primary key for the entity, or , which is the primary key for the entity. CampaignActivityItem intersect entity metadata Gets the ID of the resulting campaign activity item. Type: GuidThe ID of the resulting campaign activity item. The property corresponds to the property, which is the primary key for the intersect entity. CampaignActivityItem intersect entity metadata Gets or sets the ID of the campaign. Required. Type: GuidThe ID of the campaign. The property corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the record to be added to the campaign. Required. Type: GuidThe ID of the record to be added to the campaign. The property must be assigned a record ID of one of the following entity types: , , , or . The property must contain the corresponding logical name of the entity. CampaignItem intersect entity metadata Gets or sets the name of the type of entity that is used in the operation. Required. Type: String The name of the type of entity that is used in the operation. This property must be assigned the logical name of the entity that corresponds to the record type that is specified in the property. The valid entity names for this property are , , , and . CampaignItem intersect entity metadata Gets the ID of the resulting campaign item. Type: GuidThe ID of the resulting campaign item. The property corresponds to the property, which is the primary key for the intersect entity. CampaignItem intersect entity metadata Gets or sets the ID of the list. Required. Type: Guid The ID of the list. This corresponds to the attribute, which is the primary key for the entity. Gets or sets an array of IDs of the members that you want to add to the list. Required. Type: Guid[] The array of IDs of the members that you want to add to the list. Each element of the array corresponds to the attribute, attribute, or attribute. These record IDs are the primary keys for the corresponding entities: , , and . ListMember intersect entity metadata Gets or sets the ID of the member you want to add to the list. Required. Type: Guid The ID of the member you want to add to the list. The property must contain the record ID of one of the following types: , , or . ListMember intersect entity metadata Gets or sets the ID of the list. Required. Type: Guid The ID of the list that corresponds to the attribute, which is the primary key for the entity. Gets the ID of the resulting list member. Type: GuidThe ID of the resulting list member that corresponds to the property, which is the primary key for the intersect entity.. ListMember intersect entity metadata Gets or sets an array of IDs for the users you want to add to the team. Required. Type: Guid[] The array of user IDs to add to the team. Each element of the array corresponds to the property, which is the primary key for the entity. Gets or sets the ID of the team. Required. Type: Guid The ID of the team, that corresponds to the attribute, which is the primary key for the entity. Gets or sets the principal to add to the queue. Required. Type: The principal to add to the queue. Gets or sets the ID of the queue. Required Type: GuidThe ID of the queue. Gets or sets the IDs and depths of the privileges you want to add. Required. Type: The IDs and depths of the privileges you want to add. Gets or sets the ID of the role for which you want to add the privileges. Required. Type: GuidThe ID of the role for which you want to add the privileges. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the kit. Required. Type: Guid The ID of the kit that corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the product. Required. Type: Guid The ID of the product that corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the appointment that needs to be converted into a recurring appointment. Required. Type: GuidThe ID of the appointment that needs to be converted into a recurring appointment. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the target, which is a recurring appointment master record to which the appointment is converted. Required. Type: The target, which must be an entity reference for a entity. Gets the ID of the newly created recurring appointment. Type: GuidThe ID of the newly created recurring appointment. This corresponds to the attribute, which is the primary key for the entity. Gets or sets a value that indicates whether other solution components that are required by the solution component that you are adding should also be added to the unmanaged solution. Required. Type: Booleantrue if the components that are required by the solution component you are adding should also be added to the unmanaged solution; otherwise, false. Gets or sets the ID of the solution component. Required. Type: Guid The ID of the solution component. For solution components that derive from , this value is the property. For other solution components, use the property that is the unique identifier for the entity. Gets or sets the value that represents the solution component that you are adding. Required. Type: Int32 The integer value of the enumeration. An enumeration named that defines the supported range of values for this property is available by including the file or in your project. These values are defined by the global option set Component Type (componenttype). Indicates whether the subcomponents should be included. Type: Booleantrue if you want subcomponents to be included; otherwise, false. Gets or sets a value that specifies if the component is added to the solution with its metadata. Type: String[]When set to , the component is added to the solution with metadata; otherwise passing an empty array results in no metadata settings included with the component. A future SDK release will allow you to specify a string [] of metadata settings to include with the component. Gets or sets the unique name of the solution you are adding the solution component to. Required. Type: String The unique name of the solution you are adding the solution component to. This value can be found in the attribute. Returns the ID of the new solution component record. Type: Guid The ID of the new solution component record. This corresponds to the attribute, which is the primary key for the entity. Deprecated. Use the class and its members. Type: Guid. Deprecated. Use the class and its members. Type: Guid. Gets or sets the ID of the destination queue. Required. Type: Guid The ID of the destination queue that corresponds to the attribute, which is the primary key for the entity. Gets or sets the properties that are needed to create a queue item in the destination queue. Optional. Type: The properties that are needed to create a queue item in the destination queue. The destination queue must be an instance of the class, which is a subclass of the class. The and attribute values that are provided in this property are ignored by the operation. These values are obtained from the property and the property. Gets or sets the ID of the source queue. Optional. Type: Guid The ID of the source queue that corresponds to the attribute, which is the primary key for the entity. Gets or sets the target record to add to the destination queue. Required. Type: The target record to add to the destination queue, which must be an entity reference for an entity that is enabled for queues. For more information, see Enable entities for queues. Gets the ID of the queue item that is created in the destination queue. Type: Guid The ID of the queue item that is created in the destination queue, which corresponds to the attribute, which is the primary key for the entity Gets or sets the record for which the access team is auto created. Required. Type: The record for which the access team is auto created, which must be an entity reference for an entity that is enabled for access teams. To enable an entity for the auto created access teams, set the attribute to . Gets or sets the ID of system user (user) to add to the auto created access team. Required. Type: GuidThe ID of the system user (user) that corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of team template which is used to create the access team. Required. Type: GuidThe ID of the team template that corresponds to the attribute, which is the primary key for the entity. Gets the ID of the auto created access team. Type: GuidThe ID of the auto created access team, which corresponds to the attribute, which is the primary key for the entity. Gets or sets the target for applying the rule. Returns The target for applying the rule. A target for this operation can be an activity or a queue item record. When you pass an activity record that is associated with a queue, the rule created for the queue is applied. Otherwise, the rule created for the specified activity record is applied. When incoming activities, such as emails, custom activities, and posts, from external integrated applications are added to a queue in CRM, a queue item record is created. If you specify a queue item record instead of an activity record as the target, the rule created for the specified queue and activity (determined by the queue item) will be applied. Gets or sets the target incident to apply the routing rule to. Required. Type: The target incident to apply the routing rule to. Gets or sets the proposed appointment end date and time. Type: Nullable<DateTime>The proposed appointment end date and time. Gets or sets the structure that contains extra data. Type: ExtensionDataObject Gets or sets an array of parties needed for the proposed appointment. Type: []The array of parties needed for the proposed appointment. Gets or sets the ID of the site for the proposed appointment. Type: Guid The ID of the site for the proposed appointment. Gets or sets the name of the site for the proposed appointment. Type: String The name of the site for the proposed appointment. Gets or sets the proposed appointment start date and time. Type: Nullable<DateTime>The proposed appointment start date and time. Gets or sets the time offset in minutes, from midnight, when the first occurrence of the appointment can take place. Type: Int32The time offset in minutes. Gets or sets the appointments to ignore in the search for possible appointments. Type: The appointments to ignore in the search for possible appointments. Gets or sets any additional constraints. Type: Additional constraints for the appointment. Gets or sets the direction of the search. Type: The search direction. Gets or sets the appointment duration, in minutes. Type: Int32 The appointment duration, in minutes. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the number of results to be returned from the search request. Type: Int32 The number of results to be returned from the search request. Gets or sets the scheduling strategy that overrides the default constraints. Type: The scheduling strategy that overrides the default constraints. Gets or sets the time, in minutes, for which the appointment recurrence is valid. Type: Int32 The time, in minutes, for which the appointment recurrence is valid. Gets or sets a value to override the time zone that is specified by the property. Type: Int32 A value to override the time zone that is specified by the property. Gets or sets the resources that are needed for this appointment. Type: The resources that are needed for this appointment. Gets or sets the recurrence rule for appointment recurrence. Type: String The recurrence rule. Example: "FREQ=WEEKLY;BYDAY=MO;INTERVAL=60"; Where: BYDAY means which day = MO,TU,THINTERVAL is an integer valueFREQ="DAILY","WEEKLY" This is similar to the Recurrence pattern in asynchronous job execution. Gets or sets the date and time for the first possible instance of the appointment. Type: Nullable<DateTime> The date and time for the first possible instance of the appointment. Gets or sets the date and time to end the search. Type: Nullable<DateTime> The date and time to end the search. Gets or sets the date and time to begin the search. Type: Nullable<DateTime> The date and time to begin the search. Gets or sets the ID of the service to search for. Type: Guid The ID of the service, which corresponds to the attribute, which is the primary key for the entity. Gets or sets the sites where the requested appointment can take place. Type: Guid[] The array of site IDs, where the requested appointment can take place. The site ID corresponds to the attribute, which is the primary key for the entity. Gets or sets the time zone code of the user who is requesting the appointment. Type: Int32 The time zone code of the user who is requesting the appointment. Gets or sets an array of IDs of appointments to ignore. Type: Guid[] The array of IDs of appointments to ignore. Gets or sets the structure that contains extra data. Type: ExtensionDataObject. Gets or sets the resource for which appointments are to be ignored. Type: Guid The resource for which appointments are to be ignored. Gets or sets the user or team for which you want to assign a record. Required. Type: The reference to a user or team record. Gets or sets the target record to assign to another user or team. Required. Type: The target record to assign. The value must be an entity reference for an entity that supports this message. For a list of supported entity types, see the class. Deprecated. Use the class and its members. Type: The entity reference for the first record. Deprecated. Use the class and its members. Type: The entity reference for the second record. Deprecated. Use the class and its members. Type: StringThe name of the relationship between the two entities. Gets a list of deleted attributes. Type: DictionaryA dictionary containing the deleted attributes. Gets a collection of attempted attribute changes that are not valid. Type: The data collection of attempted attribute changes. Gets or sets the language code for the label. Type: Int32The language code for the label. Gets or sets a collection of new values for an entity attribute. Type: The collection of new values for an entity attribute. You can access the individual attribute values in the collection. Sample: Audit entity data changes Gets or sets a collection of former values for an entity attribute. Type: The collection of former values for an entity attribute. You can access the individual attribute values in the collection. Sample: Audit entity data changes Gets or sets the related record that contains the change details. Type: The audit record. Cast this property value to an entity type. Gets or sets the structure that contains extra data. Optional. Type: ExtensionDataObject. Gets the collection. Type: <>The collection of instances. Indicates the number of elements in the collection. Type: Int32The number of elements in the collection. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the element at the specified index. Type: Int32. The element index. Type: The element at the specified index. Indicates whether more records exist. Type: Booleantrue if more records exist; otherwise, false. Gets or sets a paging cookie. Type: String The paging cookie value. For more information on using a paging cookie, see Using a paging cookie with QueryExpression. Gets or sets the total record count in the collection. Type: Int32The total record count in the collection. Gets or sets the end date and time for the last audit record in the partition. Type: Nullable<DateTime> The date and time of the last audit record in the partition. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectA structure that contains extra data. Gets or sets the sequence (serial) number of the partition. Type: Int32The sequence (serial) number of the partition. Gets or sets the size, in bytes, of the partition. Type: Int64The size, in bytes, of the partition. Gets or sets the creation date and time of the first audit record in the partition. Type: Nullable<DateTime>The creation date and time of the first audit record in the partition. Gets or sets the structure that contains extra data. String Gets or sets whether the partition change list is a logical collection. Type: Booleantrue if the audit partition list is a logical collection; otherwise, false. The partition list is logical when the SQL Server edition does not support partitions. Currently, the auditing partitioning feature is available only with the Enterprise Edition of Microsoft SQL Server. Gets or sets the ID of the entity map to overwrite when the automated mapping is performed. Required. Type: GuidThe ID of the entity map. Use the names of the related entities to query the entity where the attribute equals the referenced entity and the attribute equals the referencing entity. Use the attribute value for the matching record. Gets or sets the query to find the email activities to send. Type: The query to find the email activities to send. Assign an instance of the , , or class. The query must specify an entity name of “email” and a . If the column set includes attributes that are not valid for retrieve or for which you do not have access, they will be ignored. Email activity entitiesEmail entity messages and methodsBackgroundSendEmail message privileges Gets the resulting emails. Required. Type: The collection of resulting emails. Gets a value that indicates whether the email has attachments. Required. Type: Booleantrue if the email has attachments; otherwise, false. For internal use only. Type: Booleantrue if you want notifications returned; otherwise, false. Gets or sets the record that is the target of the book operation. Required. Type: The target entity instance for the book operation. Set the value of this property to an instance of the entity type that you want to schedule: , , or . For internal use only. Type: ObjectThe notifications. Gets the appointment validation results. Type:The appointment validation results. Gets or sets an array of IDs for the system users (users) who are listed in the Cc box of the email notification. Required. Type: Guid[] The array of IDs for the system users (users) who are listed in the Cc box of the email notification. Each element in the array corresponds to the attribute, which is the primary key for the entity. Each ID in the array must be for a user who has a valid email address. This property is required if the property is set to ; otherwise, it is optional. If you set this property to , an email notification is sent to all users who have the IDs that are specified in this property. Gets or sets the name of an asynchronous bulk delete job. Required. Type: StringThe name of the asynchronous bulk delete job. Gets or sets an array of queries for a bulk delete job. Required. Type: The array of queries for a bulk delete job. The bulk delete job deletes the records that match the conditions that are specified in the queries. The query must specify entity names and a column set. If the column set includes attributes where is false or for which you don’t have access, they are ignored. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics 365. When you use the property, the value in the property is ignored. Instead, the system uses the query expression and creates a new object to retrieve up to 1000 records at a time. The process increments the page by 1 until all records that are included in the query are processed. You should modify the query as needed to match the exact set of records that you want to delete. Gets or sets the recurrence pattern for the bulk delete job. Optional. Type: StringThe recurrence pattern for the bulk delete job. You can run the bulk delete job daily or without recurrence. To run without recurrence, set the property to . For more information, see Recurrence pattern in asynchronous job execution. Gets or sets a value that indicates whether an email notification is sent after the bulk delete job has finished running. Required. Type: Boolean true if an email notification should be sent after the bulk deletion is finished or has failed; otherwise, false. If you set this property to , the caller must have and privileges in addition to the privileges that are needed to delete the entity instances. If you specify to send an email notification, you must also specify a value for the property. The email notification is based on these email templates: Bulk Deletion Task Completion , Bulk Deletion Task Completed With Failure, or Bulk Deletion Task Failed. To customize these email templates, see the Templates area of the web application. To access these templates, in the Navigation Pane, click Settings, click Templates, and then click Email Templates. Gets or sets the ID of the data import job. Optional. Type: Nullable<Guid> The ID of the data import job that corresponds to the property, which is the primary key for the entity. If you provide the ID of the import job in this property, all records imported by this job will be deleted from the system by the bulk delete job. Gets or sets the start date and time to run a bulk delete job. Optional. Type: DateTimeThe start date and time to run a bulk delete job. is an optional property that specifies the start date and time of an one-time-only bulk delete job, or the start date and time of a recurring bulk delete job. If this property is not set, the start date and time are set to the value that is contained in the Now. For more information, see Recurrence pattern in asynchronous job execution. Gets or sets an array of IDs for the system users (users) who are listed in the To box of an email notification. Required. Type: Guid[] The array of IDs for the system users (users) who are listed in the To box of an email notification. Each element in the array corresponds to the attribute, which is the primary key for the entity. Each ID the array must be for a user who has a valid email address. This property is required if the property is set to ; otherwise, it is optional. If the property is set to , an email notification is sent to all users who have the IDs that are specified in this property. Gets the ID of an asynchronous bulk delete job that performs a bulk deletion. Type: GuidThe ID of an asynchronous bulk delete job that performs a bulk deletion.. Gets or sets an array of IDs for the system users (users) who are listed in the Cc box of the email notification. Type: Guid[]The array of IDs for the system users (users) who are listed in the Cc box of the email notification. Each element in the array corresponds to the attribute, which is the primary key for the entity. Each ID must be for a user who has a valid email address. This property is required if the property is set to ; otherwise, it is optional. If you set this property to , an email notification is sent to all users who have the IDs that are specified in this property. Gets or sets the name of the asynchronous system job that detects and logs multiple duplicate records. Required. Type: StringThe name of the asynchronous system job that detects and logs multiple duplicate records. Gets or sets the query criteria for detecting multiple duplicate records. Required. Type: The query criteria for detecting multiple duplicate records. The asynchronous system job detects duplicate records that match the query criteria. Assign an instance of the , , or class. The query must specify entity names and a column set. If the column set includes attributes where IsValidForRead is false or for which you do not have access, they are ignored. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics 365. Gets or sets the recurrence pattern for the asynchronous system job that detects multiple duplicate records. Optional. Type: StringThe recurrence pattern for the asynchronous system job that detects multiple duplicate records. You can run the bulk detect duplicates job daily or without recurrence. To run without recurrence, set this property to . For more information, see Recurrence pattern in asynchronous job execution. Gets or sets the start date and time of an asynchronous system job that detects and logs multiple duplicate records. Optional. Type: DateTimeThe start date and time of an asynchronous system job that detects and logs multiple duplicate record. This optional property specifies the start date and time of either a one-time-only job that detects multiple duplicate records, or of a recurring job that detects multiple duplicate records. If this property is not set, the start date and time are set to the value that is contained in the Now property. For more information, see Recurrence pattern in asynchronous job execution. Gets or sets a value that indicates whether an email notification is sent after the asynchronous system job that detects multiple duplicate records finishes running. Required. Type: Booleantrue if an email notification should be sent after the job to detect multiple duplicate records is finished running or has failed; otherwise, false. If you set this property to , the following requirements also apply: The caller must have and privileges in addition to the privileges that are needed to detect duplicate records. You must specify a value for the property. For the email notification, use the email template or custom email templates. To customize the email templates, see the Templates area of the web application. To access these templates, in the nav bar, choose Settings > Templates > Email Templates. If you set the property to , the , , and properties are not used in the class. We recommend that you set the unused properties to the following values: TemplateId = Guid.Empty; ToRecipients = new Guid[0]; CCRecipients = new Guid[0]; Sets the ID of the template (email template) that is used for the email notification. Type: GuidThe ID of the template (email template) that is used for the email notification that corresponds to the attribute, which is the primary key for the entity.. This property is required if the property is set to ; otherwise, it is optional. If you send a notification and this property is set to , an exception is thrown. This property is write-only. The property corresponds to the attribute, which is the primary key for the entity. When you use the class, you can only use a template of the entity type. Use the attribute to set the template type. If you use a template of any other type, an exception is thrown. Gets or sets an array of IDs for the system users (users) who are listed in the “To” box (recipients) of the email notification. Type: Guid[] The array of IDs for the system users (users) who are listed in the “To” box (recipients) of the email notification. Each element in the array corresponds to the attribute, which is the primary key for the entity. Each ID must be for a user who has a valid email address. This property is required if the property is set to ; otherwise, it is optional. If the property is set to , an email notification is sent to all users who have the IDs that are specified in this property. Gets the ID of an asynchronous bulk detect duplicates job that detects and logs duplicate records. Type: GuidThe ID of an asynchronous bulk detect duplicates job that detects and logs duplicate records. Returns . Returns . Returns . Returns . Returns . Returns . Gets or sets the ID of the opportunity. Required. Type: GuidThe ID of the opportunity that corresponds to the attribute, which is the primary key for the entity. Gets the actual value of an opportunity. Type: DecimalThe actual value of an opportunity. For internal use only. Type Guid For internal use only. Type Gets or sets logical name of the attribute to calculate. Required. Type: StringThe logical name of the attribute to calculate. Gets or sets a reference to the record containing the rollup attribute to calculate. Required. Type: A reference to the record containing the rollup attribute to calculate. Gets an entity that contains the attributes relevant to the calculated rollup attribute. Type: An entity that contains the attributes relevant to the calculated rollup attribute. This entity will contain three attributes that are returned in this entity instance. Attribute Name Type Description Gets or sets the ID of the incident (case). Required. Type: GuidThe ID of the incident (case) that corresponds to the attribute, which is the primary key for the entity. Gets the total time, in minutes that you use when you work on an incident (case). Type: Int64The total time, in minutes that you use when you work on an incident (case). If an activity that is used to resolve the incident (case) has already been billed, those minutes are not included in the calculation. Gets or sets the contract cancellation date. Required. Type: DateTimeThe contract cancellation date. Gets or sets the ID of the contract. Required. Type: GuidThe ID of the contract that corresponds to the attribute, which is the primary key for the entity. Gets or sets the status of the contract. Required. Type: The status of the contract. The property corresponds to the attribute. It is shown as the Status Reason in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system sets the corresponding status value. For a list of the status values, see the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. For more information, see Record state and status. Gets or sets the close activity that is associated with the sales order (order) that you want to cancel. Required. Type: The close activity that is associated with the sales order (order) that you want to cancel. This is an instance of the class, which is a subclass of the class. Gets or sets the status of the sales order (order). Required. Type: The status of the sales order (order). The property corresponds to the attribute. It is shown as the Status Reason in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system sets the corresponding status value. For a list of the status values, see the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. For more information, see Record state and status. Type: Guid Type: ExtensionDataObject Type: Type: String Type: Type: Boolean Type: ExtensionDataObject Type: Boolean Type: Boolean Type: Boolean Type: Boolean Type: Boolean Type: Boolean Type: Boolean Type: Boolean Gets or sets the addresses of the blind carbon copy (Bcc) recipients for the email message. Type: StringThe addresses of the blind carbon copy (Bcc) recipients for the email message. Gets or sets the addresses of the carbon copy (Cc) recipients for the email message. Type: StringThe carbon copy (Cc) recipients for the email message. For internal use only. Type: . Gets or sets the from address for the email message. Type: StringThe from address for the email message. Gets or sets the ID of the email message stored in the email header. Required. Type: StringThe ID of the email message stored in the email header. All email messages have an ID property in their headers. This is similar to a GUID and is used to identify the message and to see whether a specific email message has already been promoted (added) to Microsoft Dynamics 365. Gets or sets the subject line for the email message. Optional. Type: StringThe subject line for the email message. Gets or sets the addresses of the recipients of the email message. Type: StringThe addresses of the recipients of the email message. Gets the reason for the result in the property. Type: Int32 The reason for the failure. The reason code is one of these values: Field Value Description Gets a value that indicates whether the message should be delivered to Microsoft Dynamics 365. Type: Booleantrue if the message should be delivered to Microsoft Dynamics 365; otherwise, false. Provides the direction of a mail checked for promotion for uniqueness. Returns . Gets or sets the message ID that is contained in the email header. Required. Type: StringThe message ID that is contained in the email header. All email messages have an ID property in their headers. This is similar to a GUID and is used to identify the message and to see if a specific email message has already been promoted (added) to Microsoft Dynamics 365. Gets or sets the subject of the message. Optional. Type: StringThe subject of the message. Gets the reason for the result in the property. Type: Int32The reason for the result in the property. Gets a value that indicates whether the message should be promoted to Microsoft Dynamics 365. Type: BooleanIndicates whether the message should be promoted to Microsoft Dynamics 365. , to promote, otherwise, . Gets or sets the name of the cloned solution. Type: StringThe name of the cloned solution. Gets or sets the unique name of the parent solution. Type: StringThe unique name of the parent solution. Gets or sets the version number of the patch. Type: StringThe version number of the patch. The version must be greater than the parent solution but have the same major.minor number. Gets the unique identifier of the solution patch. Type: GuidThe unique identifier of the solution patch. Gets or sets the name of the cloned solution. Type: StringThe name of the cloned solution. Gets or sets the name of the parent solution. Type: StringThe name of the parent solution.. This name must be the same as the parent name in the original solution that was cloned. Gets or sets the version number of the cloned solution. Type: StringThe version number of the cloned solution.. The cloned solution major.minor version number must be a higher than the original solution that was cloned. Gets the unique identifier of the cloned solution. Type: GuidThe unique identifier of the cloned solution. Gets or sets the ID of the contract to be copied. Required. Type: GuidThe ID of the contract to be copied that corresponds to the attribute, which is the primary key for the entity. Gets or sets a value that indicates whether the canceled line items of the originating contract are to be included in the copy (clone). Required. Type: Boolean to include canceled line items, otherwise, (default). Gets the resulting contract. Type: The resulting contract. This is an instance of the class, which is a subclass of the class. Gets or sets the source product family, product, or bundle record that you want to clone. Type The source product family, product, or bundle record that you want to clone. Gets the cloned product record. Type The cloned product record. Gets or sets the incident resolution (case resolution) that is associated with the incident (case) to be closed. Required. Type: The incident resolution (case resolution) that is associated with the incident (case) to be closed. This is an instance of the class, which is a subclass of the class. Gets or sets a status of the incident. Required. Type: The status of the incident. The property corresponds to the attribute. It is shown as “Status Reason” in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system sets the appropriate corresponding status value. For more information, see Record state and status. Gets or sets a quote to be closed. Required. Type: The quote to be closed. This is an instance of the class, which is a subclass of the class. Gets or sets a status of the quote. Required. Type: The status of the quote. The property corresponds to the attribute. It is shown as “Status Reason” in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system sets the appropriate corresponding status value. For more information, see Record state and status. Gets or sets the display name of the solution component. Type: String The display name of the solution component. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the ID of the solution component. Type: GuidThe ID of the solution component. Gets or sets the display name of the parent solution component. Type: String The display name of the parent solution component. Gets or sets the ID of the parent solution component. Type: Guid The ID of the parent solution component. Gets or sets the schema name of the parent solution component. Type: String The schema name of the parent solution component.. Gets or sets the schema name of the solution component. Type: String The schema name of the solution component. Gets or sets the name of the solution. Type: String The name of the solution. Gets or sets the component type of the solution component. Type: Int32 The component type of the solution component. The enumeration named defines the supported range of values for this property. You can access the available values by including the file SampleCode\CS\HelperCode\OptionSets.cs or SampleCode\VB\HelperCode\OptionSets.vb in your project. These values are defined by the global option set Component Type (componenttype). Deprecated. Type: Deprecated. Type: Deprecated. Type: Guid Gets or sets a collection of the duplicate rule conditions that you want updated. Required. Type: The collection of the duplicate rule conditions that you want updated. Gets or sets the duplicate rule that you want updated. Required. Type: The duplicate rule that you want updated. This is instance of a class. Deprecated. Type: Deprecated. Type: Gets or sets the set of additional constraints. Type: String The set of additional constraints. Constraints can specify resources to be included or excluded from the search criteria. Attributes that can be used in the expression for the constraint are: The expression also supports operations such as , , , , and so on. The following example selects the resource only if the name is "John". string constraint = @" <Constraints> <Constraint> <Expression> <Body>resource[""name""] == ""John""</Body> <Parameters> <Parameter name=""resource""></Parameter> </Parameters> </Expression> </Constraint> </Constraints>"; constraintRelation.Constraints = constraint; Gets or sets the type of constraints. Type: String The type of constraints, which must be "Resource Selection". Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the ID of the calendar rule to which the constraint is applied. Type: Guid The ID of the calendar rule to which the constraint is applied. This corresponds to the attribute, which is the primary key for the entity. CalendarRule entity messages and methods Gets or sets the ID of the kit. Required. Type: GuidThe ID of the kit that corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the owner team to be converted. Required. Type: GuidThe ID of the team to be converted that corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the product. Required. Type: GuidThe ID of the product that corresponds to the attribute, which is the primary key for the entity. Gets or sets the collection of attributes to retrieve in the resulting sales order (order). Required. Type: The collection of attributes to retrieve in the resulting sales order (order). Assign null to this property to retrieve only the primary key. The non-null values are returned for the specified attributes in the column set. For attributes that are not included in the column set, the message response contains null values for those attributes. If the column set includes attributes where is false, they are ignored, and the message response contains no data for those attributes. To learn which attributes are valid for retrieval, see the the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. Gets or sets the date when the quote is closed. Returns DateTimeThe date when the quote is closed. Gets or sets the description for closing the quote. Returns StringThe description. Gets or sets the status of the closed quote. Returns The status of the quote that is closed. The Status property corresponds to the attribute. It is shown as “Status Reason” in the Microsoft Dynamics CRM application. If you set the value of this property to -1, the system sets the appropriate corresponding status value. For more information, see Record state and status. Gets or sets the subject associated with the closed quote. Returns The subject associated with the quote close activity. Gets or sets the ID of the quote to convert. Required. Type: GuidThe ID of the quote to convert that corresponds to the attribute, which is the primary key for the entity.. Gets the resulting sales order (order). Required. Type: The resulting sales order (order). This is an instance of the class. Gets or sets the collection of attributes to retrieve from the resulting invoice. Required. Type: The collection of attributes to retrieve from the resulting invoice. Assign null to this property to retrieve only the primary key. The non-null values are returned for the specified attributes in the column set. For attributes that are not included in the column set, the message response contains null values for those attributes. If the column set includes attributes where is false, they are ignored, and the message response contains no data for those attributes. To learn which attributes are valid for retrieval, see the the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. Gets or sets the ID of the sales order (order) to convert. Required. Type: GuidThe ID of the sales order (order) to convert that corresponds to the attribute, which is the primary key for the entity. Gets the resulting invoice. Type:The resulting invoice. This is an instance of the class. Gets or sets the ID of the base campaign to copy from. Required. Type: GuidThe ID of the base campaign to copy from that corresponds to the attribute, which is the primary key for the entity. Gets or sets a value that indicates whether to save the campaign as a template. Required. Type: Boolean to save the campaign as a template; otherwise, . Gets the ID of the newly created campaign. Type: GuidThe ID of the newly created campaign that corresponds to the attribute, which is the primary key for the entity. Gets or sets the campaign response to copy from. Required. Type: The campaign response to copy from. Gets the ID of the newly created campaign response. Type: GuidThe ID of the newly created campaign response that corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the dynamic list. Required. Type: GuidThe ID of the dynamic list that corresponds to the attribute, which is the primary key for the entity. Gets the ID of the created static list. Type: GuidThe ID of the created static list that corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the source list. Required. Type: GuidThe ID of the source list that corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the target list. Required. Type: GuidThe ID of the target list that corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID value of the form to copy. Required. Type: Guid The ID value of the form to copy. Required. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the that the original system form should be copied to. Optional. Returns . This must be an entity reference for a system form (system dashboard) entity. SystemForm (system dashboard) entity messages and methods Gets the ID of the system form that the original was copied to. Type: Guid If no Target was specified, this is the ID of the system form that the original was copied to. It corresponds to the attribute, which is the primary key for the entity. Gets or sets the activity to be distributed. Required. Type: The activity to be distributed. This value must be an instance of an activity class. For this property, only use activities that specify a recipient: a phone call, appointment, letter, fax, or email. Activity entities Gets or sets a display name for the campaign. Required. Type: StringThe display name for the campaign. Gets or sets the ID of the list. Required. Type: GuidThe ID of the list that corresponds to the attribute, which is the primary key for the entity. Gets or sets the owner for the activity. Required. Type: The owner for the activity. Gets or sets the propagation ownership options. Required. Type: The propagation ownership options. Gets or sets a value that indicates whether an asynchronous job is used to distribute an activity, such as an email, fax, or letter, to the members of a list. Required. Type: BooleanIndicates whether an asynchronous job is used to distribute an activity, such as an email, fax, or letter, to the members of a list. if an asynchronous job is used to distribute the activity; if mail merge is used to distribute the activity. Gets or sets a value that indicates whether the activity is both created and executed. Required. Type: BooleanIndicates whether the activity is both created and executed. if an activity is both created and executed; if an activity is created but not executed. This property is primarily used for the email activity. For the email activity, use if an email is created, sent, and marked as complete. Use if an email is created but not sent. Gets or sets the ID of the queue to which the created activities are added. Required. Type: GuidThe ID of the queue to which the created activities are added that corresponds to the attribute, which is the primary key for the entity. Gets or sets a value that indicates whether to send an email about the new activity. Required. Type: BooleanIndicates whether to send an email about the new activity. if you want email messages sent automatically; otherwise, . Use this property for the email activity. Gets or sets the ID of the email template. Required. Type: GuidThe ID of the email template that corresponds to the attribute, which is the primary key for the entity. Use the email template if is . Gets the ID of the bulk operation created to distribute the campaign activity. Type GuidThe ID of the bulk operation created to distribute the campaign activity that corresponds to the attribute, which is the primary key for the entity. Gets or sets whether the appointment instance is deleted. Type: BooleanIndicates if the appointment instance is deleted. , if deleted, otherwise, . Gets or sets the original start date of the recurring appointment. Type: DateTimeThe original start date of the recurring appointment. Gets or sets the target appointment for the exception. Type: The target appointment for the exception. This must be an entity reference for an appointment entity. Appointment entity messages and methods Gets the ID of the exception appointment. Type: GuidThe ID of the exception appointment. This corresponds to the . attribute, which is the primary key for the entity. Gets or sets the number of instances to be created. Required. Type: Int32The number of instances to be created. Gets or sets the target appointment instance to create. Required. Type: The target appointment instance to create. This is an instance of the class, which is a subclass of the class. Appointment entity messages and methods Gets whether the series can be expanded. Type: BooleanIndicates whether the series can be expanded. if can be expanded, otherwise, . Get or sets whether to create a major or minor version of the knowledge article record. Required. Type: Boolean if major version; if minor version. Gets or sets the language to which the knowledge article is translated to. Required. Type: The language locale record to which the knowledge article record is translated to. You can translate your knowledge article in more than 150 languages, and information about these supported languages is available in the entity. More information: LanguageLocale (Language) entity messages and methods Gets or sets the knowledge article record to be translated. Required. Type: The knowledge article record to be translated. Gets the translated knowledge article record. Type: The translated knowledge article record. The translated knowledge article record has the title, content, description and keywords copied from the source knowledge article record, and the language set to the one you specified in the message. You can update the translated knowledge article record to specify the translated content for the title, content, description and keywords attributes. Get or sets whether to create a major or minor version of the knowledge article record. Required. Type: Boolean if major version; if minor version. Gets or sets the knowledge article record for which you want to create a version. Required. Type: The knowledge article record for which you want to create a version. Gets the version record created for a knowledge article record. Type: The version record created for a knowledge article record. Gets or sets the name of the new workflow. Required. Type: StringThe name of the new workflow. Gets or sets the ID of the workflow template. Required. Type: GuidThe ID of the workflow template. The property corresponds to the property, which is the primary key for the entity. Gets or sets the ID of the new workflow. Type: GuidThe ID of the new workflow. The property corresponds to the property, which is the primary key for the entity. Gets or sets the unique name of the solution being replaced. Type: StringThe unique name of the solution being replaced. Gets the unique identifier of the promoted solution. Type: GuidThe unique identifier of the promoted solution. Gets or sets the end date and time. Required. Type: DateTimeThe end date and time. entity records created before the specified end date will be deleted when the is processed. Gets the number of deleted audit partitions or the number of deleted records. Type: Int32The number of deleted audit partitions or records. The returned value depends on whether the version of Microsoft SQL Server that is used by the Microsoft Dynamics 365 server supports database partitions. If it does, the number of deleted partitions is returned. Otherwise, the number of deleted records is returned. Gets or sets the end date for the recurring appointment series. Required. Type: DateTimeThe end date for the appointment series. Gets or sets the value to be used to set the status of appointment instances that have already passed. Required. Type: DateTimeThe status code. The value should be one of the option set values for the attribute. For more information, see the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. If you are using the generated enumerations, use to set this property. For more information about generating enumerations, see Helper code: Enumerations for option sets. Gets or sets the target record for the operation. Required. Type: The record that defines the instances to delete. This must be an entity reference for a entity. Gets or sets a collection of activity mime attachment (email attachment) instances to attach to the email message. Required. Type: The collection of records to attach to the email message. Gets or sets the addresses of the blind carbon copy (Bcc) recipients for the email message. Required. Type: String The addresses of the blind carbon copy (Bcc) recipients for the email message. Gets or sets the message body for the email. Required. Type: String The message body for the email. Gets or sets the addresses of the carbon copy (Cc) recipients for the email message. Required. Type: String The addresses of the carbon copy (Cc) recipients for the email message. For internal use only. Type: . Gets or sets the from address for the email message. Required. Type: String The from address for the email message. Gets or sets the level of importance for the email message. Required. Type: String The level of importance for the email message. Gets or sets the ID of the email message stored in the email header. Required. Type: String The ID of the email message stored in the email header. All email messages have an ID property in their headers. This is similar to a GUID and is used to identify the message and to see if a specific email message has already been promoted (added) to Microsoft Dynamics 365. Gets or sets the time the message was received on. Required. Type: DateTime The time the message was received on. Gets or sets the subject line for the email message. Optional. Type: String The subject line for the email message. Gets or sets the email address of the account that is creating the email activity instance. Required. Type: String The email address of the account that is creating the email activity instance. Gets or sets the addresses of the recipients of the email message. Required. Type: String The addresses of the recipients of the email message. Gets or sets whether to validate before the create operation occurs. Type: Booleantrue to validate before the create operation; otherwise, false. Gets or sets the ID of the email. Type: GuidThe ID of the email. This corresponds to the attribute, which is the primary key for the entity. Gets or sets a collection of activity mime attachment (email attachment) records to attach to the email message. Required. Type: The collection of attachments, which a collection of records.. Gets or sets the addresses of the blind carbon copy (Bcc) recipients for the email message. Required. Type: String The addresses of the BCC recipients. Gets or sets the message body for the email. Required. Type: String The message body. Gets or sets the addresses of the carbon copy (Cc) recipients for the email message. Required. Type: String The addresses of the CC recipients. Gets or sets the ID of the email from which to create the email. Required. Type: Guid The ID of the email, which corresponds to the attribute, which is the primary key for the entity.. Gets or sets the extra properties for the email. Optional. Type: The extra properties. Gets or sets the from address for the email message. Required. Type: String The from address for the email. Gets or sets the level of importance for the email message. Required. Type: String The level of importance for the email. The following are the valid values for this property: Value Meaning "0" low "1" normal "2" high Gets or sets the ID of the email message stored in the email header. Required. Type: String The the ID of the email message from the email header. All email messages have an ID property in their headers. This is similar to a GUID and is used to identify the message and to see if a specific email message has already been promoted (added) to Microsoft Dynamics 365. Gets or sets the time the message was received on. Required. Type: DateTimeThe time the message was received. Gets or sets the subject line for the email message. Optional. Type: String The subject line for the email. Gets or sets the email address of the account that is creating the email activity instance. Required. Type: String The email address of the account that is creating the email activity. Gets or sets the addresses of the recipients of the email message. Required. Type: String The addresses of the recipients of the email message. Gets the ID of the newly created email activity. Type: GuidThe ID of the newly created email activity. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the language to deprovision. Required. Type: Int32The language to deprovision. Required. Valid locale ID values can be found at Locale ID (LCID) Chart. Deprecated. Use the class and its members. Type: . Deprecated. Use the class and its members. Type: . Deprecated. Use the class and its members. Type: String Gets or sets the activity to be distributed. Required. Type: The activity to be distributed, which must be instance of an activity class. You can only use activities that specify a recipient: a phone call, appointment, letter, fax, or email. . Activity entities Gets or sets the ID of the campaign activity for which the activity is distributed. Required. Type: GuidThe ID of the campaign activity for which the activity is distributed. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the owner for the newly created activity. Required. Type: The owner for the newly created activity. Gets or sets the ownership options for the activity. Required. Type: The ownership options for the activity. Gets or sets a value that indicates whether an asynchronous job is used to distribute activities, such as an email, fax, or letter, to the members of a list. Required. Type: Boolean if an asynchronous job is used to distribute the activity; if mail merge is used to distribute the activity. Gets or sets a value that indicates whether the activity is both created and executed. Required. Type: BooleanIndicates whether the activity is both created and executed. if an activity is both created and executed; if an activity is created but not executed. This property is primarily used for the email activity. For the email activity, use if an email is created, sent, and marked as complete. Use if an email is created but not sent. Gets or sets the ID of the queue to which the created activity is added. Optional. Type: GuidThe ID of the queue to which the created activity is added. This corresponds to the attribute, which is the primary key for the entity. Gets or sets a value that indicates whether to send an email about the new activity. Required. Type: Boolean if you want emails sent automatically; otherwise, . Use this property for the email activity. Gets or sets the ID of the email template. Required. Type: GuidThe ID of the email template. This corresponds to the attribute, which is the primary key for the entity. Use the email template, if is . Template entities Gets the ID of the bulk operation that is used to distribute the campaign activity. Type: GuidThe ID of the bulk operation that is used to distribute the campaign activity. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the report to download. Type: GuidThe ID of the report to download. This corresponds to the attribute, which is the primary key for the entity. Gets the report definition. Type: StringThe report definition. Contains a UTF-8 encoded XML document in the form of a string that represents the entire content of the report definition (RDL) file. Gets or sets the reason for a scheduling failure. Type: StringThe reason for a scheduling failure. This property is used in the class. For a list of possible error codes, see Web service error codes. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the array of information about a resource that has a scheduling problem for an appointment. Type: []The array of information about a resource that has a scheduling problem for an appointment. Gets or sets the ID of the saved query (view) to execute. Type: GuidThe ID of the saved query (view) to execute. This corresponds to the property, which is the primary key for the entity. Gets the results of the saved query (view). Type: StringThe the results of the saved query (view). This XML string is in the following format: <resultset> + <result>result1</result><result>result2</result> + ... + </resultset> The XML string that is returned from this method may contain multiple entity instances. If no instances are returned, the method returns an XML document for the entity type, and the document contains no data. The XML string that is returned from this method does not contain elements for attributes where the value is null or where the value contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client. Gets or sets the ID of the user query (saved view) record to be executed. Type: The ID of the user query (saved view) record to be executed. The ID corresponds to the property, which is the primary key for the entity. Gets the results of the user query (saved view). Type: StringThe results of the user query (saved view). This XML string is in the following format: <resultset> + <result>result1</result><result>result2</result> + ... + </resultset> The XML string that is returned from this method may contain multiple entity instances. If no instances are returned, the method returns an XML document for the entity type, and the document contains no data. The XML string that is returned from this method does not contain elements for attributes where the value is null or where the value contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client. Deprecated. Type: String Deprecated. Type: String Gets or sets the ID of the record on which the workflow executes. Required. Type: Guid. The ID of the record on which the workflow executes. The property corresponds to the primary key for the entity. For internal use only. Returns . Provides the ability to pass input arguments into an executing workflow. Gets or sets the ID of the workflow to execute. Required. Type: Guid. The ID of the workflow to execute. The property corresponds to the property, which is the primary key for the entity. Gets the ID of the asynchronous operation (system job) that was created. Type: GuidThe ID of the asynchronous operation. The property corresponds to the property, which is the primary key for the entity. Gets or sets the ID of the calendar. Type: GuidThe ID of the calendar. This corresponds to the property, which is the primary key for the entity. Gets or sets the end of the time period to expand. Type: DateTimeThe end of the time period to expand. Gets or sets the start of the period to expand. Type: DateTimeThe start of the time period to expand. Gets a set of time blocks with appointment information. Type:The set of time blocks with appointment information. Gets the compressed file that represents the exported translation file. Type: Byte[] The compressed file that represents the exported translation file. Gets or sets a value that indicates whether to export the entity record IDs contained in the data map. Required. Type: BooleanIndicates whether to export the entity record IDs contained in the data map. to export the record IDs, otherwise, . Gets or sets the ID of the import map (data map) to export. Required. Type: GuidThe ID of the import map (data map) to export. This corresponds to the attribute, which is the primary key for the entity. Gets the XML representation of the exported data map. Type: StringThe XML representation of the exported data map. Gets or sets whether auto numbering settings should be included in the solution being exported. Optional. Type: Booleantrue if the auto numbering settings should be included in the solution being exported; otherwise, false. This setting includes the following values with the solution: Organization.CampaignPrefix Organization.ContractPrefix Organization.CasePrefix Organization.KbPrefix Organization.OrderPrefix Organization.InvoicePrefix Organization.UniqueSpecifierLength Gets or sets whether calendar settings should be included in the solution being exported. Optional. Type: Booleantrue if the calendar settings should be included in the solution being exported; otherwise, false. This setting includes the following values with the solution: Organization.WeekStartDayCode Organization.CalendarType Organization.DateFormatCode Organization.DateSeparator Organization.TimeFormatCode Organization.ShowWeekNumber Organization.MaxAppointmentDurationDays Gets or sets whether customization settings should be included in the solution being exported. Optional. Type: Booleantrue if the customization settings should be included in the solution being exported; otherwise, false. This setting includes the following values with the solution: Organization.IsAppMode Gets or sets whether email tracking settings should be included in the solution being exported. Optional. Type: Booleantrue if the email tracking settings should be included in the solution being exported; otherwise, false. This setting includes the following values with the solution: Organization.TrackingPrefix Organization.TrackingTokenIdBase Organization.TrackingTokenIdDigits Organization.MaximumTrackingNumber Organization.IgnoreInternalEmail Organization.RenderSecureIFrameForEmail Organization.AllowUnresolvedPartiesOnEmailSend Gets or sets whether general settings should be included in the solution being exported. Optional. Type: Booleantrue if the general settings should be included in the solution being exported; otherwise, false. This setting includes the following values with the solution: Organization.FullNameConventionCode Organization.NumberFormat Organization.NegativeFormatCode Organization.CurrencySymbol Organization.CurrencyFormatCode Organization.PricingDecimalPrecision Organization.ShareToPreviousOwnerOnAssign Organization.BlockedAttachments Organization.GetStartedPaneContentEnabled Organization.IsPresenceEnabled Organization.IsAutoSaveEnabled Organization.GlobalHelpUrl Organization.GlobalHelpUrlEnabled Organization.GlobalAppendUrlParametersEnabled Organization.MobileClientMashupEnabled Gets or sets whether ISV.Config settings should be included in the solution being exported. Optional. Type: Booleantrue if the ISV.Config settings should be included in the solution being exported; otherwise, false. This setting includes the following values with the solution: The XML representing the ISV.Config. Gets or sets whether marketing settings should be included in the solution being exported. Optional. Type: Booleantrue if the marketing settings should be included in the solution being exported; otherwise, false. This setting includes the following values with the solution: Organization.AllowMarketingEmailExecution Organization.AllowAutoResponseCreation Organization.AllowAutoUnsubscribe Organization.AllowAutoUnsubscribeAcknowledgement Gets or sets whether outlook synchronization settings should be included in the solution being exported. Optional. Type: Booleantrue if the outlook synchronization settings should be included in the solution being exported; otherwise, false. This setting includes the following values with the solution: Organization.TagPollingPeriod Organization.TagMaxAggressiveCycles Organization.AllowOutlookScheduledSyncs Organization.MinOutlookSyncInterval Organization.EmailSendPollingPeriod Organization.AllowOfflineScheduledSyncs Organization.MinOfflineSyncInterval Organization.AllowAddressBookSyncs Organization.MinAddressBookSyncInterval Gets or sets whether relationship role settings should be included in the solution being exported. Optional. Type: Booleantrue if the relationship role settings should be included in the solution being exported; otherwise, false. Gets or sets whether sales settings should be included in the solution being exported. Optional. Type: Booleantrue if the sales settings should be included in the solution being exported; otherwise, false. This setting includes the following values with the solution: Organization.UseInbuiltRuleForDefaultPricelistSelection Organization.MaxProductsInBundle Organization.OOBPriceCalculationEnabled Organization.DiscountCalculationMethod Organization.MaximumDynamicPropertiesAllowed Organization.CreateProductsWithoutParentInActiveState Gets or sets whether the solution should be exported as a managed solution. Required. Type: Booleantrue if the solution should be exported as a managed solution; otherwise, false. Gets or sets the unique name of the solution to be exported. Required. Type: StringThe unique name of the solution to be exported. Required. Get or set a value indicating the version that the exported solution will support. Type: StringA value indicating the version that the exported solution will support. Optional. Until updates to Microsoft Dynamics CRM 2015 and Microsoft Dynamics CRM Online 2015 Updateare released, there is only one valid value for this property. Valid values are: Value Version 7.0.0.0 Microsoft Dynamics CRM 2015 and Microsoft Dynamics CRM Online 2015 Update Gets the compressed file that represents the exported solution. Type: Byte[] The compressed file that represents the exported solution. Gets or sets the unique name for the unmanaged solution to export translations for. Required. Type: StringThe unique name for the unmanaged solution to export translations for. Required. Gets the file that represents the data that is exported for translation. Type: Byte[]The file that represents the data that is exported for translation. Gets or sets the query to convert. Type: StringThe query to convert. This The string must contain a query that you express in FetchXML. For more information, see FetchXML schema. Gets the results of the query conversion. Type: The results of the query conversion. Gets or sets an array of IDs of the children resource groups. Type: Guid[]The array of IDs of the children resource groups. Each element of the array corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the parent resource group. Type: GuidThe ID of the parent resource group. This corresponds to the attribute, which is the primary key for the entity. Gets a value that indicates whether the parent resource group was found. Type: BooleanIndicates whether the parent resource group was found. if the parent resource group was found; otherwise, . Gets or sets the order close activity associated with the sales order (order) to be fulfilled. Required. Type: The order close activity associated with the sales order (order) to be fulfilled, which must be an instance of the class. Gets or sets a status of the sales order (order). Required. Type: The status of the sales order (order). The property corresponds to the attribute. It is shown as the Status Reason in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system will set the appropriate corresponding status value. For more information, see Record state and status. Gets or sets the query criteria to find knowledge articles with specified text. Required. Type: The query criteria to find knowledge articles with specified text. Assign an instance of the , or class. The message supports all the filtering, sorting, and paging techniques that are supported by FetchXML and QueryExpression. More information: Build queries with FetchXML and Build queries with QueryExpression. If you do not specify a sorting condition (order), search results are by default sorted by relevance. When using QueryExpression, the query must specify the entity name “knowledgearticle” and a . If the column set includes attributes that are not valid for retrieve or for which you do not have access, they will be ignored. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics 365. Gets or sets a value that indicates whether to remove multiple versions of the same knowledge article in search results. Required. Type: Boolean to remove multiple versions of the same knowledge article; to return all article versions matching the search text in the search result. Some of the filtering is done post-search from the full-text index, which depends on the values specified for the and parameters. The rules based on and parameters are: StateCode RemoveDuplicates Search result Gets or sets the text to search for in knowledge articles. Required. Type: StringThe text to search for in knowledge articles. Gets or sets the state of the knowledge articles to filter the search results. Required. Types: Int32The state code of the knowledge articles to be searched. Use this parameter to restrict the knowledge article search by state. If you do not want to filter on any state value, specify a negative value for this parameter, say -1. You can use the following state code values to filter your results: 0: Draft 1: Approved 2: Scheduled 3: Published 4: Expired 5: Archived 6: Discarded Notes for the caller Some of the filtering is done post-search from the full-text index, which depends on the values specified for the StateCode and parameters. The rules based on and parameters are: StateCode RemoveDuplicates Search result Gets or sets a value that indicates whether to use inflectional stem matching when searching for knowledge articles. Required. Type: Boolean, to use inflectional stem matching, otherwise, . In inflectional stem matching, you can use word “write” as an inflectional stem of “‘write”, “writing”, “wrote” and “written”. Gets the collection of knowledge articles that contain the specified text you searched for. Type: The collection of knowledge articles that contain the specified text you searched for. Gets or sets the collection of attributes to retrieve from the resulting invoice. Required. Type: The collection of attributes to retrieve from the resulting invoice. Assign null to this property to retrieve only the primary key. The non-null values are returned for the specified attributes in the column set. The attributes that are not included in the column set contain null values. If the column set includes attributes where is , they are ignored, and the message response contains no data for those attributes. You can find this information in the metadata for your organization. See the preceding metadata browser information. Gets or sets the ID of the opportunity to be used as the basis for the new invoice. Required. Type: GuidThe ID of the opportunity to be used as the basis for the new invoice. This corresponds to the attribute, which is the primary key for the entity. Gets the resulting invoice. Type: The resulting invoice, which must be an instance of the class. Gets or sets the collection of attributes to retrieve in the resulting quote. Required. Type: The collection of attributes to retrieve in the resulting quote. Assign null to this property to retrieve only the primary key. The non-null values are returned for the specified attributes in the column set. The attributes that are not included in the column set contain null values. If the column set includes attributes where is , they are ignored. You can find this information in the metadata for your organization. See the preceding metadata browser information. Gets or sets the ID of the opportunity to be used as the basis for the new quote. Required. Type: GuidThe ID of the opportunity to be used as the basis for the new quote. This corresponds to the attribute, which is the primary key for the entity. Gets the resulting quote. Type: The resulting quote, which must be an instance of the class. Gets or sets the collection of attributes to retrieve from the resulting sales order (order). Required. Type: The collection of attributes to retrieve from the resulting sales order (order). Assign null to this property to retrieve only the primary key. The non-null values are returned for the specified attributes in the column set. The attributes that are not included in the column set contain null values. If the column set includes attributes where is , they are ignored. You can find this information in the metadata for your organization. See the preceding metadata browser information. Gets or sets the ID of the opportunity to be used as the basis for the new sales order (order). Required. Type: GuidThe ID of the opportunity to be used as the basis for the new sales order (order). This corresponds to the attribute, which is the primary key for the entity. Gets the resulting sales order (order). Type: The resulting sales order (order), which must be an instance of the class. Gets or sets the social profile instance to return or generate. Type: The social profile instance. Gets the social profile returned by the message. Type: The social profile returned by the message. Gets or sets the locale ID. Required. Type: Int32The locale ID. Valid locale ID values can be found at Locale ID (LCID) Chart. Gets the collection of the time zone definition () records. Type: The collection of the time zone definition () records. Gets the decryption key. Type: StringThe decryption key. For internal use only. Returns . For internal use only. Returns . The supported entities for this message are: , , , and . Gets the price level (price list) for the current user. If a user territory is part of multiple price levels (price lists), gets multiple price levels (price lists). Returns The resulting price level, which is an instance of the class. Gets or sets a column number in the CSV, XML Spreadsheet 2003 (.xml), or text source file for which the distinct values are returned. Required. Type: Int32. Gets or sets in ID of the import file that is associated with the source file. Required. Type: GuidThe ID of the import file that is associated with the source file. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the page number in the source file. Required. Type: Int32The page number in the source file. Gets or sets the number of data records per page in the source file. Required. Type: Int32The number of data records per page in the source file. Gets the distinct values for a column in the source file. Type: StringThe distinct values for a column in the source file. Gets or sets the ID of the import file that is associated with the parse table. Required. Type: GuidThe ID of the import file that is associated with the parse table. This corresponds to the attribute, which is the primary key for the entity. Gets the source file header columns. Type: StringThe source file header columns. Gets or sets the ID of the invoice. Type: GuidThe ID of the invoice. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the opportunity. Type: GuidThe ID of the opportunity. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the product. Required. Type: GuidThe ID of the product. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the target record for this request. Required. Type: The target record for this request. This must be an entity reference for , , , or entity. Gets or sets the ID of the unit of measure (unit). Required. Type: GuidThe ID of the unit of measure (unit). This corresponds to the attribute, which is the primary key for the entity. Gets the quantity decimal value for a product. Type: Int32The quantity decimal value for a product. Gets or sets the ID of the opportunity. Type: GuidThe ID of the opportunity. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the quote. Type: GuidThe ID of the quote. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the report. Required. Type: GuidThe ID of the report. This corresponds to the property, which is the primary key for the entity. Gets the history limit for a report. Type: Int32 The history limit represents the number of report history snapshots that a specified report is permitted to have. The default is eight snapshots. If -1 is returned, the report is permitted to have an unlimited number of report history snapshots. Gets or sets the ID of the opportunity. Type: GuidThe ID of the opportunity. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the sales order (order). Type: GuidThe ID of the sales order (order). This corresponds to the attribute, which is the primary key for the entity. Gets or sets the locale ID. Type: Int32The locale ID. Valid locale ID values can be found at Locale ID (LCID) Chart. Gets or sets the localized name to search for. Type: StringThe localized name to search for. For example, for the Western Time Zone in the United States and Canada, specify "Pacific Standard Time" or, for summer, “Pacific Daylight Time”. Gets the time zone code that has the requested localized name. Type: Int32The time zone code that has the requested localized name. Gets or sets the context of the email. Required. Type: StringThe context of the email. Gets the requested tracking token. Type: StringThe requested tracking token. This value can be passed as a property in the message. Gets or sets the team or user that is granted access to the specified record. Required. Type: The team or user that is granted access to the target record. Gets or sets the entity that is the target of the request to grant access. Required. Type: The entity reference to the record that is the target of the request to grant access. This property value must be an entity reference for an entity that supports this message. For a list of supported entity types, see . Gets or sets the compressed translations file. Required. Type: Byte[] The compressed translations file. Gets the ID of the import job that will be created to perform this import. Type: GuidThe ID of the import job that will be created to perform this import. This corresponds to the attribute, which is the primary key for the entity. Gets or sets an XML representation of the data map. Required. Type: StringThe XML representation of the data map. Gets or sets a value that indicates whether to import the entity record IDs contained in the XML representation of the data map. Required. Type: BooleanIndicates whether to import the entity record IDs contained in the XML representation of the data map. to import the entity record IDs, otherwise, . The imported record IDs are used as primary keys for the entity records created in Microsoft Dynamics 365. Gets the ID of the newly created import map (data map). Type: GuidThe ID of the newly created import map (data map). This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the data import (import) that is associated with the asynchronous import records job. Required. Type: GuidThe ID of the data import (import) that is associated with the asynchronous import records job. This corresponds to the attribute, which is the primary key for the entity. Gets the ID of the asynchronous import records job. Type: GuidThe ID of the asynchronous import records job. Direct the system to convert any matching unmanaged customizations into your managed solution. Optional. Type: Booleantrue if the system should convert any matching unmanaged customizations into your managed solution; otherwise, false. This parameter is provided so that a system that is upgraded from Microsoft Dynamics CRM 4.0 and contains unmanaged customizations that should be part of a managed solution being installed. This scenario applies to ISVs who created solutions for Microsoft Dynamics CRM 4.0 and want to use managed solutions after their customers upgrade. Plan for solution development Gets or sets the compressed solutions file to import. Required. Type: Byte[]The compressed solutions file to import. Required. Gets or sets the ID of the import job that will be created to perform this import. Required. Type: GuidThe the ID of the import job that will be created to perform this import. This corresponds to the attribute, which is the primary key for the entity. Gets or sets whether any unmanaged customizations that have been applied over existing managed solution components should be overwritten. Required. Type: Booleantrue if the any unmanaged customizations that have been applied over existing managed solution components should be overwritten; otherwise, false. This setting applies to scenarios where the managed solution is already installed and it is being installed again, perhaps as a newer version. When this value is false importing the solution will only update the managed solution components and any unmanaged customizations of those components will remain. By setting this property to true and importing the solution, any unmanaged customizations will be overwritten. You may want to do this as a way to re-initialize the solution. To preserve any unmanaged customizations, export any unmanaged customizations before installing the update with this option set to true. Gets or sets whether any processes (workflows) included in the solution should be activated after they are imported. Required. Type: Booleantrue if the any processes (workflows) included in the solution should be activated after they are imported; otherwise, false. Gets or sets whether enforcement of dependencies related to product updates should be skipped. Type: Booleantrue if enforcement of dependencies related to product updates should be skipped; otherwise, false. This member was added because solutions exported from a Microsoft Dynamics 365 (online) organization with product updates enabled will contain dependencies on solution components that will not exist in an on-premises deployment of Microsoft Dynamics CRM 2011 or a Microsoft Dynamics 365 (online) organization that has not installed the updates. This parameter allows for the installation of the solution to proceed. Any functionality in the solution that depends on missing solution components will not function as expected. Gets or sets the ID of the import job that will be created to perform this import. Required. Type: GuidThe the ID of the import job that will be created to perform this import. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the compressed translations file. Required. Type: Byte[]The compressed translations file. Required. Gets or sets the view count of a knowledge article record. Required. Type: Int32The view count of a knowledge article record. Gets or sets the location where the knowledge article record was used. Type: Int32The location where the knowledge article record was used. In the current CRM release, you can only specify 1 (default value) for this parameter, which signifies the location as internal. The location value is stored in the . attribute. KnowledgeArticleViews entity messages and methodsknowledgearticleviews EntityType Gets or sets the knowledge article record for incrementing the view count. Required. Type: The knowledge article record for incrementing the view count. Gets or sets the date for which the view count has to be incremented. Type: DateTimeThe date for which the view count has to be incremented. Gets the knowledge article view count record. Type: The knowledge article view count record. Gets or sets the record that is the source for initializing. Type: The record that is the source for initializing. Gets or sets the logical name of the target entity. Type: StringThe logical name of the target entity. Gets or sets which attributes are to be initialized in the initialized instance. Type: Indicates which attributes are to be initialized in the initialized instance. Gets the initialized instance. Type: The initialized instance. To create a record, pass this value to the method or to a message. Gets or sets the collection. Type: An input argument. Indicates the number of elements in the collection. Type: Int32The number of elements in the collection. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data.. Gets or sets the element at the specified index in the collection. Type: String. The key used to identify a target element in the collection. Type: ObjectThe input argument. You must cast the returned object to the correct type. Gets or sets the set of filters to instantiate for the user. Type: The set of filters to instantiate for the user. This must be a collection of entity references for the entity and the attribute value for each must be or . Gets or sets the ID of the user that will own the user query records created. Type: GuidThe user that will own the user query records created. This corresponds to the property, which is the primary key for the entity. Gets or sets the ID of the record that the email is regarding. Required. Type: Guid The ID of the record that the email is regarding. This must be the ID of an entity that has a relationship to the entity. Gets or sets the type of entity that is represented by the property. Required. Type: String The logical name of the entity. Gets or sets the ID of the template. Required. Type: Guid The ID of the template that corresponds to the attribute, which is the primary key for the entity. Gets the instantiated email records. Type: The collection of the instantiated email records. Deprecated. Type: Boolean Gets or sets the ID of the solution component. Required. Type: GuidThe ID of the solution component. This corresponds to the attribute, which is the primary key for the entity. For solution components that derive from the class, this value is the property.For other solution components, use the record ID value. Gets or sets the value that represents the solution component. Required. Type: Int32The value that represents the solution component. Required. The enumeration defines the supported range of values for this property. You can access the available values by including the file SampleCode\CS\HelperCode\OptionSets.cs or SampleCode\VB\HelperCode\OptionSets.vb in your project. These values are defined by the global option set Component Type (componenttype). Gets the value that indicates whether a solution component is customizable. Type: Booleanthe value that indicates whether a solution component is customizable. Gets or sets the entity reference for the record whose transition state is validated. Type: The entity reference for the record whose transition state is validated. Gets or sets the proposed new state for the record. Type: StringThe proposed new state for the record. This property corresponds to the attribute. It specifies the possible states for an entity record. It is shown as the Status in the Microsoft Dynamics 365 application. For a list of the state values, see the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. For more information, see Record state and status. Gets or sets the proposed new status for the record. Type: Int32The proposed new status for the record. The property corresponds to the attribute. It is shown as the Status Reason in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system sets the appropriate corresponding status value. For a list of the status values, see the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. For more information, see Record state and status. Gets the value that indicates whether the state transition is valid. Type: BooleanIndicates whether the state transition is valid. if the state transition is valid; otherwise, . Gets or sets the time zone code. Type: Int32The time zone code. Gets or sets the Coordinated Universal Time (UTC). Type: DateTimeThe Coordinated Universal Time (UTC). Gets the time that is represented as local time. Type: DateTimeThe time that is represented as local time. Gets or sets the ID of the invoice. Type: GuidThe ID of the invoice. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the sales order. Type: GuidThe ID of the sales order. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the opportunity close activity. Required. Type: The opportunity close activity. This is an instance of the class. Gets or sets a status of the opportunity. Required. Type: The a status of the opportunity. The property corresponds to the attribute. It is shown as the Status Reason in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system automatically sets the corresponding status value. For a list of the status values, see the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. For more information, see Record state and status. Deprecated. Type: Guid Deprecated. Type: Guid Deprecated. Type: Guid Deprecated. Type: Guid Gets or sets a value that indicates whether to check if the parent information is different for the two entity records. Required. Type: BooleanIndicates whether to check if the parent information is different for the two entity records. to check if the parent information is different for the two entity records, otherwise, . Gets or sets the ID of the entity record from which to merge data. Required. Type: GuidThe ID of the entity record from which to merge data. The entity type of the specified record for must match the entity type of the specified record in the property. The specified record must be one of following entity types: , , or . Gets or sets the target of the merge operation. Required. Type: The target of the merge operation. A target of this operation is a record of one of following entity types: , , or . Gets or sets additional entity attributes to be set during the merge operation for accounts, contacts, or leads. This property is not applied when merging incidents. Optional. Type: The additional entity attributes to be set during the merge operation. This property is not applied when merging incidents. This property value must be an instance of the same entity type as the target and subordinate records. Only the properties that contain values or that specify null are set. Gets or sets information about the solution component in the solution file that is dependent on a missing solution component. Type: Information about the solution component in the solution file that is dependent on a missing solution component.. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets information about the required solution component that is missing. Type: Information about the required solution component that is missing.. Gets or sets the team or user whose access to the specified record is modified. Required. Type: The team or user whose access to the specified record is modified. Gets or sets the entity that is the target of the request to modify access. Required. Type: The entity that is the target of the request to modify access. This must be an entity reference to an entity that supports this message. For a list of supported entity types, see the class. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the search strategy to use in the appointment request for the message. Type: StringThe search strategy to use in the appointment request. Used in the property. The scheduling engine supports three search strategies that are specified in the property. A string that contains the search strategy is a parameter to the search methods. The examples show the valid values. Least Busy - From the list of resources that can perform that specific service, choose the resource that is the least busy and is available at the requested time. Most Busy - From the list of resources that can perform that specific service, choose the resource that is the busiest and is available at the requested time. Random - From the list of resources that can perform that specific service, choose any resource that is available at the requested time. The following table shows the supported values for an evaluation interval. Value Description P0D Refresh states per proposal. PInfinity Constantly refresh states. P1D Refresh states one time per day. The following sample shows Most Busy. <Expression> <Body>udf \"MostBusy\"(factory,resource,appointment,request,leftoffset,rightoffset)</Body> <Parameters> <Parameter name=\"factory\"/> <Parameter name=\"resource\"> </Parameter><Parameter name=\"appointment\"> </Parameter><Parameter name=\"request\"> </Parameter><Parameter name=\"leftoffset\"> </Parameter><Parameter name=\"rightoffset\"></Parameter> </Parameters> <Properties EvaluationInterval=\"P0D\" evaluationcost=\"1\"/> </Expression> The following sample shows Least Busy. <Expression> <Body>udf \"LeastBusy\"(factory,resource,appointment,request,leftoffset,rightoffset)</Body> <Parameters> <Parameter name=\"factory\"/> <Parameter name=\"resource\"> </Parameter><Parameter name=\"appointment\"> </Parameter><Parameter name=\"request\"> </Parameter><Parameter name=\"leftoffset\"> </Parameter><Parameter name=\"rightoffset\"></Parameter> </Parameters> <Properties EvaluationInterval=\"P0D\" evaluationcost=\"1\"/> </Expression> The following sample shows Random. <Expression> <Body>udf \"Random\"(factory,resource,appointment,request,leftoffset,rightoffset)</Body> <Parameters> <Parameter name=\"factory\"/> <Parameter name=\"resource\"> </Parameter><Parameter name=\"appointment\"> </Parameter><Parameter name=\"request\"> </Parameter><Parameter name=\"leftoffset\"> </Parameter><Parameter name=\"rightoffset\"></Parameter> </Parameters> <Properties EvaluationInterval=\"P0D\" evaluationcost=\"0\"/> </Expression> Gets or sets the ID of the resource specification. Type: GuidThe ID of the resource specification. The property corresponds to the property, which is the primary key for the resource specification entity. ResourceSpec (resource specification) entity messages and methods Gets the current number of active users. Type: Int32the current number of active users. User and team entities Gets the current number of custom entities. Type: Int32the current number of custom entities. Customize entity metadata Gets the current number of non-interactive users. Type: Int32the current number of non-interactive users. User and team entities Gets the current number of published workflows. Type: Int32the current number of published workflows. Write workflows to automate business processes Gets the current storage used by the organization. Type: Int32the current storage used by the organization. Gets or sets the structure that contains extra data. Type: ExtensionDataObject. Gets the maximum number of active users. Type: Int32The maximum number of active users. User and team entities Gets the maximum number of custom entities. Type: Int32the maximum number of custom entities. Customize entity metadata Gets the maximum number of non-interactive users. Type: Int32The maximum number of non-interactive users. User and team entities Gets the maximum number of published workflows. Type: Int32The maximum number of published workflows. Write workflows to automate business processes Gets the maximum storage allowed for the organization. Type: Int32The maximum storage allowed for the organization. Gets or sets the ID of the import (data import) that is associated with the asynchronous job that parses all import files for this import. Required. Type: GuidThe ID of the import (data import) that is associated with the asynchronous job that parses all import files for this import. This corresponds to the attribute, which is the primary key for the entity. Gets an ID of the asynchronous job that parses the import files for this import. Type: GuidID of the asynchronous job that parses the import files for this import. Gets or sets the Type: Guid The QueueItem. This corresponds to the attribute, which is the primary key for the entity. Gets or sets whether the queue item should be removed from the queue. Type: Booleantrue if the queue item should be removed from the queue; otherwise, false. Gets or sets the user to assign the queue item to. Required. Type: Guid The User. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the access rights of the security principal (user or team). Type: The access rights of the security principal (user or team). Set bit flags Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the security principal (user or team). Type: The security principal (user or team). Gets or sets the ID of the inbound email activity. Type: GuidThe ID of the inbound email activity. This corresponds to the attribute, which is the primary key for the entity. Alternatively, it can be the for any activity entity type, including custom activity entities. Activity entities Gets or sets the activity to be distributed. Required. Type: The activity to be distributed. This property must be an instance of a class that represents a Microsoft Dynamics 365 activity. For this property, you can only use activities that specify a recipient, such as an appointment, email, fax, letter, or phone call. Activity entities Gets or sets a value that indicates whether the activity is both created and executed. Required. Type: BooleanIndicates whether the activity is both created and executed. if an activity is both created and executed; if an activity is created but not executed. This property is primarily used for the email activity. For the email activity, use if an email is created, sent, and marked as complete. Use if an email is created but not sent. Gets or sets the user-identifiable name for the campaign. Required. Type: StringThe user-identifiable name for the campaign. Gets or sets the owner for the activity. Required. Type: The owner for the activity. Gets or sets the ownership options for propagation. Required. Type: The ownership options for propagation. Gets or sets a value that indicates whether an asynchronous job is used to distribute an activity, such as an email, fax, or letter, to the members of a list. Required. Type: BooleanIndicates whether an asynchronous job is used to distribute an activity, such as an email, fax, or letter, to the members of a list. if an asynchronous job is used to distribute the activity; if mail merge is used to distribute the activity. Gets or sets the query criteria to select accounts, contacts, or leads for which activities are created. Required. Type: The query criteria to select accounts, contacts, or leads for which activities are created. Assign an instance of the class , , or . The query must specify an entity name and column set. If the column set includes attributes where IsValidForRead is false, they are ignored and the message response contains no data for those attributes. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics 365. Gets or sets the ID of the queue to which the created activities are added. Optional. Type: GuidThe ID of the queue to which the created activities are added. This corresponds to the attribute, which is the primary key for the entity. Gets or sets a value that indicates whether to send an email about the new activity. Required. Type: BooleanIndicates whether to send an email about the new activity. true to automatically send email messages; otherwise, false. Primarily used for the email activity. Gets or sets the ID of the email template. Required. Type: GuidThe ID of the email template. This corresponds to the attribute, which is the primary key for the entity. Use the email template, if is .Use the email template, if is .Use the email template, if is .Use the email template, if is . Gets the ID of the bulk operation that is created to distribute the campaign activity. Required. Type: GuidThe ID of the bulk operation that is created to distribute the campaign activity. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the display name for the party. Type: StringThe display name for the party. Gets or sets the percentage of time that is required to perform the service. Type: DoubleThe percentage of time that is required to perform the service. Use this property to indicate the percentage of time that a service will take. For example, a dentist may fill only one cavity at a time; so the value for this service is 1. However, the dentist can schedule four simultaneous cleanings; each with a different dental hygienist. Therefore, the value for a single cleaning service is .25. Gets or sets the logical name of the type of entity that is represented by this party. Type: StringThe logical name of the type of entity that is represented by this party. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the ID of the resource that is represented by this party. Type: Guid The ID of the resource that is represented by this party. This corresponds to the attribute, which is the primary key for the entity. Resource entities Gets or sets the ID of the resource specification that is represented by this party. Type: Guid The ID of the resource specification that is represented by this party. This corresponds to the attribute, which is the primary key for the entity. The property corresponds to the attribute, which is the primary key for the entity. Resource entities Gets or sets the language to provision. Required. Type: Int32The language to provision. Required. Valid locale ID values can be found at Locale ID (LCID) Chart. Gets or sets the ID of the duplicate rule to be published. Required. Type: GuidThe ID of the duplicate rule to be published. This corresponds to the attribute, which is the primary key for the entity. Gets the ID of the asynchronous job for publishing a duplicate detection rule. Type: GuidThe ID of the asynchronous job for publishing a duplicate detection rule. This property is read-only. Gets or sets the target product family record that you want to publish along with its child records. Type The target product family record that you want to publish along with its child records. Gets or sets the theme record to publish and set as the current theme. Type: Gets or sets the XML that defines which solution components to publish in this request. Required. Type: Stringthe XML that defines which solution components to publish in this request. Required. Use the Publish request schema to compose the correct XML to pass for this parameter. You can publish the following solution components:EntitiesUse the logical name of the entity. The following example publishes just the account entity including any attributes, ribbons or forms associated with it.<importexportxml> <entities> <entity>account</entity> </entities> </importexportxml>RibbonsPublishes the Application Ribbon. You do not need to specify any value. The application ribbon will be published as long as the <ribbon> node is present.<importexportxml> <ribbons> <ribbon></ribbon> </ribbons> </importexportxml>DashboardsPublishes the SystemForm (dashboard) for the ID value passed.<importexportxml> <dashboards> <dashboard>{DEDBADA0-1C50-4E0B-BC88-5CE4225D6561}</dashboard> </dashboards> </importexportxml>Option SetsPublishes an optionset using the optionset unique name.<importexportxml> <optionsets> <optionset>sample_customoptionset</optionset> </optionsets> </importexportxml>Site MapPublishes the SiteMap. Since there is only one sitemap it is not necessary to pass a value.<importexportxml> <sitemaps> <sitemap></sitemap> </sitemaps> </importexportxml>Web ResourcesPublishes a Web resource using the web resource id value.<importexportxml> <webresources> <webresource>{025225B2-CF33-4CDB-8ACD-C6205404191E}</webresource> </webresources> </importexportxml>The following example publishes the account and contact entity together with two Web resources.<importexportxml> <entities> <entity>account</entity> <entity>contact</entity> </entities> <webresources> <webresource>{025225B2-CF33-4CDB-8ACD-C6205404191E}</webresource> <webresource>{6B72CB14-D27D-4197-B494-C1A06C977C41}</webresource> </webresources> </importexportxml> Gets or sets a value that indicates whether to create an account from the originating lead. Required. Type: BooleanIndicates whether to create an account from the originating lead. , to create an account; otherwise, . Gets or sets a value that indicates whether to create a contact from the originating lead. Required. Type: BooleanIndicates whether to create a contact from the originating lead. , to create a contact; otherwise, . Gets or sets a value that indicates whether to create an opportunity from the originating lead. Required. Type: BooleanIndicates whether to create an opportunity from the originating lead. , to create an opportunity; otherwise, . Gets or sets the ID of the lead that is qualified. Required. Type: The ID of the lead that is qualified. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the currency to use for this opportunity. Required. Type: The currency to use for this opportunity. Gets or set the account or contact that is associated with the opportunity. Required. Type: The account or contact that is associated with the opportunity. Gets or sets the source campaign that is associated with the opportunity. Required. Type: The source campaign that is associated with the opportunity. Gets or sets the status of the lead. Required. Type: The status of the lead. The property corresponds to the attribute of the entity. It is shown as the Status Reason in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system sets the appropriate corresponding status value. For a list of status values, see the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. For more information, see Record state and status. Gets the collection of references to the newly created account, contact, and opportunity records. Type: The collection of references to the newly created account, contact, and opportunity records. Gets or sets the ID of the list to qualify. Required. Type: GuidThe ID of the list to qualify. This corresponds to the attribute, which is the primary key for the entity. Gets or sets an array of IDs of the members to qualify. Required. Type: Guid[]The array of IDs of the members to qualify. The list members can be accounts, contacts, or leads. Each element of the array corresponds to the property, property, or property, which is the primary key for the corresponding entity. Gets or sets a value that indicates whether to override or remove the members from the list. Required. Type: BooleanIndicates whether to override or remove the members from the list. , to override; , to remove. Gets or sets the query to convert. Type: The query to convert. Retrieve data with queries using SDK assemblies Gets the results of the query conversion. Type: StringThe results of the query conversion. This returned value conforms to the schema for FetchXML. Build queries with FetchXMLFetchXML schema Gets or sets the end time for the scheduled block of time. Required. Type: DateTimeThe end time for the scheduled block of time. Gets or sets the IDs of the resources. Required. Type: GuidThe IDs of the resources. Each element of the array corresponds to the attribute, which is the primary key for the entity. The number of resource IDs and time codes must match. Gets or sets the start of the time slot. Required. Type: DateTimeThe start of the time slot. Gets or sets the time codes to look for: Available, Busy, Unavailable, or Filter, which correspond to the resource IDs. Required. Type: The time codes to look for: Available, Busy, Unavailable, or Filter, which correspond to the resource IDs. The number of resource IDs and time codes must match. Gets the results of the search, which is a set of possible time block for each resource. Type: The results of the search. Contains an array of possible time slots for each of the specified resource IDs in the class. Gets or sets the end of the time slot. Type: DateTimeThe end of the time slot. Gets or sets the ID of the resource. Type: GuidThe ID of the resource. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the start of the time slot. Type: DateTimeThe start of the time slot. Gets or sets the time codes to look for: Available, Busy, Unavailable, or Filter. Type: The time codes to look for: Available, Busy, Unavailable, or Filter. Gets the results of the search, a set of possible time slots for the resource. Type: The results of the search. Contains an array of possible time slots for each of the resource IDs specified in the request class. Gets or sets the security principal (user or team) for which to reassign all records. Type: The security principal (user or team) for which to reassign all records. This must be an entity reference for the entity or entity. Gets or sets the security principal (user or team) that will be the new owner for the records. Type: The security principal (user or team) that will be the new owner for the records. This must be an entity reference for the entity or entity. Gets or sets the security principal (user or team) that is the new owner for the records. Type: The security principal (user or team) that is the new owner for the records. This must be an entity reference for the entity or entity. Gets or sets the ID of the user for which you want to reassign all records. Type: GuidThe ID of the user for which you want to reassign all records. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the target record for the recalculate operation. Required. Type: The target record for the recalculate operation. This must be an entity reference for the entity. Gets or sets the relationship name before the change occurs. Type: StringThe relationship name. Provides the collection of relationship records that were added or removed. Type: <>The collection of records. Gets or sets the id of the queue item. Required. Type: Guid The queue item. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the queue item to remove from the queue. Required. The property corresponds to the attribute, which is the primary key for the entity. Type: Guid The QueueItemId. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the campaign activity. Required. Type: GuidThe ID of the campaign activity. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the item to be removed from the campaign activity. Required. Type: GuidThe ID of the item to be removed from the campaign activity. This corresponds to the property, which is the primary key for the intersect entity. CampaignActivityItem intersect entity metadata Gets or sets the ID of the campaign. Required. Type: GuidThe ID of the campaign. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the item to be removed from the campaign. Required. Type: GuidThe ID of the item to be removed from the campaign. This corresponds to the property, which is the primary key for the intersect entity. CampaignItem intersect entity metadata Gets or sets the ID of the member to be removed from the list. Required. Type: GuidThe ID of the member to be removed from the list. This corresponds to the attribute, which is the primary key for the intersect entity. ListMember intersect entity metadata Gets or sets the ID of the list. Required. Type: GuidThe ID of the list. This corresponds to the attribute, which is the primary key for the entity. Gets or sets an array of IDs of the users to be removed from the team. Type: Guid[]The array of IDs of the users to be removed from the team. Each element of the array corresponds to the property, which is the primary key for the entity. Gets or sets the ID of the team. Type: GuidThe ID of the team. This corresponds to the property, which is the primary key for the entity. Gets or sets the target systemuser (user) record for the operation. Type: The target systemuser (user) record for the operation. This must be an entity reference to a systemuser (user) record. Gets or sets the ID of the privilege that is to be removed from the existing role. Type: GuidThe ID of the privilege that is to be removed from the existing role. This corresponds to the property, which is the primary key for the entity. Gets or sets the ID of the role from which the privilege is to be removed. Type: GuidThe ID of the role from which the privilege is to be removed. This corresponds to the property, which is the primary key for the entity. Gets or sets the ID of the kit from which the product is to be removed. Type: GuidThe ID of the kit from which the product is to be removed. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the product being removed from the kit. Type: GuidThe ID of the product being removed from the kit. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the target records from which you want to remove specific related records. Type: The the target records from which you want to remove specific related records. This array must contain a set of entity references where the entities participate in a relationship. Gets or sets the ID of the solution component. Required. Type: GuidThe ID of the solution component. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the value that represents the solution component that you want to add. Required. Type: Int32The value that represents the solution component that you want to add. Required. The enumeration defines the supported range of values for this property. You can access the available values by including the file SampleCode\CS\HelperCode\OptionSets.cs or SampleCode\VB\HelperCode\OptionSets.vb in your project. These values are defined by the global option set Component Type (componenttype). Gets or sets the value of the attribute of the solution for which you want to add the solution component. Required. Type: StringThe value of the attribute of the solution for which you want to add the solution component. Required. Gets the ID value of the solution component that was removed. Type: GuidThe ID value of the solution component that was removed. This corresponds to the attribute, which is the primary key for the entity. Deprecated. Use the entity. Type: Guid Deprecated. Use the entity. Type: Guid Gets or sets the record for which the access team is auto created. Required. Type: The record for which the access team is auto created, which must be an entity reference for an entity that is enabled for access teams. To enable an entity for the auto created access teams, set the attribute to . Gets or sets the ID of system user (user) to remove from the auto created access team. Required. Type: GuidThe ID of the system user (user) that corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of team template which is used to create the access team. Required. Type: GuidThe ID of the team template that corresponds to the attribute, which is the primary key for the entity. Gets the ID of the auto created access team. Type: GuidThe ID of the auto created access team, which corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the contract to be renewed. Required. Type: GuidThe ID of the contract to be renewed. This corresponds to the attribute, which is the primary key for the entity. Gets or sets a value that indicates whether the canceled line items of the original contract should be included in the renewed contract. Required. Type: BooleanIndicates whether the canceled line items of the original contract should be included in the renewed contract. to include canceled line items; otherwise, . The default is . Gets or sets the status of the contract. Type: Int32The status of the contract. The property corresponds to the attribute of the entity. It is shown as the Status Reason in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system sets the appropriate corresponding status value. For a list of the status values, see the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. For more information, see Record state and status. Gets the resulting contract. Type: The resulting contract. This is an instance of the class. Gets or sets the id of the entitlement to renew. Type: Guid The Entitlement Id. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the value for the renewed Entitlement. Type: Int32 The status value for the renewed Entitlement. The default values for the Entitlement entity are: Value Label 0 Draft 1 Active 2 Cancelled 3 Expired Gets the renewed entitlement. Type: The renewed entitlement. Gets or sets an array that contains the IDs and depths of the privileges that replace the existing privileges. Type: The array that contains the IDs and depths of the privileges that replace the existing privileges. Gets or sets the ID of the role for which the privileges are to be replaced. Type: GuidThe ID of the role for which the privileges are to be replaced. This corresponds to the property, which is the primary key for the entity. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the ID of the required resource. Type: Guid The ID of the required resource. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the required resource specification. Type: Guid The ID of the required resource specification. This corresponds to the attribute, which is the primary key for the entity. For internal use only. Type: Boolean. Gets or sets the target of the reschedule operation. Type: The the target of the reschedule operation. This is an entity reference for an entity that supports this message. For a list of supported entity types, see . For internal use only. Type: Object. Gets the validation results for the appointment, recurring appointment master, or service appointment (service activity). Type: The validation results for the appointment, recurring appointment master, or service appointment (service activity). Gets or sets the type of filters to set. Required. Type: Int32The type of filters to set. Use, or . Gets or sets the display name for the resource. Type: String The display name for the resource found in the attribute. Gets or sets the logical name of the entity. Type: String The logical name of the entity. For a list of entity names see, Organization service entities. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the ID of the record that has a scheduling problem. Type: Guid The ID of the record that has a scheduling problem. Gets or sets the target for which the data is to be retrieved. Required. Type: The target for which the data is to be retrieved. This property must be a reference to a record of the entity or the entity type. Gets the absolute URL of the object that is specified in the request. Type: String The absolute URL of the object that is specified in the request. Gets the SharePoint site collection URL of the object that is specified in the request. Type: String The SharePoint site collection URL of the object that is specified in the request. For SharePoint Server 2010 or SharePoint Server 2010 Online: This property has a value only if: The List Component is installed on the SharePoint site collection on the target SharePoint Server. The location record for the parent SharePoint site collection exists in Microsoft Dynamics 365. In addition, the . attribute must be set to you create the parent location record. Otherwise, a blank value is returned. For SharePoint Server 2007: A blank value is returned. Gets or sets the set of attributes to retrieve. Required. Type: The set of attributes to retrieve. Assign null to this property to retrieve only the primary key. The non-null values are returned for the attributes specified in the column set. The attributes not included in the will contain null values. If the includes attributes that are not valid for retrieve, they will be ignored. To learn which attributes are valid for retrieve, see the the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. Gets or sets the ID of the system user (user). Type: GuidThe ID of the system user (user). This corresponds to the property, which is the primary key for the entity. Gets the resulting collection of all users that report to the specified system user. Type: The resulting collection of all users that report to the specified system user. Gets a compressed file that defines the ribbon. Type: Byte[]a compressed file that defines the ribbon. To extract the XML data from the compressed file, you have to use the System.IO.Packaging.ZipPackage class. The following example is a helper method that is included in the SDK sample that you can find at SampleCode\CS\Client\Ribbon\ExportRibbonXml. ExportRibbonXml#ExportRibbonXml2 Gets or sets the attribute’s logical (schema) name. Required. Type: StringThe logical name of the attribute. Gets or sets the paging information. Optional. Type: The paging information. Specifies a number of pages and a number of entity instances per page to return from the query. Page large result sets with FetchXMLPage large result sets with QueryExpression Gets or sets the target audit record for which to retrieve attribute change history. Required. Type: The target record. This must be an entity reference for an entity. Gets the attribute change history that results in a collection of audit details. Type: The collection of audit details. Gets or sets the ID of the record to retrieve. Required. Type: GuidThe ID of the record to retrieve. You can obtain the GUID of an record by using the , , and classes. Audit entity messages and methods Gets the details of the audited data changes. Type: The audit details. Cast the reference to the appropriate audit detail type; for example, cast to the class. For more information, see the class. Gets the collection of audit partition details. Type: The collection of audit partition details. Gets an array of locale ID values representing the language packs that are installed on the server. Type: Int32[]An array of locale id values representing the language packs that are installed on the server. Valid locale ID values can be found at Locale ID (LCID) Chart. Gets or sets the set of attributes to retrieve. Required. Type: The set of attributes to retrieve. Assign null to this property to retrieve only the primary key. The non-null values are returned for the attributes specified in the column set. The attributes not included in the will contain null values. If the includes attributes that are not valid for retrieve, they will be ignored. To learn which attributes are valid for retrieve, see the the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. Gets or sets the ID of the business unit. Required. Type: GuidThe ID of the business unit. This corresponds to the property, which is the primary key for the entity. Gets the resulting collection of all business units in the business unit hierarchy. Type: The the resulting collection of all business units in the business unit hierarchy. Gets or sets the query for the operation. Type: The query for the operation. The query must specify the entity name "resource" and a column set. Any other specified conditions are merged (by using the AND operator) with the conditions that are needed to retrieve the resources for the specified resource group. If the column set includes attributes where is false, they are ignored and the message response contains no data for those attributes. Gets or sets the ID of the resource group. Type: GuidThe ID of the resource group. This corresponds to the property, which is the primary key for the entity. Gets the resulting collection of all resources that are related to the specified resource group. Type: The resulting collection of all resources that are related to the specified resource group. Gets or sets the query for the operation. Type: The query for the operation. The query must specify the entity name "resourcegroup" and a column set. Any other specified conditions are merged (by using the AND operator) with the conditions that are needed to retrieve the resource groups for the specified resource. If the column set includes attributes where is false, they are ignored and the message response contains no data for those attributes. Gets or sets the ID of the resource. Type: GuidThe ID of the resource. This corresponds to the property, which is the primary key for the entity. Gets the resulting collection of all resource groups (scheduling groups) that contain the specified resource. Type: The resulting collection of all resource groups (scheduling groups) that contain the specified resource. Gets or sets the query for the operation. Type: The query for the operation. The query must specify the entity name "service" and a column set. Any other specified conditions are merged (by using the AND operator) with the conditions that are needed to retrieve the services for the specified resources. If the column set includes attributes where is false, they are ignored and the message response contains no data for those attributes. Gets or sets an array of IDs for the specified set of services. Type: Guid[]The array of IDs for the specified set of services. Each element of the array corresponds to the property, which is the primary key for the entity. Gets the resulting collection of all related services for the specified set of services. Type: The resulting collection of all related services for the specified set of services. Gets or sets the ID of the product. Required. Type: GuidThe ID of the product. This corresponds to the attribute, which is the primary key for the entity. Gets the resulting collection of articles about the specified product from the knowledge base of articles for your organization. Type: The resulting collection of articles about the specified product from the knowledge base of articles for your organization. Gets or sets the ID of the subject. Required. Type: GuidThe ID of the subject. This corresponds to the attribute, which is the primary key for the entity. Gets the resulting collection of knowledge base articles about the specified subject. Type: The resulting collection of knowledge base articles about the specified subject. Type: Guid Type: Gets or sets the access type of the organization’s service endpoint. Type: The access type. Gets detailed information about the current organization. Type: The details about the organization. Gets or sets the value for the component type that you want to delete. Required. Type: Int32The value for the component type that you want to delete. Required. The enumeration defines the supported range of values for this property. You can access the available values by including the file SampleCode\CS\HelperCode\OptionSets.cs or SampleCode\VB\HelperCode\OptionSets.vb in your project. These values are defined by the global option set Component Type (componenttype). Gets or sets the ID of the solution component that you want to delete. Required. Type: GuidThe ID of the solution component that you want to delete. This corresponds to the attribute, which is the primary key for the entity. Gets a collection of records where the and attributes represent those components that can prevent the solution component from being deleted. Type: The collection of records where the and attributes represent those components that can prevent the solution component from being deleted.. Gets or sets the name of the managed solution. Required. Type: StringThe name of the managed solution. Required. Gets a collection of records where the and attributes represent the components that can prevent you from deleting the solution. Type: A collection of records where the and attributes represent the components that can prevent you from deleting the solution. Gets or sets the value that represents the solution component. Required. Type: Int32The value that represents the solution component. Required. The enumeration defines the supported range of values for this property. You can access the available values by including the file SampleCode\CS\HelperCode\OptionSets.cs or SampleCode\VB\HelperCode\OptionSets.vb in your project. These values are defined by the global option set Component Type (componenttype). Gets or sets the ID of the solution component that you want to check. Required. Type: GuidThe ID of the solution component that you want to check. This corresponds to the attribute, which is the primary key for the entity. Gets a collection of records where the and attributes represent the components that can prevent you from deleting the solution component. Type: A collection of records where the and attributes represent the components that can prevent you from deleting the solution component. Gets the license type. Type: StringThe license type. Gets an array of locale ID values representing disabled language packs that are installed on the server. Type: Int32[]An array of locale ID values representing disabled language packs that are installed on the server. Valid locale ID values can be found at Locale ID (LCID) Chart. Gets or sets a record for which the duplicates are retrieved. Required. Type: The record for which the duplicates are retrieved. Gets or sets a name of the matching entity type. Required. Type: StringThe name of the matching entity type. A duplicate of a contact can be a lead that has the same address. The lead in this case is a matching entity type. Gets or sets a paging information for the retrieved duplicates. Required. Type: The paging information for the retrieved duplicates. Gets a collection of duplicate entity instances. Type: The collection of duplicate entity instances. Gets or sets the logical name of an entity in order to retrieve a ribbon definition. Required. Type: StringThe logical name of an entity in order to retrieve a ribbon definition. Required. Gets or sets a filter to retrieve a specific set of ribbon definitions for an entity. Required. Type: A filter to retrieve a specific set of ribbon definitions for an entity. Required. Gets a compressed file that contains the ribbon definitions. Type: Byte[]A compressed file that contains the ribbon definitions.. To extract the XML data from the compressed file, you have to use the System.IO.Packaging.ZipPackage class. The following example is a helper method that is included in the SDK sample that is found at SampleCode\CS\Client\Ribbon\ExportRibbonXml. ExportRibbonXml#ExportRibbonXml2 Gets or sets the end date of the range in UTC. Type: DateTimeThe end date of the range in UTC. Gets or sets the start date of the range in UTC. Type: DateTimeThe start date of the range in UTC. Gets the Exchange appointments returned by the request Type: A collection of Exchange appointments which use the structure of Dynamics 365 appointments. Although this data is returned using the structure of Dynamics 365 appointment, they do not represent data from Dynamics 365. This data comes from Exchange. Gets or sets the ID of the currency. Required. Type: GuidThe ID of the currency. This corresponds to the attribute, which is the primary key for the entity. Gets the exchange rate for the currency. Type: DecimalThe exchange rate for the currency. Gets or sets the logical name for the entity. Required. Type: StringThe logical name for the entity. Required. Gets or sets the type of form. Required. Type: The type of form. Required. The property corresponds to the attribute. It specifies the possible types of records.. Gets or sets the ID of the user. Required. Type: GuidThe ID of the user. This corresponds to the attribute, which is the primary key for the entity. Gets a collection of entity references. Type: A collection of entity references. Gets or sets the GUID of an import job. Required. Type: GuidThe GUID of an import job. This corresponds to the attribute, which is the primary key for the entity. ImportJob entity messages and methods Gets the formatted results of the import job. Type: StringThe formatted results of the import job. The results are returned in Microsoft Excel format. For internal use only. Type: StringFor internal use only. For internal use only. Type: Int32For internal use only. For internal use only. Type: Int32For internal use only. For internal use only. Type: StringFor internal use only. For internal use only. Type: GuidFor internal use only. Gets an array of locale ID values that represent the installed language packs. Type: Int32[]An array of locale ID values that represent the installed language packs. Valid locale ID values can be found at Locale ID (LCID) Chart. Gets or sets the value that represents the locale ID for the language pack. Required. Type: Int32The value that represents the locale ID for the language pack. Required. Valid locale ID values can be found at Locale ID (LCID) Chart. Gets the version number of the installed language pack. Type: StringThe version number of the installed language pack. The version information is in the format major.minor.build.revision, for example: 5.x.xxxx.x. Gets or sets the access mode for retrieving the license information. Type: Int32The access mode for retrieving the license information. Use one of the option set values for . For a list of these values, the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. Gets the number of unused licenses. Type: Int32The number of unused licenses. Gets the number of licenses that have been granted to users. Type: Int32The number of licenses that have been granted to users. Gets or sets the name of the attribute for which to retrieve the localized labels. Required. Type: StringThe name of the attribute for which to retrieve the localized labels. Required. Gets or sets the entity. Required. Type: The entity. Required. Gets or sets whether to include unpublished labels. Required. Type: Booleantrue if unpublished labels should be included; otherwise, false. This property doesn’t apply when retrieving localized labels for localizable property values. More information: Localize product property values. Gets the label for the requested entity attribute. Type: The label for the requested entity attribute. Gets or sets the mailbox ID of the user for which you want to retrieve the folder-level tracking rules. Returns StringThe mailbox ID of a user. Gets a collection of folder-level tracking rules for a mailbox containing Exchange folder and entity record mapping. Returns Collection of folder-level tracking rules. Gets or sets the ID of the bulk operation. Required. Type: GuidThe ID of the bulk operation. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the source for a bulk operation. Required. Type:Int32The source for a bulk operation. The return value for this property is a enumeration type. Gets or sets which members of a bulk operation to retrieve. Required. Type: Int32Describes which members of a bulk operation to retrieve. The return value for this property is an type. Gets or sets the query for the retrieve operation that can be used to break up large data sets into pages. Optional. Type: The query for the retrieve operation that can be used to break up large data sets into pages. Assign an instance of the , , or class. The query must specify the entity name “bulkoperation” and a column set. If the column set includes attributes where is or for which you do not have access, they are ignored and the message response contains no data for those attributes. You can find this information in the metadata for your organization. See the preceding metadata browser information. This optional property is recommended for use if you are likely to return a large number of results and want to avoid a time-out. Use the property or property to retrieve subsequent pages of data. For more information, see Page large result sets with QueryExpression. Build queries with QueryExpression Gets the collection of members of a bulk operation. Type: The collection of members of a bulk operation. Deprecated. Type: Guid Deprecated. Type: Deprecated. Use the class and its associated response class. Type: Gets or sets a file for a solution. Required. Type: Byte[]A file for a solution Use File.ReadAllBytes Method to convert the file from disk into a byte array. Gets an array of records. Type: []An array of records. Gets or sets the name of the solution. Required. Type: StringThe name of the solution. Required. Gets an entity collection that represents the solution components that the solution requires in the target system. Type: An entity collection that represents the solution components that the solution requires in the target system. Gets the data that describes the resources used by an organization. Type: The data that describes the resources used by an organization. Gets or sets the query for the operation. Type: The query for the operation. The query must specify the entity name "resourcegroup" and a columnset. If the column set includes attributes that are not valid for retrieve, they will be ignored. Gets or sets the ID of the resource group. Type: GuidThe ID of the resource group. This corresponds to the property, which is the primary key for the entity. Gets the resulting collection of parent resource groups for the specified resource group (scheduling group). Type: The resulting collection of parent resource groups for the specified resource group (scheduling group). Gets or sets the ID of the import file that is associated with the parse table. Required. Type: GuidThe ID of the import file that is associated with the parse table. This property corresponds to the attribute, which is the primary key for the entity. Gets or sets the paging information for the retrieved data. Required. Type: The paging information for the retrieved data. Gets the parsed data. Type: StringThe parsed data. The returned data has the same column order as the column order in the source file. Gets or sets, for retrieval, the number of comments per post. Required. Type: Int32The number of comments per post to retrieve. The maximum number of retrieved comments, per post, is 50; the minimum number is 0. Gets or sets the end date and time of the posts that you want to retrieve. Optional. Type: DateTimeThe end date and time of the posts that you want to retrieve. If specified, the posts that were created on or before the specified end date and time are retrieved. Gets or sets, for retrieval, a specific page of posts that is designated by its page number. Required. Type: Int32The specific page of posts that is designated by its page number. The page number for the first page is 1. If you specify a value of 0, it is treated as a value of 1. Gets or sets, for retrieval, the number of posts per page. Required. Type: Int32The number of posts per page. The maximum number of retrieved posts, per page, is 100; the minimum number is 1. Gets or sets a value that specifies the source of the post. Optional. Type: The value that specifies the source of the post. Use this property to filter the posts by their source type, such as an auto post or a manual post (user post). The following table contains the valid values for this property. Value Description 1 Auto post 2 Manual post Gets or sets the start date and time of the posts that you want to retrieve. Optional. Type: DateTimeThe start date and time of the posts that you want to retrieve. If specified, only the posts that were created on or after the specified date and time are retrieved. Reserved for future use. Type: . Gets the collection of posts with their associated comments and the calculated attribute values. Type: The collection of posts with their associated comments and the calculated attribute values. The associated comments are returned in the for each post. This property returns the following calculated attributes: (Integer), (Boolean), and (Boolean) on each post; and (Boolean) on each post comment. This property also returns the (Boolean), which indicates whether there are more pages of posts to retrieve. Gets or sets the security principal (team or user) for which to return the access rights to the specified record. Type: The security principal (team or user) for which to return the access rights to the specified record. The entity reference must be a or entity. Gets or sets the target record for which to retrieve access rights. Type: The target record for which to retrieve access rights. This must be an entity reference for an entity that supports this message. For a list of supported entity types, see . Gets the access rights that the security principal (team or user) has to the specified record. Type: The access rights that the security principal (team or user) has to the specified record. Gets or sets the security principal (user or team) for which to retrieve attribute privileges. Required. Type: The security principal (user or team) for which to retrieve attribute privileges. This must be a reference to a or entity. Gets the collection of attribute privileges for the security principal (user or team). Type: The collection of attribute privileges for the security principal (user or team). Returns . Returns . Gets the resulting collection of privileges. Type: The resulting collection of privileges. Gets or sets the product record for which you want to retrieve all the property instances (dynamic property instances). Type Product record for which you want to retrieve all the property instances (dynamic property instances). Gets the property instances (dynamic property instances) for a product associated to an opportunity, quote, order, and invoice. Type Property instances (dynamic property instances) for a product associated to an opportunity, quote, order, and invoice. Gets or sets the Locale Id for the language. Required. Type: Int32The Locale Id for the language. Required. Valid locale ID values can be found at Locale ID (LCID) Chart. Gets the version number of the installed language pack. Type: StringThe version number of the installed language pack. The version information is in the format major.minor.build.revision, for example: 5.x.xxxx.x. Gets an array of locale ID values that represent the provisioned languages. Type: Int32[] An array of locale ID values that represent the provisioned languages.. Valid locale ID values can be found at Locale ID (LCID) Chart. Gets or sets the paging information for the retrieved data. Required. Type: The paging information for the retrieved data. Gets or sets the target audit record. Required. Type: . This value must be an entity reference for an entity. Audit entity messages and methodsPage large result sets with FetchXMLPage large result sets with QueryExpression Contains the history of data changes for the target entity. Type: The history of data changes for the target entity. Gets or sets, for retrieval, the number of comments per post. Required. Type: Int32The number of comments per post to retrieve. The maximum number of retrieved comments, per post, is 50; the minimum number is 0. Gets or sets the end date and time of the posts that you want to retrieve. Optional. Type: DateTimeThe end date and time of the posts that you want to retrieve. If specified, the posts that were created on or before the specified end date and time are retrieved. Gets or sets the record for which to retrieve the wall. Required. Type: The record for which to retrieve the wall. This must be an entity reference for an entity that is enabled for activity feeds. Gets or sets, for retrieval, a specific page of posts that is designated by its page number. Required. Type: Int32The specific page of posts that is designated by its page number. The page number for the first page is 1. If you specify a value of 0, it is treated as a value of 1. Gets or sets, for retrieval, the number of posts per page. Required. Type: Int32The number of posts per page. The maximum number of retrieved posts, per page, is 100; the minimum number is 1. Gets or sets a value that specifies the source of the post. Optional. Type: The value that specifies the source of the post. Use this property to filter the posts by their source type, such as an auto post or a manual post (user post). The following table contains the valid values for this property. Value Description 1 Auto post 2 Manual post Gets or sets the start date and time of the posts that you want to retrieve. Optional. Type: DateTimeThe start date and time of the posts that you want to retrieve. If specified, only the posts that were created on or after the specified date and time are retrieved. Reserved for future use. Type: . Gets the collection of posts with their associated comments and the calculated attribute values. Type: The collection of posts with their associated comments and the calculated attribute values. The comments are returned in for each post. This property returns the following calculated attribute values: (Integer), LikeCount (int) (Boolean), liked (bool), and (Boolean) on each post; and (Boolean) on each post comment. This property also returns the (Boolean) attribute, which indicates whether there are more pages of posts to retrieve. Gets or sets the value that represents the solution component. Required. Type: Int32The value that represents the solution component. Required. The enumeration defines the supported range of values for this property. You can access the available values by including the file SampleCode\CS\HelperCode\OptionSets.cs or SampleCode\VB\HelperCode\OptionSets.vb in your project. These values are defined by the global option set Component Type (componenttype). Gets or sets the ID of the solution component that you want to check. Required. Type: GuidThe ID of the solution component that you want to check. Required. Gets a collection of records where the and attributes represent those components that the solution component requires. Type: a collection of records where the and attributes represent those components that the solution component requires. Gets or sets the ID of the role for which the privileges are to be retrieved. Type: GuidThe ID of the role for which the privileges are to be retrieved. This corresponds to the property, which is the primary key for the entity. Gets an array that contains the IDs and depths of the privileges that are held by the specified role. Type: The array that contains the IDs and depths of the privileges that are held by the specified role. Gets or sets the target record for which you want to retrieve security principals (users and teams) and their access rights. Type: The target record for which you want to retrieve security principals (users and teams) and their access rights. This property must be an entity reference for an entity that supports this message. For a list of supported entity types, see the class. Gets the requested security principals (teams and users) for the specified record. Type: The requested security principals (teams and users) for the specified record. Gets or sets the query for the operation. Type: The query for the operation. The query must specify the entity name "resourcegroup" and a column set. Any other specified conditions are merged (by using the AND operator) with the conditions that are needed to retrieve the resource groups for the specified resource. If the column set includes attributes where is false, they are ignored and the message response contains no data for those attributes. Gets or sets the ID of the resource group. Type: GuidThe ID of the resource group. This corresponds to the property, which is the primary key for the entity. Gets the resulting collection of child resource groups for the specified resource group (scheduling group). Type: The resulting collection of child resource groups for the specified resource group (scheduling group). Deprecated. Use the class and its members. Type: . Deprecated. Use the class and its members. Type: Guid Deprecated. Use the class and its associated response class. Type: Deprecated. Use the class and its members. Type: Deprecated. Use the class and its members. Type: Guid Deprecated. Use the class and its associated response class. Type: Gets or sets the team for which you want to retrieve privileges. Type: GuidThe team for which you want to retrieve privileges. This corresponds to the attribute, which is the primary key for the entity. Gets the list of privileges that the team holds for a record. Type: array. The list of privileges that the team holds for a record. How role-based security can be used to control access to entities in Microsoft Dynamics 365 Deprecated. Use the class and its members. Type: Deprecated. Use the class and its members. Type: Guid Deprecated. Use the class and its associated response class. Type: Gets or sets the query criteria defining the records to retrieve.Required. Type: The query criteria defining the records to retrieve. Assign an instance of the , , or class. The query must specify entity names and a column set. If the column set includes attributes where is false or that you do not have access to, they are ignored and the message response contains no data for those attributes. Gets the collection of records that satisfy the query in the request. Type: The collection of records that satisfy the query in the request. Gets or sets the collection of attributes for which non-null values are returned from a query. Required. Type: The collection of attributes for which non-null values are returned from a query. Required.. Gets or sets the target record for the operation. Required. Type: the target record for the operation. Required. This target record must be an entity reference for an entity that supports this message. For a list of supported entity types, see . Gets the unpublished record that is specified in the request. Type: The unpublished record that is specified in the request. Gets or sets the user to retrieve privileges for. Type: GuidThe user to retrieve privileges for. This corresponds to the attribute, which is the primary key for the entity. Gets an array of privileges that the user holds. Type: arrayThe array of privileges that the user holds. Gets or sets whether the response should include public queues. Type: Booleantrue if the response should include public queues; otherwise, false. Type: Guid The id of the user. This corresponds to the attribute, which is the primary key for the entity. Gets a collection of queues that match the properties of the request. Type: A collection of queues that match the properties of the request. Deprecated. Use the class and its members. Type: Deprecated. Use the class and its members. Type: Guid Deprecated. Use the class and its associated response class. Type: Gets the version number of the Microsoft Dynamics 365 Server. Type: StringThe version number of the Microsoft Dynamics 365 Server. Gets or sets the target product family, product, or bundle record for which you want to revert the changes done to its properties since it was last published. Required. Type The target product family, product, or bundle record for which you want to revert the changes done to its properties since it was last published. Gets or sets the collection of attributes to retrieve in the revised quote. Required. Type: The the collection of attributes to retrieve in the revised quote. Assign null to this property to retrieve only the primary key. The non-null values are returned for the specified attributes in the column set. The attributes that are not included in the column set contain null values. If the column set includes attributes where is , they are ignored, and the message response contains no data for those attributes. To learn which attributes are valid for retrieval, see the quote entity metadata. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. Gets or sets the ID of the original quote. Required. Type: GuidThe the ID of the original quote. This corresponds to the attribute, which is the primary key for the entity. Gets the revised quote. Type: The revised quote. This is instance of the class, which is a subclass of the class. Gets or sets a security principal (team or user) whose access you want to revoke. Required. Type: The security principal (team or user) whose access you want to revoke. Gets or sets the target record for which you want to revoke access. Required. Type: The target record for which you want to revoke access. This property value must be an entity reference for an entity that supports this message. For a list of supported entity types, see the class. Gets or sets the ID of the business unit. Type: Guid The ID of the business unit, which corresponds to the attribute, which is the primary key for the entity.. Gets or sets the depth of the privilege. Type: The depth of the privilege. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the ID of the privilege. Type: Guid The ID of the privilege, which corresponds to the attribute, which is the primary key for the entity.. The property corresponds to the attribute, which is the primary key for the entity. Gets the collection of invalid privileges for the role. Type: <Guid>The collection of invalid privileges for the role. If an attempt is made to assign a set of privileges to a role, and some of those privileges cannot be assigned, the privileges that cannot be assigned will be in this property. Gets or sets the role’s new privileges. Type: The new privileges for the role. Gets or sets the role’s old privileges. Type: The old privileges for the role. Gets or sets the query criteria for the rollup operation. Required. Type: The query criteria for the rollup operation. The query must specify entity names and a column set. If the column set includes attributes where is false, they are ignored, and the message response contains no data for those attributes. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics 365. Gets or sets the rollup type. Required. Type: The the rollup type. Use the enumeration for this property. Gets or sets the target record for the rollup operation. Required. Type The target record for the rollup operation, which must be an entity reference for an account, contact, or opportunity entity. Gets the collection of records that are related to the specified record. Type:The collection of records that are related to the specified record. Gets or sets the id of the queue item to route. Required Type: Guid The QueueItem id. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the target record to route the queue item to. Required. Type: The target record to route the queue item to. Queue items may be routed to a queue, a user, or a team Gets or sets the query criteria to find knowledge base articles with specified body text. Required. Type: The query criteria to find knowledge base articles with specified body text. Assign an instance of the class , or . The query must specify the entity name “kbarticle” and a . If the column set includes attributes that are not valid for retrieve or for which you do not have access, they will be ignored. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics 365. Retrieve data with queries using SDK assemblies Gets or sets the text contained in the body of the article. Required. Type: StringThe text contained in the body of the article. Gets or sets the ID of the knowledge base article subject. Required. Type: GuidThe ID of the knowledge base article subject. This corresponds to the attribute, which is the primary key for the entity. Gets or sets a value that indicates whether to use inflectional stem matching when searching for knowledge base articles with a specified body text. Required. Type: BooleanIndicates whether to use inflectional stem matching when searching for knowledge base articles with a specified body text. , to use inflectional stem matching, otherwise, . In inflectional stem matching, you can use word “write” as an inflectional stem of “‘write”, “writing”, “wrote” and “written”. Gets the collection of knowledge base articles that contain the specified body text. Type: The collection of knowledge base articles that contain the specified body text. Gets or sets the query criteria to find knowledge base articles with specified keywords. Required. Type: The query criteria to find knowledge base articles with specified keywords. Assign an instance of the class , or . The query must specify the entity name “kbarticle” and a . If the column set includes attributes that are not valid for retrieve or for which you do not have access, they will be ignored. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics 365. Retrieve data with queries using SDK assemblies Gets or sets the keywords in the article. Required. Type: StringThe keywords in the article. Gets or sets the ID of the knowledge base article subject. Required. Type: GuidThe ID of the knowledge base article subject. This corresponds to the attribute, which is the primary key for the entity. Gets or sets a value that indicates whether to use inflectional stem matching when searching for knowledge base articles with the specified keywords. Required. Type: BooleanIndicates whether to use inflectional stem matching when searching for knowledge base articles with the specified keywords. , to use inflectional stem matching, otherwise, . In inflectional stem matching, you can use word “write” as an inflectional stem of “write”, “writing”, “wrote” and “written”. Gets the collection of knowledge base articles that contain the specified keywords. Type: The collection of knowledge base articles that contain the specified keywords. Gets or sets the query criteria to find knowledge base articles with the specified title. Required. Type: The query criteria to find knowledge base articles with the specified title. Assign an instance of the , , or class. The query must specify the entity name “kbarticle” and a column set. If the column set includes attributes where is false or for which you do not have access, they are ignored, and the message response contains no data for those attributes. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics 365. Retrieve data with queries using SDK assemblies Gets or sets the title in the articles. Required. Type: StringThe title of the article. Gets or sets the ID of the subject for the knowledge base article. Required. Type: GuidThe ID of the knowledge base article subject. This corresponds to the attribute, which is the primary key for the entity. Gets or sets a value that indicates whether to use inflectional stem matching when you search for knowledge base articles by a specific title. Required. Type: BooleanIndicates whether to use inflectional stem matching when searching for knowledge base articles with a specified title. , to use inflectional stem matching, otherwise, . In inflectional stem matching, you can use the word “write” as an inflectional stem of “write”, “writing”, “wrote”, and “written”. Gets the collection of knowledge base articles that contain the specified title. Type: The collection of knowledge base articles that contain the specified title. Gets or sets the appointment request. Type: The appointment request. Gets the results of the search. Type: The results of the search. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe the structure that contains extra data. Gets the set of proposed appointments that meet the appointment request criteria. Type: The set of proposed appointments that meet the appointment request criteria. Gets information regarding the results of the search. Type: The information regarding the results of the search. Gets or sets the query to retrieve the recipients for the email messages. Type: The query to retrieve the recipients for the email messages. The query must specify entity names and a column set. If the column set includes attributes that are not valid for retrieve or that you do not have access to, they will be ignored. Retrieve data with queries using SDK assemblies Gets or sets the ID of the record with which the email messages are associated. Type: GuidThe ID of the record with which the email messages are associated. The property is the ID of record that is valid for the property. The property must contain the logical name of the entity type for this record. Gets or sets the type of the record with which the email messages are associated. Type: StringThe type of the record with which the email messages are associated. The property is the logical entity name of the record specified in the property. Gets or sets the sender of the email messages. Type: The sender of the email messages. The property contains the ID of record and the logical name of an entity. This must be a system user record. Gets or sets the ID of the email template to use. Type: GuidThe ID of the email template to use. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the record with which the email message is associated. Type: GuidThe ID of the record with which the email message is associated. The property is the ID of a record that is valid for the attribute. The property must contain the logical name of the entity type for this record. Gets or sets the type of the record with which the email message is associated. Type: StringThe type of the record with which the email message is associated. This must be the logical name of the entity represented by the property. Gets or sets the email record to send. Type: The the email record to send. This is an instance of an entity. Gets or sets the ID of the email template to use for the email. Type: GuidThe ID of the email template to use for the email. This corresponds to the attribute, which is the primary key for the entity. Gets the ID of the email record that was sent. Type: GuidThe ID of the email record that was sent. This corresponds to the property, which is the primary key for the entity. Gets or sets the ID of the email to send. Type: Guid The ID of the email to send, which corresponds to the attribute, which is the primary key for the entity. Gets or sets whether to send the email, or to just record it as sent. Type: Booleantrue if the email should be sent; otherwise, false, just record it as sent. Gets or sets the tracking token. Type: StringThe tracking token, which is used to correlate an email with a context. You can generate a tracking token with the message. If this property is unspecified it defaults to null. In this case, the message generates a tracking token automatically. Gets the subject line for the email message. Type: StringThe subject line for the email message. Gets or sets the ID of the fax to send. Type: GuidThe ID of the fax to send. This corresponds to the attribute, which is the primary key for the entity. Gets or sets whether to send the e-mail, or to just record it as sent. Type: BooleanIndicates whether to send the e-mail, or to just record it as sent. , to send the e-mail, otherwise, . Gets or sets the delivery priority code for the email. Type: . Used the same way as , which specifies the priority so that preferred customers or critical issues are handled quickly. You can use the helper code enumeration to get or set this value. More information: Helper code: Enumerations for option sets Gets or sets the array that contains the list of recipients for the email. Required. Type: Guid[] The array of recipients for the email. The recipients must be of the same entity type that is specified in the property. Gets or sets the type of entity that is represented by the list of recipients. Required. Type: StringThe name of the entity that is represented by the list of recipients. Set this property to the name of the entity type for the recipient list that is specified in the property. Gets or sets the ID of a record that the email is regarding. Required. Type: Guid The ID of a record that the email is regarding. This property is the ID of a record that is valid for the attribute. The property must contain the logical name of the entity type for this record. Gets or sets the type of entity that is represented by the regarding ID. Required. Type: String The name of entity that is represented by the regarding ID. This property is the logical entity name of the record that is specified in the property. Gets or sets the sender of the email. Type: The sender of the email. The property contains the ID of a record and an entity type. The return value of this property must be a system user. Gets or sets the ID of the template to be used for the email. Required. Type: Guid The ID of the template to be used for the email, which corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the business unit. Type: GuidThe ID of the business unit. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the equipment (facility/equipment). Type: GuidThe ID of the equipment (facility/equipment). This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the business unit to which the user is moved. Required. Type: GuidThe ID of the business unit to which the user is moved. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the target security principal (user) to which the instances of entities previously owned by the user are to be assigned. Required. Type: The target security principal (user) to which the instances of entities previously owned by the user are to be assigned. If this property is set to null or an empty string, an error occurs. Gets or sets the ID of the user. Required. Type: GuidThe ID of the user. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the name of the attribute. Required. Type: StringThe name of the attribute. Required. Gets or sets the entity. Required. Type: The entity. Required. Gets or sets the label. Required. Type: The label. Gets or sets the ID of the business unit. Returns . The property corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the new parent business unit. Returns . The property corresponds to the attribute, which is the primary key for the entity. Gets or sets whether the child users are to be retained. Required. Type: BooleanIndicates whether the child users are to be retained. Use to retain the child users reporting to the original user, otherwise, use (default) to update the child users to report to the original manager of the user. Gets or sets the ID of the new parent user. Required. Type: GuidThe ID of the new parent user. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the user. Required. Type: GuidThe ID of the user. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the business unit to which to move the team. Required. Type: GuidThe ID of the business unit to which to move the team. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the team. Required. Type: GuidThe ID of the team. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the new process to be set to the target entity, or null. Type: The new process to be set to the target entity, or null. Gets or sets the target entity. Type: The target entity. Gets or sets the target records of the set related action. Required. Type: The target records of the set related action. This array must contain a set of entity references where the entities participate in a relationship. Gets or sets an array of report category codes. Required. Type: Int32[]The array of report category codes. The Categories property value is used to set the attribute. The report category codes determine in which report categories the report is shown. Report Category Code Value Sales 1 Service 2 Marketing 3 Administrative 4 The report category codes and their values can be found in the Customization area of the Web application. In the Navigation Pane, click Settings, click Customizations, and then click Customize the System. In the Default Solution page, expand Entities, and then Report Related Category (reportcategory) entity. Click Fields, and double-click the categorycode attribute. In Type, click a report category, such as Sales Reports or Service Reports, to obtain the report category code value. Gets or sets an array of entity type codes for the related entities. Required. Type: Int32[]The array of entity type codes for the related entities. Organization service entities Gets or sets the ID of the report. Required. Type: GuidThe ID of the report. This corresponds to the attribute, which is the primary key for the report entity. Gets or sets an array of report visibility codes. Required. Type: Int32[]The array of report visibility codes. The Visibility property value is used to set the attribute. Gets or sets the entity. Required. Type: The entity. Gets or sets the state of the entity record. Required. Type: The state of the entity record. The property corresponds to the attribute of an entity. It specifies the possible states for an entity record. It is shown as the Status in the Microsoft Dynamics 365 application. For a list of the state values, refer to the entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.More information: Record state and status. Gets or sets the status that corresponds to the property. Required. Type: The status that corresponds to the property. The property corresponds to the attribute of an entity. It is shown as the Status Reason in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system sets the appropriate corresponding status value. For a list of the status values, refer to the entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.More information: Record state and status. Gets or sets the privileges of the user after a change. Type: The privileges of the user after a change. Gets or sets the privileges of the user before a change. Type: The privileges of the user before a change. Returns in a few cases. Gets or sets the security principal (user or team) that shares the audit detail record. Type: The user or team that shares the record. Gets or sets the status of the activity. Type: Int32The activity status code. For a list of valid status codes, see the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. Gets or sets the ID of the calendar for this block of time. Type: Guid The the ID of the calendar for this block of time, which corresponds to the attribute, which is the primary key for the entity. Gets or sets the display text shown in the calendar for the time block. Type: StringThe display text shown in the calendar for the time block.. Gets or sets the amount of effort required for this block of time. Type: Double The amount of effort required for this block of time. Gets or sets the end time for the block. Type: Nullable<DateTime> The end time for the block. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the value that indicates whether the block of time refers to an activity. Type: Booleantrue if the block of time refers to an activity; otherwise, false. Gets or sets the ID of the record referred to in the time block. Type: Guid The ID of the record, which corresponds to the primary key for the entity. Gets or sets the type of entity referred to in the time block. Type: Int32 The entity type code. For a list of all default entities and their type codes, see Organization service entities. Gets or sets the start time for the block. Type: Nullable<DateTime> The start time for the block. Gets or sets information about the time block such as whether it is an appointment, break, or holiday. Type: The information about the time block. Gets or sets the value that indicates whether the time block is available, busy, filtered or unavailable. Type: The time code. Gets or sets the list of error information for the scheduling operation. Returns []The the list of error information for the scheduling operation. Scheduling errors occur, for example, when a resource is not available for the specified appointment time. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the ID of the import (data import) that is associated with the asynchronous job that transforms the imported data. Required. Type: GuidThe ID of the import (data import) that is associated with the asynchronous job that transforms the imported data. This corresponds to the attribute, which is the primary key for the entity. Gets the ID of the asynchronous job that transforms the parsed data for this import. Type: GuidThe ID of the asynchronous job that transforms the parsed data for this import. Gets or sets the record that contains the configuration. Required. Type: The entity reference of the service endpoint record. Gets or sets the ID of the invoice. Type: GuidThe ID of the invoice. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the sales order (order). Type: GuidThe ID of the sales order (order). This corresponds to the attribute, which is the primary key for the entity. Gets or sets the ID of the duplicate rule to be unpublished. Required. Type: GuidThe ID of the duplicate rule to be unpublished. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the property instances (dynamic property instances) for a product to be updated. Type: The property instances (dynamic property instances) for a product to be updated. Gets or sets the unique identifier of the component to update. Type: GuidThe unique identifier of the component to update. Gets or sets the type of component to be updated. Type: Int32The type of component to be updated. Gets or sets a value that specifies if the component is added to the solution with its metadata. Type: String[]When set to , the component is added to the solution with metadata; otherwise passing an empty array results in no metadata settings included with the component. A future SDK release will allow you to specify a string [] of metadata settings to include with the component. Gets or sets the unique name of the solution where the component should exist. Type: StringThe unique name of the solution where the component should exist.. Deprecated. Use the class and its members. Type: . Deprecated. Use the class and its members. Type: . For internal use only. Type: DateTime For internal use only. Type: Int32 Gets or sets the local time. Required. Type: DateTimeThe the local time. Gets or sets the time zone code. Required. Type: Int32The time zone code. Gets the local time and expresses it in Coordinated Universal Time (UTC) time. Type: DateTimeThe local time expressed as Coordinated Universal Time (UTC) time. Gets or sets the recurrence rule record to validate. Type: The recurrence rule record to validate. This is an instance of the entity. Gets the description. Type: StringThe description. Gets or sets the activities to validate. The activities to validate. Each activity record in the property must have a valid value for that corresponds to the attribute, which is the primary key for the entity. Gets the results of the validate operation. Type: The results of the validate operation. Gets or sets the FetchXML query string to be validated. Type: String The FetchXML query string to be validated. Build queries with FetchXMLFetchXML schema Gets or sets the type of the query. Type: Int32 The query type, which should be one of the values in the class. Gets or sets the ID of the validated activity. Type: Guid The ID of the validated activity. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the reasons for any scheduling failures. Type: The reasons for any scheduling failures. Gets or sets the value that indicates whether the appointment or service appointment was validated successfully. Type: Booleantrue if the appointment or service appointment was validated successfully; otherwise, false. Gets the ID of the business to which the logged on user belongs. Type: GuidThe ID of the business to which the logged on user belongs. This corresponds to the attribute, which is the primary key for the entity. Gets the ID of the organization that the user belongs to. Type: GuidID of the organization that the user belongs to. This corresponds to the attribute, which is the primary key for the entity. Gets the ID of the user who is logged on. Type: GuidThe ID of the user who is currently logged on or the user under whose context the executed code is running. This corresponds to the attribute, which is the primary key for the entity. Gets or sets the opportunity close activity associated with this state change. Required. Type: The opportunity close activity associated with this state change. This must be an instance of the class, which is a subclass of the class. Gets or sets a new status of the opportunity. Required. Type: The status of the opportunity. The property corresponds to the attribute. It is shown as the Status Reason in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system will set the appropriate corresponding status value. For more information, see Record state and status. Gets or sets the quote close activity associated with this state change. Required. Type: The quote close activity associated with this state change. This must be an instance of the class, which is a subclass of the class. Gets or sets a new status of the quote. Required. Type: The new status of the quote. The property corresponds to the attribute. It is shown as the Status Reason in the Microsoft Dynamics 365 application. If you set the value of this property to -1, the system will set the appropriate corresponding status value. For more information, see Record state and status. Contains integer values that are used for the attribute. The following table shows the values that you can set for this class. Member Value Description Set bit flagsBusinessUnit entity Contains integer flags that are used for the attribute. The attribute defines how calendar rule overlap is handled during calendar rule expansion. The following table shows the values for this class. Member Value Description CalendarRule entity messages and methods Contains integer flags that are used for the attribute, used to indicate whether a list specifies accounts, contacts, or leads. The following table shows the values for this class. Member Value Description List (marketing list) entitySample: Distribute campaign activities to dynamic and static lists Contains the possible access rights for a user. This enumeration is used for the property. The security model of Microsoft Dynamics 365Set bit flags No access. Value = 0 (0x00). The right to read the specified type of record. Value = 1 (0x01). The right to update the specified record. Value = 2 (0x02). The right to append the specified record to another object. Value = 4 (0x04). The right to append another record to the specified object. Value = 16 (0x10). The right to create a record. Value = 32 (0x20). The right to delete the specified record. Value = 65536 (0x10000). The right to share the specified record. Value = 262144 (0x40000). The right to assign the specified record to another user or team. Value = 524288 (0x80000). For internal use only. For internal use only. Contains the data that is needed to add an item to a campaign activity. For the Web API use the AddItemCampaignActivity Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and on the specified entity in the property. The caller must also have access rights on the specified records in the and properties. For a complete list of the required privileges, see AddItemCampaignActivity message privileges. Notes to Callers The added item must be one of the following entity types: or . Campaign entitiesSample: Distribute campaign activities to dynamic and static listsAddItemCampaignActivity message privilegesCampaignActivityItem intersect entity metadataHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For the Web API the AddItemCampaignActivityResponse ComplexType is the response value from the AddItemCampaignActivity Action. Campaign entities Contains the data that is needed to add an item to a campaign. For the Web API use AddItemCampaign Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and on the entity that is specified in the property. The caller must also have access rights on the specified records in the and properties. For a complete list of the required privileges, see AddItemCampaign message privileges. Notes to Callers The added item must be one of the following entity types: , , , or . Campaign entitiesSample: Distribute campaign activities to dynamic and static listsSample: Distribute campaign activities to qualified marketing listAddItemCampaign message privilegesCampaignItem intersect entity metadataHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to add members to the list. For the Web API use the AddListMembersList Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and on the specified entity in the property. The caller must also have access rights on the specified records in the property and the property. For a complete list of the required privileges, see AddListMembersList message privileges. Notes for Callers The members that are added to the list must be of the same type: , , or . For example, you cannot add accounts and contacts to the same list. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Marketing#DistributeCampaignFromMarketingList6 List (marketing list) entityAddListMembersList message privilegesSample: Distribute campaign activities to qualified marketing listListMember intersect entity metadataHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to add a member to a list (marketing list). For the Web API use the AddMemberList Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and on the specified entity in the property. The caller must also have access rights on the specified records in the and properties. For a complete list of the required privileges, see AddMemberList message privileges. Notes for Callers A member that is added to the list must be of the same type: , , or . For example, you cannot add accounts and contacts to the same list. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. List newList = new List() { ListName = "TestList", CreatedFromCode = new OptionSetValue((int)ListCreatedFromCode.Account) }; _newListId = _serviceProxy.Create(newList); for (int j = 0; j < 5; j++) { AddMemberListRequest addMemberListRequest = new AddMemberListRequest(); addMemberListRequest.EntityId = _accountIdArray[j]; addMemberListRequest.ListId = _newListId; AddMemberListResponse addMemberListResponse = _serviceProxy.Execute(addMemberListRequest) as AddMemberListResponse; } Guid BOId = CreateAndRetrieveQuickCampaignForMarketingList( _templateLetterActivity, _newListId, PropagationOwnershipOptions.ListMemberOwner, true); AddMemberList message privilegesCampaign entitiesSample: Distribute a quick campaignList (marketing list) entityListMember intersect entity metadataHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For the Web API the AddMemberListResponse ComplexType is the response value from the AddMemberList Action. Contains the data that is needed to add members to a team. For the Web API use the AddMembersTeam Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see AddMembersTeam message privileges. User and team entitiesTeam entity messages and methodsAddMembersTeam message privileges Contains the response from the class. There is no return value from this operation. Contains the data to add the specified principal to the list of queue members. If the principal is a team, add each team member to the queue. For the Web API use the AddPrincipalToQueue Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see AddPrincipalToQueue message privileges. Sample: Add a security principal (user or team) to a queue (early bound)Queue entity messages and methods Contains the response from the message. There is no return value from this operation. Contains the data that is needed to add a set of existing privileges to an existing role. For the Web API use the AddPrivilegesRole Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see AddPrivilegesRole message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. strongtypes#AssignRecordToTeam2 strongtypesVB#AssignRecordToTeam2 Privilege and role entitiesRole (security role) entity messages and methodsPrivilege entity messages and methodsSample: Assign a record to a teamAddPrivilegesRole message privileges Contains the response from the class. There is no return value from this operation. Deprecated. Use the entity. Contains the data that is needed to add a product to a kit. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified records in the and properties. For a complete list of the required privileges, see AddProductToKit message privileges. Bundles and kitsProduct catalog entitiesAddProductToKit message privilegesProduct entity messages and methods Deprecated. Use the entity. Contains the response from the class. There is no return value from this operation. Bundles and kits Contains the data that is needed to add recurrence information to an existing appointment. For the Web API use the AddRecurrence Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the and entities, and access rights on the specified record in the property. For a complete list of the required privileges, see AddRecurrence message privileges. Notes for Callers When you convert an existing appointment to a recurring appointment by using this message, the data from the existing appointment is copied to a new recurring appointment master instance, and the existing appointment record is deleted. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ScheduleAndAppointment#ConvertAnAppointmenttoRecurringAppointment1 Create a recurring appointment series, instance, or exceptionRecurringAppointmentMaster entity messages and methodsAddRecurrence message privilegesSample: Convert an appointment to a recurring appointment Contains the response from the class. AddRecurrence message privilegesCreate a recurring appointment series, instance, or exception Contains the data that is needed to add a solution component to an unmanaged solution. For the Web API use the AddSolutionComponent Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of class. Privileges and Access Rights To perform this action, the caller must have the privileges that are listed in AddSolutionComponent message privileges. Notes for Callers The enumeration defines the supported range of values for this property. You can access the available values by including the SampleCode\CS\HelperCode\OptionSets.cs file or the SampleCode\VB\HelperCode\OptionSets.vb file in your project. An alternative to using this message is to create or update the solution component for a specific solution. When you use this technique, you add the solution component to both the default solution and the specified solution. You can implement the specific-solution technique in two ways. Use the parameter on the solution component create and update requests. Pass the optional parameter to the or . Use the parameter on the solution component create and update requests.For solution components that have a create or update request message that includes the property, passing the unique name of the solution adds the solution component to that solution. The following messages include a property: Pass the optional parameter to the or .For other solution components, add “SolutionUniqueName” as a parameter to the property when you use the or messages. For more information, see Pass optional parameters in messages. Supported Entities This message can only be used for valid solution components. Adding Application Ribbons to a Solution. When you use to add application ribbons to your solution, you must make sure to include the RibbonCustomization solution component that is associated with the active solution. Use the in the query expression you use to retrieve the RibbonCustomization record.QueryExpression query = new QueryExpression("ribboncustomization"); query.ColumnSet = new ColumnSet("ribboncustomizationid"); query.Criteria = new FilterExpression(); query.Criteria.AddCondition("entity", ConditionOperator.Null); query.Criteria.AddCondition("solutionid", ConditionOperator.Equal, new Guid("{FD140AAE-4DF4-11DD-BD17-0019B9312238}")); RetrieveMultipleRequest req = new RetrieveMultipleRequest(); req.Query = query; RetrieveMultipleResponse resp = (RetrieveMultipleResponse)_context.Execute(req); RibbonCustomization activeRibbonCustomization = (RibbonCustomization)resp.EntityCollection[0]; The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. The following code example adds the account entity to a solution that is specified in the property. Solutions#WorkWithSolutions5 SolutionsVB#WorkWithSolutions5 AddSolutionComponent message privilegesSample: Work with solutionsWork with solutionsSolutionComponent entity messages and methodsDependency tracking for solution componentsConstant SolutionId Values Contains the response from the message. For the Web API the AddSolutionComponentResponse ComplexType is the response value from the AddSolutionComponent Action. Deprecated. Use the class. Adds a link between two entity instances in a many-to-many relationship. AddSubstituteProduct message privileges Deprecated. Use the class and its associated response class. Contains the response from the class. Contains the data that is needed to move an entity record from a source queue to a destination queue. For the Web API use the AddToQueue Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the and entities and on the entity that is referred to in the property. You must also have access rights on the source and destination queue records and on the specified record in the property. For a complete list of required privileges, see AddToQueue message privileges. Notes for Callers Specifying the property is optional. If the record that is specified by the is not in a queue, it is added to the destination queue. If the record is already in a queue, it is moved from the queue to the destination queue. The records cannot be added to multiple queues, except for email records that have the status “Received.” However, a “Received” email record cannot be added multiple times to the same queue. Specifying the property is optional. The minimally required data for creating a queue item is provided in the and properties. However, if you want to include additional data, such as who works on the case (), or to add custom fields, you have to use the property. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#AddToQueue1 Queue entitiesSample: Add a record to a queue (early bound)AddToQueue message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For the Web API the AddToQueueResponse ComplexType is the response value from the AddToQueue Action. Contains the data that is needed to add a user to the auto created access team for the specified record. For the Web API use the AddUserToRecordTeam Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the Share privilege on the entity specified in the property. The caller must also have privileges on the entity and the entity and access rights on the records specified in the property and the property. In addition, the caller must have access rights on the record specified in the property that match access rights specified in the team template. For example, if the team template specifies the Read access right on the account entity, the caller must have the Read access right on the account record, specified in the property. For a complete list of required privileges, see AddUserToRecordTeam message privileges. AddUserToRecordTeam message privilegesUse access teams and owner teams to collaborate and share informationUser and team entitiesTeam entity messages and methodsTeamTemplate entity messages and methodsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For the Web API the AddUserToRecordTeamResponse ComplexType is the response value from the AddUserToRecordTeam Action. Contains data to apply record creation and update rules to activities in CRM created as a result of the integration with external applications. For the Web API use the ApplyRecordCreationAndUpdateRule Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the activity, and entities, and access rights on the specified record in the property. For a complete list of the required privileges, see ApplyRecordCreationAndUpdateRule message privileges. Notes to Callers The record creation and update rules in CRM enable you to automatically convert incoming activities, such as emails, custom activities, and posts, from external integrated applications (mobile applications, portals or social channels) to system or custom records in CRM. These rules can be created or edited using the web client or Microsoft Dynamics CRM for Outlook only; rule creation and update is not supported through SDK. More information: Help & Training: Automatically create records in CRM Use the message to retroactively apply a record creation and update rule to the activity that got created in CRM while the rule was inactive. To edit a rule, you need to deactivate the rule, edit the rule definition, and then reactivate the rule. While the rule is in inactive stage because its being edited, the activities from the external applications will continue to come into CRM (if you have configured an external application to integrate with CRM), but will not be acted upon as the rule is not active. Help & Training: Automatically create records in CRMhttp://go.microsoft.com/fwlink/?LinkId=533523 Contains the response from the class. Contains the data that is needed to apply the active routing rule to an incident. For the Web API use the ApplyRoutingRule Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the Target property. For a complete list of the privileges required, see ApplyRoutingRule message privileges. Incident (case) entities Contains the response from the message. There is no return value from this operation. Represents a proposed appointment time and date as a result of the message. For the Web API the corresponding type is AppointmentProposal ComplexType. Provides the details of an appointment request for the class. For the Web API the corresponding type is AppointmentRequest ComplexType. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ScheduleAndAppointment#ScheduleResource1 ScheduleAndAppointmentVB#ScheduleResource1 Sample: Search for openings to schedule a resource Specifies the appointments to ignore in an appointment request from the class. For the Web API the corresponding type is AppointmentsToIgnore ComplexType. Contains the data that is needed to assign the specified record to a new owner (user or team) by changing the OwnerId attribute of the record. This message request is deprecated. Consider using the instead. For more information see Perform specialized operations using Update. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entity in the property and access rights on the specified record in the property. For a list of the required privileges, see Assign message privileges. Notes for Callers This action applies to the parent record and the associated records that have the same owner as the parent record. Therefore, when you assign the parent record to a new owner, only the associated records that have the same owner as the parent record are also assigned. If the value of the attribute is , when a record is assigned to a new owner, it is shared with the previous owner with full rights. In this case, either the new owner or the previous owner can remove the relationship or lower the level of privileges that the previous owner has on the record. For a description of how actions on a parent record affect child records, see Cascading behavior. Supported Entities You can use this message to associate records of any two entities that participate in a relationship, including records for custom entities. You can find the default relationships listed in the Entity Metadata topic for each entity. The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available. Entity Availability Account 0 (Server) Annotation 0 (Server) Appointment 0 (Server) Campaign 0 (Server) CampaignActivity 0 (Server) CampaignResponse 0 (Server) Connection 0 (Server) Contact 0 (Server) Contract 0 (Server) ConvertRule 0 (Server) CustomerOpportunityRole 0 (Server) CustomerRelationship 0 (Server) DuplicateRule 0 (Server) Email 0 (Server) EmailServerProfile 0 (Server) Entitlement 0 (Server) Fax 0 (Server) Goal 0 (Server) GoalRollupQuery 0 (Server) ImportFile 0 (Server) ImportMap 0 (Server) Incident 0 (Server) IncidentResolution 0 (Server) Invoice 0 (Server) Lead 0 (Server) Letter 0 (Server) List 0 (Server) Mailbox 0 (Server) MailMergeTemplate 0 (Server) msdyn_PostAlbum 0 (Server) msdyn_wallsavedqueryusersettings 0 (Server) Opportunity 0 (Server) OpportunityClose 0 (Server) OrderClose 0 (Server) PhoneCall 0 (Server) ProcessSession 0 (Server) Queue 0 (Server) Quote 0 (Server) QuoteClose 0 (Server) RecurringAppointmentMaster 0 (Server) Report 0 (Server) RoutingRule 0 (Server) SalesOrder 0 (Server) ServiceAppointment 0 (Server) SharePointDocumentLocation 0 (Server) SharePointSite 0 (Server) SLA 0 (Server) SLAKPIInstance 0 (Server) SocialActivity 0 (Server) SocialProfile 0 (Server) Task 0 (Server) Template 0 (Server) UserForm 0 (Server) UserQuery 0 (Server) UserQueryVisualization 0 (Server) Workflow 0 (Server) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. StrongTypes#Assign1 Actions on entity recordsEntity ownershipSample: Assign a record to a new ownerSample: Assign a record to a team Contains the response from the . There is no return value from this operation. Assign message privilegesSample: Assign a record to a new owner Deprecated. Use the class. Contains the data that is needed to add a link between two entity instances in a many-to-many relationship. Deprecated. Use the class and its associated response class. Contains the response from the class. Contains the details of changes to entity attributes. Sample: Audit entity data changes Provides a base class for storing the details of data changes. When you cast an object of this type, use one of its specialized (derived) types: , , , or . Contains a collection of objects. Identifies a Microsoft SQL Server partition that is used to store changes to entity data records. For the Web API the corresponding type is AuditPartitionDetail ComplexType. You can use this class only on Microsoft SQL Servers that support partitioning, such as the Enterprise edition. Contains a data collection of objects. Contains the data that is needed to generate a new set of attribute mappings based on the metadata. For the Web API use the AutoMapEntity Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the privileges that are listed in AutoMapEntity message privileges. Notes for Callers Use this helper function after you create a new relationship. This message is provided as a productivity enhancement so that you don’t have to manually add all attribute mappings. Instead, you can generate a set of likely mappings and minimize the amount of manual work to add or remove individual mappings to meet your requirements. This message will map all the attributes between the two related entities where the attribute names are identical and the types are identical. The mapping may result in some mappings that you don’t want; therefore, you should always check the resulting mapping before you publish the customization. If you use this function where entity mappings already exist, the existing mappings are removed. Customize entity and attribute mappingsAutoMapEntity message privileges Contains the response from the class. There is no return value from this operation. Contains the data that is needed to send email messages asynchronously. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the email entity and access rights on the records returned from the query. For a complete list of the privileges required, see BackgroundSendEmail message privileges. Email activity entitiesEmail entity messages and methods Contains the response from the class. BackgroundSendEmail message privilegesEmail entity messages and methods Contains the data that is needed to schedule or “book” an appointment, recurring appointment, or service appointment (service activity). For the Web API use the Book Action. Web API support for this message was added with Microsoft Dynamics CRM Online 2016 Update 1 and Microsoft Dynamics CRM 2016 Service Pack 1 Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entity in the property and access rights on the specified record in the property. For a complete list of the required privileges, see Book message privileges. Supported Entities The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available. Entity Availability appointment Server recurringappointmentmaster Server serviceappointment Server The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ScheduleAndAppointment#BookAppointment1 Schedule and appointment entitiesCreate a recurring appointment seriesSample: Book an appointment Contains the response from the class. Book message privilegesSample: Book an appointment Contains the data that’s needed to submit a bulk delete job that deletes selected records in bulk. This job runs asynchronously in the background without blocking other activities. For the Web API use the BulkDelete Action. Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have read access rights on the entity records that are specified in the request class. The caller must also have Delete message privileges for the entity types being deleted. For a complete list of the required privileges, see BulkDelete message privileges. Notes for Callers By default, a system administrator has the privileges for bulk deletions. Other users must be granted the privileges before they can perform a bulk deletion. When a record is deleted, all its child records are also deleted. The entire deletion fails if the caller doesn’t have delete privileges or access rights to perform bulk deletions for any of these records. The deletion order of the related records depends on the cascade configuration for each entity relationship. For a description of how actions on a parent record can affect related records, see Entity relationship behavior. Supported Entities You can delete the records in bulk of an entity that supports the message, including custom entities. The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available. Entity Availability account Server activitymimeattachment Server annotation Server annualfiscalcalendar Server appointment Server asyncoperation Server attributemap Server bulkdeleteoperation Server bulkoperation Server businessunit Server businessunitnewsarticle Server calendar Server campaign Server campaignactivity Server campaignresponse Server columnmapping Server competitor Server connection Server connectionrole Server connectionroleobjecttypecode Server constraintbasedgroup Server contact Server contract Server contractdetail Server contracttemplate Server customeraddress Server customeropportunityrole Server customerrelationship Server discount Server discounttype Server duplicaterule Server duplicaterulecondition Server email Server equipment Server fax Server fieldpermission Server fieldsecurityprofile Server fixedmonthlyfiscalcalendar Server goal Server goalrollupquery Server import Server importdata Server importentitymapping Server importfile Server importjob Server importmap Server incident Server incidentresolution Server invoice Server invoicedetail Server isvconfig Server kbarticle Server kbarticlecomment Server kbarticletemplate Server lead Server letter Server list Server lookupmapping Server mailmergetemplate Server metric Server monthlyfiscalcalendar Server opportunity Server opportunityclose Server opportunityproduct Server orderclose Server ownermapping Server phonecall Server picklistmapping Server pluginassembly Server plugintype Server pricelevel Server principalobjectattributeaccess Server processsession Server product Server productpricelevel Server publisher Server publisheraddress Server quarterlyfiscalcalendar Server queue Server queueitem Server quote Server quoteclose Server quotedetail Server recurrencerule Server recurringappointmentmaster Server relationshiprole Server relationshiprolemap Server report Server reportcategory Server reportentity Server reportvisibility Server resourcespec Server role Server rollupfield Server salesliterature Server salesliteratureitem Server salesorder Server salesorderdetail Server savedquery Server savedqueryvisualization Server sdkmessageprocessingstep Server sdkmessageprocessingstepimage Server sdkmessageprocessingstepsecureconfig Server semiannualfiscalcalendar Server service Server serviceappointment Server serviceendpoint Server sharepointdocumentlocation Server sharepointsite Server site Server solution Server subject Server systemform Server task Server team Server template Server territory Server transactioncurrency Server transformationmapping Server transformationparametermapping Server uom Server uomschedule Server userentityinstancedata Server userentityuisettings Server userform Server userquery Server userqueryvisualization Server webresource Server webwizard Server wizardaccessprivilege Server wizardpage Server workflow Server workflowdependency Server workflowlog Server The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BulkDelete#BulkDelete BulkDeleteVB#BulkDelete Delete data in bulkSample: Bulk delete exported recordsSample: Bulk delete records that match common criteriaBulkDelete message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to submit an asynchronous system job that detects and logs multiple duplicate records. For the Web API use the BulkDetectDuplicates Action. Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have access rights on the entity records that are specified in the request class. For a complete list of the required privileges, see BulkDetectDuplicates message privileges. Notes for Callers The asynchronous system job detects multiple duplicate records and logs them as duplicate records by using the entity. Before you use this message, set the attribute for an entity to and publish all duplicate rules (duplicate detection rules) for an entity. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DuplicateDetection#BulkDetectDuplicates1 DuplicateDetectionVB#BulkDetectDuplicates1 Detect duplicate dataRun duplicate detectionSample: Detect multiple duplicate recordsBulkDetectDuplicates message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the possible sources of a bulk operation. This enumeration is used for the property. Campaign entities The bulk operation is to distribute a quick campaign to members of a list of accounts, contacts, or leads that are selected by a query. Value = 0. The bulk operation is for distributing a campaign activity to members of a list. Value = 1. For internal use only. For internal use only. For internal use only. For internal use only. Contains the data that is needed to calculate the value of an opportunity that is in the "Won" state. For the Web API use the CalculateActualValueOpportunity Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see CalculateActualValueOpportunity message privileges. Notes for Callers "Won" is one of the possible states for an opportunity. It indicates that the opportunity has been won. The state of an record is specified in the attribute. For a list of the opportunity state and status values, see the metadata for this entity. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download. For more information, see Record state and status. Opportunity entitiesCalculateActualValueOpportunity message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For the Web API the CalculateActualValueOpportunityResponse ComplexType is the response value from the CalculateActualValueOpportunity Action. Contains the data that is needed to calculate price in an opportunity, quote, order, and invoice. This is used internally for custom pricing calculation when the default system pricing is overridden. For the Web API use the CalculatePrice Action. Message Availability For this message to work, the caller must be connected to the server. Usage This message does not have any usage scenario of its own. It provides you the capability to plug in your own custom pricing calculation logic if you do not want to use the out-of-box pricing provided by Dynamics 365. To use this message, you must create a plug-in with the custom pricing logic, and register the plug-in on the message. Additionally, you must set the value of the attribute to (false) to override the system pricing engine. More information: Use custom pricing for products Privileges and Access Rights To perform this action, the caller must have privileges on the , , , and entities. Use custom pricing for productsSample: Calculate Price plug-in Contains the response from the class. There is no return value from this operation. Use custom pricing for products Contains the data that is needed to calculate the value of a rollup attribute. For the Web API use the CalculateRollupField Function. Web API support for this message was added with Microsoft Dynamics CRM Online 2016 Update 1 and Microsoft Dynamics CRM 2016 Service Pack 1. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have read privileges on the entity instance that contains the rollup field. Calculated and rollup attributes Contains the response from the class. Calculated and rollup attributes Contains the data that is needed to calculate the total time, in minutes, that you used while you worked on an incident (case). For the Web API use the CalculateTotalTimeIncident Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see CalculateTotalTimeIncident message privileges. Notes for Callers If an activity that is used to resolve the incident (case) has already been billed, those minutes are not included in the calculation of the current incident. Incident (case) entitiesSample: Close an incidentCalculateTotalTimeIncident message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For the Web API the CalculateTotalTimeIncidentResponse ComplexType is the response value from the CalculateTotalTimeIncident Function. Contains the data that is needed to cancel a contract. For the Web API use the CancelContract Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see CancelContract message privileges. Contract entitiesCancelContract message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to cancel a sales order (order). For the Web API use the CancelSalesOrder Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of the required privileges, see CancelSalesOrder message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#CancelSalesOrder Quote, order, and invoice entitiesSalesOrder (order) entity messages and methodsSample: Process quotes, sales orders and invoicesCancelSalesOrder message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. For internal use only. For internal use only. For internal use only. Contains the data that is needed to check whether the incoming email message is relevant to the Microsoft Dynamics 365 system. For the Web API use the CheckIncomingEmail Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the activity entity. For a complete list of the privileges required, see CheckIncomingEmail message privileges. Email entity messages and methodsCheckIncomingEmail message privileges Contains the response from the class. Email entity messages and methodsCheckIncomingEmail message privileges Contains the data that is needed to check whether the incoming email message should be promoted to the Microsoft Dynamics 365 system. For the Web API use the CheckPromoteEmail Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the activity entity. For a complete list of the privileges required, see CheckPromoteEmail message privileges. Email entity messages and methodsEmail activity entities Contains the response from the class. For the Web API the CheckPromoteEmailResponse ComplexType is the response value from the CheckPromoteEmail Function. Email entity messages and methodsCheckPromoteEmail message privileges Contains the data that is needed to create a solution patch from a managed or unmanaged solution. For the Web API use the CloneAsPatch Action Create patches to simplify solution updates Contains the response from executing the CloneAsPatchRequest class. For the Web API the CloneAsPatchResponse ComplexType is the response value from the CloneAsPatch Action. Contains the data that is needed to create a new copy of an unmanaged solution that contains the original solution plus all of its patches. For the Web API use the CloneAsSolution Action Create patches to simplify solution updates Contains the response from executing the class. For the Web API the CloneAsSolutionResponse ComplexType is the response value from the CloneAsSolution Action. Contains the data that is needed to copy an existing contract and its line items. For the Web API use the CloneContract Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the required privileges, see CloneContract message privileges. Notes for Callers By default the caller will become the owner for the new record. For this to work, the caller must have both Create and Read privileges for the contract entity. For more information, see Privileges by entity. Alternatively, you can set the property to the ID of another user. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Service#CloneContract Contract entitiesCloneContract message privilegesContract entity messages and methodsSample: Manage contractsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contract entity messages and methodsSample: Manage contracts For the Web API use the CloneMobileOfflineProfile Action. For internal use only. For internal use only. Contains the data that is needed to copy an existing product family, product, or bundle under the same parent record. For the Web API use the CloneProduct Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. Notes for Callers By default, the caller will become the owner for the new record. For this to work, the caller must have both Create and Read privileges for the product entity. For more information, see Privileges by entity. Clone a product family, product, or bundleSample: Clone product records Contains the response from the class. Clone a product family, product, or bundleSample: Clone product records Contains the data that is needed to close an incident (case). For the Web API use the CloseIncident Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of the required privileges, see CloseIncident message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#CloseIncident CloseIncident message privilegesSample: Validate record state and set the state of the recordHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to close a quote. For the Web API use the CloseQuote Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of the required privileges, see CloseQuote message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#CloseQuote CloseIncident message privilegesQuote, order, and invoice entitiesSample: Process quotes, sales orders and invoicesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Provides additional information about the solution components that are related to a missing component. For the Web API the corresponding type is ComponentDetail ComplexType. Dependency tracking for solution components Deprecated. Use the class. Creates a compound entity, such as a sales order (order), invoice, quote, or duplicate rule (duplicate detection rule); and its related entity, such as a sales order detail (order product), invoice detail (invoice product), quote detail (quote product), or duplicate rule condition. CompoundCreate message privileges Deprecated. Use the class and its associated response class. Contains the data that is needed to update a duplicate rule (duplicate detection rule) and its related duplicate rule conditions. For the Web API use the CompoundUpdateDuplicateDetectionRule Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and the entity. For a complete list of the required privileges, see CompoundUpdateDuplicateDetectionRule message privileges. Detect duplicate dataDuplicateRule entity messages and methodsCompoundUpdateDuplicateDetectionRule message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Deprecated. Use the class. Contains the data that is needed to update a compound record, such as a sales order (order), invoice, quote, or duplicate rule (duplicate detection rule); and its related detail record, such as a sales order detail (order product), invoice detail (invoice product), quote detail (quote product), or duplicate rule condition. CompoundUpdate message privileges Deprecated. Use the class and its associated response class. Contains the response from the class. Specifies additional constraints to be applied when you select resources for appointments. For the Web API the corresponding type is ConstraintRelation ComplexType. Calendar entities Deprecated. Contains the data that is needed to convert a kit to a product. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see ConvertKitToProduct message privileges. Bundles and kitsProduct catalog entitiesProduct entity messages and methodsConvertKitToProduct message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Deprecated. Contains the response from the class. Contains the data that is needed to convert a team of type owner to a team of type access. For the Web API use the ConvertOwnerTeamToAccessTeam Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of required privileges, see ConvertOwnerTeamToAccessTeam message privileges. Notes for Callers You can convert an owner team to an access team, if the owner team doesn’t have the records and security roles assigned to the team. After you convert the owner team to the access team, it can’t convert the team back to the owner team. It is a one way process. During conversion, all queues and mailboxes associated with the team are deleted. Use access teams and owner teams to collaborate and share informationTeam entity messages and methodsConvertOwnerTeamToAccessTeam message privileges Contains the response from the class. Deprecated. Contains the data that is needed to convert a product to a kit. For the Web API use the ConvertProductToKit Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the required privileges, see ConvertProductToKit message privileges. Bundles and kitsProduct catalog entitiesProduct entity messages and methodsConvertProductToKit message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Deprecated. Contains the response from the class. Contains the data that is needed to convert a quote to a sales order. For the Web API use the ConvertQuoteToSalesOrder Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see ConvertQuoteToSalesOrder message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. businessmanagement#convertquotetosalesorder Sales entities (lead, opportunity, competitor, quote, order, invoice)ConvertQuoteToSalesOrder message privilegesSample: Process quotes, sales orders and invoicesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to convert a sales order to an invoice. For the Web API use the ConvertSalesOrderToInvoice Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see ConvertSalesOrderToInvoice message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. businessmanagement#convertsalesordertoinvoice Sales entities (lead, opportunity, competitor, quote, order, invoice)ConvertSalesOrderToInvoice message privilegesSample: Process quotes, sales orders and invoicesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to copy a campaign. For the Web API use the CopyCampaign Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of required privileges, see CopyCampaign message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Marketing#DistributeCampaignFromMarketingList1 MarketingVB#DistributeCampaignFromMarketingList1 Campaign entitiesSample: Distribute campaign activities to qualified marketing listCopyCampaign message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to create a copy of the campaign response. For the Web API use the CopyCampaignResponse Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of required privileges, see CopyCampaignResponse message privileges. Campaign entitiesCampaignResponse entity messages and methodsCopyCampaignResponse message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to create a static list from the specified dynamic list and add the members that satisfy the dynamic list query criteria to the static list. For the Web API use the CopyDynamicListToStatic Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which will return an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the required privileges, see CopyDynamicListToStatic message privileges. Notes for Callers The newly created static list is locked. To unlock the list, set the value of the attribute to . The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Marketing#CopyDynamicListToStatic MarketingVB#CopyDynamicListToStatic List (marketing list) entitySample: Distribute campaign activities to dynamic and static listsCopyDynamicListToStatic message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to copy the members from the source list to the target list without creating duplicates. For the Web API use the CopyMembersList Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which will return an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the property and the property. For a complete list of the required privileges, see CopyMembersList message privileges. Notes for Callers The type of entities contained in the source and target lists must match. The entity type is specified in the attribute. The OptionSet values for this attribute are Account, Contact, and Lead. List (marketing list) entitySample: Distribute campaign activities to qualified marketing listCopyMembersList message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to create a new entity form that is based on an existing entity form. For the Web API use the CopySystemForm Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in CopySystemForm message privileges. Notes for Callers If the Target is not set a new will be created based on the original. Customize entity forms Contains the response from the class. Contains the data that is needed to create a quick campaign to distribute an activity to members of a list (marketing list). For the Web API use the CreateActivitiesList Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the , , and entities and on the specified entity in the property. The caller must also have access rights on the specified records in the following properties: , , and . For a complete list of the required privileges, see CreateActivitiesList message privileges. Notes for Callers This operation distributes activities that specify a recipient: a phone call, appointment, letter, fax, or email. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. /// <summary> /// This method creates Quick Campaign for a given Marketing List and retruns the /// Guid of the Quich Campaign which is modelled as bulk operation in CRM /// </summary> /// <param name="activityEntity"> /// An object that indicates activity type for the quick campaign and /// contains values for each activity that will be created /// </param> /// <param name="marketingListId"> /// The ID of the marketing list to which quick campaign is distributed /// </param> /// <param name="ownershipOption"> /// Specifies who will own the activities created by the Quick Campaign /// The PropagationOwnershipOptions enum is used to specify value for this parameter /// </param> /// <param name="isPropagate"> /// Specifies whether the operation is to be executed. /// This input is often 'true' for Quick Campaign /// </param> public Guid CreateAndRetrieveQuickCampaignForMarketingList( Entity letterActivityEntity, Guid marketingListId, PropagationOwnershipOptions ownershipOption, bool isPropagate) { //Create the request object from input parameters CreateActivitiesListRequest request = new CreateActivitiesListRequest() { Activity = letterActivityEntity, ListId = marketingListId, OwnershipOptions = ownershipOption, Propagate = isPropagate, TemplateId = Guid.Empty, FriendlyName = "Quick Campaign for My List", Owner = new EntityReference("systemuser", _currentUser), PostWorkflowEvent = true }; //Execute the request CreateActivitiesListResponse response = (CreateActivitiesListResponse)_serviceProxy.Execute(request); //On executing the request a BulkOperation record would be created in CRM. //If isPropagate is true, a corresponding Async job is also created which runs and creates the required activities //The response has BulkOperationId. This is the Id of the bulkoperation that mimics QuickCampaign in CRM Guid BOId = response.BulkOperationId; System.Console.WriteLine( "Quick Campaign with following name has been created. " + "Please verify in Web app manually: \n" + request.FriendlyName + "\nPress enter to continue...."); System.Console.ReadLine(); return BOId; } Campaign entitiesSample: Distribute a quick campaignCreateActivitiesList message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For the Web API the CreateActivitiesListResponse ComplexType is the response value from the CreateActivitiesList Action. Contains the data that is needed to create an exception for the recurring appointment instance. For the Web API use the CreateException Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity that is specified in the property and access rights on the specified record in the property. For a complete list of the required privileges, see CreateException message privileges. Update a recurring appointmentCreate a recurring appointment exception Contains the response from the class. For the Web API the CreateExceptionResponse ComplexType is the response value from the CreateException Action. Contains the data that is needed to create future unexpanded instances for the recurring appointment master. For the Web API use the CreateInstance Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the appointment entity and access rights on the specified record in the property. For a complete list of the required privileges, see CreateInstance message privileges. Create a recurring appointment exceptionAppointment entity messages and methods Contains the response from the class. For the Web API the CreateInstanceResponse ComplexType is the response value from the CreateInstance Action. Contains the data that is required to create translation of a knowledge article record. For the Web API use the CreateKnowledgeArticleTranslation Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of the required privileges, see CreateKnowledgeArticleTranslation message privileges. Notes for Callers Using the message creates a new knowledge article record with the title, content, description and keywords copied from the source record to the new record, and the language of the new record set to the one you specified in the message. Work with knowledge articles in Dynamics 365 Contains the response from the class. Work with knowledge articles in Dynamics 365 Contains the data that is required to create a major or minor version of a knowledge article record. For the Web API use the CreateKnowledgeArticleVersion Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of the required privileges, see CreateKnowledgeArticleVersion message privileges. Work with knowledge articles in Dynamics 365 Contains the response from the class. Work with knowledge articles in Dynamics 365 Contains the data that is needed to create a workflow (process) from a workflow template. For the Web API use the CreateWorkflowFromTemplate Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the workflow entity and access rights on the record specified in the property. For a complete list of the privileges required, see CreateWorkflowFromTemplate message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Workflows#CreateProcessFromTemplate1 Workflow and process entitiesWorkflow (process) entity messages and methodsSample: Create a process using a template Contains the response from the class. Contains the data needed to replace a managed solution plus all of its patches. This message request can be used on a base solution when there is a new version of the solution imported as a holding solution. This message request deletes the base solution along with all of its patches and renames the holding solution to the same name as the base solution. Create patches to simplify solution updates Contains the response from executing the class. For the Web API the DeleteAndPromoteResponse ComplexType is the response value from the DeleteAndPromote Action. Contains the data that is needed to delete all audit data records up until a specified end date. For the Web API use the DeleteAuditData Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which will return an instance of . Privileges and Access Rights For a list of the privileges required, see DeleteAuditData message privileges. Notes for Callers This message behaves slightly different depending on the version of Microsoft SQL Server that is installed on the Microsoft Dynamics 365 server. See Retrieve and delete the history of audited data changes for more information. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Auditing#Auditing4 AuditingVB#Auditing4 Audit entity data changesSample: Audit entity data changes Contains the response from the class. For the Web API the DeleteAuditDataResponse ComplexType is the response value from the DeleteAuditData Action. Retrieve and delete the history of audited data changesSample: Audit entity data changes Contains the data that is needed to delete instances of a recurring appointment master that have an “Open” state. For the Web API use the DeleteOpenInstances Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity specified in the property and access rights on the record specified in the property. For a list of the privileges required, see DeleteOpenInstances message privileges. Notes for Callers Using this message does the following: Deletes all the “open” and “scheduled” future instances of the specified series from the date specified in the property. However, if the state of the future instances is changed to “completed” or “canceled”, they are not deleted. Sets the status of the past instances to the specified value in the property. However, the past instances are not deleted. Terminates the series to the last occurring past instance date with respect to the date specified in the property, and sets the state of the series to “canceled”. This allows you to preserve the instances of a recurring appointment series even if you have decided to end it prematurely. This is useful if you have attached notes or attachments to past instances of a recurring appointment series that contain important information about the customer or business. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ScheduleAndAppointment#EndRecurringAppointmentSeries1 ScheduleAndAppointmentVB#EndRecurringAppointmentSeries1 Delete or end a recurring appointment series or instanceRecurringAppointmentMaster entity messages and methodsSample: End a recurring appointment series Contains the response from the class. There is no return value from this operation. Contains the data that is needed to create an email activity record from an incoming email message (Track in CRM). For the Web API use the DeliverIncomingEmail Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights For a complete list of the privileges required, see DeliverIncomingEmail message privileges. Email activity entitiesEmail entity messages and methods Contains the response from the class. Contains the data that is needed to create an email activity record from the specified email message (Track in CRM). For the Web API use the DeliverPromoteEmail Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the activity entity. For a complete list of the privileges required, see DeliverPromoteEmail message privileges. Notes for Callers This method is used by Microsoft Dynamics 365 for Outlook. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Activities#DeliverPromoteEmail1 ActivitiesVB#DeliverPromoteEmail1 Email activity entitiesEmail entity messages and methodsSample: Promote an email message to Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to deprovision a language. For the Web API use the DeprovisionLanguage Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges listed in DeprovisionLanguage message privileges. Customize labels to support multiple languages Contains the response from the class. There is no return value from this operation. Deprecated. Use the class. Contains the data that is needed to remove a link between two entity instances in a many-to-many relationship. Deprecated. Use the class and its associated response class. Contains the response from the class. Contains the data that is needed to create a bulk operation that distributes a campaign activity. The appropriate activities, such as a phone call or fax, are created for the members of the list that is associated with the specified campaign activity. For the Web API use the DistributeCampaignActivity Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the , , and entities and on the specified entity in the property. You must also have access rights on the specified records in the following properties: , , and . For a complete list of the required privileges, see DistributeCampaignActivity message privileges. Notes for Callers This operation distributes activities that specify a recipient: phone call, appointment, letter, letter via mail merge, fax, fax via mail merge, email, and email via mail merge. DistributeCampaignActivity message privilegesMarketing entities (campaign, list)Sample: Distribute a quick campaignActivity entitiesThe security model of Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to download a report definition. For the Web API use the DownloadReportDefinition Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the report entity and access rights on the record specified in the . For a complete list of the privileges required, see DownloadReportDefinition message privileges. Notes for Callers The response from the message is a UTF-8 encoded XML document in the form of a string that represents the entire content of the report definition (RDL) file. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Reporting#DownloadReportDefinition1 Report entitiesReport entity messages and methodsSample: Download report definition Contains the response from the class. For the Web API the DownloadReportDefinitionResponse ComplexType is the response value from the DownloadReportDefinition Function. Describes which members of a bulk operation to retrieve. This enumeration is used for the property. BulkOperation (quick campaign) entity messages and methodsCampaign entities Retrieve account entities. Value = 0. Retrieve contact entities. Value = 1. Retrieve lead entities. Value = 2. Retrieve all entities. Value = 3. Specifies the results of a scheduling operation using the , , or message. For the Web API the corresponding type is ErrorInfo ComplexType. Contains the data that is needed to execute a saved query (view) that has the specified ID. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of. Privileges and Access Rights To perform this action, the caller must have privileges on the entity access rights on the record specified by the property. For a complete list of the privileges required, see ExecuteByIdSavedQuery message privileges. Notes for Callers This message returns a String type that specifies the XML data containing the results of the query. This XML string is in the following format: <resultset> + <result>result1</result><result>result2</result> + ... + </resultset> The XML string returned from this method may contain multiple entity instances. If no instances are returned, the method simply returns an XML document for the entity type, with no data. The XML string returned from this method does not contain elements for attributes where the value is or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client. SavedQuery (view) entity messages and methodsSample: Work with views Contains the response from the class. Contains the data that is needed to execute the user query (saved view) that has the specified ID. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges and access rights on the entity specified in the property. For a list of the privileges required, see ExecuteByIdUserQuery message privileges. Notes for Callers This message returns a type that specifies the XML data containing the results of the query. This XML string is in the following format: <resultset> + <result>result1</result><result>result2</result> + ... + </resultset> The XML string returned from this method may contain multiple records. If no records are returned, the method simply returns an XML document for the entity type, with no data. The XML string returned from this method does not contain elements for attributes where the value is or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client. UserQuery (saved view) entity messages and methodsExecuteByIdUserQuery message privileges Contains the response from the class. Deprecated. Use the class. ExecuteFetch message privileges Deprecated. Use the class and its associated response class. Contains the data that’s needed to execute a workflow. For the Web API use the ExecuteWorkflow Action . Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the and properties. For a complete list of the privileges required, see ExecuteWorkflow message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Workflows#ExecuteWorkflow1 WorkflowsVB#ExecuteWorkflow1 Workflow categoriesSample: Run a workflow Contains the response from the class. Contains the data that is needed to convert the calendar rules to an array of available time blocks for the specified period. For the Web API use the ExpandCalendar Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the calendar entity and access rights on the specified record in the property. For a complete list of the required privileges, see ExpandCalendar message privileges. Calendar entitiesCalendar entity messages and methodsExpandCalendar message privileges Contains the response from the class. For the Web API the ExpandCalendarResponse ComplexType is the response value from the ExpandCalendar Function. For internal use only. For internal use only. For internal use only. Contains the data that is needed to export localizable fields values to a compressed file. For the Web API use ExportFieldTranslation Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To export the labels for specific records the user must have read privileges for those records. Localize product property values Contains the response from the class. For the Web API the ExportFieldTranslationResponse ComplexType is the response value from the ExportFieldTranslation Function. Localize product property values Contains the data that is needed to export a data map as an XML formatted data. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and the access rights on the record specified in the property. For a complete list of required privileges, see ExportMappingsImportMap message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DataImport#ExportMappingsImportMap DataImportVB#ExportMappingsImportMap Import dataCreate data maps for importAdd transformation mappings for importSample: Export and import a data mapThe security model of Microsoft Dynamics 365 Contains the response from the class. For the Web API the ExportMappingsImportMapResponse ComplexType is the response value from the ExportMappingsImportMap Action. Contains the data that’s needed to export a solution. For the Web API use the ExportSolution Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in ExportSolution message privileges. Notes for Callers The properties of this request correspond to the options in the export solution dialog box in the application. The following table describes the settings included with each of the Export* settings. Member Setting Display Name Description The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. solutions#WorkWithSolutions7 solutionsVB#WorkWithSolutions7 Sample: Work with solutionsPackage and distribute extensions using solutions Contains the response from the class. For the Web API the ExportSolutionResponse ComplexType is the response value from the ExportSolution Action. Contains the data that is needed to export all translations for a specific solution to a compressed file. For the Web API use the ExportTranslation Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in ExportTranslation message privileges. Notes for Callers Customize labels to support multiple languages Contains the response from the class. For the Web API the ExportTranslationResponse ComplexType is the response value from the ExportTranslation Action. Contains the data that is needed to convert a query in FetchXML to a QueryExpression. For the Web API use the FetchXmlToQueryExpression Function. Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights For a complete list of the required privileges, see FetchXmlToQueryExpression message privileges. Notes for Callers The use of the keyword in query expressions is different from the FetchXML query language. When mapping a query from Fetch to , results will not be consistent if the keyword is used in the FetchXML string. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Query#FetchXmlAndQueryExpressionQueryConversion1 QueryVB#FetchXmlAndQueryExpressionQueryConversion1 Retrieve data with queries using SDK assembliesFetchXML schemaSample: Convert queries between Fetch and QueryExpression Contains the response from the class. Contains the data that is needed to find a parent resource group (scheduling group) for the specified resource groups (scheduling groups). For the Web API use the FindParentResourceGroup Function . Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the and properties. For a complete list of the privileges required, see FindParentResourceGroup message privileges. Resource entitiesResourceGroup (scheduling group) entity messages and methods Contains the response from the class. Contains the data that is needed to fulfill the sales order (order). For the Web API use the FulfillSalesOrder Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the property. For a complete list of required privileges, see FulfillSalesOrder message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#Fulfill1 Sales entities (lead, opportunity, competitor, quote, order, invoice)FulfillSalesOrder message privilegesSample: Fulfill a sales orderHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to perform a full-text search on knowledge articles in CRM using the specified search text. For the Web API use the FullTextSearchKnowledgeArticle Action. Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of required privileges, see FullTextSearchKnowledgeArticle message privileges. Notes for Callers This message supports queries using FetchXML and QueryExpression. For more information, see Build queries with FetchXML and Build queries with QueryExpression. Some of the filtering is done post-search from the full-text index, which depends on the values specified for the and parameters. For information about the rules based on these parameters, see and . Work with knowledge articles in Dynamics 365 Contains the response from the class. Contains the data that is needed to generate an invoice from an opportunity. For the Web API use the GenerateInvoiceFromOpportunity Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights to the specified record in the property. For a complete list of the required privileges, see GenerateInvoiceFromOpportunity message privileges. Sales entities (lead, opportunity, competitor, quote, order, invoice)GenerateInvoiceFromOpportunity message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to generate a quote from an opportunity. For the Web API use the GenerateQuoteFromOpportunity Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights to the specified record in the property. For a complete list of the required privileges, see GenerateQuoteFromOpportunity message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#GenerateQuoteFromOpportunity Sales entities (lead, opportunity, competitor, quote, order, invoice)Sample: Process quotes, sales orders and invoicesGenerateInvoiceFromOpportunity message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to generate a sales order (order) from an opportunity. For the Web API use the GenerateSalesOrderFromOpportunity Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights to the specified record in the property. For a complete list of the required privileges, see GenerateSalesOrderFromOpportunity message privileges. Sales entities (lead, opportunity, competitor, quote, order, invoice)GenerateSalesOrderFromOpportunity message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data to return an existing social profile record if one exists, otherwise generates a new one and returns it. For the Web API use the GenerateSocialProfile Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the Entity property. For a complete list of the privileges required, see GenerateSocialProfile message privileges. SocialProfile entity messages and methods Contains the response from the message. Contains the data that is needed to retrieve all the time zone definitions for the specified locale and to return only the display name attribute. For the Web API use the GetAllTimeZonesWithDisplayName Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Time zone entitiesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For internal use only. See . Contains the data that is needed to obtain the key that is used to encrypt or decrypt a user's or queue's email credentials that are stored in the Microsoft Dynamics 365 database. This message was incorrectly marked as public in previous Microsoft Dynamics 365 SDK releases. Message Availability For this message to work, the caller must be connected to the server. This message is supported only for on-premises and Internet-facing deployments (IFDs). Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a complete list of the required privileges, see GetDecryptionKey message privileges. Notes for Callers The caller must be a member of the Active DirectoryPrivUserGroup security group in on-premises installations or must be the root business-unit administrator in Services Provider License Agreement (SPLA) or Internet-facing deployments (IFDs). By default, this message enforces Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS). If you choose to enable HTTP for this communication, it is recommended that you enforce Internet Protocol security (IPsec) on the Microsoft Dynamics 365 server and on the email router. For internal use only. Contains the response from the class. This message is supported only for on-premises and Internet-facing deployments (IFDs). Contains the data that is needed to retrieve the default price level (price list) for the current user based on the user’s territory relationship with the price level. For the Web API use the GetDefaultPriceLevel Function. Message Availability For this message to work, the caller must be connected to the server. Usage This message does not have any usage scenario of its own. CRM internally uses the message to determine the default price level for an opportunity, quote, order, or invoice based on the current user and the territory relationship with the price level. More information: Enable automatic selection of default price level If you have Microsoft Dynamics CRM Online 2015 Update 1, this message also provides you the capability to specify your custom logic for selecting default price level instead of using the out-of-box rule for the selection of default price level for an opportunity, quote, order, and invoice. To use this message, you must create a plug-in with the custom code for returning price levels based on your business requirement, and register it on the message. More information: Extend default price level selection Privileges and Access Rights To perform this action, the caller must have privileges on the , , , , , and entities. Notes to Caller If a user territory is part of multiple price levels, this message will retrieve all those price levels. Set default price level for opportunity, quote, order, invoice Contains the response from the class. Set default price level for opportunity, quote, order, invoice Contains the data that is needed to retrieve distinct values from the parse table for a column in the source file that contains list values. For the Web API use the GetDistinctValuesImportFile Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the required privileges, see GetDistinctValuesImportFile message privileges. Notes for Callers Use this message only after you have created a parse table by using the message. Do not use this message after you use the message. You cannot access the parse table after the import job submitted by the message has finished running. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DataImport#ImportWithCreate3 DataImportVB#ImportWithCreate3 Import dataImportFile entity messages and methodsRun data importSample: Import data using complex data mapGetDistinctValuesImportFile message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to retrieve the source-file column headings; or retrieve the system-generated column headings if the source file does not contain column headings. For the Web API use GetHeaderColumnsImportFile Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see GetHeaderColumnsImportFile message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DataImport#ImportWithCreate1 DataImportVB#ImportWithCreate1 Import dataImportFile entity messages and methodsRun data importSample: Import data using complex data mapGetDistinctValuesImportFile message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to retrieve the products from an opportunity and copy them to the invoice. For the Web API use the GetInvoiceProductsFromOpportunity Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the and entities and access rights on the records specified in the property and the property. For a complete list of required privileges, see GetInvoiceProductsFromOpportunity message privileges. GetInvoiceProductsFromOpportunity message privilegesSales entities (lead, opportunity, competitor, quote, order, invoice)Opportunity entitiesInvoice entity messages and methodsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to get the quantity decimal value of a product for the specified entity in the target. For the Web API use the GetQuantityDecimal Function. Message Availability This message works regardless whether the caller is connected to the server or offline. For more information, see Supported Entities later in this topic. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity, on the entity, and on the entity that is referred to in the property. You also need access rights on the specified records in the property and the property. For a complete list of the required privileges, see GetQuantityDecimal message privileges. Supported Entities The following table shows the default entities that support this message. This message works regardless whether the caller is connected to the server or offline. Entity GetQuantityDecimal message privilegesSales entities (lead, opportunity, competitor, quote, order, invoice)UoM (unit) entity messages and methodsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to retrieve the products from an opportunity and copy them to the quote. For the Web API use the GetQuoteProductsFromOpportunity Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the and entities and access rights on the records specified in the property and the property. For a complete list of required privileges, see GetQuoteProductsFromOpportunity message privileges. GetQuoteProductsFromOpportunity message privilegesSales entities (lead, opportunity, competitor, quote, order, invoice)How role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to retrieve the history limit for a report. For the Web API use the GetReportHistoryLimit Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the privileges required, see GetReportHistoryLimit message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Reporting#GetReportHistoryLimit1 ReportingVB#GetReportHistoryLimit1 Sample: Get the report history limitDevelopers guide to reports for Microsoft Dynamics 365Report entity messages and methodsGetReportHistoryLimit message privileges Contains the response from the class. For the Web API the GetReportHistoryLimitResponse ComplexType is the response value from the GetReportHistoryLimit Function. Contains the data that is needed to retrieve the products from an opportunity and copy them to the sales order (order). For the Web API use GetSalesOrderProductsFromOpportunity Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the and entities and access rights on the records specified in the property and the property. For a complete list of required privileges, see GetSalesOrderProductsFromOpportunity message privileges. GetSalesOrderProductsFromOpportunity message privilegesSales entities (lead, opportunity, competitor, quote, order, invoice)How role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to retrieve the time zone code for the specified localized time zone name. For the Web API use the GetTimeZoneCodeByLocalizedName Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Time zone entitiesSample: Retrieve time zone informationHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For the Web API the GetTimeZoneCodeByLocalizedNameResponse ComplexType is the response value from the GetTimeZoneCodeByLocalizedName Function. Contains the data that is needed to return a tracking token that can then be passed as a parameter to the message. For the Web API use the GetTrackingTokenEmail Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of the required privileges, see GetTrackingTokenEmail message privileges. Notes for Callers The tracking token is used to correlate an email with a context that is specified in the property. Email activity entitiesEmail entity messages and methods Contains the response from the class. For the Web API the GetTrackingTokenEmailResponse ComplexType is the response value from the GetTrackingTokenEmail Action. Contains the data that is needed to grant a security principal (user or team) access to the specified record. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entity in the property and access rights on the specified record in the property. For a list of the required privileges, see GrantAccess message privileges. Notes for Callers This action applies to all child records of the target record. For all child records, if the caller does not have share privileges for those entity types, or share rights to the records, the child records are not shared. As a result, the owner of the instance, or a user who shares the instance with share rights, automatically has share rights to all child records of the target record. In this case, only the lack of privileges for a particular entity type prevents the child records from being shared. For a description of how actions on a parent instance affect child records, see Cascading behavior. Supported Entities The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available. Entity Availability Account 0 (Server) Annotation 0 (Server) Appointment 0 (Server) Campaign 0 (Server) CampaignActivity 0 (Server) CampaignResponse 0 (Server) Connection 0 (Server) Contact 0 (Server) Contract 0 (Server) ConvertRule 0 (Server) CustomerOpportunityRole 0 (Server) CustomerRelationship 0 (Server) DuplicateRule 0 (Server) Email 0 (Server) EmailServerProfile 0 (Server) Entitlement 0 (Server) Fax 0 (Server) Goal 0 (Server) GoalRollupQuery 0 (Server) Import 0 (Server) ImportFile 0 (Server) ImportMap 0 (Server) Incident 0 (Server) IncidentResolution 0 (Server) Invoice 0 (Server) Lead 0 (Server) Letter 0 (Server) List 0 (Server) Mailbox 0 (Server) MailMergeTemplate 0 (Server) msdyn_PostAlbum 0 (Server) msdyn_wallsavedqueryusersettings 0 (Server) Opportunity 0 (Server) OpportunityClose 0 (Server) OrderClose 0 (Server) PhoneCall 0 (Server) ProcessSession 0 (Server) Queue 0 (Server) Quote 0 (Server) QuoteClose 0 (Server) RecurringAppointmentMaster 0 (Server) Report 0 (Server) RoutingRule 0 (Server) SalesOrder 0 (Server) ServiceAppointment 0 (Server) SharePointDocumentLocation 0 (Server) SharePointSite 0 (Server) SLA 0 (Server) SLAKPIInstance 0 (Server) SocialActivity 0 (Server) SocialProfile 0 (Server) Task 0 (Server) Template 0 (Server) UserForm 0 (Server) UserQuery 0 (Server) UserQueryVisualization 0 (Server) Workflow 0 (Server) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. StrongTypes#UserAccess1 StrongTypesVB#UserAccess1 How record-based security can be used to control access to records in Microsoft Dynamics 365Actions on entity recordsSample: Share records using GrantAccess, ModifyAccess and RevokeAccess messages Contains the response from the class. There is no return value from this operation. Contains the data that is needed to import translations from a compressed file. For the Web API use the ImportFieldTranslation Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To update the labels for specific records the user must have update privileges for those records. Localize product property values Contains the response from the class. Localize product property values Contains the data that is needed to import the XML representation of a data map and create an import map (data map) based on this data. For the Web API use the ImportMappingsImportMap Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of. Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of required privileges, see ImportMappingsImportMap message privileges. Notes for Callers The XML data describing the data map must be well-formed and valid. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DataImport#ImportMappingsImportMap DataImportVB#ImportMappingsImportMap Import dataCreate data maps for importAdd transformation mappings for importSample: Export and import a data mapThe security model of Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to submit an asynchronous job that uploads the transformed data into Microsoft Dynamics 365. For the Web API use the ImportRecordsImport Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the required privileges, see ImportRecordsImport message privileges. Notes for Callers Pass the ID of the associated data import (import) in the property. The ID of the asynchronous job that runs in the background and uploads the data into Microsoft Dynamics 365 is returned in the property of the message response. All import files that are associated with the specified data import (import) are imported. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DataImport#ImportWithCreate6 DataImportVB#ImportWithCreate6 Import dataImport (data import) entity messages and methodsRun data importSample: Import data using complex data mapImportRecordsImport message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to import a solution. For the Web API use the ImportSolution Action. Message Availability For this message to work, the caller must be connected to the server. Usage This request is the only one that can be called either synchronously or asynchronously. To use this messages synchronously, pass an instance of this class to the method, which returns an instance of . To use this message asynchronously, instantiate a and set the property to an instance of this class. Use the method to return an . The property will contain the . Use the . to track the success of the solution import. Privileges and Access Rights To perform this action, the caller must have privileges listed in ImportSolution message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. solutions#WorkWithSolutions8 solutionsVB#WorkWithSolutions8 Sample: Work with solutionsPackage and distribute extensions using solutions Contains the response from the class. There is no return value from this operation. Contains the data that is needed to import translations from a compressed file. For the Web API use the ImportTranslation Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in ImportTranslation message privileges. Customize labels to support multiple languagesUse the Organization service with Dynamics 365 metadata Contains the response from the class. There is no return value from this operation. Contains the data that is required to increment the per day view count of a knowledge article record. For the Web API use the IncrementKnowledgeArticleViewCount Function. For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of the required privileges, see IncrementKnowledgeArticleViewCount message privileges. Notes for Callers If a view count record doesn’t exist for a knowledge article for a specified day, this message will create a record and then set the specified view count value. If a record already exists for a knowledge article for the specified day, this message will just increment the view count in the existing record with the specified view count. Work with knowledge articles in Dynamics 365 Contains the response from the class. Work with knowledge articles in Dynamics 365 Contains the data that is needed to initialize a new record from an existing record. For the Web API use the InitializeFrom Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity that is specified in the property and access rights on the record that is specified in the property. For a complete list of the required privileges, see InitializeFrom message privileges. Notes for Callers To create a record from the result, pass the value to the method or the message. Account entity messages and methodsBulkOperationLog (quick campaign log) entity messages and methods Contains the response from the class. Contains custom application data. Contains a collection of objects. Contains the data that is needed to install the sample data. For the Web API use the InstallSampleData Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights For a complete list of the privileges required, see InstallSampleData message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Other#ImportOrRemoveSampleData1 OtherVB#ImportOrRemoveSampleData1 Sample data for Microsoft Dynamics 365Sample: Install or remove sample data Contains the response from the class. There is no return value from this operation. Contains the data that is needed to instantiate a set of filters for Dynamics 365 for Outlook for the specified user. For the Web API use the InstantiateFilters Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the property. For a complete list of the privileges required, see InstantiateFilters message privileges. Notes for Callers This creates a user query record for the specified user for each filter specified in the property. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Outlook#RetrieveDataFilters2 OutlookVB#RetrieveDataFilters2 Offline and Outlook filters and templatesSample: Create and retrieve Outlook filters Contains the response from the class. There is no return value from this operation. Contains the parameters that are needed to create an email message from a template (email template). For the Web API use the InstantiateTemplate Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the and entities and access rights on the specified record in the and properties. For a complete list of the required privileges, see InstantiateTemplate message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Templates#CreateEmailUsingTemplate1 TemplatesVB#CreateEmailUsingTemplate1 Email activity entitiesTemplate (email template) entity messages and methodsSample: Create an email using a template Contains the response from the class. Deprecated. Checks whether Microsoft Dynamics GP 9.0 is installed. This value is stored in attribute. Use the class or method. IsBackOfficeInstalled message privileges Deprecated. Contains the data that is needed to determine whether a solution component is customizable. For the Web API use the IsComponentCustomizable Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the privileges that are listed in IsComponentCustomizable message privileges. SolutionComponent entity messages and methods Contains the response from the class. For the Web API the AddItemCampaignActivityResponse ComplexType is the response value from the AddItemCampaignActivity Action. Contains the data that is needed to validate the state transition. For the Web API use the IsValidStateTransition Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entity in the property and access rights on the specified record in the property. For a complete list of the required privileges, see IsValidStateTransition message privileges. Notes for Callers If an incident (case) or opportunity is already closed or canceled, or if an incident (case) has open activities, an exception is thrown. Supported Entities The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Incident 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#IsValidStateTransition Opportunity entitiesIncident (case) entitiesIsValidStateTransition message privilegesSample: Validate record state and set the state of the recordHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to retrieve the local time for the specified Coordinated Universal Time (UTC). Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#LocalTimeFromUTCTime LocalTimeFromUtcTime message privilegesTime zone entitiesSample: Retrieve time zone informationHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to lock the total price of products and services that are specified in the invoice. For the Web API use the LockInvoicePricing Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see LockInvoicePricing message privileges. Notes for Callers When the invoice pricing is locked, changes to underlying price lists (price levels) do not affect the prices for an invoice. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#LockInvoicePricing LockInvoicePricing message privilegesQuote, order, and invoice entitiesSample: Process quotes, sales orders and invoicesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to lock the total price of products and services that are specified in the sales order (order). For the Web API use the LockSalesOrderPricing Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see LockSalesOrderPricing message privileges. Notes for Callers When the sales order pricing is locked, changes to underlying price lists (price levels) do not affect the prices for a sales order (order). The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#LockSalesOrderPricing LockSalesOrderPricing message privilegesQuote, order, and invoice entitiesSalesOrder (order) entity messages and methodsSample: Process quotes, sales orders and invoicesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to set the state of an opportunity to Lost. For the Web API use the LoseOpportunity Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of the required privileges, see LoseOpportunity message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#LoseOpportunity LoseOpportunity message privilegesSales entities (lead, opportunity, competitor, quote, order, invoice)Sample: Process quotes, sales orders and invoicesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Deprecated. Use the class. MakeAvailableToOrganizationReport message privileges Deprecated. Use the class and its associated response class. Deprecated. Use the class. MakeAvailableToOrganizationTemplate message privileges Deprecated. Use the class and its associated response class. Deprecated. Use the class. MakeUnavailableToOrganizationReport message privileges Deprecated. Use the class and its associated response class. Deprecated. Use the class. MakeUnavailableToOrganizationTemplate message privileges Deprecated. Use the class and its associated response class. Contains the data that’s needed to merge the information from two entity records of the same type. For the Web API use the Merge Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges and access rights on the specified entity in the property and privileges on the entity that is referred to in the property. For a complete list of the required privileges, see Merge message privileges. Supported Entities The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available. Entity For a description of how actions on a parent record affect child records, see Entity relationship behavior.Merge incidentsThe behavior of merge for incidents is different from merging accounts, contacts, or leads in the following ways:The property is not used.For other entities this property may be used to transfer selected values from the subordinate record to the target record. When merging incidents the value of this property is ignored.Merge is performed in the security context of the user.Merge operations for other entities are performed with a system user security context. Because incident merge operations are performed in the security context of the user, the user must have the security privileges to perform any of the actions, such as re-parenting related records, that are performed by the merge operation.If the user merging records doesn’t have privileges for all the actions contained within the merge operation, the merge operation will fail and roll back to the original state. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#Merge1 Merge message privilegesSample: Merge two recordsCustomer entities (account, contact)Lead entity messages and methodsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data to describe a solution component that is required by a solution but not found in the system. For the Web API the corresponding type is MissingComponent ComplexType. Dependency tracking for solution components Contains the data that is needed to replace the access rights on the target record for the specified security principal (user or team). Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity that is specified in the property and access rights on the record that is specified in the property. For a list of the required privileges, see ModifyAccess message privileges. Notes for Callers This action applies to all child records of the target entity record. For all child records, if the caller does not have share privileges for those entity types or share rights to the records, the child records are not shared. As a result, the owner of the entity record, or a user who shares the record that has share rights, automatically has share rights to all child records of the target entity record. In this case, only the lack of privileges to a particular entity type prevents the child records from being shared. For a description of how actions on a parent record affect child records, see Cascading behavior. Supported Entities The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available. Entity Availability Account 0 (Server) Annotation 0 (Server) Appointment 0 (Server) Campaign 0 (Server) CampaignActivity 0 (Server) CampaignResponse 0 (Server) Connection 0 (Server) Contact 0 (Server) Contract 0 (Server) ConvertRule 0 (Server) CustomerOpportunityRole 0 (Server) CustomerRelationship 0 (Server) DuplicateRule 0 (Server) Email 0 (Server) EmailServerProfile 0 (Server) Entitlement 0 (Server) Fax 0 (Server) Goal 0 (Server) GoalRollupQuery 0 (Server) Import 0 (Server) ImportFile 0 (Server) ImportMap 0 (Server) Incident 0 (Server) IncidentResolution 0 (Server) Invoice 0 (Server) Lead 0 (Server) Letter 0 (Server) List 0 (Server) Mailbox 0 (Server) MailMergeTemplate 0 (Server) msdyn_PostAlbum 0 (Server) msdyn_wallsavedqueryusersettings 0 (Server) Opportunity 0 (Server) OpportunityClose 0 (Server) OrderClose 0 (Server) PhoneCall 0 (Server) ProcessSession 0 (Server) Queue 0 (Server) Quote 0 (Server) QuoteClose 0 (Server) RecurringAppointmentMaster 0 (Server) Report 0 (Server) RoutingRule 0 (Server) SalesOrder 0 (Server) ServiceAppointment 0 (Server) SharePointDocumentLocation 0 (Server) SharePointSite 0 (Server) SLA 0 (Server) SLAKPIInstance 0 (Server) SocialActivity 0 (Server) SocialProfile 0 (Server) Task 0 (Server) Template 0 (Server) UserForm 0 (Server) UserQuery 0 (Server) UserQueryVisualization 0 (Server) Workflow 0 (Server) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. StrongTypes#UserAccess2 StrongTypesVB#UserAccess2 How record-based security can be used to control access to records in Microsoft Dynamics 365Actions on entity recordsSample: Share records using GrantAccess, ModifyAccess and RevokeAccess messages Contains the response from the class. There is no return value from this operation. Contains the data that describes the scheduling strategy for an and that overrides the default constraints. For the Web API the corresponding type is ObjectiveRelation ComplexType. Schedules in Microsoft Dynamics 365 Contains data regarding the resources used by an organization. For the Web API the corresponding type is OrganizationResources ComplexType. Contains the data that is needed to submit an asynchronous job that parses all import files that are associated with the specified import (data import). Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see ParseImport message privileges. Notes for Callers Pass the ID of the associated import (data import) in the property. The ID of the asynchronous job that runs in the background and performs data parsing is returned in the property of the message response. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DataImport#ImportWithCreate2 DataImportVB#ImportWithCreate2 Import dataRun data importSample: Import data using complex data mapImport (data import) entity messages and methodsParseImport message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to assign a queue item to a user and optionally remove the queue item from the queue. For the Web API use the PickFromQueue Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see PickFromQueue message privileges. Queue entitiesQueueItem entity messages and methodsSample: Specify a queue item to work on (early bound) Contains the response from the message. There is no return value from this operation. Contains access rights information for the security principal (user or team). Sample: Add a security principal (user or team) to a queue (early bound) Contains the possible values for the depth of a privilege within a role. This enumeration is used to compare and set values in records returned from Fetch or QueryExpression queries. If you use LINQ, the privilege depth is returned as a bit mask. In this case you can use the following constants to determine the privilege depth. public const int BASIC_MASK = 0x00000001; public const int LOCAL_MASK = 0x00000002; public const int DEEP_MASK = 0x00000004; public const int GLOBAL_MASK = 0x00000008; For the Web API use the PrivilegeDepth EnumType. Privilege and role entities Indicates basic privileges. Users who have basic privileges can only use privileges to perform actions on objects that are owned by, or shared with, the user. Value = 0. Indicates local privileges. Users who have local privileges can only use privileges to perform actions on data and objects that are in the user's current business unit. Value = 1. Indicates deep privileges. Users who have deep privileges can perform actions on all objects in the user's current business units and all objects down the hierarchy of business units. Value = 2. Indicates global privileges. Users who have global privileges can perform actions on data and objects anywhere within the organization regardless of the business unit or user to which it belongs. Value = 3. Contains the data that is needed to process the email responses from a marketing campaign. For the Web API use the ProcessInboundEmail Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see ProcessInboundEmail message privileges. Notes for Callers This message is used in the following scenario: A user executes a marketing campaign. Email messages are generated and sent to a list of contacts. Optionally, the messages can contain an unsubscribe link. A customer (contact) replies to the generated email. A call to this message does the following: Creates a campaign response record. If the response is an unsubscribe reply, the . property for the contact is set to true. If the response is an unsubscribe reply and the . property is true, an unsubscribe confirmation email is sent. Email activity entitiesEmail entity messages and methods Contains the response from the class. There is no return value from this operation. Contains the data that is needed to create a quick campaign to distribute an activity to accounts, contacts, or leads that are selected by a query. For the Web API use thePropagateByExpression Action . Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the and entities, and on the specified entity in the property. The caller must also have access rights on the specified records in the property and the property. For a complete list of the required privileges, see PropagateByExpression message privileges. Notes for Callers This operation distributes activities that specify a recipient: phone call, appointment, letter, fax, or email. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Marketing#QuickCampaign2 MarketingVB#QuickCampaign2 Campaign entitiesSample: Distribute a quick campaignPropagateByExpression message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the possible values for propagation ownership options. For the Web API use the PropagationOwnershipOptions EnumType. Used for the , , and properties. There is no change in ownership for the created activities. Value = 0. All created activities are assigned to the caller of the API. Value = 1. Created activities are assigned to respective owners of target members. Value = 2. Represents a party (user, team, or resource) that is needed for the proposed appointment. For the Web API the corresponding type is ProposalParty ComplexType. Contains the data that is needed to provision a new language. For the Web API use the ProvisionLanguage Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in ProvisionLanguage message privileges. Notes for Callers Before you can provision a language you must first install language packs. If you have activity feeds enabled environment, do not use this message. Use Microsoft Dynamics 365 Web application to provision a new language. Customize labels to support multiple languagesActivity feeds entities Contains the response from the class. There is no return value from this operation. Contains the data that is needed to publish all changes to solution components. For the Web API use the PublishAllXml Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in PublishAllXml message privileges. Notes for Callers Solution components are published automatically when they are created or deleted. You must publish changes when solution components are updated. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. entities#CreateUpdateEntityMetadata6 entitiesVB#CreateUpdateEntityMetadata6 Publish customizationsSample: Create and update entity metadata Contains the response from the class. There is no return value from this operation. Contains the data that is needed to submit an asynchronous job to publish a duplicate rule. For the Web API use the PublishDuplicateRule Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the required privileges, see PublishDuplicateRule message privileges. Notes for Callers A duplicate rule publishing job creates a matchcode for every entity record that a duplicate detection rule applies to. The matchcode is used as a part of the process for detecting duplicates. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DuplicateDetection#PublishDuplicateRule PublishDuplicateRule message privilegesSample: Enable duplicate detection and retrieve duplicatesDetect duplicate dataHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contain the data that is needed to publish a product family record and all its child records. For the Web API use the PublishProductHierarchy Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the product family record specified in the property. Notes to Callers This message will publish the entire hierarchy of child product family, product, and bundle records under the specified product family record. Publish a product family, product, or bundleSample: Create and publish products Contains the response from the class. There is no return value from this operation. Contains the data that is needed to publish a theme and set it as the current theme. For the Web API use the PublishTheme Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Query and edit an organization theme Contains the response from the class. There is no return value from this operation. Contains the data that is needed to publish specified solution components. For the Web API use the PublishXml Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in PublishXml message privileges. Notes for Callers Use this message to publish a specified subset of solution components. See for details about how to specify the solution components to publish. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. This sample updates a global option set and then publishes just that option set. optionsets#WorkwithGlobalOptionSets4 optionsetsVB#WorkwithGlobalOptionSets4 Sample: Work with global option setsPublish customizationsPublish request schema Contains the response from the class. There is no return value from this operation. Contains the data that is needed to qualify a lead and create account, contact, and opportunity records that are linked to the originating lead record. For the Web API use the QualifyLead Action . Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the , , , , , and entities. The caller must also have access rights on the specified records in the following properties: , , , and . For a complete list of required privileges, see QualifyLead message privileges. Notes for Callers If SharePoint integration is enabled, the document location records for the lead are copied for the newly created account, contact, and opportunity. If you set the property and the property to , the created account becomes a parent () of the contact and the contact becomes a primary contact () for the account. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#WorkingWithLeads1 Sales entities (lead, opportunity, competitor, quote, order, invoice)Sample: Qualify a leadCustomer entities (account, contact)Transaction Currency (currency) entityCampaign entitiesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365QualifyLead message privileges Contains the response from the class. Contains the data that is needed to qualify the specified list and either override the list members or remove them according to the specified option. For the Web API use the QualifyMemberList Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the property and the property. For a complete list of required privileges, see QualifyMemberList message privileges. Notes to Callers The list members are accounts, contacts, or leads. Qualify means to evaluate which members to keep in the list. You select members to evaluate by using a query. For example, you might search for members that are in a particular zip code. This message is invoked by using Manage Members in the web application. QualifyMemberList message privilegesList (marketing list) entitySample: Distribute campaign activities to qualified marketing listListMember intersect entity metadataCustomer entities (account, contact)Lead entityHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to convert a query, which is represented as a class, to its equivalent query, which is represented as FetchXML. For the Web API use the QueryExpressionToFetchXml Action . Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a complete list of the required privileges, see QueryExpressionToFetchXml message privileges. Notes for Callers Use of the keyword in query expressions is different from the FetchXML query language. When you map a query from Fetch to , you receive inconsistent results if you use the keyword in the FetchXML string. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Query#FetchXmlAndQueryExpressionQueryConversion2 QueryVB#FetchXmlAndQueryExpressionQueryConversion2 Retrieve data with queries using SDK assembliesPage large result sets with QueryExpressionBuild queries with QueryExpressionFetchXML schemaSample: Convert queries between Fetch and QueryExpression Contains the response from the class. Contains the data that is needed to search multiple resources for available time block that match the specified parameters. For the Web API use the QueryMultipleSchedules Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified records in the property. For a list of the required privileges, see QueryMultipleSchedules message privileges. Notes for Callers This class functions similarly to the class, except that this class searches for multiple resources at one time. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. // Retrieve the working hours of the current and the other user. QueryMultipleSchedulesRequest scheduleRequest = new QueryMultipleSchedulesRequest(); scheduleRequest.ResourceIds = new Guid[2]; scheduleRequest.ResourceIds[0] = _currentUserId; scheduleRequest.ResourceIds[1] = _otherUserId; scheduleRequest.Start = DateTime.Now; scheduleRequest.End = DateTime.Today.AddDays(7); scheduleRequest.TimeCodes = new TimeCode[] { TimeCode.Available }; QueryMultipleSchedulesResponse scheduleResponse = (QueryMultipleSchedulesResponse)_serviceProxy.Execute(scheduleRequest); // Verify if some data is returned for the availability of the users if (scheduleResponse.TimeInfos.Length > 0) { Console.WriteLine("Successfully queried the working hours of multiple users."); } Schedules in Microsoft Dynamics 365Sample: Query the working hours of multiple users Contains the response from the class. Contains the data that is needed to search the specified resource for an available time block that matches the specified parameters. For the Web API use the QuerySchedule Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a list of the required privileges, see QuerySchedule message privileges. Notes for Callers This request class is similar to the class; however, this class searches for only one resource at a time. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. // Get the current user's information. WhoAmIRequest userRequest = new WhoAmIRequest(); WhoAmIResponse userResponse = (WhoAmIResponse)_serviceProxy.Execute(userRequest); // Retrieve the working hours of the current user. QueryScheduleRequest scheduleRequest = new QueryScheduleRequest { ResourceId = userResponse.UserId, Start = DateTime.Now, End = DateTime.Today.AddDays(7), TimeCodes = new TimeCode[] { TimeCode.Available } }; QueryScheduleResponse scheduleResponse = (QueryScheduleResponse)_serviceProxy.Execute(scheduleRequest); // Verify if some data is returned for the availability of the current user if (scheduleResponse.TimeInfos.Length > 0) { Console.WriteLine("Successfully queried the working hours of the current user."); } Schedules in Microsoft Dynamics 365Sample: Query the working hours of a user Contains response from . For the Web API the QueryScheduleResponse ComplexType is the response value from the QuerySchedule Function. Contains the data that is needed to reassign all records that are owned by the security principal (user or team) to another security principal (user or team). For the Web API use the ReassignObjectsOwner Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights For a complete list of the privileges required, see ReassignObjectsOwner message privileges. Entity ownershipUser and team entities Contains the response from the class. There is no return value from this operation. Contains the data that is needed to reassign all records that are owned by a specified user to another security principal (user or team). For the Web API use the ReassignObjectsSystemUser Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a complete list of the required privileges, see ReassignObjectsSystemUser message privileges. Entity ownershipUser and team entitiesSystemUser (user) entity messages and methods Contains the response from the class. There is no return value from this operation. Contains the data that is needed to recalculate system-computed values for rollup fields in the goal hierarchy. For the Web API use the Recalculate Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see Recalculate message privileges. Notes for Callers Regardless which goal record is a target of the recalculate operation, the rollup fields for all goals in the specified hierarchy are updated. For each goal in the hierarchy, this operation recalculates the rollup field values that are specified in the associated rollup field () entity records. The remaining goal-related rollup fields contain values. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Goals#Recalculate1 Goal management entitiesSample: Rollup goal data for a custom period against the target revenueHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365Recalculate message privileges Contains the response from the . There is no return value from this operation. Contains the audited details of a change in a relationship. Contains the data that is needed to assign a queue item back to the queue owner so others can pick it. For the Web API use the ReleaseToQueue Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see ReleaseToQueue message privileges. Sample: Release a queue item to the queue (early bound)ReleaseToQueue message privilegesQueueItem entity messages and methods Contains the response from the message. There is no return value from this operation. Contains the data that is needed to remove a queue item from a queue. For the Web API use the RemoveFromQueue Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the privileges required, see RemoveFromQueue message privileges. Notes for Callers This method is equivalent to deleting the queue item. RemoveFromQueue message privilegesQueueItem entity messages and methods Contains the response from the message. There is no return value from this operation. Contains the data that is needed to remove an item from a campaign activity. This message does not have a corresponding Web API action or function in Microsoft Dynamics 365 (online & on-premises). More information: Missing functions and actions for some organization service messages. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the property and the property. For a complete list of the required privileges, see RemoveItemCampaignActivity message privileges. RemoveItemCampaignActivity message privilegesCampaignActivityItem intersect entity metadataCampaignActivity entity messages and methodsMarketing entities (campaign, list)How role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to remove an item from a campaign. This message does not have a corresponding Web API action or function in Microsoft Dynamics 365 (online & on-premises). More information: Missing functions and actions for some organization service messages. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the property and the property. For a complete list of the required privileges, see RemoveItemCampaign message privileges. RemoveItemCampaign message privilegesCampaignItem intersect entity metadataMarketing entities (campaign, list)How role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to remove a member from a list (marketing list). This message does not have a corresponding Web API action or function in Microsoft Dynamics 365 (online & on-premises). More information: Missing functions and actions for some organization service messages. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the property and the property. For a complete list of the required privileges, see RemoveMemberList message privileges. RemoveMemberList message privilegesList (marketing list) entityHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to remove members from a team. For the Web API use the RemoveMembersTeam Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights For a complete list of the privileges required, see RemoveMembersTeam message privileges. User and team entitiesTeam entity messages and methods Contains the response from the class. There is no return value from this operation. Contains the data that is needed to remove the parent for a system user (user) record. For the Web API use the RemoveParent Action Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have access rights on the role record. For a complete list of the privileges required, see RemoveParent message privileges. User and team entitiesSystemUser (user) entity messages and methods Contains the response from the class. There is no return value from this operation. Contains the data that is needed to remove a privilege from an existing role. For the Web API use the RemovePrivilegeRole Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the privileges required, see RemovePrivilegeRole message privileges. Privilege and role entities Contains the response from the class. There is no return value from this operation. Deprecated. Use the entity. Contains the data that is needed to remove a product from a kit. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in and . For a complete list of the required privileges, see RemoveProductFromKit message privileges. Bundles and kitsRemoveProductFromKit message privilegesProduct entity messages and methodsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Deprecated. Use the entity. Contains the response from the . There is no return value from this operation. Bundles and kits Use the class. Contains the data that is needed to remove the relationship between the specified records for specific relationships. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges and access rights on the records that are specified in the property. For a complete list of the required privileges, see RemoveRelated message privileges. Notes for Callers This message works for a limited set of relationships and will be deprecatedin a future version. Instead, use . Supported Relationships The following table shows the entities and relationships that support this message. Entity Relationship Schema Name Invoice contactinvoices_association Lead accountleads_association contactleads_association Opportunity opportunity_customer_accounts opportunitycompetitors_association opportunity_customer_contacts Product competitorproduct_association leadproduct_association Quote contactquotes_association SalesLiterature competitorsalesliterature_association productsalesliterature_association SalesOrder contactorders_association Actions on entity records Contains the response from the class. There is no return value from this operation. Contains the data that is needed to remove a component from an unmanaged solution. For the Web API use the RemoveSolutionComponent Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have the privileges that are listed in RemoveSolutionComponent message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. solutions#WorkWithSolutions6 solutionsVB#WorkWithSolutions6 Sample: Work with solutionsPackage and distribute extensions using solutions Contains the response from the class. For the Web API the RemoveSolutionComponentResponse ComplexType is the response value from the RemoveSolutionComponent Action. There is no return value from this operation. Deprecated. Use the entity. Define product relationships for enhanced suggestions during product saleRemoveSubstituteProduct message privileges Deprecated. Use the entity. Define product relationships for enhanced suggestions during product sale Contains the data that is needed to remove a user from the auto created access team for the specified record. For the Web API use the RemoveUserFromRecordTeam Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the Share privilege on the entity specified in the property. The caller must also have privileges on the entity and the entity and access rights on the records specified in the property and the property. In addition, the caller must have access rights on the record specified in the property that match access rights specified in the team template. For example, if the team template specifies the Read access right on the account entity, the caller must have the Read access right on the account record, specified in the property. For a complete list of required privileges, see RemoveUserFromRecordTeam message privileges. RemoveUserFromRecordTeam message privilegesUse access teams and owner teams to collaborate and share informationUser and team entitiesTeam entity messages and methodsTeamTemplate entity messages and methodsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For the Web API the RemoveUserFromRecordTeamResponse ComplexType is the response value from the RemoveUserFromRecordTeam Action. Contains the data that is needed to renew a contract and create the contract details for a new contract. For the Web API use the RenewContract Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see RenewContract message privileges. Contract entitiesRenewContract message privilegesSample: Manage contractsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to renew an entitlement. For the Web API use the RenewEntitlement Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see RenewEntitlement message privileges. Entitlement entitiesEntitlement entity messages and methodsRenewEntitlement message privileges Contains the response from the message. Contains the data that is needed to replace the privilege set of an existing role. For the Web API use the ReplacePrivilegesRole Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see ReplacePrivilegesRole message privileges. Privilege and role entitiesRole (security role) entity messages and methods Contains the response from the class. There is no return value from this operation. Specifies a resource that is required for a scheduling operation. For the Web API the corresponding type is RequiredResource ComplexType. Sample: Search for openings to schedule a resource Contains the data that is needed to reschedule an appointment, recurring appointment, or service appointment (service activity). For the Web API use the Reschedule Action. Web API support for this message was added with Microsoft Dynamics CRM Online 2016 Update 1 and Microsoft Dynamics CRM 2016 Service Pack 1. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entity in the property and access rights on the specified record in the property. For a list of the required privileges, see Reschedule message privileges. Supported Entities The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available. Entity The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ScheduleAndAppointment#RescheduleandCancelRecurringAppointmentInstance2 ScheduleAndAppointmentVB#RescheduleandCancelRecurringAppointmentInstance2 Schedule and appointment entitiesSample: Reschedule and cancel a recurring appointment Contains the response from the class. Contains the data that is needed to reset the offline data filters for the calling user to the default filters for the organization. For the Web API use the ResetUserFilters Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights For a complete list of the privileges required, see ResetUserFilters message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Outlook#RetrieveDataFilters3 OutlookVB#RetrieveDataFilters3 Offline and Outlook filters and templatesSample: Create and retrieve Outlook filters Contains the response from the class. There is no return value from this operation. Contains information about a resource that has a scheduling problem for an appointment. For the Web API the corresponding type is ResourceInfo ComplexType. Contains the data that is needed to retrieve the absolute URL and the site collection URL for a SharePoint location record in Microsoft Dynamics 365. For the Web API use the RetrieveAbsoluteAndSiteCollectionUrl Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the and entities and access rights on the specified record in the parameter. For a list of the required privileges, see RetrieveAbsoluteAndSiteCollectionUrl message privileges. Notes for Callers This message works only if your target server is SharePoint Server 2010 or 2013, and both the following conditions are true: The Microsoft Dynamics CRM List Component for SharePoint Server is installed on the SharePoint site collection on the target SharePoint Server. For more information, see Microsoft Dynamics CRM list component for Microsoft SharePoint Server. The location record for the parent SharePoint site collection exists in Microsoft Dynamics 365. In addition, the attribute must be set to when you create the parent location record. Otherwise, a blank value is returned for the property. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. SharePointIntegration#RetrieveAbsoluteAndSiteCollectionURLs2 SharePointIntegrationVB#RetrieveAbsoluteAndSiteCollectionURLs2 Actions on SharePoint location recordsSample: Retrieve absolute URL and site collection URL of a location recordSharePointDocumentLocation entity messages and methodsSharePointSite entity messages and methods Contains the response from the class. For the Web API the RetrieveAbsoluteAndSiteCollectionUrlResponse ComplexType is the response value from the RetrieveAbsoluteAndSiteCollectionUrl Function. For the Web API use the RetrieveActivePath Function. Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Contains the data that is needed to retrieve the collection of users that report to the specified system user (user). For the Web API use the RetrieveAllChildUsersSystemUser Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see RetrieveAllChildUsersSystemUser message privileges. User and team entities Contains the response from the class. Contains the data that is needed to retrieve the data that defines the content and behavior of the application ribbon. For the Web API use the RetrieveApplicationRibbon Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the privileges that are listed in RetrieveApplicationRibbon message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ExportRibbonXml#ExportRibbonXml3 ExportRibbonXmlVB#ExportRibbonXml3 Export ribbon definitionsCustomize commands and the ribbon Contains the response from the class. For the Web API the RetrieveApplicationRibbonResponse ComplexType is the response value from the RetrieveApplicationRibbon Function. Contains the data that is needed to retrieve all metadata changes to a specific attribute. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights For a complete list of the privileges required, see RetrieveAttributeChangeHistory message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Auditing#Auditing7 AuditingVB#Auditing7 Audit entity data changesAudit entity messages and methodsSample: Audit entity data changes Contains the response from the class. Contains the data that is needed to retrieve the full audit details from an record. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a list of the required privileges, see RetrieveAuditDetails message privileges. Notes for Callers Changes to entity attribute values are stored in an record in a comma-separated value (.csv) file. The class returns the changed data as a data collection. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Auditing#Auditing8 AuditingVB#Auditing8 Retrieve and delete the history of audited data changesAudit entity data changesSample: Audit entity data changes Contains the response from the class. Retrieve and delete the history of audited data changes Contains the data that is needed to retrieve the list of database partitions that are used to store audited history data. For the Web API use the RetrieveAuditPartitionList Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a list of the required privileges, see RetrieveAuditPartitionList message privileges. Notes for Callers New partitions are automatically created by the Microsoft Dynamics CRM platform on a quarterly basis each year. Audit partitions exist only on Microsoft Dynamics 365 database servers that support partitioning. The partition list is sorted in date order and then returned. Auditing#Auditing6 AuditingVB#Auditing6 Retrieve and delete the history of audited data changesSample: Audit entity data changes Contains the response from the class. For the Web API the RetrieveAuditPartitionListResponse ComplexType is the response value from the RetrieveAuditPartitionList Function. Retrieve and delete the history of audited data changesSample: Audit entity data changes Contains the data that is needed to retrieve the list of language packs that are installed and enabled on the server. For the Web API use the RetrieveAvailableLanguages Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the privileges that are listed in RetrieveAvailableLanguages message privileges. Customize labels to support multiple languages Contains the response from the class. For the Web API the RetrieveAvailableLanguagesResponse ComplexType is the response value from the RetrieveAvailableLanguages Function. Contains the data that is needed to retrieve all business units (including the specified business unit) from the business unit hierarchy. For the Web API use the RetrieveBusinessHierarchyBusinessUnit Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see RetrieveBusinessHierarchyBusinessUnit message privileges. BusinessUnit entity Contains the response from the class. Contains the data that is needed to retrieve all resources that are related to the specified resource group (scheduling group). For the Web API use the RetrieveByGroupResource Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see RetrieveByGroupResource message privileges. Resource entitiesResource entity messages and methods Contains the response from the class. Contains the data that is needed to retrieve the resource groups (scheduling groups) that contain the specified resource. For the Web API use the RetrieveByResourceResourceGroup Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record that is specified in the property. For a complete list of the required privileges, see RetrieveByResourceResourceGroup message privileges. Resource entitiesResourceGroup (scheduling group) entity messages and methods Contains the response from the class. Contains the data that is needed to retrieve the collection of services that are related to the specified set of resources. For the Web API use theRetrieveByResourcesService Function . Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records that are specified in the property. For a complete list of the required privileges, see RetrieveByResourcesService message privileges. Service entityResource entitiesService entity messages and methods Contains the response from the class. Contains the data that is needed to retrieve the top-ten articles about a specified product from the knowledge base of articles for your organization. For the Web API use the RetrieveByTopIncidentProductKbArticle Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the and entities. The caller must also have access rights on the specified record in the property and on the records that are returned in the response of this message. For a complete list of required privileges, see RetrieveByTopIncidentProductKbArticle message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Service#RetrieveByTopIncidentProductKbArticle Knowledge management entitiesSample: Search and retrieve articlesSearchByBodyKbArticle message privilegesProduct entity messages and methodsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to retrieve the top-ten articles about a specified subject from the knowledge base of articles for your organization. For the Web API use the RetrieveByTopIncidentSubjectKbArticle Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the and entities. The caller must also have access rights on the specified record in the property and on the records that are returned in the response of this message. For a complete list of the required privileges, see RetrieveByTopIncidentSubjectKbArticle message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Service#RetrieveByTopIncidentSubjectKbArticle Knowledge management entitiesSample: Search and retrieve articlesSearchByBodyKbArticle message privilegesSubject entityHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For internal use only. For internal use only. Contains the data that’s needed to retrieve information about the current organization. For the Web API use the RetrieveCurrentOrganization Function. While the organization details are available from the discovery service, this message request enables you to get that same information from the organization service that your application is already connected to. Contains the response from processing . For the Web API the RetrieveCurrentOrganizationResponse ComplexType is the response value from the RetrieveCurrentOrganization Function. An instance of a response class is returned from the method. Contains the data that is needed to retrieve a collection of dependency records that describe any solution components that would prevent a solution component from being deleted. For the Web API use the RetrieveDependenciesForDelete Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the privileges that are listed in RetrieveDependenciesForDelete message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Solutions#GetSolutionDependencies8 SolutionsVB#GetSolutionDependencies8 Dependency tracking for solution componentsWork with solutionsSample: Detect solution dependencies Contains the response from the class. Contains the data that is needed to retrieve a list of the solution component dependencies that can prevent you from uninstalling a managed solution. For the Web API use the RetrieveDependenciesForUninstall Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in RetrieveDependenciesForUninstall message privileges. Check for solution component dependenciesPackage and distribute extensions using solutions Contains the response from the class. Contains the data that is needed to retrieves a list dependencies for solution components that directly depend on a solution component. For the Web API use the RetrieveDependentComponents Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in RetrieveDependentComponents message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. optionsets#WorkwithGlobalOptionSets12 optionsetsVB#WorkwithGlobalOptionSets12 Sample: Work with global option setsSample: Detect solution dependenciesCheck for solution component dependenciesPackage and distribute extensions using solutions Contains the response from the class. Contains the data that is needed to retrieve the type of license for a deployment of Microsoft Dynamics 365. For the Web API use the RetrieveDeploymentLicenseType Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a complete list of the required privileges, see RetrieveDeploymentLicenseType message privileges. Contains the response from the class. For the Web API the RetrieveDeploymentLicenseTypeResponse ComplexType is the response value from the RetrieveDeploymentLicenseType Function. Contains the data that is needed to retrieve a list of language packs that are installed on the server that have been disabled. For the Web API use the RetrieveDeprovisionedLanguages Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in RetrieveDeprovisionedLanguages message privileges. Customize labels to support multiple languages Contains the response from the class. For the Web API the RetrieveDeprovisionedLanguagesResponse ComplexType is the response value from the RetrieveDeprovisionedLanguages Function. Contains the data that is needed to detect and retrieve duplicates for a specified record. For the Web API use the RetrieveDuplicates Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entities and the access rights to the specified records in the property. For a complete list of the required privileges, see RetrieveDuplicates message privileges. Notes to Callers This message works for all entities. Before you use this message, set the attribute for an entity to and publish all duplicate detection rules for an entity. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DuplicateDetection#RetrieveDuplicatesRequest RetrieveDuplicates message privilegesSample: Enable duplicate detection and retrieve duplicatesDetect duplicate dataHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to retrieve ribbon definitions for an entity. For the Web API use the RetrieveEntityRibbon Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in RetrieveEntityRibbon message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ExportRibbonXml#ExportRibbonXml4 ExportRibbonXmlVB#ExportRibbonXml4 Export ribbon definitions Contains the response from the class. For the Web API the RetrieveEntityRibbonResponse ComplexType is the response value from the RetrieveEntityRibbon Function. Retrieves the appointments for the current user for a specific date range from the exchange web service. For the Web API use the RetrieveExchangeAppointments Function. Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Use of this message requires that the proper Mailbox and Email Server are set up for the user. If these are not property configured, this message can return the following errors; Error Possible Cause The remote server returned an error: (401) Unauthorized. Email credentials are incorrect. The remote name could not be resolved: '<hostname>' Invalid Exchange Web Services endpoint The remote server returned an error: (403) Forbidden. Invalid SSL (HTTPS) settings Could not determine exchange server URL.. Auto discovery error. Contains the data that is needed to retrieve the exchange rate. For the Web API use the RetrieveExchangeRate Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights to the specified record in the property. For a complete list of the required privileges, see RetrieveExchangeRate message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#TransactionCurrencyExchangeRate1 BusinessManagementVB#TransactionCurrencyExchangeRate1 RetrieveExchangeRate message privilegesTransaction Currency (currency) entitySample: Retrieve currency exchange rateHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For the Web API the RetrieveExchangeRateResponse ComplexType is the response value from the RetrieveExchangeRate Function. Contains the data that is needed to retrieve the entity forms that are available for a specified user. For the Web API use the RetrieveFilteredForms Function. Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in RetrieveFilteredForms message privileges. Create and design forms : Control access to formshttp://technet.microsoft.com/en-us/library/dn531143.aspx#BKMK_ControlAccessToFormsCustomize entity forms Contains the response from the class. Contains the data that is needed to retrieve the formatted results from an import job. For the Web API use the RetrieveFormattedImportJobResults Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a list of the required privileges, see RetrieveFormattedImportJobResults message privileges. Notes for Callers The data is returned in Microsoft Excel format. Work with solutionsImportJob entity messages and methods Contains the response from the class. For the Web API the RetrieveFormattedImportJobResultsResponse ComplexType is the response value from the RetrieveFormattedImportJobResults Function. For internal use only. Use the entity to retrieve FormXml for entities. SystemForm (system dashboard) entity messages and methods For internal use only. For internal use only. Contains the data that is needed to retrieve the list of language packs that are installed on the server. For the Web API use the RetrieveInstalledLanguagePacks Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in RetrieveInstalledLanguagePacks message privileges. Customize labels to support multiple languages Contains the response from the class. For the Web API the RetrieveInstalledLanguagePacksResponse ComplexType is the response value from the RetrieveInstalledLanguagePacks Function. Contains the data that is needed to retrieve the version of an installed language pack. For the Web API use the RetrieveLicenseInfo Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in RetrieveInstalledLanguagePackVersion message privileges. Customize labels to support multiple languages Contains the response from the class. For the Web API the RetrieveInstalledLanguagePackVersionResponse ComplexType is the response value from the RetrieveInstalledLanguagePackVersion Function. Contains the data that is needed to retrieve the number of used and available licenses for a deployment of Microsoft Dynamics 365. For the Web API use the RetrieveLicenseInfo Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a complete list of the required privileges, see RetrieveLicenseInfo message privileges. Contains the response from the class. For the Web API the RetrieveLicenseInfoResponse ComplexType is the response value from the RetrieveLicenseInfo Function. Contains the data that is needed to retrieve localized labels for a limited set of entity attributes. For the Web API use the RetrieveLocLabels Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in RetrieveLocLabels message privileges. Notes for Callers This message only retrieves the localized display names for specific entity attributes or localizable properties. It can’t retrieve localized labels that are used for other application user interface areas, such as the labels that are used in the ribbon or form elements. Supported Entities This message only supports the following entity attributes or localized property values DynamicProperty.Name DynamicPropertyOptionSetItem.DynamicPropertyOptionName DynamicPropertyOptionSetItem.DynamicPropertyOptionDescription Product.Name SavedQuery.Description SavedQuery.Name SavedQueryVisualization.Description SavedQueryVisualization.Name SystemForm.Description SystemForm.Name TimeZoneDefinition.UserInterfaceName TimeZoneDefinition.StandardName TimeZoneLocalizedName.UserInterfaceName Customize labels to support multiple languagesLocalize product property values Contains the response from the class. Contains the data needed to retrieve folder-level tracking rules for a mailbox. For the Web API use the RetrieveMailboxTrackingFolders Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the and entities, and access rights on the specified record in the property. The following example shows how to use this message to retrieve folder-level tracking rules for a mailbox. For this sample to work correctly, you must be connected to the server to get an interface. // Retrieve the folder mapping rules for a Mailbox RetrieveMailboxTrackingFoldersRequest req = new RetrieveMailboxTrackingFoldersRequest { MailboxId = _mailboxId.ToString() }; RetrieveMailboxTrackingFoldersResponse resp = (RetrieveMailboxTrackingFoldersResponse) _serviceProxy.Execute(req); Console.WriteLine("Retrieved folder-level tracking rules for {0}:", _mailboxName); int n = 1; foreach (var folderMapping in resp.MailboxTrackingFolderMappings) { Console.WriteLine("\tRule {0}: '{1}' is mapped to '{2}'.", n, folderMapping.ExchangeFolderName, folderMapping.RegardingObjectName); n++; } Configure Exchange folder-level tracking rules Contains the response from the class. For the Web API the RetrieveMailboxTrackingFoldersResponse ComplexType is the response value from the RetrieveMailboxTrackingFolders Function. Configure Exchange folder-level tracking rules Contains the data that is needed to retrieve the members of a bulk operation. For the Web API use the RetrieveMembersBulkOperation Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record that is contained in the property. The caller must also have access rights on the records that are returned from the query. For a complete list of the required privileges, see RetrieveMembersBulkOperation message privileges. RetrieveMembersBulkOperation message privilegesBulkOperation (quick campaign) entity messages and methodsSample: Distribute campaign activities to qualified marketing listHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Deprecated. Use the class. RetrieveMembersTeam message privileges Deprecated. Use the class and its associated response class. Contains the response from the class. Contains the data that is needed to retrieve a list of missing components in the target organization. For the Web API use the RetrieveMissingComponents Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in RetrieveMissingComponents message privileges. Notes for Callers The solution file contains a list of required components. This message uses the list in the file to query the target organization and returns any components that are not in the target organization in the property. Dependency tracking for solution components Contains the response from the class. For the Web API the RetrieveMissingComponentsResponse ComplexType is the response value from the RetrieveMissingComponents Function. Contains the data that is needed to retrieve any required solution components that are not included in the solution. For the Web API use the RetrieveMissingDependencies Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in RetrieveMissingDependencies message privileges. Notes for Callers Use this message before exporting a solution to determine which solution components not currently included in the solution must exist in the target organization in order to successfully import this solution. Dependency tracking for solution components Contains the response from the class. Contains the data that is needed to retrieve the resources that are used by an organization. For the Web API use the RetrieveOrganizationResources Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a complete list of the required privileges, see RetrieveOrganizationResources message privileges. Organization entity messages and methods Contains the response from the class. For the Web API the RetrieveOrganizationResourcesResponse ComplexType is the response value from the RetrieveOrganizationResources Function. Contains the data needed to retrieve the collection of the parent resource groups of the specified resource group (scheduling group). For the Web API use the RetrieveParentGroupsResourceGroup Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the privileges required, see RetrieveParentGroupsResourceGroup message privileges. Resource entitiesResourceGroup (scheduling group) entity messages and methods Contains the response from the class. Contains the data that is needed to retrieve the data from the parse table. For the Web API use the RetrieveParsedDataImportFile Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the required privileges, see RetrieveParsedDataImportFile message privileges. Notes for Callers The parsed data is returned in a two-dimensional array of strings in the property of the message response. The data is returned with the same column order as the column order in the source file. Use this message only after you have created a parse table by using the message. Do not use this message after you use the message. You cannot access the parse table after the import job submitted by the message has finished running. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DataImport#ImportWithCreate4 DataImportVB#ImportWithCreate4 Import dataImportFile entity messages and methodsSample: Import data using complex data mapRetrieveParsedDataImportFile message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. For the Web API the RetrieveParsedDataImportFileResponse ComplexType is the response value from the RetrieveParsedDataImportFile Function. Contains the data that is needed to retrieve pages of posts, including comments for each post, for all records that the calling user is following. For the Web API use the RetrievePersonalWall Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a complete list of the required privileges, see RetrievePersonalWall message privileges. Notes for Callers The posts that are retrieved for your personal wall include the following: the posts that are regarding the records that you follow; the posts that mention records that you follow; and the posts that are regarding you or that mention you. If a post is regarding a record, the attribute contains the record ID. If a post mentions a record, the record ID is specified within the attribute. You can only follow records that you have Read permissions for. If you lose Read permissions on a record, a follow is automatically removed. All Microsoft Dynamics 365 users automatically follow themselves. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ActivityFeeds#RetrievePersonalWall ActivityFeedsVB#RetrievePersonalWall RetrievePersonalWall message privilegesActivity feeds entitiesSample: Collaborate with activity feedsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to retrieve the access rights of the specified security principal (team or user) to the specified record. For the Web API use the RetrievePrincipalAccess Function. Message Availability This message works regardless whether the caller is connected to the server or offline. However, a few entities of this message class are exceptions to that availability. To determine which entities have a more restricted availability, see Supported Entities later in this topic. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity that is specified by the property and access rights on the specified record in the property. For a complete list of the required privileges, see RetrievePrincipalAccess message privileges. Supported Entities The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) Annotation 2 (Both) Appointment 2 (Both) AsyncOperation 2 (Both) BulkOperation 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignResponse 2 (Both) Connection 2 (Both) Contact 2 (Both) Contract 2 (Both) ConvertRule 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) DuplicateRule 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) Fax 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) Import 2 (Both) ImportFile 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) Invoice 2 (Both) Lead 2 (Both) Letter 2 (Both) List 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OrderClose 2 (Both) PhoneCall 2 (Both) ProcessSession 2 (Both) Queue 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) RecurringAppointmentMaster 2 (Both) Report 2 (Both) RoutingRule 2 (Both) SalesOrder 2 (Both) ServiceAppointment 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) SLA 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialProfile 2 (Both) Task 2 (Both) Template 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) Workflow 2 (Both) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. StrongTypes#UserAccess4 StrongTypesVB#UserAccess4 How record-based security can be used to control access to records in Microsoft Dynamics 365Entity ownershipSample: Share records using GrantAccess, ModifyAccess and RevokeAccess messages Contains the response from the class. Contains the data that is needed to retrieves all the secured attribute privileges a user or team has through direct or indirect (through team membership) associations with the entity. For the Web API use the RetrievePrincipalAttributePrivileges Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have access rights on the record specified in the property. For a complete list of the privileges required, see RetrievePrincipalAttributePrivileges message privileges. How field security can be used to control access to field values in Microsoft Dynamics 365Field security entitiesFieldSecurityProfile entity messages and methods Contains the response from the class. For the Web API the RetrievePrincipalAttributePrivilegesResponse ComplexType is the response value from the RetrievePrincipalAttributePrivileges Function. For internal use only. For the Web API use the RetrievePrincipalSyncAttributeMappings Function. For internal use only. For the Web API the RetrievePrincipalSyncAttributeMappingsResponse ComplexType is the response value from the RetrievePrincipalSyncAttributeMappings Function. Contains the data needed to retrieve the set of privileges defined in the system. For the Web API use the RetrievePrivilegeSet Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights For a complete list of the privileges required, see RetrievePrincipalAttributePrivileges message privileges. How role-based security can be used to control access to entities in Microsoft Dynamics 365Privilege and role entitiesPrivilege entity messages and methods Contains the response from the class. For the Web API use the RetrieveProcessInstances Function. Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Contains data that is needed to retrieve all the property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice. For the Web API use the RetrieveProductProperties Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the , , , , and entities and access rights on the record specified in the property. DynamicPropertyInstance (property instance) methods and messages Contains the response from the class. Contains the data that is needed to retrieve the version of a provisioned language pack. For the Web API use the RetrieveProvisionedLanguagePackVersion Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in RetrieveProvisionedLanguagePackVersion message privileges. Customize labels to support multiple languages Contains the response from the class. Contains the data that is needed to retrieve the list of provisioned languages. For the Web API use the RetrieveProvisionedLanguages Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in RetrieveProvisionedLanguages message privileges. Customize labels to support multiple languages Contains the response from the class. There is no return value from this operation. Contains the data that is needed to retrieve all attribute data changes for a specific entity. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a list of the required privileges, see RetrieveRecordChangeHistory message privileges. Auditing#Auditing5 AuditingVB#Auditing5 Retrieve and delete the history of audited data changesSample: Audit entity data changes Contains the response from the class. Sample: Audit entity data changes Contains the data that is needed to retrieve pages of posts, including comments for each post, for a specified record. For the Web API use the RetrieveRecordWall Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the privileges on the specified entity in the property and the access rights on the records that the returned posts regard or mention. For a complete list of the required privileges, see RetrieveRecordWall message privileges. Notes for Callers The posts that are retrieved for a record wall include the posts that are regarding the record or that mention the record. For a system user (user) record wall, retrieved posts also include the posts that the user created. If a post is regarding a record, the attribute contains the record ID. If a record is the system user (user) record, the attribute contains the current user ID. If a post mentions a record, the record ID is specified within the attribute. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ActivityFeeds#RetrieveRecordWall ActivityFeedsVB#RetrieveRecordWall RetrieveRecordWall message privilegesActivity feeds entitiesIntroduction to activity feedsSample: Collaborate with activity feedsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to retrieve a collection of solution components that are required for a solution component. For the Web API use the RetrieveRequiredComponents Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have the privileges that are listed in RetrieveRequiredComponents message privileges. Dependency tracking for solution componentsPackage and distribute extensions using solutions Contains the response from the class. Contains the data that is needed to retrieve the privileges that are assigned to the specified role. For the Web API use the RetrieveRolePrivilegesRole Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see RetrieveRolePrivilegesRole message privileges. How role-based security can be used to control access to entities in Microsoft Dynamics 365Privilege and role entitiesPrivilege entity messages and methodsRole (security role) entity messages and methods Contains the response from the class. For the Web API the RetrieveRolePrivilegesRoleResponse ComplexType is the response value from the RetrieveRolePrivilegesRole Function. Contains the data that is needed to retrieve all security principals (users or teams) that have access to, and access rights for, the specified record. Message Availability This message works regardless whether the caller is connected to the server or offline. However, a few entities of this message class are exceptions to that availability. To determine which entities have a more restricted availability, see Supported Entities later in this topic. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the privileges on the specified entity in the property and access rights on the specified record in the property. For a complete list of the required privileges, see the topic RetrieveSharedPrincipalsAndAccess message privileges. Supported Entities The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) Annotation 2 (Both) Appointment 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignResponse 2 (Both) Connection 2 (Both) Contact 2 (Both) Contract 2 (Both) ConvertRule 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) DuplicateRule 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) Fax 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) Import 2 (Both) ImportFile 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) Invoice 2 (Both) Lead 2 (Both) Letter 2 (Both) List 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OrderClose 2 (Both) PhoneCall 2 (Both) ProcessSession 2 (Both) Queue 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) RecurringAppointmentMaster 2 (Both) Report 2 (Both) RoutingRule 2 (Both) SalesOrder 2 (Both) ServiceAppointment 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) SLA 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialProfile 2 (Both) Task 2 (Both) Template 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) Workflow 2 (Both) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. StrongTypes#UserAccess5 StrongTypesVB#UserAccess5 How record-based security can be used to control access to records in Microsoft Dynamics 365Entity ownershipSample: Share records using GrantAccess, ModifyAccess and RevokeAccess messages Contains the response from the class. Contains the data that is needed to retrieve the collection of child resource groups from the specified resource group (scheduling group). For the Web API use the RetrieveSubGroupsResourceGroup Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see RetrieveSubGroupsResourceGroup message privileges. Resource entitiesResourceGroup (scheduling group) entity messages and methods Contains the response from the class. Deprecated. Use the class. Contains the data needed to retrieve a collection of entity instances based on the specified query criteria. RetrieveSubsidiaryTeamsBusinessUnit message privileges Deprecated. Use the class and its associated response class. Deprecated. Use the class. Contains the data needed to retrieve all user information from the child business units of the specified business unit. RetrieveSubsidiaryUsersBusinessUnit message privileges Deprecated. Use the class and its associated response class. Contains the response from the message. Contains the data that is needed to retrieve the privileges for a team. For the Web API use the RetrieveTeamPrivileges Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see RetrieveTeamPrivileges message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. StrongTypesVB#AssignRecordToTeam3 Team entity messages and methodsSample: Assign a record to a team Contains the response from the class. For the Web API the RetrieveTeamPrivilegesResponse ComplexType is the response value from the RetrieveTeamPrivileges Function. Deprecated. Use the class. Contains the data needed to retrieve the list of teams of which the specified user is a member. RetrieveTeamsSystemUser message privileges Deprecated. Use the class and its associated response class. Contains the response from the message. Contains the data that is needed to retrieve a collection of unpublished organization-owned records that satisfy the specified query criteria. For the Web API use the RetrieveUnpublishedMultiple Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entities in the property and read access rights on the records that are returned from the query. For a list of the required privileges, see RetrieveUnpublishedMultiple message privileges. Notes for Callers This message is included to support scenarios where you are creating a program to edit these types of entity records. These organization-owned entities can be published. This message corresponds to the message except that it returns the current unpublished version of the records. As soon as the records are published, this message and return the same data. Because these records are automatically published when they are created or deleted, this message and always return the same number of records. Supported Entities The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available. Entity Availability SavedQuery Server SavedQueryVisualization Server SiteMap Server SystemForm Server WebResource Server Publish customizations Contains the response from the class. Contains the data that is needed to retrieve an unpublished record. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have read access rights on the record specified in the property and the privileges that are listed in RetrieveUnpublished message privileges. Notes for Callers This message is included to support scenarios where you are creating a program to edit these types of entity records. These organization-owned entities can be published. This message corresponds to the class except that it returns the current unpublished version of the record. When the record is published, this method and return the same data. Because these records are automatically published when they are created or deleted, this message and only retrieve different data when a record has been updated but not published. Supported Entities The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available. Entity Availability savedquery Server savedqueryvisualization Server systemform Server webresource Server Publish customizations Contains the response from the class. Contains the data needed to retrieve the privileges a system user (user) has through his or her roles in the specified business unit. For the Web API use the RetrieveUserPrivileges Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the privileges required, see RetrieveUserPrivileges message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. // Get the GUID of the current user. WhoAmIRequest whoAmI = new WhoAmIRequest(); Guid userLoggedId = ((WhoAmIResponse)_serviceProxy.Execute(whoAmI)).UserId; Console.WriteLine("User logged: " + userLoggedId); // Check if this user has prvReadPOAA. RetrieveUserPrivilegesRequest userPrivilegesRequest = new RetrieveUserPrivilegesRequest(); userPrivilegesRequest.UserId = userLoggedId; RetrieveUserPrivilegesResponse userPrivilegesResponse = (RetrieveUserPrivilegesResponse)_serviceProxy.Execute(userPrivilegesRequest); // Fixed the GUID for prvReadPOAA. Guid prvReadPOAA = new Guid("{68564CD5-2B2E-11DF-80A6-00137299E1C2}"); if (userPrivilegesResponse.RolePrivileges.Any(r => r.PrivilegeId.Equals(prvReadPOAA))) { Console.WriteLine("This user DOES have prvReadPOAA"); } else { Console.WriteLine("This user DOESN'T have prvReadPOAA"); } SystemUser (user) entity messages and methods Contains the response from the class. For the Web API the RetrieveUserPrivilegesResponse ComplexType is the response value from the RetrieveUserPrivileges Function. Contains the data needed to retrieve all private queues of a specified user and optionally all public queues. For the Web API use the RetrieveUserQueues Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the privileges required, see RetrieveUserQueues message privileges. Queue entity messages and methods Contains the response from the message. Deprecated. Use the class. Contains the data needed to retrieve the user settings for the specified system user (user). RetrieveUserSettingsSystemUser message privileges Deprecated. Use the class and its associated response class. Contains the data that is needed to retrieve the version number of the Microsoft Dynamics 365 Server. For the Web API use the RetrieveVersion Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights There are no special privileges or access rights required to use this message. Contains the response from the class. For the Web API the RetrieveVersionResponse ComplexType is the response value from the RetrieveVersion Function. Contains the data that is needed to revert changes done to properties of a product family, product, or bundle record, and set it back to its last published () state. For the Web API use the RevertProduct Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. Notes to Callers All the product property (attribute) changes done to the record since it was last published () will be lost. Revert a product family, product, or bundleProduct catalog entities Contains the response from the class. There is no return value from this operation. Contains the data that is needed to set the state of a quote to Draft. For the Web API use the ReviseQuote Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights to the specified record in the property. For a complete list of the required privileges, see ReviseQuote message privileges. ReviseQuote message privilegesQuote entity messages and methodsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to replace the access rights on the target record for the specified security principal (user or team). For the Web API use the RevokeAccess Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entity in the property and access rights on the specified record in the property. For a list of the required privileges, see RevokeAccess message privileges. Notes for Callers This action also applies to all child records of the target record. However for all child records, access rights are only modified if the caller has share privileges for those entity types and share access rights to the records. As a result, the owner of the target record, or a user who shares the target record, automatically has share rights to all child records of the target record. For a description of how actions on a parent record affect child records, see Cascading behavior. Supported Entities The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available. Entity Availability Account 0 (Server) Annotation 0 (Server) Appointment 0 (Server) Campaign 0 (Server) CampaignActivity 0 (Server) CampaignResponse 0 (Server) Connection 0 (Server) Contact 0 (Server) Contract 0 (Server) ConvertRule 0 (Server) CustomerOpportunityRole 0 (Server) CustomerRelationship 0 (Server) DuplicateRule 0 (Server) Email 0 (Server) EmailServerProfile 0 (Server) Entitlement 0 (Server) Fax 0 (Server) Goal 0 (Server) GoalRollupQuery 0 (Server) Import 0 (Server) ImportFile 0 (Server) ImportMap 0 (Server) Incident 0 (Server) IncidentResolution 0 (Server) Invoice 0 (Server) Lead 0 (Server) Letter 0 (Server) List 0 (Server) Mailbox 0 (Server) MailMergeTemplate 0 (Server) msdyn_PostAlbum 0 (Server) msdyn_wallsavedqueryusersettings 0 (Server) Opportunity 0 (Server) OpportunityClose 0 (Server) OrderClose 0 (Server) PhoneCall 0 (Server) ProcessSession 0 (Server) Queue 0 (Server) Quote 0 (Server) QuoteClose 0 (Server) RecurringAppointmentMaster 0 (Server) Report 0 (Server) RoutingRule 0 (Server) SalesOrder 0 (Server) ServiceAppointment 0 (Server) SharePointDocumentLocation 0 (Server) SharePointSite 0 (Server) SLA 0 (Server) SLAKPIInstance 0 (Server) SocialActivity 0 (Server) SocialProfile 0 (Server) Task 0 (Server) Template 0 (Server) UserForm 0 (Server) UserQuery 0 (Server) UserQueryVisualization 0 (Server) Workflow 0 (Server) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. StrongTypes#UserAccess3 StrongTypesVB#UserAccess3 How record-based security can be used to control access to records in Microsoft Dynamics 365Actions on entity recordsSample: Share records using GrantAccess, ModifyAccess and RevokeAccess messages Contains the response from the class. There is no return value from this operation. Contains the values for ribbon filters for an entity. For the Web API use the RibbonLocationFilters EnumType. This enumeration is used with . Retrieve just the form ribbon. Value = 1. Retrieve just the ribbon displayed for entity grids. Value = 2. Retrieve just the ribbon displayed when the entity is displayed in a subgrid or associated view. Value = 4. Retrieve all Ribbons. Equivalent to . Value = 7. Retrieve all Ribbons. Equivalent to . Value = 7. Contains information about a privilege. For the Web API the corresponding type is RolePrivilege ComplexType. How role-based security can be used to control access to entities in Microsoft Dynamics 365Privilege and role entitiesSample: Assign a record to a team Represents audited changes to the privileges of a security role. How role-based security can be used to control access to entities in Microsoft Dynamics 365 Contains the data that is needed to retrieve all the entity records that are related to the specified record. For the Web API use the Rollup Function. Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . A rollup operation retrieves all annotations that are related to a specified account. An annotation is a note that is attached to one or more objects, including other notes. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entities in the properties. The caller must also have access rights on the specified record in the property and read access rights on the records that are returned from the query. For a complete list of the required privileges, see Rollup message privileges. Notes for Callers The target entities include: account, contact, and opportunity. The rollup type () for the supported entities depends on the target entity type. Supported Entities The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability activitypointer Both annotation Both contract Both incident Both invoice Both opportunity Both quote Both salesorder Both Rollup Types The following table lists the available rollup types for each supported entity depending on the target of the rollup operation. Supported entity Target entity Rollup type The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#Rollup1 Rollup message privilegesSample: Rollup records related to a specific recordHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the possible values for the property in the class, which you use to retrieve all the entity records for a specified record. Used in the property. Entity relationship behavior A rollup record is not requested. This member only retrieves the records that are directly related to a parent record. Value = 0. A rollup record that is directly related to a parent record and to any direct child of a parent record. Value = 1. A rollup record that is directly related to a parent record and to any descendent record of a parent record, for example, children, grandchildren, and great-grandchildren records. Value = 2. Contains the data that is needed to route a queue item to a queue, a user, or a team. For the Web API use the RouteTo Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. The caller must also have privileges for the entity. QueueItem entity messages and methods Contains the response from the message. There is no return value from this operation. QueueItem entity messages and methods Contains the data that is needed to search for knowledge base articles that contain the specified body text. For the Web API use the SearchByBodyKbArticle Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of. Privileges and Access Rights To perform this action, the caller must have privileges on the and entities. The caller must also have access rights on the record specified in the property and on the records returned from the query. For a complete list of required privileges, see SearchByBodyKbArticle message privileges. Notes for Callers This message supports queries using Query Expression and FetchXML. For more information see Retrieve data with queries using SDK assemblies. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Service#SearchByBodyKbArticle Knowledge management entitiesSubject entitySample: Search and retrieve articlesSearchByBodyKbArticle message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to search for knowledge base articles that contain the specified keywords. For the Web API use the SearchByKeywordsKbArticle Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of. Privileges and Access Rights To perform this action, the caller must have privileges on the and entities. The caller must also have access rights on the record specified in the property and on the records returned from the query. For a complete list of required privileges, see SearchByKeywordsKbArticle message privileges. Notes for Callers This message supports queries using Query Expression and FetchXML. For more information see Retrieve data with queries using SDK assemblies. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Service#SearchByKeywordsKbArticle Knowledge management entitiesSubject entitySample: Search and retrieve articlesSearchByKeywordsKbArticle message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to search for knowledge base articles that contain the specified title. For the Web API use the SearchByTitleKbArticle Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the and entities. The caller must also have access rights on the specified record in the property and on the records that are returned from the query. For a complete list of the required privileges, see SearchByTitleKbArticle message privileges. Notes for Callers This message supports queries that use a query expression and FetchXML. For more information, see Retrieve data with queries using SDK assemblies. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Service#SearchByTitleKbArticle Knowledge management entitiesSample: Search and retrieve articlesSearchByTitleKbArticle message privilegesSubject entityHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the possible values for the search direction in an appointment request. For the Web API use the SearchDirection EnumType. This enumeration is used for the property. Search forward in the calendar. Value = 0. Search backward in the calendar. Value = 1. Contains the data needed to search for available time slots that fulfill the specified appointment request. For the Web API use the Search Function. Message Availability For this message to work, the caller must be connected to the server. Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights For a list of the privileges required, see Search message privileges. Notes for Callers This message will return a set of available appointments as time blocks. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ScheduleAndAppointment#ScheduleResource1 ScheduleAndAppointmentVB#ScheduleResource1 Schedules in Microsoft Dynamics 365Sample: Search for openings to schedule a resourceAppointment entity messages and methods Contains the response from the class. For the Web API the SearchResponse ComplexType is the response value from the Search Function. Contains the results from the message. For the Web API the corresponding type is SearchResults ComplexType. Sample: Search for openings to schedule a resource Contains the data that is needed to send bulk email messages. For the Web API use the SendBulkMail Action . Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a list of the privileges required, see SendBulkMail message privileges. Notes for Callers To specify the tracking parameter, set the property as follows: request.RequestId = trackingId; Email activity entitiesEmail entity messages and methods Contains the response from the class. There is no return value from this operation. Contains the data that is needed to send an email message using a template. For the Web API use the SendEmailFromTemplate Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the , and properties. For a complete list of the privileges required, see SendEmailFromTemplate message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Activities#SendEmailUsingTemplate1 ActivitiesVB#SendEmailUsingTemplate1 Email activity entitiesEmail entity messages and methodsSample: Send an email using a template Contains the response from the class. Contains the data that is needed to send an email message. For the Web API use the SendEmail Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a list of the privileges required, see SendEmail message privileges. Email activity entitiesEmail entity messages and methods Contains the response from the class. For the Web API the SendEmailResponse ComplexType is the response value from the SendEmail Action. Contains the data that is needed to send a fax. For the Web API use the SendFax Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a list of the privileges required, see SendFax message privileges. Email activity entitiesFax entity messages and methods Contains the response from the class. There is no return value from this operation. Contains the data that is needed to send a bulk email message that is created from a template. For the Web API use the SendTemplate Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a list of the required privileges, see SendTemplate message privileges. Email activity entitiesTemplate (email template) entity messages and methods Contains the response from the class. There is no return value from this operation. Contains the data that is needed to assign equipment (facility/equipment) to a specific business unit. For the Web API use the SetBusinessEquipment Action. This message request is deprecated. Consider using the instead. For more information see Perform specialized operations using Update. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the and properties. For a list of the privileges required, see SetBusinessEquipment message privileges. Resource entitiesEquipment (facility/equipment) entity messages and methods Contains the response from the class. There is no return value from this operation. Contains the data that is needed to move a system user (user) to a different business unit. For the Web API use the SetBusinessSystemUser Action. This message request is deprecated. Consider using the instead. For more information see Perform specialized operations using Update. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the and properties. For a list of the privileges required, see SetBusinessSystemUser message privileges. Notes for Callers You must specify a value for the property. The instances of the entities that had been assigned to the user specified by the property will be assigned to that security principal (user). If any of the direct reports of the user are no longer in the new business unit hierarchy after the user is moved, these direct reports are updated to report to the previous manager of the user. If the user has been moved out of his or her manager's business-unit hierarchy, the manager of the user is set to null. You may list the same user for both the and properties if you would like the user to retain the entities assigned. Administration and security entitiesSystemUser (user) entity messages and methods Contains the response from the class. There is no return value from this operation. For the Web API use the SetFeatureStatus Action . Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Contains the data that is needed to set localized labels for a limited set of entity attributes. For the Web API use the SetLocLabels Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in SetLocLabels message privileges. Notes for Callers This message only sets the localized display names for specific entity attributes. It cannot set localized labels used for other application user interface areas such as labels used in the ribbon or form elements. Supported Entities This message is supported by the following entity attributes and localizable properties: DynamicProperty.Name DynamicPropertyOptionSetItem.DynamicPropertyOptionName DynamicPropertyOptionSetItem.DynamicPropertyOptionDescription Product.Name SavedQuery.Description SavedQuery.Name SavedQueryVisualization.Description SavedQueryVisualization.Name SystemForm.Description SystemForm.Name TimeZoneDefinition.UserInterfaceName TimeZoneDefinition.StandardName TimeZoneLocalizedName.UserInterfaceName Customize labels to support multiple languagesLocalize product property values Contains the response from the class. There is no return value from this operation. Contains the data that is needed to set the parent business unit for a business unit. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the and properties. For a list of the privileges required, see SetParentBusinessUnit message privileges. Contains the response from the class. There is no return value from this operation. Contains the data needed to set a new parent system user (user) for the specified user. This message request is deprecated. Consider using the instead. For more information see Perform specialized operations using Update. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the and properties. For a list of the privileges required, see SetParentSystemUser message privileges. User and team entitiesSystemUser (user) entity messages and methods Contains the response from the class. There is no return value from this operation. Contains the data needed to set the parent business unit of a team. This message request is deprecated. Consider using the instead. For more information see Perform specialized operations using Update. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the records specified in the and properties. For a list of the privileges required, see SetParentTeam message privileges. User and team entitiesTeam entity messages and methods Contains the response from the class. There is no return value from this operation. Contains the data that is needed to set the process that associates with a given target entity. The user can set to another business process or specify to clear out the current process. Contains the response from executing the class. Contains the data needed to create a relationship between a set of records that participate in specific relationships. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have access rights on the records specified in the property. For a list of the privileges required, see SetRelated message privileges. Notes for Callers This message works for a limited set of relationships and will be deprecated in a future version. Use instead. Executing this message when the relationship already exists will result in an error. Supported Relationships The following table shows which relationships support this message. Entity Relationship Schema Name Invoice contactinvoices_association Lead accountleads_association contactleads_association Opportunity opportunity_customer_accounts opportunitycompetitors_association opportunity_customer_contacts Product competitorproduct_association leadproduct_association Quote contactquotes_association SalesLiterature competitorsalesliterature_association productsalesliterature_association SalesOrder contactorders_association Actions on entity records Contains the response from the class. There is no return value from this operation. Contains the data needed to link an instance of a report entity to related entities. For the Web API use the SetReportRelated Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a list of the privileges required, see SetReportRelated message privileges. Developers guide to reports for Microsoft Dynamics 365Report entity messages and methods Contains the response from . There is no return value from this operation. Contains the data that’s needed to set the state of an entity record. This message request is deprecated. Consider using the instead. For more information see Perform specialized operations using Update. Message Availability This message works regardless whether the caller is connected to the server or offline. Not all entity types support this message offline. See Supported Entities later in this topic. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entity in the property. For a complete list of the required privileges, see SetState message privileges. Valid State and Status value combinations The valid combinations of state and status code values varies for many entities. For a list of default values for specific system entities, see Default status and status reason values. For a list of the state and status values valid for custom entities in your organization, refer to the entity metadata. No token name is specified <token xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"> <?Comment JD: The link to the conceptual topic within this token does not work in compiled helpmreftopics. 2014-06-02T12:35:00Z Id='16?>metadata_browser<?CommentEnd Id='16' ?></token>. Supported Entities The following table shows the default entities that support this message and whether the message is available when the caller is connected to the server (Server), disconnected from the server (Offline) or both (Both). Entity Availability Account 2 (Both) Appointment 2 (Both) BusinessUnit 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignResponse 2 (Both) Connection 2 (Both) ConnectionRole 2 (Both) Contact 2 (Both) Contract 2 (Both) ContractDetail 2 (Both) ConvertRule 2 (Both) DiscountType 2 (Both) DynamicProperty 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) Fax 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) Invoice 2 (Both) KbArticle 2 (Both) Lead 2 (Both) Letter 2 (Both) List 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) Metric 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OrderClose 2 (Both) PhoneCall 2 (Both) Position 2 (Both) PriceLevel 2 (Both) ProcessSession 2 (Both) Product 2 (Both) ProductAssociation 2 (Both) Queue 2 (Both) QueueItem 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) RecurringAppointmentMaster 2 (Both) RelationshipRole 2 (Both) RoutingRule 2 (Both) SalesOrder 2 (Both) SavedQuery 2 (Both) SdkMessageProcessingStep 2 (Both) ServiceAppointment 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) SLA 2 (Both) SocialActivity 2 (Both) SocialProfile 2 (Both) SystemUser 2 (Both) Task 2 (Both) TransactionCurrency 2 (Both) UoMSchedule 2 (Both) UserQuery 2 (Both) Workflow 2 (Both) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#SetState SetState message privilegesSample: Validate record state and set the state of the recordHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Represents a shared audit detail record. Contains the possible values for a subcode, used in scheduling appointments. For the Web API use the SubCode EnumType. Specifies free time with no specified restrictions. Value = 0. A schedulable block of time. Value = 1. A block of time that is committed to perform an action. Value = 2. A block of time that is tentatively scheduled but not committed. Value = 3. A block of time that cannot be committed due to a scheduled break. Value = 4. A block of time that cannot be scheduled due to a scheduled holiday. Value = 5. A block of time that cannot be scheduled due to a scheduled vacation. Value = 6. A block of time that is already scheduled for an appointment. Value = 7. Specifies to filter a resource start time. Value = 8. A restriction for a resource for the specified service. Value = 9. Specifies the capacity of a resource for the specified time interval. Value = 10. Specifies that a service is restricted during the specified block of time. Value = 11. An override to the service cost for the specified time block. Value = 12. Indicates the attribute type for the target of the message. Initialize all possible attribute values. Value = 0. Initialize the attribute values that are valid for create. Value = 1. initialize the attribute values that are valid for update. Value = 2. Initialize the attribute values that are valid for read. Value = 3. Contains the possible values for a time code, used when querying a schedule. For the Web API use the TimeCode EnumType. The time is available within the working hours of the resource. Value = 0. The time is committed to an activity. Value = 1. The time is unavailable. Value = 2. Use additional filters for the time block such as service cost or service start time. Value = 3. Specifies a set of time blocks with appointment information. For the Web API the corresponding type is TimeInfo ComplexType. Specifies the results of a scheduling operation using the , , , or messages. For the Web API the corresponding type is TraceInfo ComplexType. Contains the data that is needed to submit an asynchronous job that transforms the parsed data. For the Web API use the TransformImport Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the specified record in the property. For a complete list of the required privileges, see TransformImport message privileges. Notes for Callers Pass the ID of the associated import (data import) in the property. The ID of the asynchronous job that runs in the background and performs the transformation is returned in the property of the message response. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DataImport#ImportWithCreate5 DataImportVB#ImportWithCreate5 Import dataImport (data import) entity messages and methodsRun data importSample: Import data using complex data mapTransformImport message privilegesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to validate the configuration of a Microsoft Azure Service Bus solution’s service endpoint. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which will return an instance of . Privileges and Access Rights For a list of the privileges required, seeTriggerServiceEndpointCheck message privileges. ServiceEndpoint entity messages and methods Contains the response from the . Contains the data that is needed to unlock pricing for an invoice. For the Web API use the UnlockInvoicePricing Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of required privileges, see UnlockInvoicePricing message privileges. Notes to Callers This message unlocks the total price of products and services specified in the invoice. When the invoice pricing is unlocked, changes to underlying price lists (price level) can affect the prices for an invoice. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#UnlockInvoicePricing UnlockInvoicePricing message privilegesInvoice entity messages and methodsSample: Set negative prices in opportunities, quotes, and sales ordersSample: Process quotes, sales orders and invoicesSales entities (lead, opportunity, competitor, quote, order, invoice)How role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to unlock pricing for a sales order (order). For the Web API use the UnlockSalesOrderPricing Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of required privileges, see UnlockSalesOrderPricing message privileges. Notes to Callers This message unlocks the total price of products and services specified in the sales order (order). When the sale order pricing is unlocked, changes to underlying price lists (price level) can affect the prices for a sales order. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#UnlockSalesOrderPricing UnlockSalesOrderPricing message privilegesSalesOrder (order) entity messages and methodsSample: Set negative prices in opportunities, quotes, and sales ordersSample: Process quotes, sales orders and invoicesSales entities (lead, opportunity, competitor, quote, order, invoice)How role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to submit an asynchronous job to unpublish a duplicate rule. For the Web API use the UnpublishDuplicateRule Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the required privileges, see UnpublishDuplicateRule message privileges. Notes for Callers This message unpublishes a duplicate rule by deleting all matchcodes that were created for this duplicate detection rule by the publishing job. UnpublishDuplicateRule message privilegesDetect duplicate dataSample: Use duplicate detection when creating and updating recordsHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. For the Web API use the UpdateFeatureConfig Action. Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Contains the data that is needed to update values of the property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice. For the Web API use the UpdateProductProperties Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the and entities and access rights on the records specified in the property. Define product propertiesDynamicPropertyInstance (property instance) methods and messages Contains the response from the class. There is no return value from this operation. DynamicPropertyInstance (property instance) methods and messages Contains the data that is needed to update a component in an unmanaged solution. Package and distribute extensions using solutions Contains the response from executing the class. Deprecated. Use the class. UpdateUserSettingsSystemUser message privileges Deprecated. Use the class and its associated response class. For internal use only. Contains the data that is needed to retrieve the Coordinated Universal Time (UTC) for the specified local time. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights For a complete list of the required privileges, see UtcTimeFromLocalTime message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#UtcTimeFromLocalTime UtcTimeFromLocalTime message privilegesTime zone entitiesSample: Retrieve time zone informationHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. Contains the data that is needed to validate a rule for a recurring appointment. For the Web API use the ValidateRecurrenceRule Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the property. For a complete list of the privileges required, see ValidateRecurrenceRule message privileges. Recurring appointment entitiesRecurrenceRule entity messages and methods Contains the response from the class. Contains the data that is needed to verify that an appointment or service appointment (service activity) has valid available resources for the activity, duration, and site, as appropriate. For the Web API use the Validate Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have access rights on the specified entities in the property. For a list of the required privileges for this message, see Validate message privileges. For the Web API use the RenewContract Action. For the Web API use the RenewContract Action. Each activity record in the property must have a valid value for . The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ScheduleAndAppointment#Validate1 ScheduleAndAppointmentVB#Validate1 Sample: Validate an appointmentServiceAppointment entity messages and methods Contains the response from the class. For the Web API the ValidateResponse ComplexType is the response value from the Validate Action. Contains the data that is needed to validate a saved query (view). For the Web API use the ValidateSavedQuery Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights For a complete list of the privileges required, see ValidateSavedQuery message privileges. Customize entity viewsOffline and Outlook filters and templatesSavedQuery (view) entity messages and methods Contains the response from the class. There is no return value from this operation. Contains the result from the , , or messages. For the Web API the corresponding type is ValidationResult ComplexType. Sample: Validate an appointmentSample: Book an appointmentSample: Reschedule and cancel a recurring appointment Contains the data that is needed to retrieve the system user ID for the currently logged on user or the user under whose context the code is running. For the Web API use the WhoAmI Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights For a complete list of the privileges required, see WhoAmI message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Auditing#Auditing1 AuditingVB#Auditing1 Organization entitiesBusinessUnit entityUser and team entitiesSample: Audit entity data changes Contains the response from the class. For the Web API the WhoAmIResponse ComplexType is the response value from the WhoAmI Function. Contains the data that is needed to set the state of an opportunity to Won. For the Web API use the WinOpportunity Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of the required privileges, see WinOpportunity message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#WinOpportunity WinOpportunity message privilegesOpportunity entitiesSample: Process quotes, sales orders and invoicesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains the data that is needed to set the state of a quote to Won. For the Web API use the WinQuote Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity. For a complete list of the required privileges, see WinQuote message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#WinQuote WinQuote message privilegesQuote, order, and invoice entitiesSample: Process quotes, sales orders and invoicesHow role-based security can be used to control access to entities in Microsoft Dynamics 365How record-based security can be used to control access to records in Microsoft Dynamics 365 Contains the response from the class. There is no return value from this operation. Contains integer values that are used for the attribute. The following table shows the values for this class. Member Value Description Organization entities Contains integer values that are used for the attribute. The following table shows the values for this class. Member Value Description SavedQuery (view) entity messages and methodsTypes of viewsCustomize entity views Contains integer values that are used for the and attributes. The following table contains the values for this class. Member Value Description Plug-in registration entities Contains integer values that are used for the attribute. The following table contains the values for this class. Member Value Description Plug-in registration entities For internal use only. The following table shows the values for this class. Member Value Description Contains integer values that are used for the attribute. The following table shows the values for this class. Member Value Description Contains integer values that are used for the attribute. The following table shows the values for this class. Member Value Description UserQuery (saved view) entityTypes of viewsCustomize entity views Contains integer values that are used for the attribute. The following table shows the values for this class. Member Value Description UserSettings entity messages and methods Contains integer values that are used for the attribute. The following table shows the values for this class. Member Value Description UserSettings entity messages and methods Contains integer values that are used for the attribute. UserSettings entity messages and methods