Récupérer les données du catalogue dans Power Platform

La méthode statique suivante GetPowerCatalogInformationExample récupère les données à l’aide des classes mspcat_GetPowerCatalogInformationRequest et mspcat_GetPowerCatalogInformationResponse générées pour le message mspcat_GetPowerCatalogInformation par la commande pac modelbuilder build.

/// <summary>
/// Returns data about the catalog for an environment
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance.</param>
/// <param name="permissionsonly">Whether to only return information about permissions.</param>
static void GetPowerCatalogInformationExample(IOrganizationService service, bool permissionsonly = false)
{
   var request = new mspcat_GetPowerCatalogInformationRequest();
   if (permissionsonly) {
         request.permissionsonly = true;
   }
   var response = (mspcat_GetPowerCatalogInformationResponse)service.Execute(request);

   Console.WriteLine($"SolutionVersion: {response.SolutionVersion}");
   Console.WriteLine($"CatalogDescription: {response.CatalogDescription}");
   Console.WriteLine($"CanRead: {response.CanRead}");
   Console.WriteLine($"CatalogName: {response.CatalogName}");
   Console.WriteLine($"ImageLink: {response.ImageLink}");
   Console.WriteLine($"CanSubmit: {response.CanSubmit}");
}

Sortie

Avec permissionsonly égal à false.

SolutionVersion: 1.1.24.500
CatalogDescription: Catalog in Power Platform applications created by your company.
CanRead: True
CatalogName: Default Catalog Name
ImageLink:
CanSubmit: True

Générer des classes à liaison anticipée pour le SDK pour .NET
Utiliser le SDK pour .NET Dataverse

La fonction PowerShell suivante GetPowerCatalogInformationExample invoque la fonction mspcat_GetPowerCatalogInformation et traite les résultats qui sont représentés par le type complexe mspcat_GetPowerCatalogInformationResponse. Cette fonction dépend des valeurs $baseURI et $baseHeaders définies avec la fonction Connect comme décrit dans Créer une fonction Connect.

