ENenviance
CustomField

GET /ver2/CostomFieldService.svc/customFields/{customFieldIdOrName}

envianceSdk.customFields.getCustomField

[
  "nameOrID",
  "onsuccess",
  "onerror"
]

Request

Path parameters

customFieldIdOrNamestring required

Headers

EnvApi-Systemidstring

Specify specific system to run instead of Home

EnvApi-Packageidstring

(optional) Clients application/package ID

EnvApi-Udf-DateTime-Iso-In-CustomFieldsstring

Udfs of DateTime should use Iso

EnvApi-Udf-DateTime-ReadInUserTzstring

(obsolete) Udfs of DateTime type whould be in ReadInUserTz

EnvApi-Udf-Value-Invariantstring

(optional) Udfs - Force Non-Localized (invariant) values

EnvApi-Localization-Allstring

(optional) Extend objects with User-given Localizations

x-client-request-idstring

(optional) Client ID for double submit prevention

Response

not available

descriptionstring
captionstring
sizeinteger
dataType'Text' | 'Float' | 'Datetime' | 'Boolean' | 'Formula' | 'Hyperlink' | 'CitationHyperlink' | 'UniqueTag' | 'Undefined' | 'Label' enum
valueEntryMethod'Text' | 'TextWithHistory' | 'DropdownList' | 'CheckBox' | 'Date' | 'Time' | 'DateAndTime' | 'AutoIncrement' | 'ManualIncrement' | 'MultiSelectionList' | 'CalculatedNumber' | 'PredefinedNumber' | 'PredefinedTime' | 'NumericLookup' enum
hyperlinkType'DefaultURL' | 'ActivityProperties' | 'TaskProperties' | 'ObjectProperties' | 'ChemicalProperties' | 'MaterialProperties' | 'ChemicalListProperties' | 'CitationProperties' | 'TaskCompletion' | 'DataEntry' enum
isListValuesByTemplateboolean
trackValueHistoryboolean
isLinkedListboolean
labelstring
isSensitiveDataboolean
sortOptionsByValueboolean
updatedstring date-time
linkedListIdstring guid
autoIncrementboolean
grandChildsstring[]
valueobject
precisioninteger
idstring guid
namestring

Changes

No recorded changes to this operation across all 1 revision of this API.