Agreement Substatus (msdyn_agreementsubstatus) table/entity reference (Microsoft Dynamics 365 Field Service)

Статья
2025-02-08

Specify custom agreement substatuses, which can be used to specify the current agreement status more precisely.

Messages

The following table lists the messages for the Agreement Substatus (msdyn_agreementsubstatus) 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
`Assign` Event: True	`PATCH` /msdyn_agreementsubstatuses(msdyn_agreementsubstatusid) Update the `ownerid` property.	AssignRequest
`Associate` Event: True	Associate records	Associate records
`BulkRetain` Event: True	BulkRetain	Learn to use messages with the SDK for .NET
`Create` Event: True	`POST` /msdyn_agreementsubstatuses See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /msdyn_agreementsubstatuses(msdyn_agreementsubstatusid) See Delete	Delete records
`Disassociate` Event: True	Disassociate records	Disassociate records
`GrantAccess` Event: True	GrantAccess	GrantAccessRequest
`IsValidStateTransition` Event: False	IsValidStateTransition	IsValidStateTransitionRequest
`ModifyAccess` Event: True	ModifyAccess	ModifyAccessRequest
`PurgeRetainedContent` Event: True	PurgeRetainedContent	Learn to use messages with the SDK for .NET
`Restore` Event: True	Restore	Learn to use messages with the SDK for .NET
`Retain` Event: True	Retain	Learn to use messages with the SDK for .NET
`Retrieve` Event: True	`GET` /msdyn_agreementsubstatuses(msdyn_agreementsubstatusid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /msdyn_agreementsubstatuses See Query data	Query data
`RetrievePrincipalAccess` Event: True	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
`RetrieveSharedPrincipalsAndAccess` Event: True	RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
`RevokeAccess` Event: True	RevokeAccess	RevokeAccessRequest
`RollbackRetain` Event: True	RollbackRetain	Learn to use messages with the SDK for .NET
`SetState` Event: True	`PATCH` /msdyn_agreementsubstatuses(msdyn_agreementsubstatusid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /msdyn_agreementsubstatuses(msdyn_agreementsubstatusid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: False	`PATCH` /msdyn_agreementsubstatuses(msdyn_agreementsubstatusid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: False	UpsertMultiple	UpsertMultipleRequest
`ValidateRetentionConfig` Event: True	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Agreement Substatus (msdyn_agreementsubstatus) table.

Property	Value
DisplayName	Agreement Substatus
DisplayCollectionName	Agreement Substatuses
SchemaName	`msdyn_agreementsubstatus`
CollectionSchemaName	`msdyn_agreementsubstatuses`
EntitySetName	`msdyn_agreementsubstatuses`
LogicalName	`msdyn_agreementsubstatus`
LogicalCollectionName	`msdyn_agreementsubstatuses`
PrimaryIdAttribute	`msdyn_agreementsubstatusid`
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_agreementsubstatusId
msdyn_DefaultSubStatus
msdyn_name
msdyn_SystemStatus
OverriddenCreatedOn
OwnerId
OwnerIdType
statecode
statuscode
TimeZoneRuleVersionNumber
UTCConversionTimeZoneCode

ImportSequenceNumber

Property	Value
Description	Shows the 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_agreementsubstatusId

Property	Value
Description	Shows the entity instances.
DisplayName	Agreement Substatus
IsValidForForm	False
IsValidForRead	True
LogicalName	`msdyn_agreementsubstatusid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_DefaultSubStatus

Property	Value
Description	Specify whether this status should be the default substatus for this status type
DisplayName	Default Substatus
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_defaultsubstatus`
RequiredLevel	ApplicationRequired
Type	Boolean
GlobalChoiceName	`msdyn_agreementsubstatus_msdyn_defaultsubstatus`
DefaultValue	False
True Label	Yes
False Label	No

msdyn_name

Property	Value
Description	Shows the agreement substatus name.
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_name`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

msdyn_SystemStatus

Property	Value
Description	Specify the system status.
DisplayName	System Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_systemstatus`
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	`msdyn_agreementsystemstatus`

msdyn_SystemStatus Choices/Options

Value	Label
690970000	Estimate
690970001	Active
690970002	Expired
690970003	Canceled

OverriddenCreatedOn

Property	Value
Description	Shows the 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 Agreement Substatus
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`msdyn_agreementsubstatus_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 Agreement Substatus
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	`msdyn_agreementsubstatus_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	Shows the 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	Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
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	Shows who created the record on behalf of another user.
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	Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
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	Shows who last updated the record on behalf of another user.
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_msdyn_agreementsubstatus_msdyn_agreement_SubStatus

Many-To-One Relationship: msdyn_agreement msdyn_msdyn_agreementsubstatus_msdyn_agreement_SubStatus

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