Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Defines geographic and temporal criteria for cancelling proactive deliveries
Messages
The following table lists the messages for the Cancellation Policy Attributes (msdyn_cancellation_policy) 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 |
|---|---|---|
AssignEvent: True |
PATCH /msdyn_cancellation_policies(msdyn_cancellation_policyid)Update the ownerid property. |
AssignRequest |
AssociateEvent: True |
Associate records | Associate records |
BulkRetainEvent: True |
BulkRetain | Learn to use messages with the SDK for .NET |
CreateEvent: True |
POST /msdyn_cancellation_policiesSee Create |
Create records |
CreateMultipleEvent: True |
CreateMultiple | CreateMultipleRequest |
DeleteEvent: True |
DELETE /msdyn_cancellation_policies(msdyn_cancellation_policyid)See Delete |
Delete records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
GrantAccessEvent: True |
GrantAccess | GrantAccessRequest |
IsValidStateTransitionEvent: False |
IsValidStateTransition | IsValidStateTransitionRequest |
ModifyAccessEvent: True |
ModifyAccess | ModifyAccessRequest |
PurgeRetainedContentEvent: True |
PurgeRetainedContent | Learn to use messages with the SDK for .NET |
RestoreEvent: True |
Restore | Learn to use messages with the SDK for .NET |
RetainEvent: True |
Retain | Learn to use messages with the SDK for .NET |
RetrieveEvent: True |
GET /msdyn_cancellation_policies(msdyn_cancellation_policyid)See Retrieve |
Retrieve records |
RetrieveMultipleEvent: True |
GET /msdyn_cancellation_policiesSee Query data |
Query data |
RetrievePrincipalAccessEvent: True |
RetrievePrincipalAccess | RetrievePrincipalAccessRequest |
RetrieveSharedPrincipalsAndAccessEvent: True |
RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccessRequest |
RevokeAccessEvent: True |
RevokeAccess | RevokeAccessRequest |
RollbackRetainEvent: True |
RollbackRetain | Learn to use messages with the SDK for .NET |
SetStateEvent: True |
PATCH /msdyn_cancellation_policies(msdyn_cancellation_policyid)Update the statecode and statuscode properties. |
SetStateRequest |
UpdateEvent: True |
PATCH /msdyn_cancellation_policies(msdyn_cancellation_policyid)See Update |
Update records |
UpdateMultipleEvent: True |
UpdateMultiple | UpdateMultipleRequest |
UpsertEvent: False |
PATCH /msdyn_cancellation_policies(msdyn_cancellation_policyid)See Upsert a table row |
UpsertRequest |
UpsertMultipleEvent: False |
UpsertMultiple | UpsertMultipleRequest |
ValidateRetentionConfigEvent: True |
ValidateRetentionConfig | Learn to use messages with the SDK for .NET |
Properties
The following table lists selected properties for the Cancellation Policy Attributes (msdyn_cancellation_policy) table.
| Property | Value |
|---|---|
| DisplayName | Cancellation Policy Attributes |
| DisplayCollectionName | Cancellation Policy Attributes |
| SchemaName | msdyn_cancellation_policy |
| CollectionSchemaName | msdyn_cancellation_policies |
| EntitySetName | msdyn_cancellation_policies |
| LogicalName | msdyn_cancellation_policy |
| LogicalCollectionName | msdyn_cancellation_policies |
| PrimaryIdAttribute | msdyn_cancellation_policyid |
| PrimaryNameAttribute | msdyn_name |
| TableType | Standard |
| OwnershipType | UserOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ImportSequenceNumber
- msdyn_cancellation_comment
- msdyn_cancellation_policyId
- msdyn_country_codes
- msdyn_end_date
- msdyn_name
- msdyn_postal_codes
- msdyn_state_codes
- OverriddenCreatedOn
- OwnerId
- OwnerIdType
- 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 |
msdyn_cancellation_comment
| Property | Value |
|---|---|
| Description | Reason for the policy cancellation |
| DisplayName | Cancellation Comment |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_cancellation_comment |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 2000 |
msdyn_cancellation_policyId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | Cancellation Policy Attributes |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | msdyn_cancellation_policyid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
msdyn_country_codes
| Property | Value |
|---|---|
| Description | Comma-separated list of country codes where proactive deliveries should be cancelled |
| DisplayName | Country Codes |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_country_codes |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 2000 |
msdyn_end_date
| Property | Value |
|---|---|
| Description | End date and time when the cancellation policy becomes inactive |
| DisplayName | End Date |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | msdyn_end_date |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | True |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Auto |
| SourceTypeMask | 0 |
msdyn_name
| Property | Value |
|---|---|
| Description | The name of the cancellation policy |
| DisplayName | Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_name |
| RequiredLevel | ApplicationRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
msdyn_postal_codes
| Property | Value |
|---|---|
| Description | Comma-separated list of postal codes where proactive deliveries should be cancelled |
| DisplayName | Postal Codes |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_postal_codes |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 2000 |
msdyn_state_codes
| Property | Value |
|---|---|
| Description | Comma-separated list of state codes where proactive deliveries should be cancelled |
| DisplayName | State Codes |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_state_codes |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 2000 |
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 |
OwnerId
| Property | Value |
|---|---|
| Description | Owner Id |
| DisplayName | Owner |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | ownerid |
| RequiredLevel | SystemRequired |
| Type | Owner |
| Targets | systemuser, team |
OwnerIdType
| Property | Value |
|---|---|
| Description | Owner Id Type |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridtype |
| RequiredLevel | SystemRequired |
| Type | EntityName |
statecode
| Property | Value |
|---|---|
| Description | Status of the Cancellation Policy Attributes |
| DisplayName | Status |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
| DefaultFormValue | |
| GlobalChoiceName | msdyn_cancellation_policy_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 Cancellation Policy Attributes |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
| DefaultFormValue | |
| GlobalChoiceName | msdyn_cancellation_policy_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
- OwnerIdName
- OwnerIdYomiName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- 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 |
OwnerIdName
| Property | Value |
|---|---|
| Description | Name of the owner |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridname |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
OwnerIdYomiName
| Property | Value |
|---|---|
| Description | Yomi name of the owner |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridyominame |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
OwningBusinessUnit
| Property | Value |
|---|---|
| Description | Unique identifier for the business unit that owns the record |
| DisplayName | Owning Business Unit |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | owningbusinessunit |
| RequiredLevel | None |
| Type | Lookup |
| Targets | businessunit |
OwningTeam
| Property | Value |
|---|---|
| Description | Unique identifier for the team that owns the record. |
| DisplayName | Owning Team |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningteam |
| RequiredLevel | None |
| Type | Lookup |
| Targets | team |
OwningUser
| Property | Value |
|---|---|
| Description | Unique identifier for the user that owns the record. |
| DisplayName | Owning User |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owninguser |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
VersionNumber
| Property | Value |
|---|---|
| Description | Version Number |
| DisplayName | Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| RequiredLevel | None |
| Type | BigInt |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
msdyn_cancellation_policy_msdyn_proactive_eng_config_cancellation_policy
Many-To-One Relationship: msdyn_proactive_eng_config_cancellation_policy msdyn_cancellation_policy_msdyn_proactive_eng_config_cancellation_policy
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_proactive_eng_config_cancellation_policy |
| ReferencingAttribute | msdyn_cancellation_policy |
| ReferencedEntityNavigationPropertyName | msdyn_cancellation_policy_msdyn_proactive_eng_config_cancellation_policy |
| IsCustomizable | False |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference