Ask Learn
Preview
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign inconnector EntityType
Connector Entity to support Solutioning Integration
- Entity set path:
- [organization URI]/api/data/v9.2/connectors
- Base type:
- crmbaseentity
- Display name:
- Connector
- Primary key:
- connectorid
- Primary name column:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| capabilities | Edm.String |
Capabilities Display name: Capabilities
Default options
|
||||||||||||||
| componentstate | Edm.Int32 |
For internal use only. Display name: Component State Read only
Default options
|
||||||||||||||
| connectionparameters | Edm.String |
Connection parameters of the Connector Display name: ConnectionParameters |
||||||||||||||
| connectionparametersets | Edm.String |
Connection parameter sets of the Connector Display name: ConnectionParameterSets |
||||||||||||||
| connectorid | Edm.Guid |
Unique identifier for entity instances Display name: Connector |
||||||||||||||
| connectoridunique | Edm.Guid |
For internal use only. Read only
|
||||||||||||||
| connectorinternalid | Edm.String |
Internal Connector Id Display name: Internal Connector Id |
||||||||||||||
| connectortype | Edm.Int32 |
Connector Type Display name: Connector Type
Default options
|
||||||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||||||||||
| customcodeblobcontent | Edm.String |
Custom Code Content for the Connector Display name: Custom Code Blob Content |
||||||||||||||
| description | Edm.String |
Description of the Connector Display name: Description |
||||||||||||||
| displayname | Edm.String |
Display Name of the Connector Display name: Display Name |
||||||||||||||
| iconblob | Edm.Binary |
Icon for the Connector Display name: Icon Blob |
||||||||||||||
| iconblob_timestamp | Edm.Int64 |
Read only
|
||||||||||||||
| iconblob_url | Edm.String |
Read only
|
||||||||||||||
| iconblobid | Edm.Guid |
Read only
|
||||||||||||||
| iconbrandcolor | Edm.String |
Connector Icon Branding Color Display name: Icon Brand Color |
||||||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||||||||||
| introducedversion | Edm.String |
Version in which the form is introduced. Display name: Introduced Version |
||||||||||||||
| iscustomizable | BooleanManagedProperty |
Tells whether the component can be customized. Display name: Customizable |
||||||||||||||
| ismanaged | Edm.Boolean |
Indicates whether the solution component is part of a managed solution. Display name: Is Managed Read only
Default options
|
||||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||||||||||
| name | Edm.String |
Required logical name of the Connector Display name: Logical Name of the Connector |
||||||||||||||
| openapidefinition | Edm.String |
OpenApi Definition supported by Connector Display name: Open Api Definition |
||||||||||||||
| 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
|
||||||||||||||
| policytemplateinstances | Edm.String |
Apim Policy Template Instances Display name: PolicyTemplateInstances |
||||||||||||||
| scriptoperations | Edm.String |
A list of operations to which the custom code will apply to. Display name: ScriptOperations |
||||||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display name: Solution Read only
|
||||||||||||||
| statecode | Edm.Int32 |
Status of the Connector Display name: Status
Default options
|
||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Connector 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 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 |
|---|---|---|
| _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 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 | lk_connector_createdby |
| createdonbehalfby | systemuser | lk_connector_createdonbehalfby |
| modifiedby | systemuser | lk_connector_modifiedby |
| modifiedonbehalfby | systemuser | lk_connector_modifiedonbehalfby |
| ownerid | principal | owner_connector |
| owningbusinessunit | businessunit | business_unit_connector |
| owningteam | team | team_connector |
| owninguser | systemuser | user_connector |
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 |
|---|---|---|
| AIPlugin_connector_connector | aiplugin | connector |
| ConnectionInstance_connectorid_con | connectioninstance | connectorid |
| connector_AsyncOperations | asyncoperation | regardingobjectid_connector |
| connector_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_connector |
| connector_connectionreference | connectionreference | CustomConnectorId |
| connector_DuplicateBaseRecord | duplicaterecord | baserecordid_connector |
| connector_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_connector |
| connector_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_connector |
| connector_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_connector |
| connector_ProcessSession | processsession | regardingobjectid_connector |
| connector_SyncErrors | syncerror | regardingobjectid_connector |
The following operations can be used with the connector 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 |
| RevokeAccess | Not Bound |
| UpdateMultiple | Not Bound |