Merge pull request #2 from kerski/development-scale-out

Adding SyncStatus EndPoint for Dataset Scale-out

Author: kerski

PBIRESTAPIComm.pq

@@ -54,6 +54,7 @@ let
             {"GetDatasetRefreshExecutionDetailsInGroup","GetDatasetRefreshExecutionDetailsInGroup",PBIRESTAPIComm.GetDatasetRefreshExecutionDetailsInGroup,"Function","GetDatasetRefreshExecutionDetailsInGroup",true},
             {"GetDatasetRefreshHistoryInGroup","GetDatasetRefreshHistoryInGroup",PBIRESTAPIComm.GetDatasetRefreshHistoryInGroup,"Function","GetDatasetRefreshHistoryInGroup",true},
             {"GetDatasetRefreshScheduleInGroup","GetDatasetRefreshScheduleInGroup",PBIRESTAPIComm.GetDatasetRefreshScheduleInGroup,"Function","GetDatasetRefreshScheduleInGroup",true},
+            {"GetDatasetSyncStatusInGroup","GetDatasetSyncStatusInGroup",PBIRESTAPIComm.GetDatasetSyncStatusInGroup,"Function","GetDatasetSyncStatusInGroup",true},
             {"ExecuteQuery","ExecuteQuery",PBIRESTAPIComm.ExecuteQuery,"Function","ExecuteQuery",true},
             {"ExecuteQueryInGroup","ExecuteQueryInGroup",PBIRESTAPIComm.ExecuteQueryInGroup,"Function","ExecuteQueryInGroup",true},
             /* Reports */
