IService.MetadataGet(MetadataGetRequest) Method

  • Reference

Definition

Namespace:
Microsoft.MasterDataServices.Services.ServiceContracts
Assembly:
Microsoft.MasterDataServices.Services.Contracts.dll

Searches for and returns metadata.

public:
 Microsoft::MasterDataServices::Services::MessageContracts::MetadataGetResponse ^ MetadataGet(Microsoft::MasterDataServices::Services::MessageContracts::MetadataGetRequest ^ request);
[System.ServiceModel.FaultContract(typeof(Microsoft.MasterDataServices.Services.DataContracts.SkuNotSupportedMessage))]
[System.ServiceModel.FaultContract(typeof(Microsoft.MasterDataServices.Services.DataContracts.EditionExpiredMessage))]
[System.ServiceModel.OperationContract]
public Microsoft.MasterDataServices.Services.MessageContracts.MetadataGetResponse MetadataGet (Microsoft.MasterDataServices.Services.MessageContracts.MetadataGetRequest request);
[<System.ServiceModel.FaultContract(typeof(Microsoft.MasterDataServices.Services.DataContracts.SkuNotSupportedMessage))>]
[<System.ServiceModel.FaultContract(typeof(Microsoft.MasterDataServices.Services.DataContracts.EditionExpiredMessage))>]
[<System.ServiceModel.OperationContract>]
abstract member MetadataGet : Microsoft.MasterDataServices.Services.MessageContracts.MetadataGetRequest -> Microsoft.MasterDataServices.Services.MessageContracts.MetadataGetResponse
Public Function MetadataGet (request As MetadataGetRequest) As MetadataGetResponse

Parameters

request
MetadataGetRequest

Returns

MetadataGetResponse
Attributes
FaultContractAttribute OperationContractAttribute

Remarks

The MetadataGet(MetadataGetRequest) operation searches for and returns metadata from an MDS repository. The response contains the results of the search (such as items that match the MetadataSearchCriteria) and returns the metadata in a format and to a level of detail as specified in MetadataResultOptions.

About the search criteria:

  • Various metadata components can be searched, including models, entities, attributes, derived hierarchies, hierarchies, member types, versions, and attribute groups. Each metadata component has a corresponding list of identifiers within the search criteria. To find objects by GUIDs and/or names, the identifiers are populated.
  • The GUIDs and names from each list are combined with AND logic. For example, providing the criteria Model.ID=some-guid1 and the criteria Entity.ID=some-guid2 filters for objects where (Model.ID=some-guid1 AND Entity.ID=some-guid2).
  • Providing multiple IDs or names within the same criteria list looks for all items in the set. For example, providing the criteria Model.ID(1)=some-guid1 and Model.ID(2)=some-guid2 and the criteria Entity.ID=some-guid3 filters for objects where (Model.ID IN [some-guid1, some-guid2] AND Entity.ID=some-guid3).
About the result options:
  • For each property of the Metadata complex type, the MetadataResultOptions type specifies the inclusion and level of detail to return in the response.
  • The information that is retrieved for each component is based on the following possible result type settings:
    • None: No data is returned for this component (this is the default value).
    • Identifiers: Identifiers (GUIDs and names) and other properties are retrieved for this component.
    • Details: Full data is populated for this component, including child objects.

Applies to