plugintype EntityType
Type that inherits from the IPlugin interface and is contained within a plug-in assembly.
- Entity Set Path
- [organization URI]/api/data/v9.0/plugintypes
- Base Type
- crmbaseentity
- Display Name
- Plug-in Type
- Primary Key
- plugintypeid
- 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| assemblyname | Edm.String |
Full path name of the plug-in assembly. Display Name: Assembly Name Read Only
|
||||||||||
| componentstate | Edm.Int32 |
For internal use only. Display Name: Component State Read Only
Default Options
|
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the plug-in type was created. Display Name: Created On Read Only
|
||||||||||
| culture | Edm.String |
Culture code for the plug-in assembly. Display Name: Culture Read Only
|
||||||||||
| customizationlevel | Edm.Int32 |
Customization level of the plug-in type. Read Only
|
||||||||||
| customworkflowactivityinfo | Edm.String |
Serialized Custom Activity Type information, including required arguments. For more information, see SandboxCustomActivityInfo. Display Name: Custom Workflow Activity Info Read Only
|
||||||||||
| description | Edm.String |
Description of the plug-in type. Display Name: Description |
||||||||||
| friendlyname | Edm.String |
User friendly name for the plug-in. Display Name: Display Name |
||||||||||
| ismanaged | Edm.Boolean |
Read Only
Default Options
|
||||||||||
| isworkflowactivity | Edm.Boolean |
Indicates if the plug-in is a custom activity for workflows. Display Name: Is Workflow Activity Read Only
Default Options
|
||||||||||
| major | Edm.Int32 |
Major of the version number of the assembly for the plug-in type. Display Name: Version major Read Only
|
||||||||||
| minor | Edm.Int32 |
Minor of the version number of the assembly for the plug-in type. Display Name: Version minor Read Only
|
||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the plug-in type was last modified. Display Name: Modified On Read Only
|
||||||||||
| name | Edm.String |
Name of the plug-in type. Display Name: Name |
||||||||||
| overwritetime | Edm.DateTimeOffset |
For internal use only. Display Name: Record Overwrite Time Read Only
|
||||||||||
| plugintypeid | Edm.Guid |
Unique identifier of the plug-in type. Display Name: Plug-in Type |
||||||||||
| plugintypeidunique | Edm.Guid |
Unique identifier of the plug-in type. Read Only
|
||||||||||
| publickeytoken | Edm.String |
Public key token of the assembly for the plug-in type. Display Name: Public Key Token Read Only
|
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display Name: Solution Read Only
|
||||||||||
| typename | Edm.String |
Fully qualified type name of the plug-in type. Display Name: Type Name |
||||||||||
| version | Edm.String |
Version number of the assembly for the plug-in type. Display Name: Version Read Only
|
||||||||||
| versionnumber | Edm.Int64 |
Read Only
|
||||||||||
| workflowactivitygroupname | Edm.String |
Group name of workflow custom activity. Display Name: Workflow Activity Group Name |
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 Retrieve data about lookup properties.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the plug-in type. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the plugintype. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who last modified the plug-in type. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who last modified the plugintype. |
| _organizationid_value | organizationid |
Unique identifier of the organization with which the plug-in type is associated. |
| _pluginassemblyid_value | pluginassemblyid |
Unique identifier of the plug-in assembly that contains this plug-in type. |
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 |
|---|---|---|
| createdby | systemuser | createdby_plugintype |
| createdonbehalfby | systemuser | lk_plugintype_createdonbehalfby |
| modifiedby | systemuser | modifiedby_plugintype |
| modifiedonbehalfby | systemuser | lk_plugintype_modifiedonbehalfby |
| organizationid | organization | organization_plugintype |
| pluginassemblyid | pluginassembly | pluginassembly_plugintype |
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 |
|---|---|---|
| CustomAPIId | customapi | PluginTypeId |
| plugintype_plugintypestatistic | plugintypestatistic | plugintypeid |
| plugintype_sdkmessageprocessingstep | sdkmessageprocessingstep | eventhandler_plugintype |
| plugintypeid_sdkmessageprocessingstep | sdkmessageprocessingstep | plugintypeid |
Solutions
The following solutions include the plugintype entity type.
| Name | Description |
|---|---|
| API messages extension solution | This solution contains CDS API message extensions. |
| RuntimeIntegration | CDS Runtime Integration Extensions Solution |