aiplugin EntityType
AIPlugins component
- Entity set path:
- [organization URI]/api/data/v9.2/aiplugins
- Base type:
- crmbaseentity
- Display name:
- AIPlugin
- Primary key:
- aipluginid
- Primary key attribute:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties
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
|
||||||||||||||||||||
| contactemail | Edm.String |
Contact Email Display name: ContactEmail |
||||||||||||||||||||
| 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
|
||||||||||||||||||||
| legalinfourl | Edm.String |
Legal Info Url Display name: LegalInfoUrl |
||||||||||||||||||||
| 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
|
||||||||||||||||||||
| pluginsubtype | Edm.Int32 |
Display name: PluginSubType
Default options
|
||||||||||||||||||||
| plugintype | Edm.Int32 |
Display name: PluginType
Default options
|
||||||||||||||||||||
| privacypolicyurl | Edm.String |
Privacy Policy Url Display name: PrivacyPolicyUrl |
||||||||||||||||||||
| schemaversion | Edm.Int32 |
SchemaVersion of OpenAI Manifest Display name: SchemaVersion
Default options
|
||||||||||||||||||||
| sharedconnector | Edm.String |
SharedConnector Description Display name: SharedConnector |
||||||||||||||||||||
| 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
|
||||||||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the AIPlugin Display name: Status Reason
Default options
|
||||||||||||||||||||
| 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 | |
| _connector_value | connector |
Connector reference for AIPlugin |
| _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. |
| _pluginauthid_value | AIPluginAuth |
Auth reference for AIPlugin |
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 |
|---|---|---|
| AIPluginAuth | aipluginauth | AIPluginAuth_AIPlugin |
| AIPluginTitle | aiplugintitle | aiplugin_AIPluginTitle_aiplugintitle |
| connector | connector | AIPlugin_connector_connector |
| 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_AIPluginConversationStarterMapping | aipluginconversationstartermapping | 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 |
| aiplugingovernance_aiplugin | aiplugingovernance | AIPlugin |
| AIPluginInstance_AIPlugin_AIPlugin | aiplugininstance | AIPlugin |
| AIPluginOperation_AIPlugin_AIPlugin | aipluginoperation | AIPlugin |
| sideloadedaiplugin_AIPlugin_aiplugin | sideloadedaiplugin | AIPlugin |
Operations
The following operations can be used with the aiplugin entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RetrieveUnpublished | Bound to Entity |
| RetrieveUnpublishedMultiple | Bound to Collection |
| RevokeAccess | Not Bound |
| UpdateMultiple | Not Bound |