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 | DocuParameters/(resolvedAttributes)/RecId | attribute |
is.CDM.entityVersion
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.1" | 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: Parameter/DocuParameters (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 | DocuParameters/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
ActiveTable
First included in: Parameter/DocuParameters (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Use Active document tables |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the ActiveTable attribute are listed below.
is.dataFormat.integer
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.integer
ArchivePath
First included in: Parameter/DocuParameters (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Azure storage |
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ArchivePath 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
Key
First included in: Parameter/DocuParameters (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | int32 |
| isReadOnly | true |
| isNullable | true |
Traits
List of traits for the Key attribute are listed below.
is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
MaxFileSizeInDatabase
First included in: Parameter/DocuParameters (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Max. file size in database |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the MaxFileSizeInDatabase attribute are listed below.
is.dataFormat.integer
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.integer
MaxFileSizeInFileSystem
First included in: Parameter/DocuParameters (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Max. file size in file system |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the MaxFileSizeInFileSystem attribute are listed below.
is.dataFormat.integer
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.integer
SubmitToWorkflow
First included in: Parameter/DocuParameters (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Submit document files to workflow |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the SubmitToWorkflow attribute are listed below.
is.dataFormat.integer
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.integer
WebAppsServerURL
First included in: Parameter/DocuParameters (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Office Web Apps Server |
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the WebAppsServerURL 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
WebAppsSharedSecret
First included in: Parameter/DocuParameters (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the WebAppsSharedSecret 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
DefaultSharePointServer
First included in: Parameter/DocuParameters (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Default SharePoint server |
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the DefaultSharePointServer 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
DataAreaId
First included in: Parameter/DocuParameters (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the DataAreaId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.dataFormat.character
is.dataFormat.array
Relationship_CompanyRelationshipId
First included in: Parameter/DocuParameters (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | guid |
Traits
List of traits for the Relationship_CompanyRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array