Properties
This table lists the whole set of properties contained into this data type.
Some properties are "native", and have a single serialization format.
Some properties are "polymorphic", and can be serialized/deserialized using multiple formats (known as "styles")
Name | Kind | Description |
---|---|---|
active | native | Is the configuration active ? |
appointmentDelay | native | The value to indicate the number of days to be taken to synchronize appointments |
createdById | native | Creato da The creator of the entity |
createdDate | native | Data creazione The creation date for the entity |
domain | native | The domain used to log into the exchange service |
exchangeCompanyConfId | native | The ID of the company configuration associated to the account |
externalReference | native | External Reference |
externalReferences | native | Campi aggiuntivi The external references linked to current object |
id | native | |
lastModifiedById | native | Modificato da The last modified by id |
lastModifiedDate | native | Data modifica The last modified date |
lastSyncDateUTCAppointments | native | The last sync date UTC of the appointments items in current account |
lastSyncDateUTCCompanies | native | The last sync date UTC of the companies items in current account |
lastSyncDateUTCContacts | native | The last sync date UTC of the contacts items in current account |
lastSyncDateUTCLeads | native | The last sync date UTC of the leads items in current account |
oAuth | native | O Auth |
ownerId | polymorphic | Proprietario The owner of the entity |
password | native | The password used to log into the exchange service |
refreshToken | native | Refresh Token |
serviceHost | native | Service Host |
serviceUrl | native | The URL of the exchange service |
serviceVersion | native | The version of the exchange service |
tags | polymorphic | |
username | native | The username used to log into the exchange service |
active
Is the configuration active ?
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | Active |
Physical property type | bool |
Is Required | YES |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
appointmentDelay
The value to indicate the number of days to be taken to synchronize appointments
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
createdById
Creato da
The creator of the entity
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | CreatedById |
Physical property type | int |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=createdById eq 123 |
Is Enum | NO |
Foreign Key |
|
createdDate
Data creazione
The creation date for the entity
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
domain
The domain used to log into the exchange service
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | Domain |
Physical property type | string |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
exchangeCompanyConfId
The ID of the company configuration associated to the account
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | ExchangeCompanyConfId |
Physical property type | long |
Is Required | YES |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
externalReference
External Reference
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | ExternalReference |
Physical property type | string |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
externalReferences
Campi aggiuntivi
The external references linked to current object
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | ExternalReferences |
Physical property type | array of ExternalReferencesDTO |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | YES |
Is Searchable | NO |
Is Enum | NO |
Max value | -1 |
id
This property contains the primary key of the object inside the system. It can be used to universally identify the record containing all the object's data
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
lastModifiedById
Modificato da
The last modified by id
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | LastModifiedById |
Physical property type | int |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=lastModifiedById eq 123 |
Is Enum | NO |
Foreign Key |
|
lastModifiedDate
Data modifica
The last modified date
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
lastSyncDateUTCAppointments
The last sync date UTC of the appointments items in current account
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
lastSyncDateUTCCompanies
The last sync date UTC of the companies items in current account
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
lastSyncDateUTCContacts
The last sync date UTC of the contacts items in current account
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
lastSyncDateUTCLeads
The last sync date UTC of the leads items in current account
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
oAuth
O Auth
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | OAuth |
Physical property type | bool |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
ownerId
Proprietario
The owner of the entity
This polymorphic property is a foreign key, and refers to the account ID of the owner of this object.
Multiple serialization styles are available (see the section below).
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | OwnerId |
Physical property type | int |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=ownerId eq 123 |
Is Enum | NO |
Foreign Key |
|
Polymorphic styles for version 'v1'
For more details about using the polymorphic properties, please refer to the general guide on the options
Crm-OwnerIdStyle: AdaptiveExternalReference
Style name | Serialized as |
---|---|
AdaptiveExternalReference | string |
AdaptiveStringOnlyUserAccount | string |
AdaptiveUserAccount | string |
FlattenedExpansion | FlattenedExpansionSchema |
Id | int |
StrictEmail | string |
password
The password used to log into the exchange service
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | Password |
Physical property type | string |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
refreshToken
Refresh Token
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | RefreshToken |
Physical property type | string |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
serviceHost
Service Host
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | ServiceHost |
Physical property type | string |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
serviceUrl
The URL of the exchange service
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | ServiceUrl |
Physical property type | string |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
serviceVersion
The version of the exchange service
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | ServiceVersion |
Physical property type | string |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
tags
This polymorphic property is an array of tags (textual labels) associated to the object.
For details on using the different serialization/deserialization styles, refer to the section below "Polymorphic styles"
OData searches
You can use this property as a filter condition in an OData expression via the eq operator and the startswith, endswith functions.
Examples:
'eq' -> GET: /api/{version}/Company/Search?$filter=tags eq 'category'
'startswith' -> GET: /api/{version}/Company/Search?$filter=startswith(tags,'te')
'endswith' -> GET: /api/{version}/Company/Search?$filter=endswith(tags,'ro')
Complex example -> GET: /api/{version}/Company/Search?$filter=startswith(tags,'te') or endswith(tags,'ro') &$orderby=id asc&$top=10&$skip=0&$select=id,companyName,billed,tags
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | Tags |
Physical property type | array of long |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | YES |
Is Searchable | NO |
Is Enum | NO |
Polymorphic styles for version 'v1'
For more details about using the polymorphic properties, please refer to the general guide on the options
Crm-TagsStyle: AdaptiveCsv
Style name | Serialized as |
---|---|
AdaptiveCsv | string |
AdaptiveExternalReference | string |
AdaptiveName | string |
AdaptiveStringOnlyName | string |
Csv | string |
CsvOfIds | string |
CsvOfNames | string |
Id | int |
username
The username used to log into the exchange service
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Name | Value |
---|---|
Physical property name | Username |
Physical property type | string |
Is Required | YES |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
Schema
The following table contains the main schema information about this data type.
Feature | Value |
---|---|
Complex type | ExchangeAccountConfigurationDTO |
Required: |
Polymorphic Schema
The polymorphic schema describe how the object is serialized and deserialized by the Web API pipeline.
Some properties are "native", and have a single serialization format.
Some properties are "polymorphic", and can be serialized/deserialized using multiple formats (known as "styles")