Class VlocityObject

createAttributeAssignment - Creates Attribute assignment

   // Invoke API via method createAttributeAssignment()
   const objectId = "";
   const attributeId = "";
   productconsole
  .getVlocityObjectSdk().createAttributeAssignment(objectId,attributeId)
  .then(result => {
    Logger.info("vlocity facet details remote action success " + result);
  })
  .catch(error => {
    Logger.info("vlocity facet details remote action failed " + error);
  });

{Error} - "createAttributeAssignment :: objectId is required to create Attribute assignment"

{Error} - "createAttributeAssignment :: attributeId is required to create Attribute assignment"

createOrUpdateSectionElement - Creates or Updates section element

   // Instantiate the input object for section element upsert using createSectionElementUpsertInput() to specify parameters
   // Assign sectionId, objectId and section element model to input object

   const input = productconsole.getVlocityObjectSdk.createSectionElementUpsertInput();
   input.sectionId = "";
   input.sectionElement = {};
   input.objectId = ""

   // Invoke API via method createOrUpdateSectionElement()

   productconsole
  .getVlocityObjectSdk().createOrUpdateSectionElement(input)
  .then(result => {
    Logger.info("vlocity facet details remote action success " + result);
  })
  .catch(error => {
    Logger.info("vlocity facet details remote action failed " + error);
  });

{Error} - "UpsertSectionElementInput :: createOrUpdateSectionElement() must be defined"

{Error} - "UpsertSectionElementInput :: createOrUpdateSectionElement() must have sectionId defined"

{Error} - "UpsertSectionElementInput :: createOrUpdateSectionElement() must have sectionElement defined"

getApplicableAttributesFields - returns unassigned attributes and fields for a facet

   // Invoke API via method getApplicableAttributesFields()
   const objectId = "";
   const facetName = "";
   productconsole
  .getVlocityObjectSdk().getApplicableAttributesFields(objectId,facetName)
  .then(result => {
    Logger.info("vlocity facet details remote action success " + result);
  })
  .catch(error => {
    Logger.info("vlocity facet details remote action failed " + error);
  });

{Error} - "getApplicableAttributesFields() :: objectId is requried to fetch facet details of object"

{Error} - "getApplicableAttributesFields() :: facetName is requried to fetch facet details"

getAttributeAssignment - get attribute assignment, picklist vlaues and picklist object if data type is pick list

   const objectId = ""
   const attributeId = ""
   // Invoke API via method getAttributeAssignment()
   productconsole
  .getVlocityObjectSdk().getAttributeAssignment(objectId,attributeId)
  .then(result => {
    Logger.info("getAttributeAssignment remote action success " + result);
  })
  .catch(error => {
    Logger.info("getAttributeAssignment remote action failed " + error);
  });

{Error} - "getAttributeAssignment :: objectId must be defined"

{Error} - "getAttributeAssignment :: attributeId must be defined"

getAttributeAssignmentObject - get attribute assignment object, picklistByName

   const objectId = ""
   const attributeId = ""
   // Invoke API via method getAttributeAssignmentObject()
   productconsole
  .getVlocityObjectSdk().getAttributeAssignmentObject(objectId,attributeId)
  .then(result => {
    Logger.info("getAttributeAssignmentObject remote action success " + result);
  })
  .catch(error => {
    Logger.info("getAttributeAssignmentObject remote action failed " + error);
  });

getFacetDetails - get facet details.

   // Instantiate the input object for getFacetDetails using createGetFacetDetailsInput() to specify parameters
   // objectId and facetName as parameters to the createGetFacetDetailsInput method
   const objectId = "";
   const facetName = "";
   const input = productconsole.getVlocityObjectSdk.createGetFacetDetailsInput(objectId,facetName);

   // Invoke API via method getFacetDetails()
   productconsole
  .getVlocityObjectSdk().getFacetDetails(input)
  .then(result => {
    Logger.info("vlocity facet details remote action success " + result);
  })
  .catch(error => {
    Logger.info("vlocity facet details remote action failed " + error);
  });

{Error} - "GetFacetDetailsInput :: getFacetDetails() must have objectId"

{Error} - "GetFacetDetailsInput :: getFacetDetails() must have facetName"

{Error} - "GetFacetDetailsInput :: getFacetDetails() must be defined"

getLayoutDetails - method calls getFacetDetails, getObjectDetails and returns facetObject and objectDetails.

   // objectId and facetName as parameters to the getLayoutDetails method
   const objectId = "";
   const facetName = "";

   // Invoke API via method getLayoutDetails()
   productconsole
  .getVlocityObjectSdk().getLayoutDetails(input)
  .then(result => {
    Logger.info("getLayoutDetails() success " + result);
  })
  .catch(error => {
    Logger.info("getLayoutDetails() failed " + error);
  });

