API Request Folder (msdyn_APIRequestFolder) table/entity reference

  • Článek

Messages

The following table lists the messages for the API Request Folder (msdyn_APIRequestFolder) 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_apirequestfolders(msdyn_apirequestfolderid)
Update the ownerid property.		 AssignRequest
Create
Event: True		 POST /msdyn_apirequestfolders
See Create		 Create records
CreateMultiple
Event: True		 CreateMultiple CreateMultipleRequest
Delete
Event: True		 DELETE /msdyn_apirequestfolders(msdyn_apirequestfolderid)
See Delete		 Delete records
GrantAccess
Event: True		 GrantAccess GrantAccessRequest
IsValidStateTransition
Event: False		 IsValidStateTransition IsValidStateTransitionRequest
ModifyAccess
Event: True		 ModifyAccess ModifyAccessRequest
Restore
Event: True		 Restore Learn to use messages with the SDK for .NET
Retrieve
Event: True		 GET /msdyn_apirequestfolders(msdyn_apirequestfolderid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: True		 GET /msdyn_apirequestfolders
See Query data		 Query data
RetrievePrincipalAccess
Event: True		 RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: True		 RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess
Event: True		 RevokeAccess RevokeAccessRequest
SetState
Event: True		 PATCH /msdyn_apirequestfolders(msdyn_apirequestfolderid)
Update the statecode and statuscode properties.		 SetStateRequest
Update
Event: True		 PATCH /msdyn_apirequestfolders(msdyn_apirequestfolderid)
See Update		 Update records
UpdateMultiple
Event: True		 UpdateMultiple UpdateMultipleRequest
Upsert
Event: False		 PATCH /msdyn_apirequestfolders(msdyn_apirequestfolderid)
See Upsert a table row		 UpsertRequest
UpsertMultiple
Event: False		 UpsertMultiple UpsertMultipleRequest

Events

The following table lists the events for the API Request Folder (msdyn_APIRequestFolder) 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 API Request Folder (msdyn_APIRequestFolder) table.

Property Value
DisplayName API Request Folder
DisplayCollectionName API Request Folders
SchemaName msdyn_APIRequestFolder
CollectionSchemaName msdyn_APIRequestFolders
EntitySetName msdyn_apirequestfolders
LogicalName msdyn_apirequestfolder
LogicalCollectionName msdyn_apirequestfolders
PrimaryIdAttribute msdyn_apirequestfolderid
PrimaryNameAttribute msdyn_foldername
TableType Standard
OwnershipType UserOwned

Writable columns/attributes

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

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_APIRequestFolderId

Property Value
Description Unique identifier for entity instances
DisplayName API Request Folder
IsValidForForm False
IsValidForRead True
LogicalName msdyn_apirequestfolderid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_FolderName

Property Value
Description
DisplayName Folder Name
IsValidForForm True
IsValidForRead True
LogicalName msdyn_foldername
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

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 API Request Folder
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue
GlobalChoiceName msdyn_apirequestfolder_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 API Request Folder
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue
GlobalChoiceName msdyn_apirequestfolder_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

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 SystemRequired
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

Many-to-One relationships

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

business_unit_msdyn_apirequestfolder

One-To-Many Relationship: businessunit business_unit_msdyn_apirequestfolder

Property Value
ReferencedEntity businessunit
ReferencedAttribute businessunitid
ReferencingAttribute owningbusinessunit
ReferencingEntityNavigationPropertyName owningbusinessunit
IsHierarchical
CascadeConfiguration Archive: Restrict
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_apirequestfolder_createdby

One-To-Many Relationship: systemuser lk_msdyn_apirequestfolder_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_apirequestfolder_createdonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_apirequestfolder_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_apirequestfolder_modifiedby

One-To-Many Relationship: systemuser lk_msdyn_apirequestfolder_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_apirequestfolder_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_apirequestfolder_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

owner_msdyn_apirequestfolder

One-To-Many Relationship: owner owner_msdyn_apirequestfolder

Property Value
ReferencedEntity owner
ReferencedAttribute ownerid
ReferencingAttribute ownerid
ReferencingEntityNavigationPropertyName ownerid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

team_msdyn_apirequestfolder

One-To-Many Relationship: team team_msdyn_apirequestfolder

Property Value
ReferencedEntity team
ReferencedAttribute teamid
ReferencingAttribute owningteam
ReferencingEntityNavigationPropertyName owningteam
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

user_msdyn_apirequestfolder

One-To-Many Relationship: systemuser user_msdyn_apirequestfolder

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute owninguser
ReferencingEntityNavigationPropertyName owninguser
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

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

msdyn_apirequestcache_FolderName_msdyn_apireque

Many-To-One Relationship: msdyn_apirequestcache msdyn_apirequestcache_FolderName_msdyn_apireque

Property Value
ReferencingEntity msdyn_apirequestcache
ReferencingAttribute msdyn_foldername
ReferencedEntityNavigationPropertyName msdyn_apirequestcache_FolderName_msdyn_apireque
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 10000
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_apirequestfolder_AsyncOperations

Many-To-One Relationship: asyncoperation msdyn_apirequestfolder_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_apirequestfolder_AsyncOperations
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_apirequestfolder_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure msdyn_apirequestfolder_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_apirequestfolder_BulkDeleteFailures
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_apirequestfolder_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord msdyn_apirequestfolder_DuplicateBaseRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
ReferencedEntityNavigationPropertyName msdyn_apirequestfolder_DuplicateBaseRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_apirequestfolder_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord msdyn_apirequestfolder_DuplicateMatchingRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
ReferencedEntityNavigationPropertyName msdyn_apirequestfolder_DuplicateMatchingRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_apirequestfolder_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder msdyn_apirequestfolder_MailboxTrackingFolders

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_apirequestfolder_MailboxTrackingFolders
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_apirequestfolder_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess msdyn_apirequestfolder_PrincipalObjectAttributeAccesses

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName msdyn_apirequestfolder_PrincipalObjectAttributeAccesses
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_apirequestfolder_ProcessSession

Many-To-One Relationship: processsession msdyn_apirequestfolder_ProcessSession

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_apirequestfolder_ProcessSession
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_apirequestfolder_SyncErrors

Many-To-One Relationship: syncerror msdyn_apirequestfolder_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_apirequestfolder_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference