Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | DocuValue/(resolvedAttributes)/RecId | attribute |
is.CDM.entityVersion
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.0" | string | semantic version number of the entity |
is.application.releaseVersion
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| releaseVersion | "10.0.13.0" | string | semantic version number of the application introducing this entity |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
Attributes
RecId
First included in: Transaction/DocuValue (this entity)
Properties
| Name | Value |
|---|---|
| isPrimaryKey | true |
| dataFormat | int64 |
| isReadOnly | true |
Traits
List of traits for the RecId attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | DocuValue/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
File
First included in: Transaction/DocuValue (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | binary |
| isNullable | true |
Traits
List of traits for the File attribute are listed below.
is.dataFormat.byte
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.byte
is.dataFormat.array
FileName
First included in: Transaction/DocuValue (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
| isNullable | true |
Traits
List of traits for the FileName attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
FileType
First included in: Transaction/DocuValue (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
| isNullable | true |
Traits
List of traits for the FileType attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
Name
First included in: Transaction/DocuValue (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the Name attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
OriginalFileName
First included in: Transaction/DocuValue (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Original file name |
| dataFormat | string |
| isReadOnly | true |
| isNullable | true |
Traits
List of traits for the OriginalFileName attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
Path
First included in: Transaction/DocuValue (this entity)
Properties
| Name | Value |
|---|---|
| displayName | File location |
| dataFormat | string |
| isReadOnly | true |
| isNullable | true |
Traits
List of traits for the Path attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
Type
First included in: Transaction/DocuValue (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the Type attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
FileId
First included in: Transaction/DocuValue (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | guid |
| isNullable | true |
Traits
List of traits for the FileId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.nullable
The attribute value may be set to NULL.
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
AccessInformation
First included in: Transaction/DocuValue (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Access Information |
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the AccessInformation attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
StorageProviderId
First included in: Transaction/DocuValue (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the StorageProviderId attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer