Document types in Group(DocuType)

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	DocuType/(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	languageTag displayText en Document types	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Group/DocuType
ActionClassId		Group/DocuType
ArchivePath		Group/DocuType
DocuStructureType		Group/DocuType
FilePlace		Group/DocuType
FileRemovalConfirmation		Group/DocuType
Name		Group/DocuType
Parameters		Group/DocuType
RemoveOption		Group/DocuType
TypeGroup		Group/DocuType
TypeId		Group/DocuType
Host		Group/DocuType
Site		Group/DocuType
FolderPath		Group/DocuType
DataAreaId		Group/DocuType
Relationship_CompanyRelationshipId		Group/DocuType

RecId

First included in: Group/DocuType (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	DocuType/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

ActionClassId

First included in: Group/DocuType (this entity)

Properties

Name	Value
displayName	Class
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the ActionClassId attribute are listed below.

is.dataFormat.integer
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	languageTag displayText en Class	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

ArchivePath

First included in: Group/DocuType (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	languageTag displayText en Azure storage	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

DocuStructureType

First included in: Group/DocuType (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the DocuStructureType attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

FilePlace

First included in: Group/DocuType (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the FilePlace attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

FileRemovalConfirmation

First included in: Group/DocuType (this entity)

Properties

Name	Value
displayName	Ask for confirmation
dataFormat	int32
isNullable	true

Traits

List of traits for the FileRemovalConfirmation 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	languageTag displayText en Ask for confirmation	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Name

First included in: Group/DocuType (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

Parameters

First included in: Group/DocuType (this entity)

Properties

Name	Value
dataFormat	binary
isReadOnly	true
isNullable	true

Traits

List of traits for the Parameters attribute are listed below.

is.dataFormat.byte
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.byte
is.dataFormat.array

RemoveOption

First included in: Group/DocuType (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the RemoveOption attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

TypeGroup

First included in: Group/DocuType (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the TypeGroup attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

TypeId

First included in: Group/DocuType (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the TypeId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

Host

First included in: Group/DocuType (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Host 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

Site

First included in: Group/DocuType (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Site 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

FolderPath

First included in: Group/DocuType (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the FolderPath 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

DataAreaId

First included in: Group/DocuType (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: Group/DocuType (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	entityReference attributeReference /core/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfo RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array