Proprietà
Questa tabella elenca l'intero set di proprietà contenute in questo tipo di dati.
Alcune proprietà sono dette "native" e hanno un singolo formato di serializzazione.
Alcune proprietà sono dette "polimorfiche" e possono essere serializzate/deserializzate utilizzando più formati (noti come "stili")
Name | Kind | Description |
---|---|---|
address | native | Indirizzo The address of the entity |
associatedCompany | native | Azienda associata A company linked to this lead |
associatedContact | native | Contatto associato A contact linked to this lead |
birthDay | native | Data di nascita The lead's birthday |
birthPlace | native | Luogo di nascita The lead's birthplace |
boStatus | polymorphic | Stato anagrafica The status of the object |
businessRole | native | Ruolo aziendale The business role |
businessRoles | polymorphic | Ruoli aziendali The business roles of the lead |
categories | polymorphic | Categorie The contact categories |
city | native | Città The city of the entity |
code | native | Codice The custom code of the anagraphic |
commercialZone | polymorphic | Zona The area id of the entity |
companyName | native | Azienda The company name of the lead |
createdById | native | Creato da The creator of the entity |
createdDate | native | Data creazione The creation date for the entity |
customerFrom | native | Cliente da The customer of the anagraphic |
emails | polymorphic | Indirizzi e-mail The normalization of the emails |
estimatedCloseDate | native | Data chiusura The estimated closed date for the lead in small datetime (min 01/01/1910) |
expirationDate | native | Data scadenza fase The status expiration date |
externalReferences | native | Campi aggiuntivi The external references linked to current object |
geoLocalization | polymorphic | The geo localization object |
groups | native | Gruppi The groups of the object |
id | native | The unique id |
industry | polymorphic | Settore The lead's industry |
language | native | Lingua |
lastContact | native | Data ultimo contatto The Customer of the anagraphic |
lastModifiedById | native | Modificato da The last modified by id |
lastModifiedDate | native | Data modifica The last modified date |
leadCurrency | native | Valuta The lead's currency |
lockReason | native | The object lock reason |
name | native | Nome The name of the lead |
nextContact | native | Data prossimo contatto The Customer of the anagraphic |
noContact | native | Non contattare Show if you cannot contact this company |
note | native | The lead's notes |
ownerId | polymorphic | Proprietario The owner of the entity |
phones | polymorphic | Numeri di telefono The normalization of the phones |
photoUrl | native | The photo of the contact |
potentialRevenue | native | Reddito previsto The potential revenue for the lead |
priority | polymorphic | Priorità The priority of the lead |
privacySettings | polymorphic | Privacy Settings |
productInterest | polymorphic | Interesse The lead's product interest |
province | native | Provincia The province of the entity |
rating | polymorphic | Valutazione The cross rating of the lead |
region | native | Regione The province of the entity |
salesPersons | polymorphic | Commerciale The salesPersons Id |
source | polymorphic | Origine The product interested of the lead |
state | native | Nazione The state of the entity |
status | polymorphic | Stato The cross status of the lead |
surname | native | Cognome The surname of the lead |
sync | native | Sync Mobile Indicated if you can synchronize this with outlook |
syncProperties | native | Sync Properties |
tags | polymorphic | |
taxIdentificationNumber | native | Codice fiscale The tax identification number of the entity |
title | native | Titolo The title of the lead |
vatId | native | Partita IVA The vat identification number of the entity |
webSite | native | Sito web The WebSite of the entity |
zipCode | native | CAP The zip code of the entity |
zoneCode | native | Zona The zone's code of the entity |
address
Indirizzo
The address of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
associatedCompany
Azienda associata
A company linked to this lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | AssociatedCompany |
Physical property type | long |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=associatedCompany eq 123 |
Is Enum | NO |
Foreign Key |
|
associatedContact
Contatto associato
A contact linked to this lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | AssociatedContact |
Physical property type | long |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=associatedContact eq 123 |
Is Enum | NO |
Foreign Key |
|
birthDay
Data di nascita
The lead's birthday
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
birthPlace
Luogo di nascita
The lead's birthplace
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
boStatus
Stato anagrafica
The status of the object
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | BoStatus |
Physical property type | AnagraphicStatus |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=boStatus eq 'EnumValue' |
Is Enum | YES |
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-AnagraphicStatusEnumStyle: AdaptiveInteger
Style name | Serialized as |
---|---|
AdaptiveInteger | int |
AdaptiveString | string |
businessRole
Ruolo aziendale
The business role
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
businessRoles
Ruoli aziendali
The business roles of the lead
Supporto OData
Questa proprietà è ricercabile tramite OData.
$filter
I valori devono avere una rappresentazione in formato stringa (il nome del business role).
Gli operatori/funzioni supportati sono:
- eq
- startswith
- endswith
$select
La proprietà può essere specificata nel parametro $select
$orderby
La proprietà non può essere specificata nel parametro $orderby
Esempi OData
- api/latest/Lead/Search?$filter=businessRoles eq 'wifi'&$select=id,name,businessRoles
- api/latest/Lead/Search?$filter=startswith(businessRoles,'wifi')&$select=id,name,businessRoles
- api/latest/Lead/Search?$filter=endswith(businessRoles,'wifi')&$select=id,name,businessRoles
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-BusinessRolesStyle: AdaptiveCsv
Style name | Serialized as |
---|---|
AdaptiveCsv | string |
AdaptiveExternalReference | string |
AdaptiveName | string |
AdaptiveStringOnlyName | string |
Csv | string |
CsvOfIds | string |
CsvOfNames | string |
Id | int |
categories
Categorie
The contact categories
Supporto OData
Questa proprietà è ricercabile tramite OData.
$filter
I valori devono avere una rappresentazione in formato stringa (la descrizione della categoria).
Gli operatori/funzioni supportati sono:
- eq
- startswith
- endswith
$select
La proprietà può essere specificata nel parametro $select
$orderby
La proprietà non può essere specificata nel parametro $orderby
Esempi OData
- api/latest/Lead/Search?$filter=categories eq 'wifi'&$select=id,name,categories
- api/latest/Lead/Search?$filter=startswith(categories,'wifi')&$select=id,name,categories
- api/latest/Lead/Search?$filter=endswith(categories,'wifi')&$select=id,name,categories
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | Categories |
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'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-LeadCategoriesStyle: AdaptiveCsv
Style name | Serialized as |
---|---|
AdaptiveCsv | string |
AdaptiveExternalReference | string |
AdaptiveName | string |
AdaptiveStringOnlyName | string |
CsvOfIds | string |
CsvOfNames | string |
Id | long |
city
Città
The city of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
code
Codice
The custom code of the anagraphic
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
commercialZone
Zona
The area id of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-CommercialZoneStyle: AdaptiveCode
Style name | Serialized as |
---|---|
AdaptiveCode | string |
AdaptiveDescription | string |
AdaptiveExternalReference | string |
AdaptiveStringOnlyCode | string |
AdaptiveStringOnlyDescription | string |
Id | int |
companyName
Azienda
The company name of the lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
createdById
Creato da
The creator of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
customerFrom
Cliente da
The customer of the anagraphic
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
emails
Indirizzi e-mail
The normalization of the emails
Questa è una proprietà polimorfica, e contiene un array di indirizzi emails.
Per dettagli relativi all'utilizzo dei diversi stili di serializzazione/deserializzazione, fare riferimento alla sezione a seguire "Polymorphic styles"
Ricerche OData
E' possibile utilizzare questa proprietà sia come filtro (criterio $filter), sia come selettore di campo (criterio $select) in una espressione OData
Di seguito alcuni esempi:
'eq' -> GET: /api/{version}/Company/Search?$filter=emails eq 'my@email.com'
'startswith' -> GET: /api/{version}/Company/Search?$filter=startswith(emails,'te')
'endswith' -> GET: /api/{version}/Company/Search?$filter=endswith(emails,'ro')
Esempio complesso -> GET: /api/{version}/Company/Search?$filter=startswith(emails,'te') or endswith(emails,'ro') &$orderby=id asc&$top=10&$skip=0&$select=id,companyName,billed,emails
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | NormalizeEMail |
Physical property type | array of NormalizeEMailDTO |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | YES |
Is Searchable | NO |
Is Enum | NO |
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-EmailStyle: Compact
Style name | Serialized as |
---|---|
Compact | CompactItem |
Csv | string |
FlattenedExpansion | FlattenedExpansionSchema |
Full | EMailNormalizedDTO |
Tiny | TinyItem |
ValueOnly | string |
estimatedCloseDate
Data chiusura
The estimated closed date for the lead in small datetime (min 01/01/1910)
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
expirationDate
Data scadenza fase
The status expiration date
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
externalReferences
Campi aggiuntivi
The external references linked to current object
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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 |
geoLocalization
The geo localization object
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | GeoLocalization |
Physical property type | GeoDTO |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | NO |
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-GeoLocalizationStyle: Full
Style name | Serialized as |
---|---|
Full | GeoDTO |
GeoJSON | GeoJsonItem |
groups
Gruppi
The groups of the object
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | Groups |
Physical property type | array of long |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | YES |
Is Searchable | NO |
Is Enum | NO |
id
The unique id
L'ID del lead è un intero a 64 bits.
Questa proprietà contiene la chiave primaria dell'oggetto all'interno del sistema. Può essere utilizzato per identificare universalmente il record contenente tutti i dati dell'oggetto
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
industry
Settore
The lead's industry
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | Industry |
Physical property type | long |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=industry eq 123 |
Is Enum | NO |
Foreign Key |
|
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-AnagraphicIndustryIdStyle: AdaptiveDescription
Style name | Serialized as |
---|---|
AdaptiveDescription | string |
AdaptiveStringOnlyDescription | string |
Description | string |
FlattenedExpansion | FlattenedExpansionSchema |
Id | int |
language
Lingua
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
lastContact
Data ultimo contatto
The Customer of the anagraphic
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
lastModifiedById
Modificato da
The last modified by id
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
leadCurrency
Valuta
The lead's currency
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | LeadCurrency |
Physical property type | long |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=leadCurrency eq 123 |
Is Enum | NO |
Foreign Key |
|
lockReason
The object lock reason
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
name
Nome
The name of the lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
nextContact
Data prossimo contatto
The Customer of the anagraphic
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
noContact
Non contattare
Show if you cannot contact this company
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
note
The lead's notes
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
ownerId
Proprietario
The owner of the entity
Questa proprietà polimorfica è una foreign key, e rappresenta il legame con l'utente che fa da "owner" a questo oggetto.
Sono disponibili svariati stili di serializzazione (vedi la sezione a seguire)
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-OwnerIdStyle: AdaptiveExternalReference
Style name | Serialized as |
---|---|
AdaptiveExternalReference | string |
AdaptiveStringOnlyUserAccount | string |
AdaptiveUserAccount | string |
FlattenedExpansion | FlattenedExpansionSchema |
Id | int |
StrictEmail | string |
phones
Numeri di telefono
The normalization of the phones
Questa è una proprietà polimorfica, e contiene un array di numeri telefonici.
Per dettagli relativi all'utilizzo dei diversi stili di serializzazione/deserializzazione, fare riferimento alla sezione a seguire "Polymorphic styles"
Ricerche OData
E' possibile utilizzare questa proprietà sia come filtro (criterio $filter), sia come selettore di campo (criterio $select) in una espressione OData
Di seguito alcuni esempi:
'eq' -> GET: /api/{version}/Company/Search?$filter=phones eq 'my@phone.com'
'startswith' -> GET: /api/{version}/Company/Search?$filter=startswith(phones,'te')
'endswith' -> GET: /api/{version}/Company/Search?$filter=endswith(phones,'ro')
Esempio complesso -> GET: /api/{version}/Company/Search?$filter=startswith(phones,'te') or endswith(phones,'ro') &$orderby=id asc&$top=10&$skip=0&$select=id,companyName,billed,phones
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | NormalizePhone |
Physical property type | array of NormalizePhoneDTO |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | YES |
Is Searchable | NO |
Is Enum | NO |
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-PhoneStyle: Compact
Style name | Serialized as |
---|---|
Compact | CompactItem |
Csv | string |
FlattenedExpansion | FlattenedExpansionSchema |
Full | PhoneNormalizedDTO |
Tiny | TinyItem |
ValueOnly | string |
photoUrl
The photo of the contact
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | PhotoUrl |
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 |
potentialRevenue
Reddito previsto
The potential revenue for the lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
priority
Priorità
The priority of the lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | Priority |
Physical property type | long |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=priority eq 123 |
Is Enum | NO |
Foreign Key |
|
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-LeadPriorityIdStyle: AdaptiveDescription
Style name | Serialized as |
---|---|
AdaptiveDescription | string |
AdaptiveStringOnlyDescription | string |
Description | string |
FlattenedExpansion | FlattenedExpansionSchema |
Id | int |
privacySettings
Privacy Settings
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | PrivacySettings |
Physical property type | array of PrivacyManagementDTO |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | YES |
Is Searchable | NO |
Is Enum | NO |
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-PrivacySettingsStyle: Compact
Style name | Serialized as |
---|---|
Compact | CompactItem |
Full | PrivacyManagementDTO |
productInterest
Interesse
The lead's product interest
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | ProductInterest |
Physical property type | long |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=productInterest eq 123 |
Is Enum | NO |
Foreign Key |
|
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-LeadProductInterestIdStyle
Crm-LeadProductInterestIdStyle: AdaptiveDescription
Style name | Serialized as |
---|---|
AdaptiveDescription | string |
AdaptiveStringOnlyDescription | string |
Description | string |
FlattenedExpansion | FlattenedExpansionSchema |
Id | int |
province
Provincia
The province of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
rating
Valutazione
The cross rating of the lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | Rating |
Physical property type | long |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=rating eq 123 |
Is Enum | NO |
Foreign Key |
|
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-LeadRatingIdStyle: AdaptiveDescription
Style name | Serialized as |
---|---|
AdaptiveDescription | string |
AdaptiveStringOnlyDescription | string |
Description | string |
FlattenedExpansion | FlattenedExpansionSchema |
Id | int |
region
Regione
The province of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
salesPersons
Commerciale
The salesPersons Id
Supporto OData
Questa proprietà è ricercabile tramite OData.
$filter
I valori devono avere rappresentazioni di un numero intero (l'ID dell'account del venditore).
$select
La proprietà può essere specificata nel parametro $select
$orderby
La proprietà non può essere specificata nel parametro $orderby
Esempi OData
- api/latest/Lead/Search?$filter=salesPersons eq 1
- api/latest/Lead/Search?$filter=salesPersons gt 0
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | SalesPersons |
Physical property type | array of int |
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'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-SalesPersonsStyle: AdaptiveCsv
Style name | Serialized as |
---|---|
AdaptiveCsv | string |
AdaptiveExternalReference | string |
AdaptiveStringOnlyUserAccount | string |
AdaptiveUserAccount | string |
Csv | string |
CsvOfIds | string |
CsvOfNames | string |
Id | int |
source
Origine
The product interested of the lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | Source |
Physical property type | long |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=source eq 123 |
Is Enum | NO |
Foreign Key |
|
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-AnagraphicSourceIdStyle: AdaptiveDescription
Style name | Serialized as |
---|---|
AdaptiveDescription | string |
AdaptiveStringOnlyDescription | string |
Description | string |
FlattenedExpansion | FlattenedExpansionSchema |
Id | long |
state
Nazione
The state of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
status
Stato
The cross status of the lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | Status |
Physical property type | long |
Is Required | NO |
Is Polymorphic | YES |
Is Nullable | NO |
Is Logical Primitive | NO |
Is Enumerable | NO |
Is Searchable | YES - OData example: $filter=status eq 123 |
Is Enum | NO |
Foreign Key |
|
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-LeadStatusIdStyle: AdaptiveDescription
Style name | Serialized as |
---|---|
AdaptiveDescription | string |
AdaptiveStringOnlyDescription | string |
Description | string |
FlattenedExpansion | FlattenedExpansionSchema |
Id | int |
surname
Cognome
The surname of the lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
sync
Sync Mobile
Indicated if you can synchronize this with outlook
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
syncProperties
Sync Properties
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Name | Value |
---|---|
Physical property name | SyncProperties |
Physical property type | SyncPropertyFlag |
Is Required | NO |
Is Polymorphic | NO |
Is Nullable | NO |
Is Logical Primitive | YES |
Is Enumerable | NO |
Is Searchable | NO |
Is Enum | YES |
tags
Questa proprietà polimorfica è un array di tags (etichette testuali) associati all'oggetto corrente.
Per dettagli relativi all'utilizzo dei diversi stili di serializzazione/deserializzazione, fare riferimento alla sezione a seguire "Polymorphic styles"
Ricerche OData
E' possibile utilizzare questa proprietà come condizione di filtro in una espressione OData tramite l'operatore eq e le funzioni startswith, endswith
Esempi:
'eq' -> GET: /api/{version}/Company/Search?$filter=tags eq 'categoria'
'startswith' -> GET: /api/{version}/Company/Search?$filter=startswith(tags,'te')
'endswith' -> GET: /api/{version}/Company/Search?$filter=endswith(tags,'ro')
Esempio complesso -> 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
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
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'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-TagsStyle: AdaptiveCsv
Style name | Serialized as |
---|---|
AdaptiveCsv | string |
AdaptiveExternalReference | string |
AdaptiveName | string |
AdaptiveStringOnlyName | string |
Csv | string |
CsvOfIds | string |
CsvOfNames | string |
Id | int |
taxIdentificationNumber
Codice fiscale
The tax identification number of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
title
Titolo
The title of the lead
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
vatId
Partita IVA
The vat identification number of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
webSite
Sito web
The WebSite of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
zipCode
CAP
The zip code of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
zoneCode
Zona
The zone's code of the entity
Per ulteriori dettagli sull'utilizzo delle proprietà e sulla personalizzazione della loro serializzazione/deserializzazione, fare riferimento alla guida generale sulle opzioni
Features
Questa tabella contiene tutte le informazioni relative alle caratteristiche della proprietà.
Schema
La seguente tabella contiene le informazioni principali relative allo schema di questo tipo di dati.
Feature | Value |
---|---|
Complex type | LeadDTO |
Required: |
Schema polimorfico
Lo schema polimorfico descrive come l'oggetto viene serializzato e deserializzato dalla pipeline Web API.
Alcune proprietà sono dette "native" e hanno un singolo formato di serializzazione.
Alcune proprietà sono dette "polimorfiche" e possono essere serializzate/deserializzate utilizzando più formati (noti come "stili")
Free Fields
Questo Business Object è customizzabile, ed è quindi possibile definire un set di campi custom.
Tali campi custom sono detti Free Field.
I Free Field sono campi custom definibili dall'utente, e possono contenere dati di svariata natura.
Ogni Free Field ha un tipo dati specifico (selezionato in fase di configurazione), e sulla base di tale tipo, i dati del campo seguono determinate regole di validazione.
Per maggiori informazioni circa i Free Field, fare riferimento all'apposita sezione
Free Field e polimorfismo
Come per molti altri campi, anche i Free Field godono delle proprietà di polimorfismo, ed è quindi possibile selezionare molteplici stili di serializzazione/deserializzazione.
Per maggiori dettagli, fare riferimento all'apposito paragrafo descrittivo sulla serializzazione dei Free Field
Free Field e OData
I Free Field sono utilizzabili nelle ricerche OData come selettori di campo (criterio $select).
Al fine di poterli discriminare dagli altri campi standard del Business Object, è necessario specificare il prefisso "FF_"
Esempio:
GET: /api/{version}/{controller}/Search?$select=id,FF_MyCustomFreeField1,FF_AnotherFreeField