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 |
|---|---|---|
| budgets | native | Budget The budgets of the template |
| createdById | native | Creato da The creator of the entity |
| createdDate | native | Data creazione The creation date for the entity |
| description | native | Descrizione The description of the template joborder |
| externalReference | polymorphic | External Reference |
| externalReferences | native | Campi aggiuntivi The external references linked to current object |
| id | native | |
| jobOrderTemplate | native | Job Order Template |
| lastModifiedById | native | Modificato da The last modified by id |
| lastModifiedDate | native | Data modifica The last modified date |
| localizings | native | Descrizioni in lingua The localizing strings for current object |
| name | native | Nome The name of the template joborder |
| ownerId | polymorphic | Proprietario The owner of the entity |
| tags | polymorphic | |
| tasksTemplate | native | Interventi The jobOrderTask of the template |
budgets
Budget
The budgets of the template
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 | Budgets |
| Physical property type | array of JobOrderBudgetDTO |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
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.
description
Descrizione
The description of the template joborder
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 | 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
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 | ExternalReference |
| 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-ExternalReferenceStyle: Full
| Style name | Serialized as |
|---|---|
| Full | string |
| None | string |
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.
jobOrderTemplate
Job Order Template
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 | JobOrderTemplate |
| Physical property type | JobOrderDTO |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
| BO Type | JobOrder |
| DTO Type | JobOrderDTO |
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.
localizings
Descrizioni in lingua
The localizing strings for 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 | Localizings |
| Physical property type | array of LocalizingDTO |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
name
Nome
The name of the template joborder
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 | Name |
| 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 |
ownerId
Proprietario
The owner of the entity
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 |
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 |
tasksTemplate
Interventi
The jobOrderTask of the template
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 | TasksTemplate |
| Physical property type | array of JobOrderTaskDTO |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
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")