Policy Template (mspcat_ssPolicyTemplate) table/entity reference

Article
11/06/2024

Messages

The following table lists the messages for the Policy Template (mspcat_ssPolicyTemplate) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
`Create` Event: True	`POST` /mspcat_sspolicytemplates See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /mspcat_sspolicytemplates(mspcat_sspolicytemplateid) See Delete	Delete records
`IsValidStateTransition` Event: False	IsValidStateTransition	IsValidStateTransitionRequest
`Restore` Event: True	Restore	Learn to use messages with the SDK for .NET
`Retrieve` Event: True	`GET` /mspcat_sspolicytemplates(mspcat_sspolicytemplateid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /mspcat_sspolicytemplates See Query data	Query data
`SetState` Event: True	`PATCH` /mspcat_sspolicytemplates(mspcat_sspolicytemplateid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /mspcat_sspolicytemplates(mspcat_sspolicytemplateid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: False	`PATCH` /mspcat_sspolicytemplates(mspcat_sspolicytemplateid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: False	UpsertMultiple	UpsertMultipleRequest

Events

The following table lists the events for the Policy Template (mspcat_ssPolicyTemplate) table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name	Web API Operation	SDK for .NET
`BulkRetain`	BulkRetain	Learn to use messages with the SDK for .NET
`PurgeRetainedContent`	PurgeRetainedContent	Learn to use messages with the SDK for .NET
`Retain`	Retain	Learn to use messages with the SDK for .NET
`RollbackRetain`	RollbackRetain	Learn to use messages with the SDK for .NET
`ValidateRetentionConfig`	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Policy Template (mspcat_ssPolicyTemplate) table.

Property	Value
DisplayName	Policy Template
DisplayCollectionName	Policy Templates
SchemaName	`mspcat_ssPolicyTemplate`
CollectionSchemaName	`mspcat_ssPolicyTemplates`
EntitySetName	`mspcat_sspolicytemplates`
LogicalName	`mspcat_sspolicytemplate`
LogicalCollectionName	`mspcat_sspolicytemplates`
PrimaryIdAttribute	`mspcat_sspolicytemplateid`
PrimaryNameAttribute	`mspcat_title`
TableType	`Standard`
OwnershipType	`OrganizationOwned`

Writable columns/attributes

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

ImportSequenceNumber
mspcat_ExternalRefID
mspcat_PolicyCode
mspcat_ssPolicyTemplateId
mspcat_TemplateText
mspcat_Title
OverriddenCreatedOn
statecode
statuscode
TimeZoneRuleVersionNumber
UTCConversionTimeZoneCode

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`importsequencenumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

mspcat_ExternalRefID

Property	Value
Description
DisplayName	External Ref ID
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_externalrefid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

mspcat_PolicyCode

Property	Value
Description
DisplayName	Policy Code
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_policycode`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	mspcat_sspolicy

mspcat_ssPolicyTemplateId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Policy Template
IsValidForForm	False
IsValidForRead	True
LogicalName	`mspcat_sspolicytemplateid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

mspcat_TemplateText

Property	Value
Description
DisplayName	Template Text
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_templatetext`
RequiredLevel	ApplicationRequired
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	2000

mspcat_Title

Property	Value
Description	Required name field
DisplayName	Title
IsValidForForm	True
IsValidForRead	True
LogicalName	`mspcat_title`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OverriddenCreatedOn

Property	Value
Description	Date and time that the record was migrated.
DisplayName	Record Created On
IsValidForForm	False
IsValidForRead	True
LogicalName	`overriddencreatedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

statecode

Property	Value
Description	Status of the Policy Template
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`mspcat_sspolicytemplate_statecode`

statecode Choices/Options

Value	Details
0	Label: Active DefaultStatus: 1 InvariantName: `Active`
1	Label: Inactive DefaultStatus: 2 InvariantName: `Inactive`

statuscode

Property	Value
Description	Reason for the status of the Policy Template
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	`mspcat_sspolicytemplate_statuscode`

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`timezoneruleversionnumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
IsValidForForm	False
IsValidForRead	True
LogicalName	`utcconversiontimezonecode`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

CreatedBy
CreatedOn
CreatedOnBehalfBy
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OrganizationId
VersionNumber

CreatedBy

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

CreatedOn

Property	Value
Description	Date and time when the record was created.
DisplayName	Created On
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

CreatedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedBy

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

ModifiedOn

Property	Value
Description	Date and time when the record was modified.
DisplayName	Modified On
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

ModifiedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

OrganizationId

Property	Value
Description	Unique identifier for the organization
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`organizationid`
RequiredLevel	None
Type	Lookup
Targets	organization

VersionNumber

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`versionnumber`
RequiredLevel	None
Type	BigInt
MaxValue	9223372036854775807
MinValue	-9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

mspcat_ssPolicyTemplate_PolicyCode_msdy

One-To-Many Relationship: mspcat_sspolicy mspcat_ssPolicyTemplate_PolicyCode_msdy

Property	Value
ReferencedEntity	`mspcat_sspolicy`
ReferencedAttribute	`mspcat_sspolicyid`
ReferencingAttribute	`mspcat_policycode`
ReferencingEntityNavigationPropertyName	`mspcat_PolicyCode`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `RemoveLink` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

cr9d4_mspcat_CertificationRejectionAppliedPol

Many-To-One Relationship: mspcat_certificationrejectionappliedpolicy cr9d4_mspcat_CertificationRejectionAppliedPol

Property	Value
ReferencingEntity	`mspcat_certificationrejectionappliedpolicy`
ReferencingAttribute	`cr9d4_policyrejectionreason`
ReferencedEntityNavigationPropertyName	`cr9d4_mspcat_CertificationRejectionAppliedPol`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 10000 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Share via