TeamTemplate Entity Reference

Team template for an entity enabled for automatically created access teams.

Messages

Message Web API Operation SDK Assembly
AddUserToRecordTeam AddUserToRecordTeam Action AddUserToRecordTeamRequest
Create POST [org URI]/api/data/v9.0/teamtemplates
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/teamtemplates(teamtemplateid)
See Delete
DeleteRequest or
Delete
RemoveUserFromRecordTeam RemoveUserFromRecordTeam Action RemoveUserFromRecordTeamRequest
Retrieve GET [org URI]/api/data/v9.0/teamtemplates(teamtemplateid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/teamtemplates
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/teamtemplates(teamtemplateid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName TeamTemplates
DisplayCollectionName Team templates
DisplayName Team template
EntitySetName teamtemplates
IsBPFEntity False
LogicalCollectionName teamtemplates
LogicalName teamtemplate
OwnershipType None
PrimaryIdAttribute teamtemplateid
PrimaryNameAttribute teamtemplatename
SchemaName TeamTemplate

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

DefaultAccessRightsMask

Property Value
Description Default access rights mask for the access teams associated with entity instances.
DisplayName Access Rights
Format None
IsValidForForm True
IsValidForRead True
LogicalName defaultaccessrightsmask
MaxValue 2147483647
MinValue -2147483648
RequiredLevel SystemRequired
Type Integer

Description

Property Value
Description Type additional information that describes the team.
DisplayName Description
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

ObjectTypeCode

Property Value
Description Object type code of entity which is enabled for access teams
DisplayName Entity
Format None
IsValidForForm True
IsValidForRead True
LogicalName objecttypecode
MaxValue 100000
MinValue 0
RequiredLevel SystemRequired
Type Integer

TeamTemplateId

Property Value
Description Unique identifier of the team template.
DisplayName Primary key for team template
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName teamtemplateid
RequiredLevel SystemRequired
Type Uniqueidentifier

TeamTemplateName

Property Value
Description Type the name of the team template.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName teamtemplatename
MaxLength 100
RequiredLevel SystemRequired
Type String

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedBy

Property Value
Description Unique identifier of the user who created the team template.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the team template was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the team template.
DisplayName Created By (Delegate)
IsValidForForm True
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

IsSystem

Property Value
Description Information about whether this team template is user-defined or system-defined.
DisplayName Is System
IsValidForForm True
IsValidForRead True
LogicalName issystem
RequiredLevel SystemRequired
Type Boolean

IsSystem Options

Value Label
1 Yes
0 No

DefaultValue: False

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the team template.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the team template 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 modified the team template.
DisplayName Modified By (Delegate)
IsValidForForm True
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

One-To-Many Relationships

Listed by SchemaName.

teamtemplate_Teams

Same as team entity teamtemplate_Teams Many-To-One relationship.

Property Value
ReferencingEntity team
ReferencingAttribute teamtemplateid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName teamtemplate_Teams
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

TeamTemplate_SyncErrors

Same as syncerror entity TeamTemplate_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName TeamTemplate_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

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_teamtemplate_createdonbehalfby

See systemuser Entity lk_teamtemplate_createdonbehalfby One-To-Many relationship.

lk_teamtemplate_modifiedby

See systemuser Entity lk_teamtemplate_modifiedby One-To-Many relationship.

lk_teamtemplate_createdby

See systemuser Entity lk_teamtemplate_createdby One-To-Many relationship.

lk_teamtemplate_modifiedonbehalfby

See systemuser Entity lk_teamtemplate_modifiedonbehalfby One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
teamtemplate EntityType