Microsoft.MasterDataServices.Services.MessageContracts Namespace

 

Provides classes that are related to message contracts.

ClassDescription
System_CAPS_pubclassAnnotationsCreateResponse

The AnnotationsCreateResponse element holds the details of the response.

System_CAPS_pubclassAnnotationsDeleteRequest

The AnnotationsDeleteRequest element specifies the details of the request.

System_CAPS_pubclassAnnotationsDeleteResponse

The AnnotationsDeleteResponse element holds the details of the response.

System_CAPS_pubclassAnnotationsUpdateRequest

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

System_CAPS_pubclassAnnotationsUpdateResponse

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

System_CAPS_pubclassAttributeChangeRequest

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

System_CAPS_pubclassAttributeChangeResponse

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

System_CAPS_pubclassBusinessRulesCloneRequest

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

System_CAPS_pubclassBusinessRulesCreateRequest

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

System_CAPS_pubclassBusinessRulesCreateResponse

The BusinessRulesCreateResponse specifies the response of creating business rules.

System_CAPS_pubclassBusinessRulesDeleteRequest

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

System_CAPS_pubclassBusinessRulesGetRequest

The BusinessRulesGetRequest element MUST have a populated BRGetCriteria complex type.

System_CAPS_pubclassBusinessRulesGetResponse

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

System_CAPS_pubclassBusinessRulesPaletteGetRequest

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

System_CAPS_pubclassBusinessRulesPaletteGetResponse

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

System_CAPS_pubclassBusinessRulesPublishRequest

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.

System_CAPS_pubclassBusinessRulesUpdateRequest

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

System_CAPS_pubclassDataQualityCleansingOperationCreateRequest

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.

System_CAPS_pubclassDataQualityInstalledStateRequest

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

The DataQualityInstalledStateRequest retrieves data quality installed state.

System_CAPS_pubclassDataQualityInstalledStateResponse

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.

System_CAPS_pubclassDataQualityKnowledgeBasesGetRequest

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.

System_CAPS_pubclassDataQualityKnowledgeBasesGetResponse

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.

System_CAPS_pubclassDataQualityMatchingOperationCreateRequest

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

System_CAPS_pubclassDataQualityOperationCreateRequest

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

Request to create a DQS operation

System_CAPS_pubclassDataQualityOperationCreateResponse

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

Response after creating a DQS operation

System_CAPS_pubclassDataQualityOperationPurgeOperationRequest

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

System_CAPS_pubclassDataQualityOperationPurgeOperationResponse

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

System_CAPS_pubclassDataQualityOperationResultsGetRequest

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

System_CAPS_pubclassDataQualityOperationResultsGetResponse

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.

System_CAPS_pubclassDataQualityOperationStartRequest

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.

System_CAPS_pubclassDataQualityOperationStartResponse

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

System_CAPS_pubclassDataQualityOperationStatusRequest

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

System_CAPS_pubclassDataQualityOperationStatusResponse

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

System_CAPS_pubclassDataQualityStoreInputDataRequest

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

System_CAPS_pubclassDataQualityStoreInputDataResponse

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

System_CAPS_pubclassEntityMemberAnnotationDeleteRequest

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

System_CAPS_pubclassEntityMemberAnnotationDeleteResponse

The EntityMemberAnnotationDeleteResponse element provides the details of the response.

System_CAPS_pubclassEntityMemberAnnotationSaveRequest

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

System_CAPS_pubclassEntityMemberAnnotationSaveResponse

The EntityMemberAnnotationSaveResponse element specifies the details of the response.

System_CAPS_pubclassEntityMemberAnnotationsCreateRequest

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

System_CAPS_pubclassEntityMemberAnnotationsGetRequest

The EntityMemberAnnotationsGetRequest element specifies the details of what is requested.

System_CAPS_pubclassEntityMemberAnnotationsGetResponse

The EntityMemberAnnotationsGetResponse element holds the details of the response.

