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 value of the address |
| branch | native | Codice sede The branch name of the address |
| city | native | Città The city value of the address |
| companyName | native | Ragione sociale The company name of the address |
| contactId | native | Referente di sede The contact reference of address |
| createdById | native | Creato da The creator of the entity |
| createdDate | native | Data creazione The creation date for the entity |
| crossId | native | Cross Id |
| crossOtherId | native | Indirizzo da altra azienda Cross Other Id |
| crossOtherType | polymorphic | Cross Other Type |
| crossTypeId | polymorphic | Cross Type Id |
| emails | polymorphic | Indirizzi e-mail The normalization of the emails |
| externalReferences | native | Campi aggiuntivi The external references linked to current object |
| geoLocalization | polymorphic | The geo localization object |
| id | native | |
| lastModifiedById | native | Modificato da The last modified by id |
| lastModifiedDate | native | Data modifica The last modified date |
| legal | native | Sede legale If the address is a Legal type |
| ownerId | polymorphic | Proprietario The owner of the entity |
| phones | polymorphic | Numeri di telefono The normalization of the phones |
| province | native | Provincia The province value of the address |
| region | native | Regione The region value of the address |
| salesPersons | polymorphic | Commerciale The sale persons of the address and of the location |
| state | native | Nazione The state value of the address |
| tags | polymorphic | |
| zipCode | native | CAP The zipcode value of the address |
address
Indirizzo
The address value of the address
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à.
branch
Codice sede
The branch name of the address
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à.
city
Città
The city value of the address
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à.
companyName
Ragione sociale
The company name of the address
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à.
contactId
Referente di sede
The contact reference of address
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 | ContactId |
| Physical property type | long |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
| Foreign Key |
|
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à.
crossId
Cross 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 | CrossId |
| 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 |
crossOtherId
Indirizzo da altra azienda
Cross Other 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 | CrossOtherId |
| Physical property type | long |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
| Foreign Key |
|
crossOtherType
Cross Other Type
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 | CrossOtherType |
| Physical property type | CrossType |
| Is Required | NO |
| Is Polymorphic | YES |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | YES |
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-CrossTypeEnumStyle: AdaptiveInteger
| Style name | Serialized as |
|---|---|
| AdaptiveInteger | int |
| AdaptiveString | string |
crossTypeId
Cross Type 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 | CrossTypeId |
| Physical property type | CrossType |
| Is Required | NO |
| Is Polymorphic | YES |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | YES |
Polymorphic styles for version 'v1'
Per ulteriori dettagli sull'utilizzo delle proprietà polimorfiche, fare riferimento alla guida generale sulle opzioni
Crm-CrossTypeEnumStyle: AdaptiveInteger
| Style name | Serialized as |
|---|---|
| AdaptiveInteger | int |
| AdaptiveString | string |
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 |
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 |
id
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à.
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à.
legal
Sede legale
If the address is a Legal type
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 | Legal |
| 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
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 |
province
Provincia
The province value of the address
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à.
region
Regione
The region value of the address
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 sale persons of the address and of the location
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 |
state
Nazione
The state value of the address
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à.
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 |
zipCode
CAP
The zipcode value of the address
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 |
|---|---|
| Type | object |
| 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