Properties
This table lists the whole set of properties contained into this data type.
Some properties are "native", and have a single serialization format.
Some properties are "polymorphic", and can be serialized/deserialized using multiple formats (known as "styles")
| Name | Kind | Description |
|---|---|---|
| area | native | Area di competenza The area id of the ticket |
| attachments | native | Documenti The attachments of the ticket |
| companyId | native | Azienda del ticket The company id of the ticket |
| contactId | native | Contatto del ticket The contact id of the ticket |
| createdById | native | Creato da The creator of the entity |
| createdDate | native | Data creazione The creation date for the entity |
| crossName | polymorphic | Cross Name |
| description | native | Descrizione The description of the ticket |
| dueDate | native | Data scadenza The ticket due date |
| dueDateTime | native | Due Date Time |
| externalReferences | native | Campi aggiuntivi The external references linked to current object |
| id | native | |
| kbTicketFix | native | The id of the kb question linked to this ticket |
| lastModifiedById | native | Modificato da The last modified by id |
| lastModifiedDate | native | Data modifica The last modified date |
| leadId | native | Lead del ticket The lead id of the ticket |
| mailMessageId | native | Mail Message Id |
| onBehalfOfId | native | Per conto di Ticket created on behalf of |
| openDate | native | Data apertura The date of open of the ticket |
| ownerId | polymorphic | Operatore assegnato The owner of the ticket |
| portalAccount | native | Account di accesso esteso The portal account assigned to this ticket |
| portalVisible | native | Visibile in Portal Portal Visible |
| predefinedTitle | native | The predefined titles |
| priority | native | Priorità The priority of the ticket |
| productId | native | Prodotto the product of the ticket |
| productSerialNumber | native | Numero di serie del prodotto The serial number of the product linked to this ticket |
| replyFromPortal | native | The reply from portal to ticket |
| rollingStockId | native | Parco Macchine The id of the rolling stock linked to ticket |
| shortDescription | native | Oggetto del ticket The object of the ticket |
| slaStatus | native | Stato dello SLA The ticket sla status name |
| status | native | Stato The ticket status |
| tags | polymorphic | |
| ticketId | native | Ticket# The unique identifier of the ticket |
| type | native | Tipo di intervento The type of the ticket |
| workGroupId | native | Gruppo di lavoro The workgroup of the ticket |
area
Area di competenza
The area id of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
attachments
Documenti
The attachments of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | Attachments |
| Physical property type | array of TicketAttachDTO |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
companyId
Azienda del ticket
The company id of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | CompanyId |
| 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=companyId eq 123 |
| Is Enum | NO |
| Foreign Key |
|
contactId
Contatto del ticket
The contact id of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | ContactId |
| 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=contactId eq 123 |
| Is Enum | NO |
| Foreign Key |
|
createdById
Creato da
The creator of the entity
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | CreatedById |
| Physical property type | int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | YES - OData example: $filter=createdById eq 123 |
| Is Enum | NO |
| Foreign Key |
|
createdDate
Data creazione
The creation date for the entity
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
crossName
Cross Name
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | CrossName |
| Physical property type | string |
| Is Required | NO |
| Is Polymorphic | YES |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
Polymorphic styles for version 'v1'
For more details about using the polymorphic properties, please refer to the general guide on the options
Crm-CrossNameStyle: Full
| Style name | Serialized as |
|---|---|
| Full | string |
| None | string |
description
Descrizione
The description of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
dueDate
Data scadenza
The ticket due date
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | DueDate |
| 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 |
dueDateTime
Due Date Time
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
externalReferences
Campi aggiuntivi
The external references linked to current object
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | ExternalReferences |
| Physical property type | array of ExternalReferencesDTO |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
| Max value | -1 |
id
This property contains the primary key of the object inside the system. It can be used to universally identify the record containing all the object's data
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
kbTicketFix
The id of the kb question linked to this ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | KbTicketFix |
| 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 |
lastModifiedById
Modificato da
The last modified by id
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | LastModifiedById |
| Physical property type | int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | YES - OData example: $filter=lastModifiedById eq 123 |
| Is Enum | NO |
| Foreign Key |
|
lastModifiedDate
Data modifica
The last modified date
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
leadId
Lead del ticket
The lead id of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
mailMessageId
Mail Message Id
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
onBehalfOfId
Per conto di
Ticket created on behalf of
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | OnBehalfOfId |
| 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=onBehalfOfId eq 123 |
| Is Enum | NO |
| Foreign Key |
|
openDate
Data apertura
The date of open of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
ownerId
Operatore assegnato
The owner of the ticket
This polymorphic property is a foreign key, and refers to the account ID of the owner of this object.
Multiple serialization styles are available (see the section below).
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | OwnerId |
| Physical property type | int |
| Is Required | NO |
| Is Polymorphic | YES |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | NO |
| Is Searchable | YES - OData example: $filter=ownerId eq 123 |
| Is Enum | NO |
| Foreign Key |
|
Polymorphic styles for version 'v1'
For more details about using the polymorphic properties, please refer to the general guide on the options
Crm-OwnerIdStyle: AdaptiveExternalReference
| Style name | Serialized as |
|---|---|
| AdaptiveExternalReference | string |
| AdaptiveStringOnlyUserAccount | string |
| AdaptiveUserAccount | string |
| FlattenedExpansion | FlattenedExpansionSchema |
| Id | int |
| StrictEmail | string |
portalAccount
Account di accesso esteso
The portal account assigned to this ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
portalVisible
Visibile in Portal
Portal Visible
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | PortalVisible |
| 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 |
predefinedTitle
The predefined titles
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | PredefinedTitle |
| 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 |
priority
Priorità
The priority of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
productId
Prodotto
the product of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
productSerialNumber
Numero di serie del prodotto
The serial number of the product linked to this ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | ProductSerialNumber |
| 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 |
replyFromPortal
The reply from portal to ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | ReplyFromPortal |
| 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 |
rollingStockId
Parco Macchine
The id of the rolling stock linked to ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
shortDescription
Oggetto del ticket
The object of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
slaStatus
Stato dello SLA
The ticket sla status name
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
status
Stato
The ticket status
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
tags
This polymorphic property is an array of tags (textual labels) associated to the object.
For details on using the different serialization/deserialization styles, refer to the section below "Polymorphic styles"
OData searches
You can use this property as a filter condition in an OData expression via the eq operator and the startswith, endswith functions.
Examples:
'eq' -> GET: /api/{version}/Company/Search?$filter=tags eq 'category'
'startswith' -> GET: /api/{version}/Company/Search?$filter=startswith(tags,'te')
'endswith' -> GET: /api/{version}/Company/Search?$filter=endswith(tags,'ro')
Complex example -> GET: /api/{version}/Company/Search?$filter=startswith(tags,'te') or endswith(tags,'ro') &$orderby=id asc&$top=10&$skip=0&$select=id,companyName,billed,tags
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
| Name | Value |
|---|---|
| Physical property name | Tags |
| Physical property type | array of long |
| Is Required | NO |
| Is Polymorphic | YES |
| Is Nullable | NO |
| Is Logical Primitive | YES |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
Polymorphic styles for version 'v1'
For more details about using the polymorphic properties, please refer to the general guide on the options
Crm-TagsStyle: AdaptiveCsv
| Style name | Serialized as |
|---|---|
| AdaptiveCsv | string |
| AdaptiveExternalReference | string |
| AdaptiveName | string |
| AdaptiveStringOnlyName | string |
| Csv | string |
| CsvOfIds | string |
| CsvOfNames | string |
| Id | int |
ticketId
Ticket#
The unique identifier of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
type
Tipo di intervento
The type of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
workGroupId
Gruppo di lavoro
The workgroup of the ticket
For more details about using the properties and customizing their serialization/deserialization, please refer to the general guide on the options
Features
This table contains all the information about to this property features.
Schema
The following table contains the main schema information about this data type.
| Feature | Value |
|---|---|
| Type | object |
| Required: |
Polymorphic Schema
The polymorphic schema describe how the object is serialized and deserialized by the Web API pipeline.
Some properties are "native", and have a single serialization format.
Some properties are "polymorphic", and can be serialized/deserialized using multiple formats (known as "styles")
Free Fields
This Business Object is customizable, and it is therefore possible to define a set of custom fields.
These custom fields are called Free Fields.
Free Fields are user-definable custom fields, and can contain data of various kinds.
Each Free Field has a specific data type (selected during configuration), and on the basis of this type, the field data follow certain validation rules.
For more details about Free Fields, refer to the appropriate section
Free Field and polymorphism
As with many other fields, Free Fields also implement polymorphic serialization capabilities, and it is therefore possible to select multiple serialization/deserialization styles.
For more details, refer to the specific descriptive paragraph on the serialization of the Free Fields
Free Field and OData
Free Fields can be used in OData searches as field selectors ($select criterion).
In order to be able to discriminate them from the other standard fields of the Business Object, it is necessary to specify the prefix "FF_"
Example:
GET: /api/{version}/{controller}/Search?$select=id,FF_MyCustomFreeField1,FF_AnotherFreeField