System_CAPS_pubclassEntityMemberAttributesGetRequest

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

System_CAPS_pubclassEntityMemberAttributesGetResponse

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

  • EntityMembers

  • OperationResult

System_CAPS_pubclassEntityMemberChangeSetDeleteRequest

The EntityMemberChangeSetDeleteRequest element specifies the details about what is requested when deleting entity member change set.

System_CAPS_pubclassEntityMemberChangeSetDeleteResponse

The EntityMemberChangeSetDeleteResponse element provides the details of the response.

System_CAPS_pubclassEntityMemberChangeSetSaveRequest

The EntityMemberChangeSetSaveRequest element specifies the details of what is requested when creating entity member changeset.

System_CAPS_pubclassEntityMemberChangeSetSaveResponse

The EntityMemberChangeSetSaveResponse element provides the details of the response.

System_CAPS_pubclassEntityMemberChangeSetsGetRequest

The EntityMemberChangeSetsGetRequest element specifies the details of what is requested.

System_CAPS_pubclassEntityMemberChangeSetsGetResponse

The EntityMemberChangeSetsGetResponse element provides the details of the response.

System_CAPS_pubclassEntityMemberHistoryRollbackRequest

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

System_CAPS_pubclassEntityMemberHistoryRollbackResponse

The EntityMemberHistoryRollbackResponse element specifies the details of the response.

System_CAPS_pubclassEntityMemberKeyGetRequest

The EntityMemberKeyGetRequest element specifies the details of what is requested.

System_CAPS_pubclassEntityMemberKeyGetResponse

The EntityMemberKeyGetResponse element holds the response details.

System_CAPS_pubclassEntityMembersCopyRequest

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

System_CAPS_pubclassEntityMembersCopyResponse

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

System_CAPS_pubclassEntityMembersCreateRequest

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

System_CAPS_pubclassEntityMembersCreateResponse

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

System_CAPS_pubclassEntityMembersCrudRequest

Base class for various entity member save request classes.

System_CAPS_pubclassEntityMembersDeleteRequest

The EntityMembersDeleteRequest element provides an EntityMembers complex type.

System_CAPS_pubclassEntityMembersDeleteResponse

The EntityMembersDeleteResponse element returns an OperationResult complex type.

System_CAPS_pubclassEntityMembersGetRequest

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

System_CAPS_pubclassEntityMembersGetResponse

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

  • EntityMembers

  • EntityMembersInformation

  • OperationResult

System_CAPS_pubclassEntityMembersMergeRequest

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

System_CAPS_pubclassEntityMembersMergeResponse

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

System_CAPS_pubclassEntityMembersPurgeRequest

The EntityMembersPurgeRequest element specifies the details of what is requested.

System_CAPS_pubclassEntityMembersPurgeResponse

The EntityMembersPurgeResponse element holds the details of the response.

System_CAPS_pubclassEntityMembersSaveRequest

Request object for the EntityMembersCreate operation.

System_CAPS_pubclassEntityMembersUpdateRequest

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

System_CAPS_pubclassEntityMembersUpdateResponse

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

System_CAPS_pubclassEntityStagingClearRequest

The EntityStagingClearRequest element specifies the array of batches to clear.

System_CAPS_pubclassEntityStagingClearResponse

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

System_CAPS_pubclassEntityStagingGetRequest

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

System_CAPS_pubclassEntityStagingGetResponse

The EntityStagingGetResponse retrives Entity Staging.

System_CAPS_pubclassEntityStagingLoadRequest

The EntityStagingLoadRequest specfies the request to load entity stating.

System_CAPS_pubclassEntityStagingLoadResponse

The EntityStagingLoadResponse specifies the response of entity stating load request.

System_CAPS_pubclassEntityStagingProcessRequest

The EntityStagingProcessRequest specifies the request to process entity starting.

System_CAPS_pubclassEntityStagingProcessResponse

The EntityStagingProcessResponse specifies the response of entity stating process request.

