Advanced Operations

Topics:

The iWay Application Adapter for Microsoft Dynamics CRM 2011 On-Premises also supports Advanced Operations that are declared in WSDL files. These Advanced Operations are specific for each entity. You can retrieve XML schemas for every Advanced Operation and create input XML documents based on the schemas.

Supported Advanced Operations

The following table lists and describes the supported Advanced Operations.

Supported Advanced Operations

Description

AddItemCampaignActivity

Add an item to a campaign activity.

AddItemCampaign

Add an item to a campaign.

AddListMembersList

Add members to the list.

AddMemberList

Add a member to a list (marketing list).

AddMembersTeam

Add members to a team.

AddPrivilegesRole

Add a set of existing privileges to an existing role.

AddProductToKit

Add a product to a kit.

AddRecurrence

Add recurrence information to an existing appointment.

AddSolutionComponent

Add a solution component to an unmanaged solution.

AddToQueue

Move an entity record from a source queue to a destination queue.

Appointment

Provides the details of an appointment request for the Search operation

Assign

Assign the specified record to a new owner (user or team) by changing the OwnerId attribute of the record.

Associate

Create a link between records.

AutoMapEntity

Generate a new set of attribute mappings based on the metadata.

BackgroundSendEmail

Send email messages asynchronously.

Book

Schedule or book an appointment, recurring appointment, or service appointment (service activity).

BulkDelete

Submit a bulk delete job that deletes selected records in bulk. This job runs asynchronously in the background without blocking other activities.

BulkDetectDuplicates

Submit an asynchronous system job that detects and logs multiple duplicate records.

BulkOperationStatusClose

For internal use only.

CalculateActualValue- Opportunity

Calculate the value of an opportunity that is in the Won state.

CalculateTotalTimeIncident

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

CanBeReferenced

Check whether the specified entity can be the primary entity (one) in a one-to-many relationship.

CanBeReferencing

Check whether an entity can be the referencing entity in a one-to-many relationship.

CancelContract

Cancel a contract.

CancelSalesOrder

Cancel a sales order (order).

CanManyToMany

Check whether an entity can participate in a many-to-many relationship.

CheckIncomingEmail

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

CheckPromoteEmail

Check whether the incoming email message should be promoted to the Microsoft Dynamics CRM system.

CleanUpBulkOperation

For internal use only.

CloneContract

Copy an existing contract and its line items.

CloseIncident

Close an incident (case).

CloseQuote

Close a quote.

CompoundUpdateDuplicate- DetectionRule

Update a duplicate rule (duplicate detection rule) and its related duplicate rule conditions.

ConvertKitToProduct

Convert a kit to a product.

ConvertProductToKit

Convert a product to a kit.

ConvertQuoteToSalesOrder

Convert a quote to a sales order.

ConvertSalesOrderToInvoice

Convert a sales order to an invoice.

CopyCampaign

Copy a campaign.

CopyCampaignResponse

Create a copy of the campaign response.

CopyDynamicListToStatic

Create a static list from the specified dynamic list and add the members that satisfy the dynamic list query criteria to the static list.

CopyMembersList

Copy the members from the source list to the target list without creating duplicates.

CopySystemForm

Create a new entity form that is based on an existing entity form.

CreateActivitiesList

Create a quick campaign to distribute an activity to members of a list (marketing list).

CreateAttribute

Create a new attribute, and optionally, to add it to a specified unmanaged solution.

CreateEntity

Create a custom entity and to optionally add it to a specified unmanaged solution.

CreateException

Create an exception for the recurring appointment instance.

CreateInstance

Create future unexpanded instances for the recurring appointment master.

CreateManyToMany

Create a new Many-to-Many (N:N) entity relationship.

CreateOneToMany

Create a new One-to-Many (1:N) entity relationship.

CreateOptionSet

Create a new global option set.

CreateWorkflowFromTemplate

Create a workflow (process) from a workflow template.

DeleteAttribute

Delete an attribute.

DeleteAuditData

Delete all audit data records up until a specified end date.

DeleteOpenInstances

Delete instances of a recurring appointment master that have an Open state.

DeleteOptionSet

Delete a global option set.

DeleteOptionValue

Delete an option value in a global or local option set.

DeleteRelationship

Delete an entity relationship.

DeliverIncomingEmail

