Skip to main content
Cartegraph Campus

Class Meta for REST API

This feature may not be available in every package. Not sure if you have this feature or you want to learn more about it? Send us a message at support@cartegraph.com.

Cartegraph's API is a licensed product that requires a purchase and verified ownership before production use.

Class Meta

Contains further information about the business objects that can be used to display or query data.

BOType:

Business Objects within OMS are categorized as follows:

  • 0: None
    • Libraries like cgActivitiesClass
    • Children like cgSigns_cgInspectionsClass
  • 1: Asset
    • Shipped Assets like cgSignsClass
    • Any Versa Assets formatted by the client
  • 2: Work
    • cgTasksClass
    • cgWorkOrders
  • 3: Resource
    • cgEquipmentClass
    • cgMaterialClass
    • cgLaborClass
    • cgVendorClass
  • 4: Request
    • cgRequestsClass

CachedColor:

Contains the color value for the asset if defined using Asset Color Manager for OMS. If it hasn't been changed using Asset Color Manager, it will return null.

Examples:

-13434829  
-10092544  
-16764007  

CachedGisInfo:

Contains information about ESRI integration. This can only apply to top-level business objects. Generally, these are asset business objects.

Properties include:

  • IsIntegrated
  • HasZ
  • HasM

Children

List of child business object class names.

For example, the list of children for cgBridgesClass are:

cgBridges_cgAttachmentsClass  
cgBridges_GuardRailsOnBridgeClass  
cgBridges_cgInspectionsClass  
cgBridges_LightFixturesOnBridgeClass  
cgBridges_cgPavementClass  
cgBridges_SignsOnBridgeClass  
cgBridges_SupportsOnBridgeClass  
cgBridges_cgTasksClass  
cgBridges_cgTodaysConditionsClass  

DefaultSort:

Defines the order in which the business object records are returned when in a list. Uses the legacy format for field ids.

Examples:

"[ID] Ascending"  
"[InspectionDate] Descending"  

Fields:

List of fields within the business object and the associated field metadata.

GeoType:

Contains the geometry shape for the business object.

  • 0: No Type
  • 1: Point
  • 2: Line
  • 3: Polygon
  • 4: Mixed

Classes with a non-zero GeoType contain a property CgShape that contains the spatial information for the record.

GridStyle:

Describes how we want the list of business object records to display in our Grids.

  • Standard: Full OMS grid functionality is available.
  • ReadOnly: OMS grid will not contain checkboxes, action menu, or view buttons.
  • ReadOnlyView: OMS grid will not contain checkboxes or action menu. View buttons are available.

HierarchicalDepth:

 

  • 0: Top Level
  • 1: Child
  • 2: Grandchild
  • 3: Great - Grandchild
  • ...

IsReadOnly:

True or false value indicating whether or not the business object allows the user to perform add, edit, or delete actions.

For example, the IsReadOnly property for cgBridgeOverallRatingsClass is true.

Name:

Business Object Identifier used by OMS.

Examples:

cgSignsClass  
cgPavement_cgInspectionsClass    
cgMaterials_cgLogClass  

OidColumnName:

Name of the database column that contains the unique numerical identifier for the business object records. This value is suppressed by default in the REST API.

Examples:

faciMainGeneralOID  
wdMaterialLogOID

ParentClass:

Class name of the business object directly containing this business object child. Top level business objects will have a null value.

For example:
The ParentClass of cgPavementClass is null.
The ParentClass of cgPavement_cgInspectionsClass is cgPavementClass.
The ParentClass of cgPavement_cgInspections_cgSamplesClass is cgPavement_cgInspectionsClass.

PluralName:

Plural display name for the business object.

Examples:

Pavement  
Facilities   
Log

PrimaryField:

Field that contains a unique value that can be used as an alternative to Oid when fetching a record. Most business objects have them.

Examples:

IDField
ActivityField

ShortUID:

Short legacy identifier of the business object. Used when interacting with CAA functionality.

Examples:

cgMaterials
cgLog

SingularName:

Singular display name for the business object.

Examples:

Pavement  
Facility   
Log

TopMostParent:

Class name of the top level business object ancestor. Top level business objects will have a null value.

