Microsoft.MasterDataServices.Services.MessageContracts Namespace

Provides classes that are related to message contracts.

Classes

AnnotationsCreateResponse

The AnnotationsCreateResponse element holds the details of the response.

AnnotationsDeleteRequest

The AnnotationsDeleteRequest element specifies the details of the request.

AnnotationsDeleteResponse

The AnnotationsDeleteResponse element holds the details of the response.

AnnotationsUpdateRequest

The AnnotationsUpdateRequest element specifies the details of the annotations update request.

AnnotationsUpdateResponse

The AnnotationsUpdateResponse element holds the details of the response from AnnotationsUpdateRequest.

AttributeChangeRequest

The AttributeChangeRequest defines the message contract to change a specific attribute's name and/or type

AttributeChangeResponse

The AttributeChangeResponse defines the message contract for the attribute change response.

BusinessRulesCloneRequest

The BusinessRulesCloneRequest element MUST include a BusinessRules type that contains business rules and/or business rule components for creation in the MDS repository.

BusinessRulesCreateRequest

The BusinessRulesCreateRequest element MUST include a BusinessRules type that contains new business rules or business rule components for creation.

BusinessRulesCreateResponse

The BusinessRulesCreateResponse specifies the response of creating business rules.

BusinessRulesDeleteRequest

The BusinessRulesDeleteRequest element MUST include a BRDeleteCriteria that contains business rule GUIDs and/or business rule component GUIDs for deletion.

BusinessRulesGetRequest

The BusinessRulesGetRequest element MUST have a populated BRGetCriteria complex type.

BusinessRulesGetResponse

The BusinessRulesGetResponse element returns a BusinessRules type that contains requested business rules or rule components.

BusinessRulesPaletteGetRequest

The BusinessRulesPaletteGetRequest element MUST include a MemberType input. The allowable business rule components can be limited based on the member type that is specified.

BusinessRulesPaletteGetResponse

The BusinessRulesPaletteGetResponse element includes available conditions and actions for use in business rules.

BusinessRulesPublishRequest

The BusinessRulesPublishRequest element can include a BRPublishCriteria to limit which business rules are published. Otherwise, all business rules for all models, entities, and member types are published.

BusinessRulesUpdateRequest

The BusinessRulesUpdateRequest element MUST include a BusinessRules type that contains business rules or business rule components and their updated properties.

DataQualityCleansingOperationCreateRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityCleansingOperationCreateRequest specifies a request for a cleansing operation.

DataQualityInstalledStateRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityInstalledStateRequest retrieves data quality installed state.

DataQualityInstalledStateResponse

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityInstalledStateResponse specifies the response of data quality installed state.

DataQualityKnowledgeBasesGetRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityKnowledgeBasesGetRequest retrives the data quality knowledge bases.

DataQualityKnowledgeBasesGetResponse

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityKnowledgeBasesGetResponse specifies the response of data quality knowledge bases.

DataQualityMatchingOperationCreateRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityMatchingOperationCreateRequest specifies a request for a matching operation

DataQualityOperationCreateRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

Request to create a DQS operation

DataQualityOperationCreateResponse

This API supports the product infrastructure and is not intended to be used directly from your code.

Response after creating a DQS operation

DataQualityOperationPurgeOperationRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityOperationPurgeOperationRequest specifies a request to purge the server of any operation data

DataQualityOperationPurgeOperationResponse

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityOperationPurgeOperationResponse specifies the response after purging an operation

DataQualityOperationResultsGetRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityOperationResultsGetRequest specifies the request to get the operation's results

DataQualityOperationResultsGetResponse

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityOperationResultsGetResponse specifies the response of data quality operation result.

DataQualityOperationStartRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityOperationStartRequest specifies a request for a DQS operation.

DataQualityOperationStartResponse

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityOperationStartResponse specifies the response after starting a DQS operation

DataQualityOperationStatusRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityOperationStatusRequest specifies a request to get the status of an operation

