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")

NameKindDescription
amount native Ammontare
The amount of opportunity
budget native Obiettivo
The budget of opportunity
category polymorphic Categoria
The category of opportunity
closeDate native Data chiusura
The close date of opportunity
code native Codice
The code of the opportunity
competitors native Concorrenti
The competitors list
createdById native Creato da
The creator of the entity
createdDate native Data creazione
The creation date for the entity
crossId native Cliente
The id of anagraphic on the opportunity
crossName native Cross Name
crossType polymorphic The type of anagraphic on the opportunity
description native Descrizione
The description of the opportunity
expirationDate native Data scadenza fase
The phase expiration date
externalReferences native Campi aggiuntivi
The external references linked to current object
flow native
groups native Gruppi
The groups of the object
id native
lastModifiedById native Modificato da
The last modified by id
lastModifiedDate native Data modifica
The last modified date
lostReason native Motivazione chiusura
Lost Reason
ownerId polymorphic Proprietario
The owner of the entity
partners native Partner
The patners list
phase polymorphic Fase
The phase of opportunity
probability native Probabilità (%)
The probability of opportunity
products native Prodotti
The full products list
referrers native Referenti
The referrers list
status polymorphic Stato
The status of opportunity
tags polymorphic
title native Nome
The title of the opportunity

amount

Ammontare

The amount of opportunity

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à.

NameValue
Physical property nameAmount
Physical property typedecimal
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=amount eq 123.456
Is Enum NO

budget

Obiettivo

The budget of opportunity

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à.

NameValue
Physical property nameBudget
Physical property typedecimal
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=budget eq 123.456
Is Enum NO

category

Categoria

The category of opportunity

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à.

NameValue
Physical property nameCategory
Physical property typelong
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive NO
Is Enumerable NO
Is Searchable YES - OData example: $filter=category 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-OpportunityCategoryStyle

Crm-OpportunityCategoryStyle: AdaptiveDescription

Style nameSerialized as
AdaptiveDescription string
AdaptiveExternalReference string
AdaptiveStringOnlyDescription string
FlattenedExpansion FlattenedExpansionSchema
Id long

closeDate

Data chiusura

The close date of opportunity

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à.

NameValue
Physical property nameCloseDate
Physical property typeDateTime
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=closeDate eq 2019-10-06T23:59:59.999Z
Is Enum NO

code

Codice

The code of the opportunity

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à.

NameValue
Physical property nameCode
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=code eq 'my value'
Is Enum NO
Max chars length50

competitors

Concorrenti

The competitors list

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à.

NameValue
Physical property nameCompetitors
Physical property typearray of OpportunityCompetitorDTO
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

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à.

NameValue
Physical property nameCreatedById
Physical property typeint
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à.

NameValue
Physical property nameCreatedDate
Physical property typeDateTime
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=createdDate eq 2019-10-06T23:59:59.999Z
Is Enum NO

crossId

Cliente

The id of anagraphic on the opportunity

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à.

NameValue
Physical property nameCrossId
Physical property typelong
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=crossId eq 123
Is Enum NO
Foreign Key

crossName

Cross Name

Supporto OData

Questa proprietà è ricercabile tramite OData.

$filter

I valori devono avere una rappresentazione in formato stringa e verranno risolti in base al nome dell'azienda o della persona fisica associata all'opportunità.

$select

La proprietà può essere specificata nel parametro $select

$orderby

La proprietà non può essere specificata nel parametro $orderby

Esempi OData
  • api/latest/Opportunity/Search?$filter=crossName eq 'Rossi Mario'&$select=id,crossName
  • api/latest/Opportunity/Search?$filter=startswith(crossName,'Rossi Mario')&$select=id,crossName
  • api/latest/Opportunity/Search?$filter=endswith(crossName,'Rossi Mario')&$select=id,crossName

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à.

NameValue
Physical property nameCrossName
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable NO
Is Enum NO

crossType

The type of anagraphic on the opportunity

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à.

NameValue
Physical property nameCrossType
Physical property typeBusinessObjectType
Acceptable values
  • [ 0, 1, 2 ]
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=crossType 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-BusinessObjectTypeEnumStyle

