connector EntityType
Connector Entity to support Solutioning Integration
- Entity Set Path
- [organization URI]/api/data/v9.0/connectors
- Base Type
- crmbaseentity
- Display Name
- Connector
- Primary Key
- connectorid
- 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| capabilities | Edm.String |
Capability of a connector, i.e. "gateway" means the connector can connect to on-prem gateway Display Name: capabilities |
||||||||||
| 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 |
||||||||||
| 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
|
||||||||||
| customcodeblob | Edm.Binary |
Custom Code for the Connector Display Name: Custom Code Blob Read Only
|
||||||||||
| customcodeblob_name | Edm.String |
Read Only
|
||||||||||
| 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
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 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 |
|---|---|---|
| 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
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 |
|---|---|---|
| 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_FileAttachments | fileattachment | objectid_connector |
| connector_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_connector |
| connector_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_connector |
| connector_ProcessSession | processsession | regardingobjectid_connector |
| connector_SyncErrors | syncerror | regardingobjectid_connector |
Operations
The following operations can be used with the connector entity type.
| Name | Binding |
|---|---|
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
Solutions
The following solutions include the connector entity type.
| Name | Description |
|---|---|
| Power Connector Solution | Power Connector Solution |