DataQualityOperationStatusResponse

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityOperationStatusResponse specifies the status of the DQS operation requested

DataQualityStoreInputDataRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityStoreInputDataRequest specifies the request to create or append input data on the server

DataQualityStoreInputDataResponse

This API supports the product infrastructure and is not intended to be used directly from your code.

The DataQualityStoreInputDataResponse specifies the response after storing DQS input data

EntityMemberAnnotationDeleteRequest

The EntityMemberAnnotationDeleteRequest element specifies the details about what is requested when deleting entity member annotations.

EntityMemberAnnotationDeleteResponse

The EntityMemberAnnotationDeleteResponse element provides the details of the response.

EntityMemberAnnotationSaveRequest

The EntityMemberAnnotationSaveRequest element specifies the details of what is requested when creating entity member annotations.

EntityMemberAnnotationSaveResponse

The EntityMemberAnnotationSaveResponse element specifies the details of the response.

EntityMemberAnnotationsCreateRequest

The EntityMemberAnnotationsCreateRequest element specifies the details of what is requested when creating entity member annotations.

EntityMemberAnnotationsGetRequest

The EntityMemberAnnotationsGetRequest element specifies the details of what is requested.

EntityMemberAnnotationsGetResponse

The EntityMemberAnnotationsGetResponse element holds the details of the response.

EntityMemberAttributesGetRequest

The EntityMemberAttributesGetRequest element is a request that can take an EntityMembers complex type.

EntityMemberAttributesGetResponse

The EntityMemberAttributesGetResponse element is a response that returns NULL or one of the following complex types:

  • EntityMembers

  • OperationResult

EntityMemberChangesetDeleteRequest

The EntityMemberChangesetDeleteRequest element specifies the details about what is requested when deleting entity member Changeset.

EntityMemberChangesetDeleteResponse

The EntityMemberChangesetDeleteResponse element provides the details of the response.

EntityMemberChangesetSaveRequest

The EntityMemberChangesetSaveRequest element specifies the details of what is requested when creating entity member Changeset.

EntityMemberChangesetSaveResponse

The EntityMemberChangesetSaveResponse element provides the details of the response.

EntityMemberChangesetsGetRequest

The EntityMemberChangesetsGetRequest element specifies the details of what is requested.

EntityMemberChangesetsGetResponse

The EntityMemberChangesetsGetResponse element provides the details of the response.

EntityMemberHistoryRollbackRequest

The EntityMemberHistoryRollbackRequest element specifies what is requested when rolling back entity member historical revisions.

EntityMemberHistoryRollbackResponse

The EntityMemberHistoryRollbackResponse element specifies the details of the response.

EntityMemberKeyGetRequest

The EntityMemberKeyGetRequest element specifies the details of what is requested.

EntityMemberKeyGetResponse

The EntityMemberKeyGetResponse element holds the response details.

EntityMembersCopyRequest

The EntityMembersCopyRequest element specifies the entity member or members to be copied in the EntityMembersCopyCriteria complex type.

EntityMembersCopyResponse

The EntityMembersCopyResponse element contains the results of the operation in the OperationResult complex type.

EntityMembersCreateRequest

The EntityMembersCreateRequest element specifies the entity member or members to be created in the EntityMembers complex type.

EntityMembersCreateResponse

The EntityMembersCreateResponse element contains the results of the operation in the OperationResult complex type.

EntityMembersCrudRequest

Base class for various entity member save request classes.

EntityMembersDeleteRequest

The EntityMembersDeleteRequest element provides an EntityMembers complex type.

EntityMembersDeleteResponse

The EntityMembersDeleteResponse element returns an OperationResult complex type.

EntityMembersGetRequest

The EntityMembersGetRequest element specifies the criteria in the EntityMembersGetCriteria complex type for the retrieval of entity members and their attributes.

EntityMembersGetResponse