System_CAPS_pubclassErrorLogsGetRequest

The ErrorLogsGetRequest element specifies the error logs to retrieve.

System_CAPS_pubclassErrorLogsGetResponse

The ErrorLogsGetResponse element contains the request error log information.

System_CAPS_pubclassExportViewCreateRequest

The ExportViewCreateRequest element specifies the details of what is requested.

System_CAPS_pubclassExportViewCreateResponse

The ExportViewCreateResponse element holds the details of the response.

System_CAPS_pubclassExportViewDeleteRequest

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

System_CAPS_pubclassExportViewDeleteResponse

The ExportViewDeleteResponse element holds the details of the response.

System_CAPS_pubclassExportViewListGetRequest

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

System_CAPS_pubclassExportViewListGetResponse

The ExportViewListGetResponse element holds the details of the response.

System_CAPS_pubclassExportViewUpdateRequest

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

System_CAPS_pubclassExportViewUpdateResponse

The ExportViewUpdateResponse element holds the details of the response.

System_CAPS_pubclassFileGetRequest

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

System_CAPS_pubclassFileGetResponse

The FileGetResponse element holds the details of the response.

System_CAPS_pubclassFileSaveRequest

The FileSaveRequest element specifies the file to save in the cache

System_CAPS_pubclassFileSaveResponse

The FileSaveResponse element holds the details of the response.

System_CAPS_pubclassHierarchyMembersGetRequest

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

System_CAPS_pubclassHierarchyMembersGetResponse

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

  • HierarchyMembers

  • OperationResult

System_CAPS_pubclassHierarchyParentSaveRequest

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

System_CAPS_pubclassHierarchyParentSaveResponse

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

  • HierarchyMembers

  • OperationResult

System_CAPS_pubclassMessageCreateRequest

Represents a message creation request.

System_CAPS_pubclassMessageRequest

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

System_CAPS_pubclassMessageResponse

Specifies the standard response message for a completed operation

System_CAPS_pubclassMetadataCloneRequest

Defines the message contract for the metadata clone request.

System_CAPS_pubclassMetadataCloneResponse

The MetadataCloneResponse element provides only standard operation results.

System_CAPS_pubclassMetadataCreateRequest

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

System_CAPS_pubclassMetadataCreateResponse

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

System_CAPS_pubclassMetadataDeleteRequest

Defines the message contract for the metadata delete request.

System_CAPS_pubclassMetadataDeleteResponse

Defines the message contract for the metadata delete response.

System_CAPS_pubclassMetadataGetRequest

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

System_CAPS_pubclassMetadataGetResponse

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

System_CAPS_pubclassMetadataUpdateRequest

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

System_CAPS_pubclassMetadataUpdateResponse

The MetadataUpdateResponse element provides only standard operation results.

System_CAPS_pubclassModelMembersBulkCrudResponse

Base class for various staging CRUD operation responses.

System_CAPS_pubclassModelMembersBulkRequest

Base class for various staging operation request message contracts.

System_CAPS_pubclassModelMembersGetRequest

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.

System_CAPS_pubclassModelMembersGetResponse

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

  • ArrayOfEntityMembers

  • OperationResult

System_CAPS_pubclassSecurityCreateResponse

Represents a security create response message contract.

System_CAPS_pubclassSecurityDeleteRequest

Represents a security delete request message.

System_CAPS_pubclassSecurityGetRequest

Represents a security get request message contract.

System_CAPS_pubclassSecurityPrincipalsDeleteRequest

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

System_CAPS_pubclassSecurityPrincipalsGetRequest

Represents a request message contract to retrieve security principals.

System_CAPS_pubclassSecurityPrincipalsGetResponse

Represents a message contract for the security get response.

System_CAPS_pubclassSecurityPrincipalsRequest

Represents the request message contract for security principals.

System_CAPS_pubclassSecurityPrivilegesDeleteRequest

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