Create an email activity instance from an incoming email message.

DeliverPromoteEmail

Create an email activity record from the specified email message.

DeprovisionLanguage

Deprovision a language.

Disassociate

Delete a link between records.

DistributeCampaignActivity

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.

DownloadReportDefinition

Download a report definition.

ExecuteByIdSavedQuery

Execute a saved query (view) that has the specified ID.

ExecuteByIdUserQuery

Execute the user query (saved view) that has the specified ID.

ExecuteWorkflow

Execute a workflow.

ExpandCalendar

Convert the calendar rules to an array of available time blocks for the specified period.

ExportMappingsImportMap

Export a data map as an XML formatted data.

ExportSolution

Export a solution.

ExportTranslation

Export all translations for a specific solution to a compressed file.

FetchXmlToQueryExpression

Convert a query in FetchXML to a QueryExpression.

FindParentResourceGroup

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

FulfillSalesOrder

Fulfill the sales order (order).

GenerateInvoiceFromOpportunity

Generate an invoice from an opportunity.

GenerateQuoteFromOpportunity

Generate a quote from an opportunity.

GenerateSalesOrder- FromOpportunity

Generate a sales order (order) from an opportunity.

GetAllTimeZonesWith- DisplayName

Retrieve all the time zone definitions for the specified locale and to return only the display name attribute.

GetDecryptionKey

Obtain the key that is used to encrypt or decrypt the email credentials of a user or queue that are stored in the Microsoft Dynamics CRM database.

GetDistinctValuesImportFile

Retrieve distinct values from the parse table for a column in the source file that contains list values.

GetHeaderColumnsImportFile

Retrieve the source-file column headings; or retrieve the system-generated column headings if the source file does not contain column headings.

GetInvoiceProductsFrom- Opportunity

Retrieve the products from an opportunity and copy them to the invoice.

GetQuantityDecimal

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

GetQuoteProductsFrom- Opportunity

Retrieve the products from an opportunity and copy them to the quote.

GetReportHistoryLimit

Retrieve the history limit for a report.

GetSalesOrderProducts- FromOpportunity

Retrieve the products from an opportunity and copy them to the sales order (order).

GetTimeZoneCodeBy- LocalizedName

Retrieve the time zone code for the specified localized time zone name.

GetTrackingTokenEmail

Return a tracking token that can then be passed as a parameter to the SendEmailRequest message.

GetValidManyToMany

Retrieve a list of all the entities that can participate in a Many-to-Many entity relationship.

GetValidReferencedEntities

Contains the data that is needed to retrieve a list of entity logical names that are valid as the primary entity (one) from the specified entity in a one-to-many relationship.

GetValidReferencingEntities

Retrieve the set of entities that are valid as the related entity (many) to the specified entity in a one-to-many relationship.

GrantAccess

Grant a security principal (user or team) access to the specified record.

ImportMappingsImportMap

Import the XML representation of a data map and create an import map (data map) based on this data.

ImportRecordsImport

Submit an asynchronous job that uploads the transformed data into Microsoft Dynamics CRM.

ImportSolution

Import a solution.

ImportTranslation

Import translations from a compressed file.

InitializeFrom

Initialize a new record from an existing record.

InsertOptionValue

Insert a new option value for a global or local option set.

InsertStatusValue

Insert a new option into a StatusAttributeMetadata attribute.

InstallSampleData

Install the sample data.

InstantiateFilters

Instantiate a set of filters for Microsoft Dynamics CRM for Outlook for the specified user.

InstantiateTemplate

Contains the parameters that are needed to create an email message from a template (email template).

IsComponentCustomizable

Determine whether a solution component is customizable.

IsValidStateTransition

Validate the state transition.

LocalTimeFromUtcTime

Retrieve the local time for the specified Coordinated Universal Time (UTC).

LockInvoicePricing

Lock the total price of products and services that are specified in the invoice.

LockSalesOrderPricing

Lock the total price of products and services that are specified in the sales order (order).

LogFailureBulkOperation

For internal use only.

LogSuccessBulkOperation

For internal use only.

LoseOpportunity

Set the state of an opportunity to Lost.

Merge

Merge the information from two entity records of the same type.

ModifyAccess

Replace the access rights on the target record for the specified security principal (user or team).

OrderOption

Set the order for an option set.

ParseImport