The EntityMembersGetResponse element returns a response that contains one or more of the following complex types:

  • EntityMembers

  • EntityMembersInformation

  • OperationResult

EntityMembersMergeRequest

The EntityMembersMergeRequest element specifies the entity member or members to be created or updated.

EntityMembersMergeResponse

Represents a response to the request to create and/or update members without regard to whether the member already exists.

EntityMembersPurgeRequest

The EntityMembersPurgeRequest element specifies the details of what is requested.

EntityMembersPurgeResponse

The EntityMembersPurgeResponse element holds the details of the response.

EntityMembersSaveRequest

Request object for the EntityMembersCreate operation.

EntityMembersUpdateRequest

The EntityMembersUpdateRequest element specifies the entity member or members to be updated in the EntityMembers complex type.

EntityMembersUpdateResponse

The EntityMembersUpdateResponse element contains the results of the operation in the OperationResult complex type.

EntityStagingClearRequest

The EntityStagingClearRequest element specifies the array of batches to clear.

EntityStagingClearResponse

The EntityStagingClearResponse element specifies counts for the batches and the attribute, member, and relationship records that are cleared.

EntityStagingGetRequest

The EntityStagingGetRequest specifies the input message contract for the EntityStagingGet service call

EntityStagingGetResponse

The EntityStagingGetResponse retrives Entity Staging.

EntityStagingLoadRequest

The EntityStagingLoadRequest specfies the request to load entity stating.

EntityStagingLoadResponse

The EntityStagingLoadResponse specifies the response of entity stating load request.

EntityStagingProcessRequest

The EntityStagingProcessRequest specifies the request to process entity starting.

EntityStagingProcessResponse

The EntityStagingProcessResponse specifies the response of entity stating process request.

ErrorLogsGetRequest

The ErrorLogsGetRequest element specifies the error logs to retrieve.

ErrorLogsGetResponse

The ErrorLogsGetResponse element contains the request error log information.

ExportViewCreateRequest

The ExportViewCreateRequest element specifies the details of what is requested.

ExportViewCreateResponse

The ExportViewCreateResponse element holds the details of the response.

ExportViewDeleteRequest

The ExportViewDeleteRequest element specifies the details of the export view delete request.

ExportViewDeleteResponse

The ExportViewDeleteResponse element holds the details of the response.

ExportViewListGetRequest

The ExportViewListGetRequest element specifies the details of the request to retrieve the export view list.

ExportViewListGetResponse

The ExportViewListGetResponse element holds the details of the response.

ExportViewUpdateRequest

The ExportViewUpdateRequest element specifies the details of the export view update request.

ExportViewUpdateResponse

The ExportViewUpdateResponse element holds the details of the response.

FileGetRequest

The FileSaveRequest element specifies the file to download from in the cache

FileGetResponse

The FileGetResponse element holds the details of the response.

FileSaveRequest

The FileSaveRequest element specifies the file to save in the cache

FileSaveResponse

The FileSaveResponse element holds the details of the response.

HierarchyMembersGetRequest

The HierarchyMembersGetRequest element uses the HierarchyMembersGetCriteria complex type to specify inputs to the request.

HierarchyMembersGetResponse

The HierarchyMembersGetResponse element is a response that returns NULL or one of the following complex types:

  • HierarchyMembers

  • OperationResult

HierarchyParentSaveRequest

The HierarchyParentSaveRequest element uses the HierarchyParentCriteria complex type to specify inputs to the request.

HierarchyParentSaveResponse

The HierarchyParentSaveResponse element is a response that returns NULL or one of the following complex types:

  • HierarchyMembers

  • OperationResult

MessageCreateRequest

Represents a message creation request.

MessageRequest

Defines the base class for all requests that can be processed by a Master Data Services instance.

MessageResponse

Specifies the standard response message for a completed operation

MetadataCloneRequest

Defines the message contract for the metadata clone request.

MetadataCloneResponse

The MetadataCloneResponse element provides only standard operation results.

MetadataCreateRequest