getObjectDetails - returns object details and describe object

   // Invoke API via method getObjectDetails()
   const objectId = "";
   productconsole
  .getVlocityObjectSdk().getObjectDetails(objectId)
  .then(result => {
    Logger.info("getObjectDetails() remote action success " + result);
  })
  .catch(error => {
    Logger.info("getObjectDetails() remote action failed " + error);
  });

{Error} - "getObjectDetails() :: objectId must be defined"

getObjectPicklistsByName - get object picklist by name

   const objectName = ""
   // Invoke API via method getObjectPicklistsByName()
   productconsole
  .getVlocityObjectSdk().getObjectPicklistsByName(picklistObjectId)
  .then(result => {
    Logger.info("getObjectPicklistsByName remote action success " + result);
  })
  .catch(error => {
    Logger.info("getObjectPicklistsByName remote action failed " + error);
  });

{Error} - "getObjectPicklistsByName :: objectName must be defined"

getPicklistItems - get picklist items by picklist id

   const picklistObjectId = ""
   // Invoke API via method getPicklistItems()
   productconsole
  .getVlocityObjectSdk().getPicklistItems(picklistObjectId)
  .then(result => {
    Logger.info("getPicklistItems remote action success " + result);
  })
  .catch(error => {
    Logger.info("getPicklistItems remote action failed " + error);
  });

{Error} - "getPicklistItems :: picklistObjectId must be defined"

getPicklistObject - get picklist object by picklist id

   const picklistId = ""
   // Invoke API via method getPicklistObject()
   productconsole
  .getVlocityObjectSdk().getPicklistObject(picklistObjectId)
  .then(result => {
    Logger.info("getPicklistObject remote action success " + result);
  })
  .catch(error => {
    Logger.info("getPicklistObject remote action failed " + error);
  });

{Error} - "getPicklistObject :: picklistId must be defined"

postUpdateSection - update section to update column elements

   const objectSectionId = ""
   // Invoke API via method postUpdateSection()
   productconsole
  .getVlocityObjectSdk().postUpdateSection(objectSectionId)
  .then(result => {
    Logger.info("postUpdateSection remote action success " + result);
  })
  .catch(error => {
    Logger.info("postUpdateSection remote action failed " + error);
  });

{Error} - "postUpdateSection :: objectSectionId must be defined"

renumberSectionElements - Reorder section elements

   // Invoke API via method renumberSectionElements()
   const sectionId = "";
   productconsole
  .getVlocityObjectSdk().renumberSectionElements(sectionId)
  .then(result => {
    Logger.info("vlocity facet details remote action success " + result);
  })
  .catch(error => {
    Logger.info("vlocity facet details remote action failed " + error);
  });

{Error} - "renumberSectionElements() :: sectionId is required to renumber section elements"

renumberSections - update sequence of sections in a layout

   const objectFacetId = ""
   // Invoke API via method postUpdateSection()
   productconsole
  .getVlocityObjectSdk().renumberSections(objectFacetId)
  .then(result => {
    Logger.info("renumberSections remote action success " + result);
  })
  .catch(error => {
    Logger.info("renumberSections remote action failed " + error);
  });

transformSection - returns section object fter necessary transformation

upsertSection - create/update Section

   // Instantiate the input object for create section using createUpsertSectionInput() to specify parameters
   // Assign objectFacetId and section model to input object

   const input = productconsole.getVlocityObjectSdk.createUpsertSectionInput();
   input.objectFacetId = "";
    input.section = {};

   // Invoke API via method upsertSection()
   productconsole
  .getVlocityObjectSdk().upsertSection(input)
  .then(result => {
    Logger.info("upsert remote action success " + result);
  })
  .catch(error => {
    Logger.info("upsert remote action failed " + error);
  });

{Error} - "UpsertSectionInput :: upsertSection() must be defined"

{Error} - "UpsertSectionInput :: upsertSection() must have objectFacetId"

upsertSectionElement - create/update section element, created attribute assignment in case of attribute, renumber section elements.

   // Instantiate the input object for section element upsert using createSectionElementUpsertInput() to specify parameters
   // Assign sectionId, objectId and section element model to input object

   const input = productconsole.getVlocityObjectSdk.createSectionElementUpsertInput();
   input.sectionId = "";
   input.sectionElement = {};
   input.objectId = ""

   // Invoke API via method upsertSectionElement()
   productconsole
  .getVlocityObjectSdk().upsertSectionElement(input)
  .then(result => {
    Logger.info("upsertSectionElement remote action success " + result);
  })
  .catch(error => {
    Logger.info("upsertSectionElement remote action failed " + error);
  });

{Error} - "getApplicableAttributesFields() :: objectId is requried to fetch facet details of object"

{Error} - "getApplicableAttributesFields() :: facetName is requried to fetch facet details"