Skip to main content
Cartegraph Campus

Property 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.

Property Meta

Contains further information about the properties that can be used to display data.

DisplayName:

Name to display to the user of OMS. May contain spaces and other special characters.

Examples:

Address Number  
ID 
Last Modified 

FieldLength:

An integer value corresponding to the maximum character length for a text based properties. This will be set to 0 for non-text based property.

FieldSize:

An integer value corresponding to the size of the UI control to create.

  • 1 = Small
  • 2 = Medium
  • 3 = Large

FieldType:

Data type of the property.

  • 0 = Text
  • 1 = Boolean
  • 2 = Integer
  • 3 = Number
  • 4 = Currency
  • 5 = Date Time
  • 6 = LookUp
  • 7 = Not Used
  • 8 = Not Used
  • 9 = Attachment
  • 10 = Quantity
  • 11 = Date
  • 12 = Time

HasInitialValue:

True or false value indicating whether or not a default value has been provided for this property. If this is true, and the user does not provide a value for this property on insert, the property will be populated with the initial value rather than being saved with a null value. The initial value has no affect on updates.

IsAutoNumber:

True or false value indicating whether or not this text property's value will be automatically generated by the system using either the next incremental value or a randomly generated value. This is false for non-text properties.

IsContainerLookup:

True or false value indicating whether or not this lookup is used to define container\component relationship. This is false for non-lookup properties.

OCIWeight:

This describes the factor this business object component has on the overall OCI of the container asset. This only applies to container lookups and will be null for all other properties.

IsMemo:

True or false value indicating whether or not this is an unlimited text property. This is false for non-text properties.

IsReadOnly:

True or false value indicating whether OMS users can enter values for this property in the UI or on Import. Read-Only properties are system calculated.

IsRefEnforcedLookup:

True or false value indicating whether a value in a lookup property must also exist in the business object connected to it. This is false for non-lookup properties.

For example, a user enters "Mow the Meadow" into an Activity lookup. If the Activity lookup has IsRefEnforcedLookup set to true, the record cannot be saved until "Mow the Meadow" is added to the Activity Library. However, if IsRefEnforcedLookup is false, the record can be saved even though this value is not in the corresponding Activity library.

IsRequired:

True or false value indicating whether a business object can be saved if this property is null.

LookupClass:

Business object class whose list of values appear in this property. This is null for non-lookup properties.

For example:
The LookupClass for the StateField is cgStatesClass.
The LookupClass for the ActivityField is cgActivitiesClass.

LookupField:

The particular field referenced by the Lookup association. By default, this points to the "primary" field for a recordset.

For example:
The LookupField for the StateField is StateField of cgStatesClass.
The LookupField for the ActivityField is ActivityField of cgActivitiesClass.

Name:

OMS property identifier. Has a suffix of Field. No spaces or special characters allowed.

Examples:

AddressNumberField  
IDField 
cgLastModifiedField 

Uid:

Legacy identifier for the property. Used when interacting with CAA functionality.

Examples:

AddressNumber  
ID 
cgLastModified