The MetadataCreateRequest element MUST include a Metadata complex type that contains objects to be created in the MDS repository.

MetadataCreateResponse

The MetadataCreateResponse element can echo the created metadata objects in a Metadata complex type if requested.

MetadataDeleteRequest

Defines the message contract for the metadata delete request.

MetadataDeleteResponse

Defines the message contract for the metadata delete response.

MetadataGetRequest

The MetadataGetRequest element includes MetadataSearchCriteria and MetadataResultOptions to select the desired metadata objects at the desired level of detail.

MetadataGetResponse

The MetadataGetResponse element includes a Metadata type as a container for any requested metadata information.

MetadataUpdateRequest

The MetadataUpdateRequest element MUST include a Metadata complex type that contains objects to be updated in the MDS repository.

MetadataUpdateResponse

The MetadataUpdateResponse element provides only standard operation results.

ModelMembersBulkCrudResponse

Base class for various staging CRUD operation responses.

ModelMembersBulkRequest

Base class for various staging operation request message contracts.

ModelMembersGetRequest

The ModelMembersGetRequest element uses the ModelMembersGetCriteria complex type to specify inputs to the request. The ModelMembersGetRequest element uses the ModelMembersResultCriteria complex type to retrieve a list of model members for selected models.

ModelMembersGetResponse

The ModelMembersGetResponse element returns a response that contains one or more of the following complex types:

  • ArrayOfEntityMembers

  • OperationResult

SecurityCreateResponse

Represents a security create response message contract.

SecurityDeleteRequest

Represents a security delete request message.

SecurityGetRequest

Represents a security get request message contract.

SecurityPrincipalsDeleteRequest

The SecurityPrincipalsDeleteRequest element specifies the criteria in the SecurityPrincipalsDeleteCriteria complex type for the retrieval of security principals.

SecurityPrincipalsGetRequest

Represents a request message contract to retrieve security principals.

SecurityPrincipalsGetResponse

Represents a message contract for the security get response.

SecurityPrincipalsRequest

Represents the request message contract for security principals.

SecurityPrivilegesDeleteRequest

The SecurityPrivilegesDeleteRequest element specifies the criteria in the SecurityPrivilegesDeleteCriteria complex type for the deletion of security privileges.

SecurityPrivilegesGetRequest

The SecurityPrivilegesGetRequest element specifies the criteria in the SecurityPrivilegesGetCriteria complex type for the retrieval of security privileges.

SecurityPrivilegesGetResponse

The SecurityPrivilegesGetResponse element returns an operation result and a SecurityPrivileges instance that contains the returned security privileges.

SecurityPrivilegesRequest

Represents the request message contract for security privileges.

ServiceCheckGetRequest

The ServiceCheckGetRequest element specifies the service to be checked.

ServiceVersionGetRequest

The ServiceVersionGetRequest defines the message contract for the Service Version get request.

ServiceVersionGetResponse

The ServiceVersionGetResponse defines the message contract for the Service version check get response.

StagingNameCheckRequest

The StagingNameCheckRequest defines the message contract for the staging name check (if the staging name is unique) request.

StagingNameCheckResponse

The StagingNameCheckResponse defines the message contract for the Staging Name Check response.

SyncRelationshipDeleteRequest

The SyncRelationshipDeleteRequest element defines the message contract for the sync relationship delete request.

SyncRelationshipDeleteResponse

The SyncRelationshipDeleteResponse element defines the message contract for the sync relationship delete response.

SyncRelationshipMergeRequest

The SyncRelationshipMergeRequest element defines the message contract for the sync relationship merge request.

SyncRelationshipMergeResponse

The SyncRelationshipMergeResponse element defines the message contract for the sync relationship merge response.

SyncRelationshipRefreshRequest

The SyncRelationshipRefreshRequest element defines the message contract for the sync relationship refresh request.

SyncRelationshipRefreshResponse

The SyncRelationshipRefreshResponse element defines the message contract for the sync relationship refresh response.