For example:
The ParentClass of cgPavementClass is null.
The ParentClass of cgPavement_cgInspectionsClass is cgPavementClass.
The ParentClass of cgPavement_cgInspections_cgSamplesClass is cgPavementClass.

Uid:

Legacy identifier for the business object. Used when interacting with CAA functionality. Starts with a '$' and hierarchy is separated with a ''. The 'Class' suffix is not used in this case.

Examples:

$\cgMaterials  
$\cgMaterials\cgLog

Class Meta Properties For Shares

The following properties are used for business objects that are shared.

TrueClassForShare:

Original non-shared class name for the business object. If the business object is not a shared representation, then the property is null.

For example:
The TrueClassForShare of cgMaterials_cgLogClass is null.
The TrueClassForShare of cgTasks_cgMaterialLogClass is cgMaterials_cgLogClass.
The TrueClassForShare of cgPavement_cgTasksClass is cgTasksClass.

TrueParentForShare:

Original non-shared class name of the business object directly containing this child. Top level and non-shared business objects will have a null value.

For example:
The TrueParentForShare of cgTasksClass is null.
The TrueParentForShare of cgMaterials_cgLogClass is null.
The TrueParentForShare of cgPavement_cgTasksClass is null.
The TrueParentForShare of cgTasks_cgMaterialLogClass is cgMaterialsClass.

IsShared:

True or false value indicating whether or not the business object is a shared representation of the recordset.

For example:
The IsShared property of cgMaterials_cgLogClass is false.
The IsShared property of cgTasks_cgMaterialLogClass is true.

ShareBindingField:

Lookup field used to define the shared relationship to its non-true parent.

For example:
The ShareBindingField for cgTasks_cgMaterialLogClass is TaskIDField.
The ShareBindingField for cgPavement_cgTasksClass is cgPavementField.

Class Meta Properties for Linked Assets

The following properties are used for business objects involved in linkable asset relationships.

LinkableAssetClasses:

Contains a list of class names for assets that can be associated to this asset through a linkable relationship.

For example, the LinkableAssetClasses for cgWaterMainsClass are:

"cgWaterFacilitiesClass"
"cgWaterHydrantsClass"
"cgWaterLateralsClass"
"cgWaterMetersClass"
"cgWaterPumpsClass"
"cgWaterValvesClass"

LinkableAssetRelationships:

Information that further describes the linkable relationships possible with other business objects.

For example, cgWaterMainsClass has a linkable relationship through a Facility lookup as follows:

ClassName: "cgWaterFacilitiesClass"
Relationship: "Facility"
Id: null
Oid: 0
AssetType: null
IsLookup: true
LookupFieldId: "FacilityField"

Also, cgWaterHydrantsClass is shared under cgWaterMainsClass creating a linkable relationship of:

ClassName: "cgWaterHydrantsClass"
Relationship: "Hydrant"
Id: null
Oid: 0
AssetType: null
IsLookup: false
LookupFieldId: ""

Class Meta Properties for Container\Components

The following properties are used for business objects involved in asset container\component relationships. Refer to this business case when studying the examples below:

Let's say you wanted to track your wastewater facility within OMS and track the costs and conditions of the different types of treatment ponds separately for each facility. You could create two Versa Polygon Assets; one called WW Facilities and one called Ponds. You could create three component relationships from Ponds to WW Facilities. One Pond component would be called Stabilization Ponds and have a weight of 1.5. Another Pond component would be called Oxidation Ponds and have a weight of 2.0. The third Pond component would be called Polishing Ponds and have a weight of 2.5.

ContainerComponentMultipleLookupRelationships:

This property contains a list of business object names that are components of this business object through multiple relationships.

For example, the ContainerComponentMultipleLookupRelationships property of WWFacilitiesClass would contain PondsClass.

IsComponentSet:

True or false value indicating whether or not the business object is a component in a container/component relationship.

For example, the IsComponentSet property for WWFacilities_PolishingPondsClass is true.

OCIWeight:

Value that determines how much influence the component's OCI has on the container.

For example, the OCIWeight property for WWFacilities_PolishingPondsClass is 2.5.