function GetPowerCatalogInformationExample {
   param (
      [bool]
      $permissionsonly
   )

   $uri = $baseURI + 'mspcat_GetPowerCatalogInformation'
   if ($permissionsonly) {
      $uri += '(?permissionsonly=true)'
   }
   $results = Invoke-RestMethod `
      -Method Get `
      -Uri $uri `
      -Headers $baseHeaders 

   return  @{
      SolutionVersion     = $results.SolutionVersion
      CatalogDescription  = $results.CatalogDescription
      CanRead             = $results.CanRead
      CatalogName         = $results.CatalogName
      ImageLink           = $results.ImageLink
      CanSubmit           = $results.CanSubmit
   }
}

Utiliser l’API Web Microsoft Dataverse
Utiliser des fonctions API Web
Utiliser PowerShell et Visual Studio Code avec l’API web Dataverse

La méthode statique suivante GetPowerCatalogDetailsExample récupère les données à l’aide des classes mspcat_GetPowerCatalogDetailsRequest et mspcat_GetPowerCatalogDetailsResponse générées pour le message mspcat_GetPowerCatalogDetails par la commande pac modelbuilder build.

/// <summary>
/// Outputs details of the catalog in Power Platform.
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance.</param>
static void GetPowerCatalogDetailsExample(IOrganizationService service) {

    var request = new mspcat_GetPowerCatalogDetailsRequest();
    var response = (mspcat_GetPowerCatalogDetailsResponse)service.Execute(request);

   JsonDocument catalogDetails = JsonDocument.Parse(response.CatalogDetails);

    string catalogId = catalogDetails.RootElement.GetProperty("catalogId").GetString();
    bool isSuccess = catalogDetails.RootElement.GetProperty("isSuccess").GetBoolean();
    JsonElement sourceOptions = catalogDetails.RootElement.GetProperty("sourceOptions");
    JsonElement categoryOptions = catalogDetails.RootElement.GetProperty("categoryOptions");
    string publisherLocalizedDisplayName = catalogDetails.RootElement.GetProperty("publisherLocalizedDisplayName").GetString();
    string catalogItemLocalizedDisplayName = catalogDetails.RootElement.GetProperty("catalogItemLocalizedDisplayName").GetString();


    Console.WriteLine($"catalogId: {catalogId}");
    Console.WriteLine($"isSuccess: {isSuccess}");
    Console.WriteLine("sourceOptions:");
    foreach (JsonElement element in sourceOptions.EnumerateArray())
    {
        int id = element.GetProperty("id").GetInt32();
        string label = element.GetProperty("userLocalziedLabel").GetString();
        Console.WriteLine($"  {id} {label}");
    }
    Console.WriteLine("categoryOptions:");
    foreach (JsonElement element in categoryOptions.EnumerateArray())
    {
        int id = element.GetProperty("id").GetInt32();
        string label = element.GetProperty("userLocalziedLabel").GetString();
        Console.WriteLine($"  {id} {label}");
    }
    Console.WriteLine($"publisherLocalizedDisplayName: {publisherLocalizedDisplayName}");
    Console.WriteLine($"catalogItemLocalizedDisplayName: {catalogItemLocalizedDisplayName}");
}

Sortie

La méthode statique GetPowerCatalogDetailsExample écrit quelque chose comme ceci dans la console :

catalogId: 883278f5-07af-45eb-a0bc-3fea67caa544
isSuccess: True
sourceOptions:
  526430000 Other
  526430001 Power Automate Maker Portal
  526430002 Power Platform Maker Portal
  526430003 Power Virtual Agents Maker Portal
  526430004 Power Platform Admin API
  526430005 PAC CLI
  526430006 PAC Build Task
  526430007 Pipelines in Power Platform
categoryOptions:
  526430000 Customer Service
  526430001 Project Management
  526430002 Calendar Management & Scheduling
  526430003 Email Management
  526430004 Files & Documentation
  526430005 Notification & Reminders
  526430006 Analytics
  526430007 Collaboration
  526430008 Commerce
  526430009 Finance
  526430010 Compliance & Legal
  526430011 Sales
  526430012 IT Tools
  526430013 Marketing
  526430014 Operations & Supply Chain
  526430015 Internet of Things
  526430016 AI Machine Learning
  526430017 Geolocation
  526430018 Human Resources
publisherLocalizedDisplayName: Catalog Publisher
catalogItemLocalizedDisplayName: Catalog Item

Générer des classes à liaison anticipée pour le SDK pour .NET
Utiliser le SDK pour .NET Dataverse

Utilisez cette fonction GetPowerCatalogDetails PowerShell pour utiliser la fonction mspcat_GetPowerCatalogDetails. Cette fonction dépend des valeurs $baseURI et $baseHeaders définies avec la fonction Connect comme décrit dans Créer une fonction Connect.

function GetPowerCatalogDetails {
   $results = Invoke-RestMethod `
      -Method Get `
      -Uri $baseURI"mspcat_GetPowerCatalogDetails" `
      -Headers $baseHeaders

   $catalogDetails =  $results.CatalogDetails 
   | ConvertFrom-Json

   Write-Host "catalogId: $($catalogDetails.catalogId)"
   Write-Host "isSuccess: $($catalogDetails.isSuccess)"
   Write-Host "sourceOptions:"
   foreach($option in $catalogDetails.sourceOptions) {
      Write-Host ('   {0} {1}' -f $option.id, $option.userLocalziedLabel)
   }
   Write-Host "categoryOptions:"
   foreach($option in $catalogDetails.categoryOptions) {
      Write-Host ('   {0} {1}' -f $option.id, $option.userLocalziedLabel)
   }
   Write-Host "publisherLocalizedDisplayName: $($catalogDetails.publisherLocalizedDisplayName)"
   Write-Host "catalogItemLocalizedDisplayName: $($catalogDetails.catalogItemLocalizedDisplayName)"
}

La sortie de cette fonction ressemble à ceci :

catalogId: 883278f5-07af-45eb-a0bc-3fea67caa544
isSuccess: True
sourceOptions:
   526430000 Other
   526430001 Power Automate Maker Portal
   526430002 Power Platform Maker Portal
   526430003 Power Virtual Agents Maker Portal
   526430004 Power Platform Admin API
   526430005 PAC CLI
   526430006 PAC Build Task
   526430007 Pipelines in Power Platform