Submit an asynchronous job that parses all import files that are associated with the specified import (data import).

ProcessInboundEmail

Process the email responses from a marketing campaign.

ProcessOneMemberBulk- Operation

For internal use only.

PropagateByExpression

Create a quick campaign to distribute an activity to accounts, contacts, or leads that are selected by a query.

ProvisionLanguage

Provision a new language.

PublishAllXml

Publish all changes to solution components.

PublishDuplicateRule

Submit an asynchronous job to publish a duplicate rule.

PublishXml

Publish specified solution components.

QualifyLead

Qualify a lead and create account, contact, and opportunity records that are linked to the originating lead record.

QualifyMemberList

Qualify the specified list and either override the list members or remove them according to the specified option.

QueryExpressionToFetchXml

Convert a query, which is represented as a QueryExpression class, to its equivalent query, which is represented as FetchXML.

QueryMultipleSchedules

Search multiple resources for available time block that match the specified parameters.

QuerySchedule

Search the specified resource for an available time block that matches the specified parameters.

ReassignObjectsOwner

Reassign all records that are owned by the security principal (user or team) to another security principal (user or team).

ReassignObjectsSystemUser

Reassign all records that are owned by a specified user to another security principal (user or team).

Recalculate

Recalculate system-computed values for rollup fields in the goal hierarchy.

RemoveItemCampaignActivity

Remove an item from a campaign activity.

RemoveItemCampaign

Remove an item from a campaign.

RemoveMemberList

Remove a member from a list (marketing list).

RemoveMembersTeam

Remove members from a team.

RemoveParent

Remove the parent for a system user (user) record.

RemovePrivilegeRole

Remove a privilege from an existing role.

RemoveProductFromKit

Remove a product from a kit.

RemoveRelated

Use the Disassociate message. Remove the relationship between the specified records for specific relationships.

RemoveSolutionComponent

Remove a component from an unmanaged solution.

RenewContract

Renew a contract and create the contract details for a new contract.

ReplacePrivilegesRole

Replace the privilege set of an existing role.

Reschedule

Reschedule an appointment, recurring appointment, or service appointment (service activity).

ResetUserFilters

Reset the offline data filters for the calling user to the default filters for the organization.

RetrieveAbsoluteAndSite- CollectionUrl

Retrieve the absolute URL and the site collection URL for a SharePoint location record in Microsoft Dynamics CRM.

RetrieveAllChildUsers- SystemUser

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

RetrieveAllEntities

Retrieve metadata information about all the entities.

RetrieveAllManagedProperties

Retrieve all managed property definitions.

RetrieveAllOptionSets

Retrieve information about all global option sets.

RetrieveApplicationRibbon

Retrieve the data that defines the content and behavior of the application ribbon.

RetrieveAttributeChangeHistory

Retrieve all metadata changes to a specific attribute.

RetrieveAttribute

Retrieve attribute metadata.

RetrieveAuditDetails

Retrieve the full audit details from an Audit record.

RetrieveAuditPartitionList

Retrieve the list of database partitions that are used to store audited history data.

RetrieveAvailableLanguages

Retrieve the list of language packs that are installed on the server.

RetrieveBusinessHierarchy- BusinessUnit

Retrieve all business units (including the specified business unit) from the business unit hierarchy.

RetrieveByGroupResource

Retrieve all resources that are related to the specified resource group (scheduling group).

RetrieveByResourceResource- Group

Retrieve the resource groups (scheduling groups) that contain the specified resource.

RetrieveByResourcesService

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

RetrieveByTopIncidentProduct- KbArticle

Retrieve the top-ten articles about a specified product from the knowledge base of articles for your organization.

RetrieveByTopIncidentSubject- KbArticle

Retrieve the top-ten articles about a specified subject from the knowledge base of articles for your organization.

RetrieveDependenciesFor- Delete

Retrieve a collection of dependency records that describe any solution components that would prevent a solution component from being deleted.

RetrieveDependenciesFor- Uninstall

Retrieve a list of the solution component dependencies that can prevent you from uninstalling a managed solution.

RetrieveDependentComponents

Retrieves a list of dependencies for solution components that directly depend on a solution component.

RetrieveDeploymentLicense- Type

Retrieve the type of license for a deployment of Microsoft Dynamics CRM.

RetrieveDeprovisioned- Languages

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

