agentrule EntityType
Agent Rule for event and schedule-based instruction activation
- Entity set path:
- [organization URI]/api/data/v9.2/agentrules
- Base type:
- crmbaseentity
- Display name:
- Agent Rule
- Primary key:
- agentruleid
- Primary name column:
- displayname
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||
|---|---|---|---|---|---|---|---|---|
| agentruleid | Edm.Guid |
Unique identifier for entity instances Display name: Agent Rule Id |
||||||
| agentuserid | Edm.String |
Object ID (OID) of the Entra agentic user that owns this rule Display name: Agent User Id |
||||||
| description | Edm.String |
Description of what this Agent Rule does Display name: Description |
||||||
| displayname | Edm.String |
Display Name of the Agent Rule Display name: Display Name |
||||||
| eventtype | Edm.String |
Event type this rule applies to (email, document, message, schedule) Display name: Event Type |
||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||
| logic | Edm.String |
Logical operator for conditions: all (AND) or any (OR) Display name: Logic |
||||||
| name | Edm.String |
Name of the Agent Rule Display name: Name |
||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||
| ruledefinition | Edm.String |
JSON containing filter conditions and rules Display name: Rule Definition |
||||||
| statecode | Edm.Int32 |
Status of the Agent Rule Display name: Status
Default options
|
||||||
| statuscode | Edm.Int32 |
Reason for the status of the Agent Rule Display name: Status Reason
Default options
|
||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||
| versionnumber | Edm.Int64 |
Version Number Display name: Version Number Read only
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _mcppromptid_value | MCPPrompt |
Reference to MCPPrompt that contains the instruction for this rule |
| _ownerid_value | ownerid |
Owner Id |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier for the business unit that owns the record |
| _owningteam_value | owningteam |
Unique identifier for the team that owns the record. |
| _owninguser_value | owninguser |
Unique identifier for the user that owns the record. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| MCPPrompt | mcpprompt | AgentRule_MCPPrompt_MCPPrompt |
| ownerid | principal | owner_agentrule |
| owningbusinessunit | businessunit | business_unit_agentrule |
| owningteam | team | team_agentrule |
| owninguser | systemuser | user_agentrule |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| agentrule_AsyncOperations | asyncoperation | regardingobjectid_agentrule |
| agentrule_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_agentrule |
| agentrule_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_agentrule |
| agentrule_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_agentrule |
| agentrule_ProcessSession | processsession | regardingobjectid_agentrule |
| agentrule_SyncErrors | syncerror | regardingobjectid_agentrule |
Operations
The following operations can be used with the agentrule entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| Restore | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| UpdateMultiple | Not Bound |