Skip to content
This repository has been archived by the owner on Apr 14, 2024. It is now read-only.

Latest commit

 

History

History
114 lines (74 loc) · 3.91 KB

ObjectSystemconfigurationApi.md

File metadata and controls

114 lines (74 loc) · 3.91 KB

EZmaxApiDefinitionFull.ObjectSystemconfigurationApi

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

Method HTTP request Description
systemconfigurationEditObjectV1 PUT /1/object/systemconfiguration/{pkiSystemconfigurationID} Edit an existing Systemconfiguration
systemconfigurationGetObjectV2 GET /2/object/systemconfiguration/{pkiSystemconfigurationID} Retrieve an existing Systemconfiguration

systemconfigurationEditObjectV1

SystemconfigurationEditObjectV1Response systemconfigurationEditObjectV1(pkiSystemconfigurationID, SystemconfigurationEditObjectV1Request)

Edit an existing Systemconfiguration

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectSystemconfigurationApi();
let pkiSystemconfigurationID = 56; // Number | The unique ID of the Systemconfiguration
let SystemconfigurationEditObjectV1Request = new EZmaxApiDefinitionFull.SystemconfigurationEditObjectV1Request(); // SystemconfigurationEditObjectV1Request | 
apiInstance.systemconfigurationEditObjectV1(pkiSystemconfigurationID, SystemconfigurationEditObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiSystemconfigurationID Number The unique ID of the Systemconfiguration
SystemconfigurationEditObjectV1Request SystemconfigurationEditObjectV1Request

Return type

SystemconfigurationEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

systemconfigurationGetObjectV2

SystemconfigurationGetObjectV2Response systemconfigurationGetObjectV2(pkiSystemconfigurationID)

Retrieve an existing Systemconfiguration

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectSystemconfigurationApi();
let pkiSystemconfigurationID = 56; // Number | The unique ID of the Systemconfiguration
apiInstance.systemconfigurationGetObjectV2(pkiSystemconfigurationID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

SystemconfigurationGetObjectV2Response

Authorization

Authorization

HTTP request headers

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