RetrieveDuplicates

Detect and retrieve duplicates for a specified record.

RetrieveEntity

Retrieve entity metadata.

RetrieveEntityRibbon

Retrieve ribbon definitions for an entity.

RetrieveExchangeRate

Retrieve the exchange rate.

RetrieveFilteredForms

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

RetrieveFormattedImport- JobResults

Retrieve the formatted results from an import job.

RetrieveFormXml

For internal use only.

RetrieveInstalled- LanguagePacks

Retrieve the list of language packs that are installed on the server.

RetrieveInstalledLanguage-PackVersion

Retrieve the version of an installed language pack.

RetrieveLicenseInfo

Retrieve the number of used and available licenses for a deployment of Microsoft Dynamics CRM.

RetrieveLocLabels

Retrieve localized labels for a limited set of entity attributes.

RetrieveManagedProperty

Retrieve a managed property definition.

RetrieveMembersBulk- Operation

Retrieve the members of a bulk operation.

RetrieveMissingComponents

Retrieve a list of missing components in the target organization.

RetrieveMissingDependencies

Retrieve any required solution components that are not included in the solution.

RetrieveMultiple

Retrieve a collection of records that satisfy the specified query criteria.

RetrieveOptionSet

Retrieve a global option set.

RetrieveOrganizationResources

Retrieve the resources that are used by an organization.

RetrieveParentGroups- ResourceGroup

Contains the data needed to retrieve the collection of the parent resource groups of the specified resource group (scheduling group).

RetrieveParsedDataImportFile

Retrieve the data from the parse table.

RetrievePersonalWall

Retrieve pages of posts, including comments for each post, for all records that the calling user is following.

RetrievePrincipalAccess

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

RetrievePrincipalAttribute- Privileges

Retrieves all the secured attribute privileges a user or team has through direct or indirect (through team membership) associations with the FieldSecurityProfile entity.

RetrievePrivilegeSet

Contains the data needed to retrieve the set of privileges defined in the system.

RetrieveProvisionedLanguage- PackVersion

Retrieve the version of a provisioned language pack.

RetrieveProvisionedLanguages

Retrieve the list of provisioned languages.

RetrieveRecordChangeHistory

Retrieve all attribute data changes for a specific entity.

RetrieveRecordWall

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

RetrieveRelationship

Retrieve entity relationship metadata.

RetrieveRequiredComponents

Retrieve a collection of solution components that are required for a solution component.

RetrieveRolePrivilegesRole

Retrieve the privileges that are assigned to the specified role.

RetrieveSharedPrincipals- AndAccess

Retrieve all security principals (users or teams) that have access to, and access rights for, the specified record.

RetrieveSubGroups- ResourceGroup

Retrieve the collection of child resource groups from the specified resource group (scheduling group).

RetrieveTeamPrivileges

Retrieve the privileges for a team.

RetrieveTimestamp

Retrieves a time stamp for the metadata.

RetrieveUnpublishedMultiple

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

RetrieveUnpublished

Retrieve an unpublished record.

RetrieveUserPrivileges

Contains the data needed to retrieve the privileges a system user (user) has through his or her roles in the specified business unit.

RetrieveVersion

Retrieve the version number of the Microsoft Dynamics CRM Server.

ReviseQuote

Set the state of a quote to Draft.

RevokeAccess

Replace the access rights on the target record for the specified security principal (user or team).

Rollup

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

SearchByBodyKbArticle

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

SearchByKeywordsKbArticle

Search for knowledge base articles that contain the specified keywords.

SearchByTitleKbArticle

Search for knowledge base articles that contain the specified title.

Search

Contains the data needed to search for available time slots that fulfill the specified appointment request.

SendBulkMail

Send bulk email messages.

SendEmailFromTemplate

Send an email message using a template.

SendEmail

Send an email message.

SendFax

Send a fax.

SendTemplate

Send a bulk email message that is created from a template.

SetBusinessEquipment

Assign equipment (facility/equipment) to a specific business unit.

SetBusinessSystemUser

Move a system user (user) to a different business unit.

SetLocLabels

Set localized labels for a limited set of entity attributes.

SetParentBusinessUnit

Set the parent business unit for a business unit.

SetParentSystemUser

Contains the data needed to set a new parent system user (user) for the specified user.

