aiplugin EntityType

AIPlugins component

Entity Set Path
[organization URI]/api/data/v9.2/aiplugins
Base Type
Display Name
Primary Key
Primary Key Attribute
Operations Supported


Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
aipluginid Edm.Guid

Unique identifier for entity instances

Display Name: AIPlugin

componentidunique Edm.Guid

For internal use only.

Display Name: Row id unique

Read Only
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
humandescription Edm.String

Human-readable description of the Plugin

Display Name: HumanDescription

humanname Edm.String

Human-readable name for the model

Display Name: HumanName

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

iscustomizable BooleanManagedProperty

For internal use only.

Display Name: Is Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Values Label
1 Managed
0 Unmanaged
modeldescription Edm.String

Description better tailored to the model, such as token context length considerations or keyword usage for improved plugin prompting.

Display Name: ModelDescription

modelname Edm.String

Model name for the plugin

Display Name: ModelName

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

Display Name: Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
plugintype Edm.Int32

Display Name: PluginType

Default Options
Values Label
0 Dataverse
schemaversion Edm.Int32

SchemaVersion of OpenAI Manifest

Display Name: SchemaVersion

Default Options
Values Label
0 1.0
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the AIPlugin

Display Name: Status

Default Options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the AIPlugin

Display Name: Status Reason

Default Options
Values Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

upsertswagger Edm.String

Swagger value that is upserted to generated plugin definition, used to provide override for properties not exposed as table/columns. Example: { \"info\": { \"x-ms-keywords\": [ \"sales\", \"support\" ] } } Adds x-ms-keywords in info property.

Display Name: UpsertSwagger

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
_aiplugintitle_value AIPluginTitle
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_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
AIPluginTitle aiplugintitle aiplugin_AIPluginTitle_aiplugintitle
createdby systemuser lk_aiplugin_createdby
createdonbehalfby systemuser lk_aiplugin_createdonbehalfby
modifiedby systemuser lk_aiplugin_modifiedby
modifiedonbehalfby systemuser lk_aiplugin_modifiedonbehalfby
ownerid principal owner_aiplugin
owningbusinessunit businessunit business_unit_aiplugin
owningteam team team_aiplugin
owninguser systemuser user_aiplugin

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
AICopilot_AIPlugin_AIPlugin aicopilot AICopilot_AIPlugin_AIPlugin
aiplugin_AsyncOperations asyncoperation regardingobjectid_aiplugin
aiplugin_BulkDeleteFailures bulkdeletefailure regardingobjectid_aiplugin
aiplugin_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_aiplugin
aiplugin_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_aiplugin
aiplugin_ProcessSession processsession regardingobjectid_aiplugin
aiplugin_SyncErrors syncerror regardingobjectid_aiplugin
AIPluginInstance_AIPlugin_AIPlugin aiplugininstance AIPlugin
AIPluginOperation_AIPlugin_AIPlugin aipluginoperation AIPlugin


The following operations can be used with the aiplugin entity type.

Name Binding
CreateMultiple Not Bound
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
UpdateMultiple Not Bound

See also