JavaScript SDK Samples - Variable Groups Operations
Get All Variable Groups
class Variable
{
/**
* Get Variable Groups
* This method is used to get the details of all the variable groups and print the response.
*/
static async getVariableGroups() {
//Get instance of VariableGroupsOperations Class
let variableGroupsOperations = new ZCRM.VariableGroup.Operations();
//Call getVariableGroups method
let response = await variableGroupsOperations.getVariableGroups();
if (response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if ([204, 304].includes(response.getStatusCode())) {
console.log(response.getStatusCode() == 204 ? "No Content" : "Not Modified");
return;
}
//Get object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected ResponseWrapper instance is received
if (responseObject instanceof ZCRM.VariableGroup.Model.ResponseWrapper) {
//Get the array of obtained VariableGroup instances
let variableGroups = responseObject.getVariableGroups();
variableGroups.forEach(variableGroup => {
//Get the DisplayLabel of each VariableGroup
console.log("VariableGroup DisplayLabel: " + variableGroup.getDisplayLabel());
//Get the APIName of each VariableGroup
console.log("VariableGroup APIName: " + variableGroup.getAPIName());
//Get the Name of each VariableGroup
console.log("VariableGroup Name: " + variableGroup.getName());
//Get the Description of each VariableGroup
console.log("VariableGroup Description: " + variableGroup.getDescription());
//Get the ID of each VariableGroup
console.log("VariableGroup ID: " + variableGroup.getId());
});
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.VariableGroup.Model.APIException) {
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Get a Variable Group by its ID
class Variable
{
/**
* Get Variable Group By Id
* This method is used to get the details of any variable group with group id and print the response.
* @param {BigInt} variableGroupId The ID of the VariableGroup to be obtained
*/
static async getVariableGroupById(variableGroupId) {
//example
//let variableGroupId = 34096432275023n;
//Get instance of VariableGroupsOperations Class
let variableGroupsOperations = new ZCRM.VariableGroup.Operations();
//Call getVariableGroupById method that takes variableGroupId as parameter
let response = await variableGroupsOperations.getVariableGroupById(variableGroupId);
if (response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if ([204, 304].includes(response.getStatusCode())) {
console.log(response.getStatusCode() == 204 ? "No Content" : "Not Modified");
return;
}
//Get object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected ResponseWrapper instance is received
if (responseObject instanceof ZCRM.VariableGroup.Model.ResponseWrapper) {
//Get the array of obtained VariableGroup instances
let variableGroups = responseObject.getVariableGroups();
variableGroups.forEach(variableGroup => {
//Get the DisplayLabel of each VariableGroup
console.log("VariableGroup DisplayLabel: " + variableGroup.getDisplayLabel());
//Get the APIName of each VariableGroup
console.log("VariableGroup APIName: " + variableGroup.getAPIName());
//Get the Name of each VariableGroup
console.log("VariableGroup Name: " + variableGroup.getName());
//Get the Description of each VariableGroup
console.log("VariableGroup Description: " + variableGroup.getDescription());
//Get the ID of each VariableGroup
console.log("VariableGroup ID: " + variableGroup.getId());
});
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.VariableGroup.Model.APIException) {
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Get a Variable Group by its API Name
Class Variable
{
/**
* Get Variable Group By APIName
* This method is used to get the details of any variable group with group API name and print the response.
* @param {String} variableGroupAPIName The API Name of the VariableGroup to be obtained
*/
static async getVariableGroupByAPIName(variableGroupAPIName) {
//example
//let variableGroupAPIName = "General";
//Get instance of VariableGroupsOperations Class
let variableGroupsOperations = new ZCRM.VariableGroup.Operations();
//Call getVariableGroupByAPIName method that takes variableGroupAPIName as parameter
let response = await variableGroupsOperations.getVariableGroupByAPIName(variableGroupAPIName);
if (response != null) {
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if ([204, 304].includes(response.getStatusCode())) {
console.log(response.getStatusCode() == 204 ? "No Content" : "Not Modified");
return;
}
//Get object from response
let responseObject = response.getObject();
if (responseObject != null) {
//Check if expected ResponseWrapper instance is received
if (responseObject instanceof ZCRM.VariableGroup.Model.ResponseWrapper) {
//Get the array of obtained VariableGroup instances
let variableGroups = responseObject.getVariableGroups();
variableGroups.forEach(variableGroup => {
//Get the DisplayLabel of each VariableGroup
console.log("VariableGroup DisplayLabel: " + variableGroup.getDisplayLabel());
//Get the APIName of each VariableGroup
console.log("VariableGroup APIName: " + variableGroup.getAPIName());
//Get the Name of each VariableGroup
console.log("VariableGroup Name: " + variableGroup.getName());
//Get the Description of each VariableGroup
console.log("VariableGroup Description: " + variableGroup.getDescription());
//Get the ID of each VariableGroup
console.log("VariableGroup ID: " + variableGroup.getId());
});
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.VariableGroup.Model.APIException) {
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if (details != null) {
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}