SetParentTeam

Contains the data needed to set the parent business unit of a team.

SetRelated

Contains the data needed to create a relationship between a set of records that participate in specific relationships.

SetReportRelated

Contains the data needed to link an instance of a report entity to related entities.

SetState

Set the state of an entity record.

StatusUpdateBulkOperation

For internal use only.

TransformImport

Submit an asynchronous job that transforms the parsed data.

TriggerServiceEndpointCheck

Validate the configuration of a Windows Azure platform service endpoint of AppFabric solution.

UninstallSampleData

Uninstall data samples.

UnlockInvoicePricing

Unlock pricing for an invoice.

UnlockSalesOrderPricing

Unlock pricing for a sales order (order).

UnpublishDuplicateRule

Submit an asynchronous job to unpublish a duplicate rule.

UpdateAttribute

Update the definition of an attribute.

UpdateEntity

Contains the data that is needed to update the definition of an entity.

UpdateOptionSet

Contains the data that is needed to update the definition of a global option set.

UpdateOptionValue

Update an option value in a global or local option set.

UpdateRelationship

Contains the data that is needed to update the definition of an entity relationship.

UpdateStateValue

Update an option set value in for a StateAttributeMetadata attribute.

UtcTimeFromLocalTime

Retrieve the Coordinated Universal Time (UTC) for the specified local time.

ValidateRecurrenceRule

Validate a rule for a recurring appointment.

Validate

Verify that an appointment or service appointment (service activity) has valid available resources for the activity, duration, and site, as appropriate.

ValidateSavedQuery

Contains the data that is needed to validate a saved query (view).

VerifyProcessStateData

For internal use only.

WhoAmI

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

WinOpportunity

Set the state of an opportunity to Won.

WinQuote

Set the state of a quote to Won.

Unsupported Advanced Operations

The following table lists and describes the unsupported Advanced Operations.

Unsupported Advanced Operations

Description

AddSubstituteProduct

Deprecated. Use the Associate operation. Adds a link between two entity instances in a many-to-many relationship.

AssociateEntities

Deprecated. Use the Associate operation. Add a link between two entity instances in a many-to-many relationship.

CompoundCreate

Deprecated. Use the Create operation. This operation creates a compound entity, such as a sales order (order), invoice, quote, or duplicate rule (duplicate detection rule). It also creates its related entity, such as a sales order detail (order product), invoice detail (invoice product), quote detail (quote product), or duplicate rule condition.

CompoundUpdate

Deprecated. Use the Create operation. Update a compound record, such as a sales order (order), invoice, quote, or duplicate rule (duplicate detection rule). You can also update its related detail record, such as a sales order detail (order product), invoice detail (invoice product), quote detail (quote product), or duplicate rule condition.

DisassociateEntities

Deprecated. Use the Disassociate message. Remove a link between two entity instances in a many-to-many relationship.

ExecuteFetch

Deprecated. Use the RetrieveMultiple operation.

IsBackOfficeInstalled

Deprecated. Checks whether Microsoft Dynamics GP 9.0 is installed.

MakeAvailableTo- OrganizationReport

Deprecated. Use the Update message.

MakeAvailableTo- OrganizationTemplate

Deprecated. Use the Update message.

MakeUnavailableTo- OrganizationReport

Deprecated. Use the Update message.

MakeUnavailableTo- OrganizationTemplate

Deprecated. Use the Update message.

RemoveSubstituteProduct

Deprecated. Use the Disassociate message.

RetrieveMembersTeam

Deprecated. Use the RetrieveMultiple operation.

RetrieveSubsidiaryTeams- BusinessUnit

Deprecated. Use the RetrieveMultiple message. Contains the data needed to retrieve a collection of entity instances based on the specified query criteria.

RetrieveSubsidiaryUsers- BusinessUnit

Deprecated. Use the RetrieveMultiple message. Contains the data needed to retrieve all user information from the child business units of the specified business unit.

RetrieveTeamsSystemUser

Deprecated. Use the RetrieveMultiple message. Contains the data needed to retrieve the list of teams of which the specified user is a member.

RetrieveUserSettingsSystemUser

Deprecated. Use the RetrieveMultiple message. Contains the data needed to retrieve the user settings for the specified system user (user).

UpdateUserSettingsSystemUser

Deprecated. Use the Update operation.