Skip to content

Latest commit

 

History

History
202 lines (161 loc) · 7.88 KB

ObjectSystemconfigurationApi.md

File metadata and controls

202 lines (161 loc) · 7.88 KB

eZmaxApi.Api.ObjectSystemconfigurationApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
SystemconfigurationEditObjectV2 PUT /2/object/systemconfiguration/{pkiSystemconfigurationID} Edit an existing Systemconfiguration
SystemconfigurationGetObjectV2 GET /2/object/systemconfiguration/{pkiSystemconfigurationID} Retrieve an existing Systemconfiguration

SystemconfigurationEditObjectV2

SystemconfigurationEditObjectV2Response SystemconfigurationEditObjectV2 (int pkiSystemconfigurationID, SystemconfigurationEditObjectV2Request systemconfigurationEditObjectV2Request)

Edit an existing Systemconfiguration

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class SystemconfigurationEditObjectV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectSystemconfigurationApi(config);
            var pkiSystemconfigurationID = 56;  // int | The unique ID of the Systemconfiguration
            var systemconfigurationEditObjectV2Request = new SystemconfigurationEditObjectV2Request(); // SystemconfigurationEditObjectV2Request | 

            try
            {
                // Edit an existing Systemconfiguration
                SystemconfigurationEditObjectV2Response result = apiInstance.SystemconfigurationEditObjectV2(pkiSystemconfigurationID, systemconfigurationEditObjectV2Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectSystemconfigurationApi.SystemconfigurationEditObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the SystemconfigurationEditObjectV2WithHttpInfo variant

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

try
{
    // Edit an existing Systemconfiguration
    ApiResponse<SystemconfigurationEditObjectV2Response> response = apiInstance.SystemconfigurationEditObjectV2WithHttpInfo(pkiSystemconfigurationID, systemconfigurationEditObjectV2Request);
    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 ObjectSystemconfigurationApi.SystemconfigurationEditObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiSystemconfigurationID int The unique ID of the Systemconfiguration
systemconfigurationEditObjectV2Request SystemconfigurationEditObjectV2Request

Return type

SystemconfigurationEditObjectV2Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
404 The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body -
422 The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body -

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

SystemconfigurationGetObjectV2

SystemconfigurationGetObjectV2Response SystemconfigurationGetObjectV2 (int pkiSystemconfigurationID)

Retrieve an existing Systemconfiguration

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class SystemconfigurationGetObjectV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectSystemconfigurationApi(config);
            var pkiSystemconfigurationID = 56;  // int | The unique ID of the Systemconfiguration

            try
            {
                // Retrieve an existing Systemconfiguration
                SystemconfigurationGetObjectV2Response result = apiInstance.SystemconfigurationGetObjectV2(pkiSystemconfigurationID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectSystemconfigurationApi.SystemconfigurationGetObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the SystemconfigurationGetObjectV2WithHttpInfo variant

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

try
{
    // Retrieve an existing Systemconfiguration
    ApiResponse<SystemconfigurationGetObjectV2Response> response = apiInstance.SystemconfigurationGetObjectV2WithHttpInfo(pkiSystemconfigurationID);
    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 ObjectSystemconfigurationApi.SystemconfigurationGetObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiSystemconfigurationID int The unique ID of the Systemconfiguration

Return type

SystemconfigurationGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
404 The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body -

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