Enterprise Portal document parameters in Parameter(EPDocuParameters)
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 | EPDocuParameters/(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/EPDocuParameters (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 | EPDocuParameters/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
Document
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the Document attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
moduleActivities
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Activities |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleActivities 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
moduleBusinessRelations
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Prospects |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleBusinessRelations 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
moduleCampaigns
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Campaigns |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleCampaigns 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
moduleContacts
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Contacts |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleContacts 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
moduleCust
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Customers |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleCust 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
moduleExpense
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Expense reports |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleExpense 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
moduleInvent
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Items |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleInvent 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
moduleLeads
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Leads |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleLeads 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
moduleOpportunities
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Opportunities |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleOpportunities 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
moduleProject
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Projects |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleProject 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
modulePurch
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Purchase order |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the modulePurch 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
moduleSales
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Sales orders |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleSales 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
moduleVend
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Vendors |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the moduleVend 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
userCust
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Online customer |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the userCust 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
UserVend
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
displayName | Online vendor |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the UserVend 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
viewMode
First included in: Parameter/EPDocuParameters (this entity)
Properties
Name | Value |
---|---|
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the viewMode attribute are listed below.
is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.
is.dataFormat.integer
DataAreaId
First included in: Parameter/EPDocuParameters (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/EPDocuParameters (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