JavaScript SDK Samples - Roles Operations
Get All Roles
class Role
{
/**
* Get Roles
* This method is used to retrieve the data of roles through an API request and print the response.
*/
static async getRoles() {
//Get instance of RolesOperations Class
let rolesOperations = new ZCRM.Role.Operations();
//Call getRoles method
let response = await rolesOperations.getRoles();
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.Role.Model.ResponseWrapper) {
//Get the array of obtained Role instances
let roles = responseObject.getRoles();
roles.forEach(async role => {
//Get the DisplayLabel of each Role
console.log("Role DisplayLabel: " + role.getDisplayLabel());
//Get the forecastManager User instance of each Role
let forecastManager = role.getForecastManager();
//Check if forecastManager is not null
if (forecastManager != null) {
//Get the ID of the forecast Manager
console.log("Role Forecast Manager User-ID: " + forecastManager.getId());
//Get the name of the forecast Manager
console.log("Role Forecast Manager User-Name: " + forecastManager.getName());
}
//Get the ShareWithPeers of each Role
console.log("Role ShareWithPeers: " + role.getShareWithPeers().toString());
//Get the Name of each Role
console.log("Role Name: " + role.getName());
//Get the Description of each Role
console.log("Role Description: " + role.getDescription());
//Get the Id of each Role
console.log("Role ID: " + role.getId());
//Get the reportingTo User instance of each Role
let reportingTo = role.getReportingTo();
//Check if reportingTo is not null
if (reportingTo != null) {
//Get the ID of the reportingTo User
console.log("Role ReportingTo User-ID: " + reportingTo.getId());
//Get the name of the reportingTo User
console.log("Role ReportingTo User-Name: " + reportingTo.getName());
}
//Get the AdminUser of each Role
console.log("Role AdminUser: " + role.getAdminUser().toString());
});
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Role.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 Specific Role
class Role
{
/**
* Get Role
* This method is used to retrieve the data of single role through an API request and print the response.
* @param {BigInt} roleId The ID of the role to be obtained
*/
static async getRole(roleId) {
//example
//let roleId = 34096430026005n;
//Get instance of RolesOperations Class
let rolesOperations = new ZCRM.Role.Operations();
//Call getRole method that takes roleId as parameter
let response = await rolesOperations.getRole(roleId);
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.Role.Model.ResponseWrapper) {
//Get the array of obtained Role instances
let roles = responseObject.getRoles();
roles.forEach(role => {
//Get the DisplayLabel of each Role
console.log("Role DisplayLabel: " + role.getDisplayLabel());
//Get the forecastManager User instance of each Role
let forecastManager = role.getForecastManager();
//Check if forecastManager is not null
if (forecastManager != null) {
//Get the ID of the forecast Manager
console.log("Role Forecast Manager User-ID: " + forecastManager.getId());
//Get the name of the forecast Manager
console.log("Role Forecast Manager User-Name: " + forecastManager.getName());
}
//Get the ShareWithPeers of each Role
console.log("Role ShareWithPeers: " + role.getShareWithPeers().toString());
//Get the Name of each Role
console.log("Role Name: " + role.getName());
//Get the Description of each Role
console.log("Role Description: " + role.getDescription());
//Get the Id of each Role
console.log("Role ID: " + role.getId());
//Get the reportingTo User instance of each Role
let reportingTo = role.getReportingTo();
//Check if reportingTo is not null
if (reportingTo != null) {
//Get the ID of the reportingTo User
console.log("Role ReportingTo User-ID: " + reportingTo.getId());
//Get the name of the reportingTo User
console.log("Role ReportingTo User-Name: " + reportingTo.getName());
}
//Get the AdminUser of each Role
console.log("Role AdminUser: " + role.getAdminUser().toString());
});
}
//Check if the request returned an exception
else if (responseObject instanceof ZCRM.Role.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());
}
}
}
}
}