@@ -1269,6 +1270,49 @@ GetDatasetRefreshScheduleInGroup = (optional groupId as text , optional datasetI
         result;
 /*** End GetDatasetRefreshScheduleInGroup***/
 
+/*** GetDatasetSyncStatusInGroup ***/
+shared PBIRESTAPIComm.GetDatasetSyncStatusInGroup = Value.ReplaceType(
+    GetDatasetSyncStatusInGroup,
+    GetDatasetSyncStatusInGroupType
+);
+
+GetDatasetSyncStatusInGroupType = type function (
+    optional groupId as (
+        type text meta [
+            Documentation.FieldCaption = "Group ID",
+            Documentation.FieldDescription = "The workspace ID.",
+            Documentation.SampleValues = {
+                "xxx-xxxx-abcd..."
+            }
+        ]
+    ),
+    optional datasetId as (
+        type text meta [
+            Documentation.FieldCaption = "Dataset ID",
+            Documentation.FieldDescription = "The Dataset ID.",
+            Documentation.SampleValues = {
+                "xxx-xxxx-efgh..."
+            }
+        ]
+    )
+) as table meta [
+    Documentation.Name = "PBIRESTAPIComm.GetDatasetSyncStatusInGroup",
+    Documentation.LongDescription = "Returns the sync status information of the read-only replica and read/write dataset.",
+    Documentation.Examples = {
+        [
+            Code = "=PBIRESTAPIComm.GetDatasetSyncStatusInGroup(""xxx-xxxx-abcd..."",""xxx-xxxx-efgh..."")",
+            Result = "Defined as "
+        ]
+    }
+];
+
+GetDatasetSyncStatusInGroup = (optional groupId as text , optional datasetId as text) =>
+    let
+        result = GetJSON("v1.0/myorg/groups/" & groupId & "/datasets/" & datasetId & "/syncStatus")
+    in
+        result;
+/*** End GetDatasetSyncStatusInGroup ***/
+
 /*** ExecuteQuery ***/
 shared PBIRESTAPIComm.ExecuteQuery = Value.ReplaceType(
     ExecuteQuery,

PBIRESTAPIComm.query.pq

@@ -6,28 +6,31 @@ shared MyExtension.UnitTest =
     Source = PBIRESTAPIComm.FunctionCatalog(),
 
     /*Variables*/ 
-    AppTestID = "{APP TEST ID}",
-    AppDashboardTestID = "{APP DASHBOARD TEST ID}",
-    AppDashboardTileTestID = "{APP DASHBOARD TILE TEST ID}",
-    AppReportTestID = "{APP REPORT TEST ID}",
-    GroupTestID = "{GROUP TEST ID}",
+    AppTestID = "{INSERT VALUE}",
+    AppDashboardTestID = "{INSERT VALUE}",
+    AppDashboardTileTestID = "{INSERT VALUE}",
+    AppReportTestID = "{INSERT VALUE}",
+    GroupTestID = "{INSERT VALUE}",
     GroupNameFilter = "name eq 'Custom Connector Test'",
-    DatasetTestID = "{DATASET TEST ID}",
-    ReportTestID = "{REPORT Test ID}",
+    DatasetTestID = "{INSERT VALUE}",
+    ReportTestID = "{INSERT VALUE}",
     ReportTestName = "SampleModel",
-    PipelineTestID = "{PIPELINE TEST ID}",
-    EnchancedRefreshTestID = "{REFRESH TEST ID}",
-    DashboardTestID = "{DASHBOARD TEST ID}",
-    DashboardTileTestID = "{DASHBOARD TILE TEST ID}",
-    DataFlowTestID = "{DATAFLOW TEST ID}",
-    DownstreamDataflowTestID = "{DOWNSTREAM DATAFLOW TEST ID}",
-    ScorecardOneTestID = "{SCORECARD ONE TEST ID}",
-    ScorecardOneGoalTestID = "{SCORECARD ONE GOAL TEST ID}", 
-    ScorecardOneGoalWithRefreshTestID = "{SCORECARD ONE GOAL WITH REFRESH TEST ID}",   
-    ScorecardTwoTestID = "{SCORECARD TWO TEST ID}",
-    ScorecardInternalReportId = "{SCORECARD INTERNAL REPORT ID}",
-    ScorecardOneGoalTimestampID = "{SCORECARD ONE GOAL TIMESTAMP ID}",
-    
+    PipelineTestID = "{INSERT VALUE}",
+    EnchancedRefreshTestID = "{INSERT VALUE}",
+    DashboardTestID = "{INSERT VALUE}",
+    DashboardTileTestID = "{INSERT VALUE}",
+    DataflowTestID = "{INSERT VALUE}",
+    DownstreamDataflowTestID = "{INSERT VALUE}",
+    ScorecardOneTestID = "{INSERT VALUE}",
+    ScorecardOneGoalTestID = "{INSERT VALUE}", 
+    ScorecardOneGoalWithRefreshTestID = "{INSERT VALUE}",   
+    ScorecardTwoTestID = "{INSERT VALUE}",
+    ScorecardInternalReportId = "{INSERT VALUE}",
+    ScorecardOneGoalTimestampID = #datetimezone(2023,2,18,0,0,0,0,0),
+    // Sync Status Workspace ID
+    ScaleOutWorkspaceID = "{INSERT VALUE}",
+    ScaleOutDatasetID = "{INSERT VALUE}",
+
     // Extracts Function from group
     _GetFunction = (_func_key as text) =>
         let
@@ -63,6 +66,7 @@ shared MyExtension.UnitTest =
     GetDatasetsInGroup = _GetFunction("GetDatasetsInGroup"),
     GetDatasetDatasourcesInGroup = _GetFunction("GetDatasetDatasourcesInGroup"),
     GetDatasetDirectQueryRefreshScheduleInGroup = _GetFunction("GetDatasetDirectQueryRefreshScheduleInGroup"),
+    GetDatasetSyncStatusInGroup = _GetFunction("GetDatasetSyncStatusInGroup"),
     GetDatasetParametersInGroup = _GetFunction("GetDatasetParametersInGroup"),
     GetDatasetRefreshExecutionDetailsInGroup = _GetFunction("GetDatasetRefreshExecutionDetailsInGroup"),
     GetDatasetRefreshHistoryInGroup = _GetFunction("GetDatasetRefreshHistoryInGroup"),
@@ -339,7 +343,17 @@ shared MyExtension.UnitTest =
              true,
              Value.Is(GetDatasetDirectQueryRefreshScheduleInGroup,Function.Type)
         ),
-        /*Fact("GetDatasetDirectQueryRefreshScheduleInGroup Should Be Correct Metadata",
+        /* GetDatasetSyncStatusInGroup */
+        Fact("GetDatasetSyncStatusInGroup Should Be a Function",
+             true,
+             Value.Is(GetDatasetSyncStatusInGroup,Function.Type)
+        ), 
+        Fact("GetDatasetSyncStatusInGroup Should Have a CommitVersion Property and Value",
+             true,
+             Text.Length(Number.ToText(Json.Document(GetDatasetSyncStatusInGroup(ScaleOutWorkspaceID,ScaleOutDatasetID))[#"commitVersion"])) > 0
+        ),                
+        /*
+        Fact("GetDatasetDirectQueryRefreshScheduleInGroup Should Be Correct Metadata",
              "datasources",
              Text.AfterDelimiter(Json.Document(GetDatasetDirectQueryRefreshScheduleInGroup(GroupTestID,DatasetTestID))[#"@odata.context"],"#")
         ),*/
@@ -523,15 +537,15 @@ shared MyExtension.UnitTest =
      /*****************
      GOALS STATUS RULES
      *****************/               
-        /* GetScorecardGoalsStatusRulesInGroup */
+          /* GetScorecardGoalsStatusRulesInGroup */
         Fact("GetScorecardGoalsStatusRulesInGroup Should Be a Function",
              true,
              Value.Is(GetScorecardGoalsStatusRulesInGroup,Function.Type)
         ),
         Fact("GetScorecardGoalsStatusRulesInGroup Should Be Correct Metadata",
             "scorecards(" & ScorecardOneTestID & ")/metrics(" & ScorecardOneGoalTestID & ")/statusRules",
             Text.AfterDelimiter(Json.Document(GetScorecardGoalsStatusRulesInGroup(GroupTestID,ScorecardOneTestID,ScorecardOneGoalTestID))[#"@odata.context"],"#")
-        ),    
+        ),  
      /*****************
      GROUPS
      *****************/             
@@ -657,10 +671,12 @@ shared MyExtension.UnitTest =
              true,
              Value.Is(GetScorecardInGroup,Function.Type)
         ),
+        /*
+        Disable after odatacontext dissappeared
         Fact("GetScorecardInGroup Should Be Correct Metadata",
              "scorecards/$entity",
              Text.AfterDelimiter(Json.Document(GetScorecardInGroup(GroupTestID,ScorecardOneTestID))[#"@odata.context"],"#")
-        ),
+        ),*/
         Fact("GetScorecardInGroup Should Return a goals property",
              true,
              List.Count(Json.Document(GetScorecardInGroup(GroupTestID,ScorecardOneTestID,"goals($expand=goalValues)"))[#"goals"]) > 0

README.md

@@ -127,7 +127,8 @@ Not all functions from the Power BI REST API have been implemented.  Here are th
 | GetDatasetParametersInGroup             | Returns a list of parameters for the specified dataset from the specified workspace.  | [Datasets - Get Parameters In Group](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-parameters-in-group) |
 | GetDatasetRefreshExecutionDetailsInGroup             | Returns execution details of an enhanced refresh operation for the specified dataset from the specified workspace.  | [Datasets - Get Refresh Execution Details In Group](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-execution-details-in-group) |
 | GetDatasetRefreshHistoryInGroup| Returns the refresh history for the specified dataset from the specified workspace.  | [Datasets - Get Refresh History](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history-in-group) |
-| GetDatasetRefreshScheduleInGroup|      Description  | [Datasets - Get Refresh Schedule In Group](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-schedule-in-group) |
+| GetDatasetRefreshScheduleInGroup|      Returns the refresh schedule for the specified dataset from the specified workspace.  | [Datasets - Get Refresh Schedule In Group](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-schedule-in-group) |
+|GetDatasetSyncStatusInGroup |      Returns the sync status information of the read-only replica and read/write dataset. (<b>Preview</b>: Power BI Dataset Scale-Out)  | [Datasets - Get Dataset Sync Status In Group ](https://learn.microsoft.com/en-us/power-bi/enterprise/service-premium-scale-out#enable-scale-out-for-your-workspace) |
 
 ### GoalValues (Preview)
 | End Point                      | Description  | MSDN Documentation |