Mit dieser Funktion kannst du Konfigurationsoptionen bereitstellen, die durch die Config-App gesammelt dargestellt werden.

Damit du Konfigurationsoptionen bereitstellen kannst, musst du eine Linkrelation configfeatures bereitstellen.

Ermitteln der Konfigurationsoptionen:

Die Config-App fragt alle registrierten Apps ab. Anschließend wird jede registrierte App mit dem Aufruf /<app name>/ auf der Basisadresse (also: https://<your base address>/<app name>/) und dem Anforderungsheader "Accept: application/hal+json" abgefragt. Es wird nach der Linkrelation configfeatures gesucht. Damit die Linkrelation gefunden werden kann, muss das JSON wie folgt aufgebaut sein:

JSON Response

{
  "_links" : {
        ...
    "configfeatures" : {
        "href" : "/<app name>/configfeatures"
    }, 
        ...
  },
  ...
}

Wenn eine solche Linkrelation vorhanden ist, wird die darunter angegebene URI im Benutzerkontext mit der Anforderungsmethode GET und dem Anforderungsheader "Accept: application/hal+json" aufgerufen und das erhaltene JSON ausgewertet. Das JSON, welche Apps bereitstellen müssen, um eine oder mehrere Konfigurationsoptionen anzubieten, muss entsprechend dem nachfolgenden Schema aufgebaut sein:

JSON Response

{
  "appName": "<app name>",
  "customHeadlines":[
    {
      "caption": "<caption of your configuration option>",
      "description": "<description of your configuration option>",
      "menuItems":[ {
          "caption": "<caption of your first menu item>",
          "description": "<description of your first menu item>",
          "href": "<link to your configuration>",
          "keywords":["<first key word>", "<second key word>", ...],
          "configurationState": <state of your configuration>
        }, 
                <second menu item>,
                ...
      ], 
          "categories":[{
                  "id": "<id of your category>"
            }
          ]
    },
        <second configuration option>,
        ...
  ]
}

Die folgende Tabelle beschreibt die Kategorien, die einer App zugeordnet werden können.

Im Folgenden sind Beispiele für die verschiedenen DTOs aufgelistet, die den Aufbau eines configfeatures beschreiben. Die Beispiele sind in C# geschrieben.

ConfigFeatureDtos

public class ConfigFeatureDto
{
    public string AppName { get; set; }
    public IList<CustomHeadlineDto> CustomHeadlines { get; set; }
 
    public ConfigFeatureDto()
    {
        CustomHeadlines = new List<CustomHeadlineDto>();
    }
}

public class CustomHeadlineDto
{
    public string Caption { get; set; }
    public string Description { get; set; }
    public IList<MenuItemDto> MenuItems { get; set; }
    public IList<CategoryDto> Categories { get; set; }
 
    public CustomHeadlineDto()
    {
        MenuItems = new List<MenuItemDto>();
        Categories = new List<CategoryDto>();
    }
}

public class MenuItemDto
{
    public string Caption { get; set; }
    public string Description { get; set; }
    public string Href { get; set; }
    public IList<string> Keywords { get; set; }
    public ConfigurationStateDto ConfigurationState { get; set; }
 
    public MenuItemDto()
    {
        Keywords = new List<string>();
    }
}

public class CategoryDto
{
    public string Id { get; set; }
    public string Caption { get; set; }
}

public enum ConfigurationStateDto
{
    Complete = 0,
    Incomplete = 1
}