Base document attachments entity in SystemAdministration(DocuRefEntity)
Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
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
DocumentId
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the DocumentId 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
ActualCompanyId
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ActualCompanyId 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
TypeId
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the TypeId 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
RefCompanyId
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the RefCompanyId 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
RefRecId
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the RefRecId 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
RefTableId
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the RefTableId 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
Name
First included in: SystemAdministration/DocuRefEntity (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
Restriction
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the Restriction 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
Notes
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the Notes 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
ValueRecId
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ValueRecId 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
DocuValueType
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the DocuValueType 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
FileName
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the FileName 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
FileType
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the FileType 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
FileContents
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Archive file |
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the FileContents 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
DefaultAttachment
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the DefaultAttachment 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
Relationship_DocuTypeRelationRelationshipId
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | guid |
Traits
List of traits for the Relationship_DocuTypeRelationRelationshipId 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 | empty table | entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
BackingTable_DocuRefRelationshipId
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | guid |
Traits
List of traits for the BackingTable_DocuRefRelationshipId 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
Relationship_PrimaryCompanyContextRelationshipId
First included in: SystemAdministration/DocuRefEntity (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | guid |
Traits
List of traits for the Relationship_PrimaryCompanyContextRelationshipId 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
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for