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

Latest commit

 

History

History
218 lines (143 loc) · 6.58 KB

ObjectSignatureApi.md

File metadata and controls

218 lines (143 loc) · 6.58 KB

EZmaxApiDefinitionFull.ObjectSignatureApi

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

Method HTTP request Description
signatureCreateObjectV1 POST /1/object/signature Create a new Signature
signatureDeleteObjectV1 DELETE /1/object/signature/{pkiSignatureID} Delete an existing Signature
signatureEditObjectV1 PUT /1/object/signature/{pkiSignatureID} Edit an existing Signature
signatureGetObjectV2 GET /2/object/signature/{pkiSignatureID} Retrieve an existing Signature

signatureCreateObjectV1

SignatureCreateObjectV1Response signatureCreateObjectV1(SignatureCreateObjectV1Request)

Create a new Signature

The endpoint allows to create one or many elements at once.

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.ObjectSignatureApi();
let SignatureCreateObjectV1Request = new EZmaxApiDefinitionFull.SignatureCreateObjectV1Request(); // SignatureCreateObjectV1Request | 
apiInstance.signatureCreateObjectV1(SignatureCreateObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
SignatureCreateObjectV1Request SignatureCreateObjectV1Request

Return type

SignatureCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

signatureDeleteObjectV1

SignatureDeleteObjectV1Response signatureDeleteObjectV1(pkiSignatureID)

Delete an existing Signature

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.ObjectSignatureApi();
let pkiSignatureID = 56; // Number | The unique ID of the Signature
apiInstance.signatureDeleteObjectV1(pkiSignatureID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiSignatureID Number The unique ID of the Signature

Return type

SignatureDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

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

signatureEditObjectV1

SignatureEditObjectV1Response signatureEditObjectV1(pkiSignatureID, SignatureEditObjectV1Request)

Edit an existing Signature

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.ObjectSignatureApi();
let pkiSignatureID = 56; // Number | The unique ID of the Signature
let SignatureEditObjectV1Request = new EZmaxApiDefinitionFull.SignatureEditObjectV1Request(); // SignatureEditObjectV1Request | 
apiInstance.signatureEditObjectV1(pkiSignatureID, SignatureEditObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiSignatureID Number The unique ID of the Signature
SignatureEditObjectV1Request SignatureEditObjectV1Request

Return type

SignatureEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

signatureGetObjectV2

SignatureGetObjectV2Response signatureGetObjectV2(pkiSignatureID)

Retrieve an existing Signature

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.ObjectSignatureApi();
let pkiSignatureID = 56; // Number | The unique ID of the Signature
apiInstance.signatureGetObjectV2(pkiSignatureID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiSignatureID Number The unique ID of the Signature

Return type

SignatureGetObjectV2Response

Authorization

Authorization

HTTP request headers

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