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 |
|---|---|---|
| alarmId | native | Alarm Id |
| appointmentId | native | Appointment Id |
| byDay | native | By Day |
| byMonth | native | By Month |
| byMonthDay | native | By Month Day |
| byWeekNo | native | By Week No |
| byYearDay | native | By Year Day |
| clientMessage | native | Client Message |
| count | native | |
| exceptionDates | native | Exception Dates |
| flowId | native | Flow Id |
| frequency | polymorphic | |
| id | native | |
| interval | native | |
| jobOrderTaskId | native | Job Order Task Id |
| until | native |
alarmId
Alarm 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 | AlarmId |
| Physical property type | long? |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | YES |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
appointmentId
Appointment 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 | AppointmentId |
| Physical property type | long? |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | YES |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
byDay
By Day
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 | ByDay |
| Physical property type | array of IRecurrenceWeekDay |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
byMonth
By Month
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 | ByMonth |
| Physical property type | array of int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
byMonthDay
By Month Day
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 | ByMonthDay |
| Physical property type | array of int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
byWeekNo
By Week No
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 | ByWeekNo |
| Physical property type | array of int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
byYearDay
By Year Day
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 | ByYearDay |
| Physical property type | array of int |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | NO |
| Is Logical Primitive | NO |
| Is Enumerable | YES |
| Is Searchable | NO |
| Is Enum | NO |
clientMessage
Client Message
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 | ClientMessage |
| 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 |
count
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 | Count |
| Physical property type | int? |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | YES |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
exceptionDates
Exception Dates
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.
flowId
Flow 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 | FlowId |
| Physical property type | long? |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | YES |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
frequency
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 | Frequency |
| Physical property type | RecurrenceFrequencyType |
| 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'
For more details about using the polymorphic properties, please refer to the general guide on the options
Crm-RecurrenceFrequencyTypeEnumStyle
Crm-RecurrenceFrequencyTypeEnumStyle: AdaptiveInteger
| Style name | Serialized as |
|---|---|
| AdaptiveInteger | int |
| AdaptiveString | string |
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.
| Name | Value |
|---|---|
| Physical property name | Id |
| 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 |
interval
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 | Interval |
| 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 |
jobOrderTaskId
Job Order Task 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 | JobOrderTaskId |
| Physical property type | long? |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | YES |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| Is Searchable | NO |
| Is Enum | NO |
until
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 | Until |
| Physical property type | DateTime? |
| Is Required | NO |
| Is Polymorphic | NO |
| Is Nullable | YES |
| Is Logical Primitive | YES |
| Is Enumerable | NO |
| 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")