GetDataQualityAnalyses Method

Retrieves all Touchstone® Data Quality Analyses for a given Project within a specific Business Unit and SQL Server Instance.

The Data Quality Analysis API stores each Data Quality Analysis as a Data Quality Analysis object, and you can use the GetDataQualityAnalyses() method to retrieve a list of these objects for a particular Touchstone Project.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

Public Function GetDataQualityAnalyses( _
   ByVal request As GetDataQualityAnalysesRequest _
) As GetDataQualityAnalysesResponse

Dim instance As DataQualityAnalysisServiceClient
Dim request As GetDataQualityAnalysesRequest
Dim value As GetDataQualityAnalysesResponse
 
value = instance.GetDataQualityAnalyses(request)

public GetDataQualityAnalysesResponse GetDataQualityAnalyses( 
   GetDataQualityAnalysesRequest request
)

Parameters

request: Contains a GetDataQualityAnalysesRequest that identifies the Touchstone-generated Business Unit Sequential Identifier (SID), SQL Instance SID, and Project SID associated with the list of Data Quality Analyses that you want to retrieve.

Return Value

A GetDataQualityAnalysesResponse containing a list of Data Quality Analyses for the specified Project within the specified SQL Server Instance and Business Unit.

Remarks

To find the Business Unit SID to pass into this method, call the GetBusinessUnits() method.

To find the SQL Instance SID to pass into this method, call the GetSqlInstances() method.

To find the Project SID to pass into this method, call the GetProjects() method.

For information about retrieving specific categories of results from a Touchstone Data Quality Analysis, see the following methods:

For information about generating a summary PDF containing the results of a Data Quality Analysis, see the SubmitDataQualityAnalysisReport() method and the GetDataQualityAnalysisReportFilePath() method.

For information about submitting a new Data Quality Analysis job, see the SubmitDataQualityAnalysis() method.

Example

The following example shows how to retrieve a list of all Touchstone Data Quality Analyses for a given Project within a specific Business Unit and SQL Server Instance using the GetDataQualityAnalyses() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.DataQualityAnalysis.Api;
using AIR.Services.DataQualityAnalysis.Data;
            
class SnippetGetDataQualityAnalysesRequest
{
    private static void GetAnalysis(int businessUnitSid, int sqlInstanceSid, int projectSid)
    {
        DataQualityAnalysisServiceClient client = new DataQualityAnalysisServiceClient();
        GetDataQualityAnalysesRequest request = new GetDataQualityAnalysesRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        request.ProjectSid = projectSid;
        GetDataQualityAnalysesResponse response = client.GetDataQualityAnalyses(request);
        if (response.Status.Code == StatusCode.Success)
        {
            foreach (DataQualityAnalysis analysis in response.Analyses)
            {
                Console.WriteLine("SID: " + analysis.Sid);
                Console.WriteLine("Name: " + analysis.AnalysisOptions.Name);
            }
        }
    }
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DataQualityAnalysisServiceClient Class
DataQualityAnalysisServiceClient Members