Skip to content

Latest commit

 

History

History
100 lines (77 loc) · 3.34 KB

PublicConfigurationManagementApi.md

File metadata and controls

100 lines (77 loc) · 3.34 KB

Agravity.Public.Api.PublicConfigurationManagementApi

All URIs are relative to http://localhost:7072/api

Method HTTP request Description
HttpConfigGetFrontendAll GET /config/frontend

HttpConfigGetFrontendAll

List<FrontendAppConfig> HttpConfigGetFrontendAll (bool? customonly = null)

Lists config value only for frontend stored in config table. Optional to filter for custom values only.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Agravity.Public.Api;
using Agravity.Public.Client;
using Agravity.Public.Model;

namespace Example
{
    public class HttpConfigGetFrontendAllExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:7072/api";
            var apiInstance = new PublicConfigurationManagementApi(config);
            var customonly = true;  // bool? | This returns only the custom created configurations. (optional) 

            try
            {
                List<FrontendAppConfig> result = apiInstance.HttpConfigGetFrontendAll(customonly);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling PublicConfigurationManagementApi.HttpConfigGetFrontendAll: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the HttpConfigGetFrontendAllWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<List<FrontendAppConfig>> response = apiInstance.HttpConfigGetFrontendAllWithHttpInfo(customonly);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling PublicConfigurationManagementApi.HttpConfigGetFrontendAllWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
customonly bool? This returns only the custom created configurations. [optional]

Return type

List<FrontendAppConfig>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Returns the frontend configations values in store -
404 No config table could be found. (Code: 33d6286a-b7a4-428e-9f0b-cf7488d174ac) -
401 The config table could be be accessed. (Code: b9f176b8-cf22-4815-a90c-5a40611d2cfa) -
500 Internal server error. Please contact administrator. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]