categoryOptions:
   526430000 Customer Service
   526430001 Project Management
   526430002 Calendar Management & Scheduling
   526430003 Email Management
   526430004 Files & Documentation
   526430005 Notification & Reminders
   526430006 Analytics
   526430007 Collaboration
   526430008 Commerce
   526430009 Finance
   526430010 Compliance & Legal
   526430011 Sales
   526430012 IT Tools
   526430013 Marketing
   526430014 Operations & Supply Chain
   526430015 Internet of Things
   526430016 AI Machine Learning
   526430017 Geolocation
   526430018 Human Resources
publisherLocalizedDisplayName: Catalog Publisher
catalogItemLocalizedDisplayName: Catalog Item

Utiliser l’API Web Microsoft Dataverse
Utiliser des fonctions API Web
Utiliser PowerShell et Visual Studio Code avec l’API web Dataverse

La méthode statique RetrieveCatalogItems suivante récupère et imprime une table de données à partir des tables Élément du catalogue (mspcat_applications) et Package (mspcat_packages) concernant les éléments du catalogue. Cette fonction dépend du package ConsoleTables NuGet pour afficher la table dans une application console.

/// <summary>
/// Retrieves information about catalog items and writes it to the console
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance.</param>
static void RetrieveCatalogItems(IOrganizationService service)
{
    QueryExpression query = new("mspcat_applications")
    {
        ColumnSet = new ColumnSet(
             "mspcat_tpsid",
             "mspcat_deploytype",
             "mspcat_applicationtype",
             "mspcat_businesscategory",
             "mspcat_description",
             "mspcat_applicationsid",
             "mspcat_publisherid",
             "mspcat_name",
             "statuscode"),
        Criteria = new FilterExpression(LogicalOperator.And)
        {
            Conditions = {
                {
                    new ConditionExpression(
                        attributeName: "statecode",
                        conditionOperator: ConditionOperator.Equal,
                        value: 0)
                }
            }
        }
    };

    LinkEntity linkToPackages = query.AddLink(
       linkToEntityName: "mspcat_packages",
       linkFromAttributeName: "mspcat_packageasset",
       linkToAttributeName: "mspcat_packagesid",
       joinOperator: JoinOperator.Inner);

    linkToPackages.Columns = new ColumnSet(
        "statecode",
        "mspcat_uniquename",
        "mspcat_version",
        "statuscode");

    linkToPackages.EntityAlias = "pkg";

    EntityCollection catalogs = service.RetrieveMultiple(query);

    var table = new ConsoleTables.ConsoleTable(
        "Catalog Item Name",
        "Publisher Name",
        "Catalog Item ID",
        "Revision ID",
        "Version",
        "Status");

    foreach (Entity catalog in catalogs.Entities)
    {
        string catalogItemName = catalog.GetAttributeValue<string>("mspcat_name");
        string publisherName = catalog.FormattedValues["mspcat_publisherid"];
        string catalogItemId = catalog.GetAttributeValue<string>("mspcat_tpsid");
        Guid revisionId = catalog.GetAttributeValue<Guid>("mspcat_applicationsid");
        string version = (string)catalog.GetAttributeValue<AliasedValue>("pkg.mspcat_version").Value;
        string status = catalog.FormattedValues["statuscode"];

        string[] rowData = {
            catalogItemName,
            publisherName,
            catalogItemId,
            revisionId.ToString(),
            version,
            status
        };

        table.Rows.Add(rowData);
    }
    table.Write();
}

La sortie de cet exemple pourrait ressembler à ceci :

 -----------------------------------------------------------------------------------------------------------------------------------------------------------------
 | Catalog Item Name                  | Publisher Name          | Catalog Item ID                   | Revision ID                          | Version | Status    |
 -----------------------------------------------------------------------------------------------------------------------------------------------------------------
 | Contoso Conference Custom Connector| Catalog Conferences Team| ContosoConferencesCustomConnector | 4e882dd6-74f3-ed11-8849-000d3a0a286b | 1.0.0.1 | Published |
 -----------------------------------------------------------------------------------------------------------------------------------------------------------------
 | Contoso Themed Components          | ContosoPublisher        | ContosoThemedComponents           | efbc469d-f1b2-ed11-83fd-000d3a0a2d9d | 1.0.0.1 | Published |
 -----------------------------------------------------------------------------------------------------------------------------------------------------------------

