Subject entity reference
Information regarding subjects available in the system.
Messages
Message | SDK class or method |
---|---|
Create | CreateRequest or Create |
Delete | DeleteRequest or Delete |
Retrieve | RetrieveRequest or Retrieve |
RetrieveMultiple | RetrieveMultipleRequest or RetrieveMultiple |
Update | UpdateRequest or Update |
Properties
Property | Value |
---|---|
CollectionSchemaName | Subjects |
DisplayCollectionName | Subjects |
DisplayName | Subject |
EntitySetName | subjects |
IsBPFEntity | False |
LogicalCollectionName | subjects |
LogicalName | subject |
OwnershipType | OrganizationOwned |
PrimaryIdAttribute | subjectid |
PrimaryNameAttribute | title |
SchemaName | Subject |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
Description
Property | Value |
---|---|
Description | Description of the subject. |
DisplayName | Description |
Format | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | description |
MaxLength | 2000 |
RequiredLevel | None |
Type | Memo |
FeatureMask
Property | Value |
---|---|
Description | Information that specifies when the subject will be displayed in lists of subjects. |
DisplayName | Feature Mask |
Format | None |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | featuremask |
MaxValue | 1000000000 |
MinValue | 0 |
RequiredLevel | None |
Type | Integer |
ImportSequenceNumber
Property | Value |
---|---|
Description | Unique identifier of the data import or data migration that created this record. |
DisplayName | Import Sequence Number |
Format | None |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | importsequencenumber |
MaxValue | 2147483647 |
MinValue | -2147483648 |
RequiredLevel | None |
Type | Integer |
OverriddenCreatedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time that the record was migrated. |
DisplayName | Record Created On |
Format | DateOnly |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | overriddencreatedon |
RequiredLevel | None |
Type | DateTime |
ParentSubject
Property | Value |
---|---|
Description | Unique identifier of the parent subject. |
DisplayName | Parent Subject |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | parentsubject |
RequiredLevel | None |
Targets | subject |
Type | Lookup |
SubjectId
Property | Value |
---|---|
Description | Unique identifier of the subject. |
DisplayName | Subject |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | subjectid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
Title
Property | Value |
---|---|
Description | Title of the subject. |
DisplayName | Title |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | title |
MaxLength | 500 |
RequiredLevel | None |
Type | String |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- CreatedBy
- CreatedByExternalParty
- CreatedByExternalPartyName
- CreatedByExternalPartyYomiName
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ModifiedBy
- ModifiedByExternalParty
- ModifiedByExternalPartyName
- ModifiedByExternalPartyYomiName
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- ParentSubjectName
- VersionNumber
CreatedBy
Property | Value |
---|---|
Description | Unique identifier of the user who created the subject. |
DisplayName | Created By |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
CreatedByExternalParty
Property | Value |
---|---|
Description | Shows the external party who created the record. |
DisplayName | Created By (External Party) |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdbyexternalparty |
RequiredLevel | None |
Targets | externalparty |
Type | Lookup |
CreatedByExternalPartyName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyexternalpartyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedByExternalPartyYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyexternalpartyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the subject was created. |
DisplayName | Created On |
Format | DateAndTime |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
CreatedOnBehalfBy
Property | Value |
---|---|
Description | Unique identifier of the delegate user who created the subject. |
DisplayName | Created By (Delegate) |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
CreatedOnBehalfByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedOnBehalfByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedBy
Property | Value |
---|---|
Description | Unique identifier of the user who last modified the subject. |
DisplayName | Modified By |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
ModifiedByExternalParty
Property | Value |
---|---|
Description | Shows the external party who modified the record. |
DisplayName | Modified By (External Party) |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedbyexternalparty |
RequiredLevel | None |
Targets | externalparty |
Type | Lookup |
ModifiedByExternalPartyName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyexternalpartyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedByExternalPartyYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyexternalpartyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the subject was last modified. |
DisplayName | Modified On |
Format | DateAndTime |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
ModifiedOnBehalfBy
Property | Value |
---|---|
Description | Unique identifier of the delegate user who last modified the subject. |
DisplayName | Modified By (Delegate) |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
ModifiedOnBehalfByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedOnBehalfByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
OrganizationId
Property | Value |
---|---|
Description | Unique identifier for the organization associated with the subject. |
DisplayName | Organization |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | organizationid |
RequiredLevel | SystemRequired |
Targets | organization |
Type | Lookup |
OrganizationIdName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | organizationidname |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
ParentSubjectName
Property | Value |
---|---|
Description | Name of the parent subject. |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | parentsubjectname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
VersionNumber
Property | Value |
---|---|
Description | Version number of the subject. |
DisplayName | Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
RequiredLevel | None |
Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
- subject_products
- subject_incidents
- subject_sales_literature
- Subject_AsyncOperations
- subject_knowledgearticles
- Subject_BulkDeleteFailures
- Subject_ProcessSessions
- Subject_SyncErrors
- subject_parent_subject
- subject_kb_articles
subject_products
Added by: Product Management Solution
Same as the subject_products many-to-one relationship for the product entity.
Property | Value |
---|---|
ReferencingEntity | product |
ReferencingAttribute | subjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | subject_products |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
subject_incidents
Added by: Service Solution
Same as the subject_incidents many-to-one relationship for the incident entity.
Property | Value |
---|---|
ReferencingEntity | incident |
ReferencingAttribute | subjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | subject_incidents |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
subject_sales_literature
Added by: Sales Solution
Same as the subject_sales_literature many-to-one relationship for the salesliterature entity.
Property | Value |
---|---|
ReferencingEntity | salesliterature |
ReferencingAttribute | subjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | subject_sales_literature |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Subject_AsyncOperations
Same as the Subject_AsyncOperations many-to-one relationship for the asyncoperation entity.
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | Subject_AsyncOperations |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
subject_knowledgearticles
Same as the subject_knowledgearticles many-to-one relationship for the knowledgearticle entity.
Property | Value |
---|---|
ReferencingEntity | knowledgearticle |
ReferencingAttribute | subjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | subject_knowledgearticles |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Subject_BulkDeleteFailures
Same as the Subject_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.
Property | Value |
---|---|
ReferencingEntity | bulkdeletefailure |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | Subject_BulkDeleteFailures |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Subject_ProcessSessions
Same as the Subject_ProcessSessions many-to-one relationship for the processsession entity.
Property | Value |
---|---|
ReferencingEntity | processsession |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | Subject_ProcessSessions |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 110 |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Subject_SyncErrors
Same as the Subject_SyncErrors many-to-one relationship for the syncerror entity.
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | Subject_SyncErrors |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: Cascade Reparent: Cascade Share: Cascade Unshare: Cascade |
subject_parent_subject
Same as the subject_parent_subject many-to-one relationship for the subject entity.
Property | Value |
---|---|
ReferencingEntity | subject |
ReferencingAttribute | parentsubject |
IsHierarchical | True |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | subject_parent_subject |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
subject_kb_articles
Same as the subject_kb_articles many-to-one relationship for the kbarticle entity.
Property | Value |
---|---|
ReferencingEntity | kbarticle |
ReferencingAttribute | subjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | subject_kb_articles |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.
- lk_subjectbase_modifiedby
- lk_subjectbase_createdby
- organization_subjects
- lk_subject_createdonbehalfby
- subject_parent_subject
- lk_subject_modifiedonbehalfby
lk_subjectbase_modifiedby
See the lk_subjectbase_modifiedby one-to-many relationship for the systemuser entity.
lk_subjectbase_createdby
See the lk_subjectbase_createdby one-to-many relationship for the systemuser entity.
organization_subjects
See the organization_subjects one-to-many relationship for the organization entity.
lk_subject_createdonbehalfby
See the lk_subject_createdonbehalfby one-to-many relationship for the systemuser entity.
subject_parent_subject
See the subject_parent_subject one-to-many relationship for the subject entity.
lk_subject_modifiedonbehalfby
See the lk_subject_modifiedonbehalfby one-to-many relationship for the systemuser entity.