Crm-BusinessObjectTypeEnumStyle: AdaptiveInteger

Style nameSerialized as
AdaptiveInteger int
AdaptiveString string

description

Descrizione

The description of the opportunity

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à.

NameValue
Physical property nameDescription
Physical property typestring
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=description eq 'my value'
Is Enum NO
Max chars length3000

expirationDate

Data scadenza fase

The phase 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à.

NameValue
Physical property nameExpirationDate
Physical property typeDateTime?
Is Required NO
Is Polymorphic NO
Is Nullable YES
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=expirationDate eq 2019-10-06T23:59:59.999Z
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à.

NameValue
Physical property nameExternalReferences
Physical property typearray 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

flow

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à.

NameValue
Physical property nameFlow
Physical property typeFlowLinkDTO
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive NO
Is Enumerable NO
Is Searchable NO
Is Enum NO

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à.

NameValue
Physical property nameGroups
Physical property typearray 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

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à.

NameValue
Physical property nameId
Physical property typelong
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=id eq 123
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à.

NameValue
Physical property nameLastModifiedById
Physical property typeint
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à.

NameValue
Physical property nameLastModifiedDate
Physical property typeDateTime
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=lastModifiedDate eq 2019-10-06T23:59:59.999Z
Is Enum NO

lostReason

Motivazione chiusura

Lost 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à.

NameValue
Physical property nameLostReason
Physical property typelong
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=lostReason eq 123
Is Enum NO
Foreign Key

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à.

NameValue
Physical property nameOwnerId
Physical property typeint
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

Crm-OwnerIdStyle: AdaptiveExternalReference

Style nameSerialized as
AdaptiveExternalReference string
AdaptiveStringOnlyUserAccount string
AdaptiveUserAccount string
FlattenedExpansion FlattenedExpansionSchema
Id int
StrictEmail string

partners

Partner

The patners list

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à.

NameValue
Physical property namePartners
Physical property typearray of OpportunityPartnerDTO
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

phase

Fase

The phase of opportunity

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à.

NameValue
Physical property namePhase
Physical property typelong
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive NO
Is Enumerable NO
Is Searchable YES - OData example: $filter=phase 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-OpportunityPhaseStyle

Crm-OpportunityPhaseStyle: AdaptiveDescription

Style nameSerialized as
AdaptiveDescription string
AdaptiveExternalReference string
AdaptiveStringOnlyDescription string
FlattenedExpansion FlattenedExpansionSchema
Id long

probability

Probabilità (%)

The probability of opportunity

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à.

NameValue
Physical property nameProbability
Physical property typebyte
Is Required NO
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=probability eq 123
Is Enum NO

products

Prodotti

The full products list

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à.

NameValue
Physical property nameProducts
Physical property typearray of OpportunityProductDTO
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

referrers

Referenti

The referrers list

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à.

NameValue
Physical property nameReferrers
Physical property typearray of OpportunityReferrerDTO
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

status

Stato

The status of opportunity

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à.

NameValue
Physical property nameStatus
Physical property typeOpportunityStatus
Is Required NO
Is Polymorphic YES
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=status 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-OpportunityStatusEnumStyle

Crm-OpportunityStatusEnumStyle: AdaptiveInteger

Style nameSerialized as
AdaptiveInteger int
AdaptiveString string

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à.

NameValue
Physical property nameTags
Physical property typearray 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

Crm-TagsStyle: AdaptiveCsv

Style nameSerialized as
AdaptiveCsv string
AdaptiveExternalReference string
AdaptiveName string
AdaptiveStringOnlyName string
Csv string
CsvOfIds string
CsvOfNames string
Id int

title

Nome

The title of the opportunity

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à.

NameValue
Physical property nameTitle
Physical property typestring
Is Required YES
Is Polymorphic NO
Is Nullable NO
Is Logical Primitive YES
Is Enumerable NO
Is Searchable YES - OData example: $filter=title eq 'my value'
Is Enum NO
Max chars length50


Schema

La seguente tabella contiene le informazioni principali relative allo schema di questo tipo di dati.

FeatureValue
Typeobject
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