System_CAPS_pubclassSecurityPrivilegesGetRequest

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

System_CAPS_pubclassSecurityPrivilegesGetResponse

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

System_CAPS_pubclassSecurityPrivilegesRequest

Represents the request message contract for security privileges.

System_CAPS_pubclassServiceCheckGetRequest

The ServiceCheckGetRequest element specifies the service to be checked.

System_CAPS_pubclassServiceVersionGetRequest

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

System_CAPS_pubclassServiceVersionGetResponse

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

System_CAPS_pubclassStagingNameCheckRequest

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

System_CAPS_pubclassStagingNameCheckResponse

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

System_CAPS_pubclassSyncRelationshipDeleteRequest

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

System_CAPS_pubclassSyncRelationshipDeleteResponse

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

System_CAPS_pubclassSyncRelationshipMergeRequest

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

System_CAPS_pubclassSyncRelationshipMergeResponse

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

System_CAPS_pubclassSyncRelationshipRefreshRequest

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

System_CAPS_pubclassSyncRelationshipRefreshResponse

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

System_CAPS_pubclassSyncRelationshipsGetRequest

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

System_CAPS_pubclassSyncRelationshipsGetResponse

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

System_CAPS_pubclassSystemDomainListGetRequest

The SystemDomainListGetRequest element MUST include a SystemDomainListGetCriteria complex type.

System_CAPS_pubclassSystemDomainListGetResponse

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

System_CAPS_pubclassSystemPropertiesGetRequest

The SystemPropertiesGetRequest element contains no input parameters.

System_CAPS_pubclassSystemPropertiesGetResponse

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

System_CAPS_pubclassSystemSettingsGetRequest

The SystemSettingsGetRequest element MUST include a SystemSettingsGetCriteria complex type.

System_CAPS_pubclassSystemSettingsGetResponse

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

System_CAPS_pubclassSystemSettingsUpdateRequest

Defines the message contract for the system setting update request.

System_CAPS_pubclassSystemSettingsUpdateResponse

The SystemSettingsUpdateResponse element provides only standard operation results.

System_CAPS_pubclassTransactionAnnotationsCreateRequest

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

System_CAPS_pubclassTransactionAnnotationsGetRequest

The TransactionAnnotationsGetRequest element specifies the details of what is requested.

System_CAPS_pubclassTransactionAnnotationsGetResponse

The TransactionAnnotationsGetResponse element holds the details of the response.

System_CAPS_pubclassTransactionsGetRequest

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

System_CAPS_pubclassTransactionsGetResponse

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

System_CAPS_pubclassTransactionsReverseRequest

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

System_CAPS_pubclassTransactionsReverseResponse

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

System_CAPS_pubclassUserPreferencesDeleteRequest

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.

System_CAPS_pubclassUserPreferencesDeleteResponse

The UserPreferencesDeleteResponse element provides only standard operation results.

System_CAPS_pubclassUserPreferencesGetRequest

The UserPreferencesGetRequest element contains no input parameters.

System_CAPS_pubclassUserPreferencesGetResponse

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

System_CAPS_pubclassUserPreferencesUpdateRequest

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

System_CAPS_pubclassUserPreferencesUpdateResponse

The UserPreferencesUpdateResponse element provides only standard operation results.

System_CAPS_pubclassValidationGetRequest

The ValidationGetRequest element describes what validation information is requested.

System_CAPS_pubclassValidationGetResponse

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

System_CAPS_pubclassValidationProcessRequest

The ValidationProcessRequest element specifies the validation process criteria and options.

System_CAPS_pubclassValidationProcessResponse

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

System_CAPS_pubclassVersionCopyRequest

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

  • ToVersionDescription

  • ToVersionName

System_CAPS_pubclassVersionCopyResponse

The VersionCopyResponse element provides only standard operation results.

InterfaceDescription
System_CAPS_pubinterfaceIMetadataUpdateRequest

Defines the interface used by the Metadata updating requests.

Return to top
Show: