Name

sn_install_base.InstallBaseItemAPIConstantsSNC

Description

No description available

Script

var InstallBaseItemAPIConstantsSNC = Class.create();
InstallBaseItemAPIConstantsSNC.prototype = {
  initialize: function() {},
  type: 'InstallBaseItemAPIConstantsSNC'
};
InstallBaseItemAPIConstants.CLASS_NAME = "sys_class_name";
InstallBaseItemAPIConstants.SO_MEMBER_TABLE = "sn_csm_service_organization_member";
InstallBaseItemAPIConstants.MAX_PAGE_SIZE = 100;
InstallBaseItemAPIConstants.DEFAULT_PAGE_SIZE = 10;
InstallBaseItemAPIConstants.DEFAULT_DEPTH = 7;
InstallBaseItemAPIConstants.MAX_DEPTH = 10;
InstallBaseItemAPIConstants.SYSPARM_LIMIT = "sysparm_limit";
InstallBaseItemAPIConstants.FIELD_ACTIVE = "active";
InstallBaseItemAPIConstants.SYSPARM_OFFSET = "sysparm_offset";
InstallBaseItemAPIConstants.SYSPARM_DEPTH = "sysparm_depth";
InstallBaseItemAPIConstants.SYSPARM_CONTEXT = "sysparm_context";
InstallBaseItemAPIConstants.API_STATUS_CODES = {
  ERROR: '400',
  CREATED: '201',
  OK: '200',
  NOT_FOUND: '404',
  FORBIDDEN: '403'
};

InstallBaseItemAPIConstants.OPERATION = {
  CREATE: 'Create',
  UPDATE: 'Update',
  DELETE: 'Delete',
  READ: 'Read',
  UNINSTALL: 'Uninstall'
};

InstallBaseItemAPIConstants.SUCCESS = "SUCCESS";
InstallBaseItemAPIConstants.FAILED = "FAILED";
InstallBaseItemAPIConstants.ERROR = "ERROR";

InstallBaseItemAPIConstants.READ = "read";
InstallBaseItemAPIConstants.WRITE = "write";
InstallBaseItemAPIConstants.CREATE = "create";
InstallBaseItemAPIConstants.DELETE = "delete";

InstallBaseItemAPIConstants.DB_OBJECT_TABLE = "sys_db_object";
InstallBaseItemAPIConstants.INSTALL_BASE_TABLE_ID = "aa05feb8c322111021848cab3c40ddc7";

InstallBaseItemAPIConstants.WO_TABLE="wm_order";

InstallBaseItemAPIConstants.CHILD_INSTALL_BASE_ITEMS_ARR = "items";
InstallBaseItemAPIConstants.CHILD_INSTALL_BASE_ITEMS = "childinstallbase";
InstallBaseItemAPIConstants.SOLD_PRODUCTS_ARR = "soldproducts";
InstallBaseItemAPIConstants.ENTITLEMENTS_ARR = "entitlements";
InstallBaseItemAPIConstants.RELATED_PARTIES_ARR = "relatedparties";
InstallBaseItemAPIConstants.WORK_ORDERS_ARR = "workorders";
InstallBaseItemAPIConstants.MAINTENANCE_PLANS_ARR = "maintenanceplans";
InstallBaseItemAPIConstants.CASES_ARR = "cases";
InstallBaseItemAPIConstants.CONTRACTS_ARR = "contracts";
InstallBaseItemAPIConstants.INSTALL_BASE_ITEMS_ARR = "items";
InstallBaseItemAPIConstants.RELATED_PARTY_ID = "related_party";
InstallBaseItemAPIConstants.RESPONSIBILITY = "responsibility";
InstallBaseItemAPIConstants.INSTALL_BASE_FIELD = "install_base_item";
InstallBaseItemAPIConstants.SOLD_PRODUCT_FIELD = "sold_product";

InstallBaseItemAPIConstants.ExcludeTableAttributes = {
  CommonAttributes: function() {
      return ["sys_updated_on",
          "sys_updated_by",
          "sys_created_by",
          "sys_created_on",
          "sys_domain",
  		"sys_mod_count"
      ];
  },
  GetInstallBaseRestrictedAttributes: function() {
      var ignoreFields = ["root"];
      return ignoreFields.concat(InstallBaseItemAPIConstants.ExcludeTableAttributes.CommonAttributes());
  },
  GetSoldProductRestrictedAttributes: function() {
      return InstallBaseItemAPIConstants.ExcludeTableAttributes.CommonAttributes();
  },
  GetEntitlementRestrictedAttributes: function() {
      return InstallBaseItemAPIConstants.ExcludeTableAttributes.CommonAttributes();
  },
  GetCaseRestrictedAttributes: function() {
      return InstallBaseItemAPIConstants.ExcludeTableAttributes.CommonAttributes();
  },
  GetContractRestrictedAttributes: function() {
      return InstallBaseItemAPIConstants.ExcludeTableAttributes.CommonAttributes();
  },
  GetRelatedPartiesRestrictedAttributes: function() {
      var ignoreFields = ["sys_mod_count"];
      return ignoreFields.concat(InstallBaseItemAPIConstants.ExcludeTableAttributes.CommonAttributes());
  },
  GetWorkOrderRestrictedAttributes: function() {
      return InstallBaseItemAPIConstants.ExcludeTableAttributes.CommonAttributes();
  },
  GetMaintenancePlansRestrictedAttributes: function() {
      return InstallBaseItemAPIConstants.ExcludeTableAttributes.CommonAttributes();
  },
  PostInstallBaseRestrictedAttributes: function() {
      var ignoreFields = ["root", "sys_id", "sys_mod_count"];
      return ignoreFields.concat(InstallBaseItemAPIConstants.ExcludeTableAttributes.CommonAttributes());
  }
};
InstallBaseItemAPIConstants.IgnoreTableAttributes = {
  PostAttributes: ["sys_updated_on",
      "sys_updated_by",
      "sys_domain",
  	"sys_mod_count",
  	"sys_id"
  ],

  PatchAttributes: ["sys_updated_on",
      "sys_updated_by",
      "sys_created_by",
      "sys_created_on",
      "sys_domain",
  	"sys_mod_count",
  	"sys_id"
  ]
};
InstallBaseItemAPIConstants.TableAttributes = {
  InstallBaseAttributes: ["account",
      "active",
      "asset",
      "condition",
      "configuration_item",
      "consumer",
      "contact",
      "health_status",
      "health_status_last_update",
      "household",
      "install_date",
      "location",
      "name",
      "number",
      "parent",
      "product_model",
      "quantity",
      "service_context",
      "service_organization"
  ],

  IBItemAttributesForUpdate: ["account",
      "active",
      "asset",
      "condition",
      "configuration_item",
      "consumer",
      "contact",
      "health_status",
      "health_status_last_update",
      "household",
      "install_date",
      "location",
      "name",
      "number",
      "parent",
      "product_model",
      "quantity",
      "service_context",
      "service_organization",
      "status",
      "state",
      "uninstall_date"
  ],
  INSTALL_BASE_MANDATORY_ATTRIBUTES: ["name"],
  IB_UNINSTALL_PAYLOAD_ATTRIBUTES: ['uninstall_date']
};
InstallBaseItemAPIConstants.API_MESSAGES = {
  MALFORMED_REQUEST: gs.getMessage('Malformed request.'),
  MANDATORY_ERROR: function(msgArray) {
      return gs.getMessage('Mandatory field missing from the request. Field: {0}.', msgArray);
  },
  RESOURCE_NOT_FOUND: gs.getMessage("Resource not found"),
  INVALID_DATETIME: function(msgArray) {
      return gs.getMessage('Invalid date or time in request. Field: {1} = {2}. Expected format: {0}.', msgArray);
  },
  INVALID_INTEGER: function(msgArray) {
      return gs.getMessage('Invalid integer value in request. Field: {0} = {1}.', msgArray);
  },
  INVALID_REFERENCE: function(msgArray) {
      return gs.getMessage('Invalid reference or missing access permission. Field: {0} = {1}.', msgArray);
  },
  INVALID_BOOLEAN_VALUE: function(msgArray) {
      return gs.getMessage('Invalid boolean value in request: {2}. Field: {0} {1}.', msgArray);
  },
  FORBIDDEN: function(msgArray) {
      return gs.getMessage('User is not authorized to {0} the specified record.', msgArray);
  },
  INSTALL_BASE_ATTRIBUTE_INVALID: function(msgArray) {
      return gs.getMessage('Invalid attribute in the payload. Attribute: {0}.', msgArray);
  },
  INSTALL_BASE_NO_ATTRIBUTE_FOUND: function() {
      return gs.getMessage('No attributes were found in the payload. Please add the mandatory attributes.');
  },
  INVALID_PAGE_SIZE: function(msgArray) {
      return gs.getMessage('page size {0} is Invalid.', msgArray);
  },
  INVALID_PAGE_OFFSET: function(msgArray) {
      return gs.getMessage('Page offset {0} is Invalid.', msgArray);
  },
  INVALID_DEPTH: function(msgArray) {
      return gs.getMessage('Depth {0} is Invalid.', msgArray);
  },
  INVALID_CHOICE: function(msgArray) {
      return gs.getMessage('Invalid choice value. Field: {0} = {1}.', msgArray);
  },
  INVALID_TABLE_NAME: function() {
      return gs.getMessage('Invalid table name specified.');
  },
  INVALID_ATTRIBUTE_FOUND: gs.getMessage('Invalid attribute'),
  MANDATORY_ATTRIBUTE_MISSING: function(attribute) {
      return gs.getMessage('Mandatory field missing from the request. Field: {0}.', attribute);
  },
  REQUEST_FAILED:function(operationName){
  	return gs.getMessage('{0} request cannot be processed.',operationName);
  },
  INSTALL_BASE_ALREADY_UNINSTALLED: gs.getMessage('Specified install base item has already been uninstalled.'),
  CANNOT_RESOLVE_RECORD: function(msg)
  {
  return gs.getMessage("Multiple Records found with Attribute Value: {0}.", msg);
  },
  ONE_OR_MORE_IB_CREATION_REQUEST_FAILED: function(msg)
  {
  	return gs.getMessage("Failed to create {0} IB Item(s). Please check response for more details", msg.toString());
  },
  REQUEST_CANNOT_BE_PROCESSED: gs.getMessage('This request cannot be processed.'),
};

Sys ID

a5a10d2923d12110e32f13d1d7bf6510

Offical Documentation

Official Docs: