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 |
|---|---|---|
| code | native | |
| compositionRule | polymorphic | Composition Rule |
| compositionSequence | native | Composition Sequence |
| createdById | native | Creato da The creator of the entity |
| createdDate | native | Data creazione The creation date for the entity |
| defaultValue | native | Default Value |
| description | native | |
| externalReference | native | External Reference |
| externalReferences | native | Campi aggiuntivi The external references linked to current object |
| finalPosition | native | Final Position |
| fractionalSize | native | Fractional Size |
| gridMode | polymorphic | Grid Mode |
| hasDefault | native | Has Default |
| hasGroup | native | Has Group |
| id | native | |
| initialPosition | native | Initial Position |
| inputType | polymorphic | Input Type |
| integerSize | native | Integer Size |
| isMandatory | native | Is Mandatory |
| lastModifiedById | native | Modificato da The last modified by id |
| lastModifiedDate | native | Data modifica The last modified date |
| options | native | |
| ownerId | polymorphic | Proprietario The owner of the entity |
| size | native | |
| tags | polymorphic |
code
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 | Code |
| 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 |
compositionRule
Composition Rule
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 | CompositionRule |
| Physical property type | CatalogVariantComposition |
| 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-CatalogVariantCompositionEnumStyle
Crm-CatalogVariantCompositionEnumStyle: AdaptiveInteger
| Style name | Serialized as |
|---|---|
| AdaptiveInteger | int |
| AdaptiveString | string |
compositionSequence
Composition Sequence
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 | CompositionSequence |
| Physical property type | int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
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à.
defaultValue
Default Value
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 | DefaultValue |
| 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 |
description
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 | Description |
| 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 |
externalReference
External Reference
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 | 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
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 |
finalPosition
Final Position
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 | FinalPosition |
| Physical property type | int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
fractionalSize
Fractional Size
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 | FractionalSize |
| Physical property type | int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
gridMode
Grid Mode
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 | GridMode |
| Physical property type | CatalogVariantGridMode |
| 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-CatalogVariantGridModeEnumStyle
Crm-CatalogVariantGridModeEnumStyle: AdaptiveInteger
| Style name | Serialized as |
|---|---|
| AdaptiveInteger | int |
| AdaptiveString | string |
hasDefault
Has Default
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 | HasDefault |
| 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 |
hasGroup
Has Group
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 | HasGroup |
| 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 |
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à.
initialPosition
Initial Position
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 | InitialPosition |
| Physical property type | int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
inputType
Input 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 | InputType |
| Physical property type | CatalogVariantInputType |
| 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-CatalogVariantInputTypeEnumStyle
Crm-CatalogVariantInputTypeEnumStyle: AdaptiveInteger
| Style name | Serialized as |
|---|---|
| AdaptiveInteger | int |
| AdaptiveString | string |
integerSize
Integer Size
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 | IntegerSize |
| Physical property type | int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
isMandatory
Is Mandatory
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 | IsMandatory |
| 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 |
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à.
options
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 | Options |
| Physical property type | array of CatalogVariantOptionDTO |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| 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 |
size
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 | Size |
| Physical property type | int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
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 |
Schema
La seguente tabella contiene le informazioni principali relative allo schema di questo tipo di dati.
| Feature | Value |
|---|---|
| Complex type | CatalogVariantDTO |
| 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")