Utiliser le SDK pour .NET Dataverse
Interroger les données à l’aide de QueryExpression

Cette fonction PowerShell RetrieveCatalogItems récupère et imprime une table de données à partir des tables Élément du catalogue (mspcat_applications) et Package (mspcat_packages) concernant les éléments du catalogue. Cette fonction dépend de la fonction Get-Records introduite dans Utiliser PowerShell et Visual Studio Code avec l’API web Dataverse

function Get-CatalogItems{

   $columns = @(
      "mspcat_tpsid",
      "mspcat_deploytype",
      "mspcat_applicationtype",
      "mspcat_businesscategory",
      "mspcat_description",
      "mspcat_applicationsid",
      "_mspcat_publisherid_value",
      "mspcat_name",
      "statuscode"
   )
   $select = "?`$select=" + ($columns -join ',')

   $filter = "&`$filter=statecode eq 0 and _mspcat_packageasset_value ne null"

   $expandColumns = @(
      "statecode",
      "mspcat_uniquename",
      "mspcat_version",
      "statuscode"
   )

   $expand = "&`$expand=mspcat_PackageAsset"
   $expand += "(`$select=" + ($expandColumns -join ',')+ ")"

   (Get-Records `
      -setName 'mspcat_applicationses' `
      -query ($select + $filter + $expand)).value 
      | Format-Table @{Name='Catalog Item Name' ; Expression={$_.mspcat_name}}, `
         @{Name='Publisher Name' ; Expression={$_.'_mspcat_publisherid_value@OData.Community.Display.V1.FormattedValue'}}, `
         @{Name='Catalog Item ID' ; Expression={$_.mspcat_tpsid}}, `
         @{Name='Revision ID' ; Expression={$_.mspcat_applicationsid }}, `
         @{Name='Version' ; Expression={$_.mspcat_PackageAsset.mspcat_version}}, `
         @{Name='Status' ; Expression={$_.mspcat_PackageAsset.'statuscode@OData.Community.Display.V1.FormattedValue'}}
}

La requête HTTP envoyée par la fonction Get-CatalogItems ressemble à ceci :

GET [Organization URI]/api/data/v9.2/mspcat_applicationses?$select=mspcat_tpsid,mspcat_deploytype,mspcat_applicationtype,mspcat_businesscategory,mspcat_description,mspcat_applicationsid,_mspcat_publisherid_value,mspcat_name,statuscode&$filter=statecode%20eq%200%20and%20_mspcat_packageasset_value%20ne%20null&$expand=mspcat_PackageAsset($select=statecode,mspcat_uniquename,mspcat_version,statuscode) HTTP/1.1
OData-MaxVersion: 4.0
Authorization: Bearer [REDACTED]
Prefer: odata.include-annotations="*"
OData-Version: 4.0
Accept: application/json
User-Agent: Mozilla/5.0 (Windows NT 10.0; Microsoft Windows 10.0.22631; en-US) PowerShell/7.4.2
Accept-Encoding: gzip, deflate, br

La sortie de cet exemple pourrait ressembler à ceci :

Catalog Item Name                   Publisher Name           Catalog Item ID                   Revision ID                          Version Status
----------------------------------- ------------------------ --------------------------------- -----------------------------------  ------- ---------
Contoso Conference Custom Connector Catalog Conferences Team ContosoConferencesCustomConnector 4e882dd6-74f3-ed11-8849-000d3a0a286b 1.0.0.1 Published
Contoso Themed Components           ContosoPublisher         ContosoThemedComponents           efbc469d-f1b2-ed11-83fd-000d3a0a2d9d 1.0.0.1 Published

Utiliser l’API Web Microsoft Dataverse
Interroger les données à l’aide de l’API web