Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateAttributeDetails

Properties used in attribute update operations.

Properties

Functions

Properties

Optional businessName

businessName: undefined | string

Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.

Optional customPropertyMembers

customPropertyMembers: Array<CustomPropertySetUsage>

The list of customized properties along with the values for this object

Optional description

description: undefined | string

Detailed description of the attribute.

Optional displayName

displayName: undefined | string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional externalDataType

externalDataType: undefined | string

Data type of the attribute as defined in the external system.

Optional externalDatatypeEntityKey

externalDatatypeEntityKey: undefined | string

External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.

Optional externalParentAttributeKey

externalParentAttributeKey: undefined | string

External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.

Optional isIncrementalData

isIncrementalData: undefined | false | true

Property that identifies if this attribute can be used as a watermark to extract incremental data.

Optional isNullable

isNullable: undefined | false | true

Property that identifies if this attribute can be assigned nullable values.

Optional length

length: undefined | number

Max allowed length of the attribute value. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional maxCollectionCount

maxCollectionCount: undefined | number

The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type. For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity". Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in Xml , maxItems in Json Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional minCollectionCount

minCollectionCount: undefined | number

The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional position

position: undefined | number

Position of the attribute in the record definition. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional precision

precision: undefined | number

Precision of the attribute value usually applies to float data type. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional properties

properties: undefined | object

A map of maps that contains the properties which are specific to the attribute type. Each attribute type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most attributes have required properties within the "default" category. To determine the set of required and optional properties for an Attribute type, a query can be done on '/types?type=attribute' which returns a collection of all attribute types. The appropriate attribute type, which will include definitions of all of it's properties, can be identified from this collection. Example: {@code {"properties": { "default": { "key1": "value1"}}}}

Optional scale

scale: undefined | number

Scale of the attribute value usually applies to float data type. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional timeExternal

timeExternal: Date

Last modified timestamp of this object in the external system.

Functions

getDeserializedJsonObj

getJsonObj