SyncRelationshipsGetRequest

The SyncRelationshipsGetRequest element specifies the message contract for the sync relationship get request.

SyncRelationshipsGetResponse

The SyncRelationshipsGetResponse element specifies the message contract for the sync relationship get response.

SystemDomainListGetRequest

The SystemDomainListGetRequest element MUST include a SystemDomainListGetCriteria complex type.

SystemDomainListGetResponse

The SystemDomainListGetResponse element provides a SystemDomainLists property that contains the domain list results.

SystemPropertiesGetRequest

The SystemPropertiesGetRequest element contains no input parameters.

SystemPropertiesGetResponse

The SystemPropertiesGetResponse element includes retrieved system property values in an array of SystemPropertyValue complex types.

SystemSettingsGetRequest

The SystemSettingsGetRequest element MUST include a SystemSettingsGetCriteria complex type.

SystemSettingsGetResponse

The SystemSettingsGetResponse element provides system settings within an ArrayOfSystemSettingGroup complex type.

SystemSettingsUpdateRequest

Defines the message contract for the system setting update request.

SystemSettingsUpdateResponse

The SystemSettingsUpdateResponse element provides only standard operation results.

TransactionAnnotationsCreateRequest

The TransactionAnnotationsCreateRequest element specifies the details of what is requested in the operation.

TransactionAnnotationsGetRequest

The TransactionAnnotationsGetRequest element specifies the details of what is requested.

TransactionAnnotationsGetResponse

The TransactionAnnotationsGetResponse element holds the details of the response.

TransactionsGetRequest

The TransactionsGetRequest element specifies the criteria in the TransactionSearchCriteria complex type for the retrieval of transactions.

TransactionsGetResponse

The TransactionsGetResponse element returns an operation result, the total number of transaction records returned, and an ArrayOfTransaction instance that contains the returned transactions.

TransactionsReverseRequest

Represents a request message for specifying the transactions (by ID) to reverse.

TransactionsReverseResponse

The TransactionsReverseResponse element returns an operation result and an ArrayOfReplacementId instance that contains the reversed transactions.

UserEffectiveObjectPermissionsGetRequest

The UserEffectiveObjectPermissionsGetRequest represents get users by effective object permission request message contract.

UserEffectiveObjectPermissionsGetResponse

The UserEffectiveObjectPermissionsGetResponse represents get users by effective object permission response message contract.

UserPreferencesDeleteRequest

The UserPreferencesDeleteRequest element can include one of the following:

  • UserPreferences property that contains one or more preference keys.

  • DeleteAllUserPreferences property, which specifies whether deletion of all preferences for the current user ought to occur.

UserPreferencesDeleteResponse

The UserPreferencesDeleteResponse element provides only standard operation results.

UserPreferencesGetRequest

The UserPreferencesGetRequest element contains no input parameters.

UserPreferencesGetResponse

The UserPreferencesGetResponse element returns an array of key/value pairs that represent the user preference settings and their current values.

UserPreferencesUpdateRequest

The UserPreferencesUpdateRequest element MUST include a UserPreferences property that has one or more preference settings as key/value pairs.

UserPreferencesUpdateResponse

The UserPreferencesUpdateResponse element provides only standard operation results.

ValidationGetRequest

The ValidationGetRequest element describes what validation information is requested.

ValidationGetResponse

List of issues and summary information related to the requested validation processing.

ValidationProcessRequest

The ValidationProcessRequest element specifies the validation process criteria and options.

ValidationProcessResponse

The ValidationProcessResponse element holds the response values back from the validation process.

VersionCopyRequest

The VersionCopyRequest element MUST include the FromVersionId property as a GUID. It MUST also include the following string properties:

  • ToVersionDescription

  • ToVersionName

VersionCopyResponse

The VersionCopyResponse element provides only standard operation results.

Interfaces

IMetadataUpdateRequest

Defines the interface used by the Metadata updating requests.