Muokkaa

Jaa


Recurring Appointment in crmCommon

The Master appointment of a recurring appointment series.

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"1.1"stringsemantic version number of the entity

is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.

ParameterValueData typeExplanation
groupList
attributeGroupReference
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsCreationModificationDatesAndIds
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsOwnershipInfo
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsTimeZoneInfo
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsVersionTracking
/core/wellKnownCDSAttributeGroups.cdm.json
/activityCommon
/core/applicationCommon
/RecurringAppointment.cdm.json
/RecurringAppointment/hasAttributes
/attributesAddedAtThisScope
/core/applicationCommon/foundationCommon
/crmCommon/RecurringAppointment.cdm.json
/RecurringAppointment/hasAttributes
/attributesAddedAtThisScope
entity

is.ordered

ParameterValueData typeExplanation
attribute[RecurringAppointment/(resolvedAttributes)/sortDate](#sortDate)attribute

means.entityState
the attribute represents the current state of the entity.

ParameterValueData typeExplanation
attributeRecurringAppointment/(resolvedAttributes)/stateCodeattribute

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecurring Appointment
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe Master appointment of a recurring appointment series.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"RecurringAppointmentMaster"string

Attributes

Name Description First Included in Instance
createdOn Date and time when the record was created. crmCommon/RecurringAppointment
createdBy Shows who created the record. crmCommon/RecurringAppointment
modifiedOn Date and time when the record was modified. crmCommon/RecurringAppointment
modifiedBy Shows who last updated the record. crmCommon/RecurringAppointment
createdOnBehalfBy Shows who created the record on behalf of another user. crmCommon/RecurringAppointment
modifiedOnBehalfBy Shows who last updated the record on behalf of another user. crmCommon/RecurringAppointment
overriddenCreatedOn Date and time that the record was migrated. crmCommon/RecurringAppointment
importSequenceNumber Unique identifier of the data import or data migration that created this record. crmCommon/RecurringAppointment
ownerId Owner Id crmCommon/RecurringAppointment
ownerIdType The type of owner, either User or Team. crmCommon/RecurringAppointment
owningBusinessUnit Unique identifier for the business unit that owns the record crmCommon/RecurringAppointment
owningUser Unique identifier of the user that owns the activity. crmCommon/RecurringAppointment
owningTeam Unique identifier for the team that owns the record. crmCommon/RecurringAppointment
timeZoneRuleVersionNumber For internal use only. crmCommon/RecurringAppointment
UTCConversionTimeZoneCode Time zone code that was in use when the record was created. crmCommon/RecurringAppointment
versionNumber Version Number crmCommon/RecurringAppointment
activityId Unique identifier of the activity. crmCommon/RecurringAppointment
activityTypeCode Type of activity. crmCommon/RecurringAppointment
isBilled Information regarding whether the fax activity was billed as part of resolving a case. crmCommon/RecurringAppointment
isRegularActivity Information regarding whether the activity is a regular activity type or event type. crmCommon/RecurringAppointment
isWorkflowCreated Information regarding whether the activity was created from a workflow rule. crmCommon/RecurringAppointment
priorityCode Priority of the activity. crmCommon/RecurringAppointment
priorityCode_display crmCommon/RecurringAppointment
regardingObjectId Unique identifier of the object with which the activity is associated. crmCommon/RecurringAppointment
regardingObjectTypeCode The name of the entity linked by regardingObjectId crmCommon/RecurringAppointment
scheduledEnd Scheduled end time of the activity. crmCommon/RecurringAppointment
scheduledStart Scheduled start time of the activity. crmCommon/RecurringAppointment
sortDate Shows the date and time by which the activities are sorted. crmCommon/RecurringAppointment
subject Subject associated with the activity. crmCommon/RecurringAppointment
category Type a category to identify the activity type, such as lead outreach, customer follow-up, or service alert, to tie the eactivity to a business group or function. crmCommon/RecurringAppointment
subcategory Type a subcategory to identify the activity type and relate the activity to a specific product, sales region, business group, or other function. crmCommon/RecurringAppointment
instanceTypeCode Type of instance of a recurring series. crmCommon/RecurringAppointment
instanceTypeCode_display crmCommon/RecurringAppointment
isMapiPrivate For internal use only. crmCommon/RecurringAppointment
organizer The user who is in charge of coordinating or leading the activity. crmCommon/RecurringAppointment
requiredAttendees Enter the account, contact, lead, user, or other equipment resources that are required to attend the recurring appointment. crmCommon/RecurringAppointment
optionalAttendees Enter the account, contact, lead, user, or other equipment resources that are not needed at the recurring appointment, but can optionally attend. crmCommon/RecurringAppointment
isWeekDayPattern Indicates whether the weekly recurrence pattern is a daily weekday pattern. Valid for weekly recurrence pattern only. crmCommon/RecurringAppointment
ruleId Unique identifier of the recurrence rule that is associated with the recurring appointment series. crmCommon/RecurringAppointment
isNthYearly Indicates whether the recurring appointment series should occur after every N years. Valid for yearly recurrence pattern only. crmCommon/RecurringAppointment
stateCode Shows whether the recurring appointment is open, scheduled, completed, or canceled. Completed and canceled appointments are read-only and can't be edited. crmCommon/RecurringAppointment
stateCode_display crmCommon/RecurringAppointment
groupId Unique identifier of the recurring appointment series for which the recurrence information was updated. crmCommon/RecurringAppointment
lastExpandedInstanceDate Date of last expanded instance of a recurring appointment series. crmCommon/RecurringAppointment
effectiveEndDate Actual end date of the recurring appointment series based on the specified end date and recurrence pattern. crmCommon/RecurringAppointment
patternStartDate Start date of the recurrence range. crmCommon/RecurringAppointment
isRegenerate For internal use only. crmCommon/RecurringAppointment
firstDayOfWeek First day of week for the recurrence pattern. crmCommon/RecurringAppointment
outlookOwnerApptId Unique identifier of the Microsoft Office Outlook recurring appointment series owner that correlates to the PR_OWNER_APPT_ID MAPI property. crmCommon/RecurringAppointment
recurrencePatternType Select the pattern type for the recurring appointment to indicate whether the appointment occurs daily, weekly, monthly, or yearly. crmCommon/RecurringAppointment
recurrencePatternType_display crmCommon/RecurringAppointment
nextExpansionInstanceDate Date of the next expanded instance of a recurring appointment series. crmCommon/RecurringAppointment
expansionStateCode State code to indicate whether the recurring appointment series is expanded fully or partially. crmCommon/RecurringAppointment
expansionStateCode_display crmCommon/RecurringAppointment
patternEndDate End date of the recurrence range. crmCommon/RecurringAppointment
globalObjectId Unique Outlook identifier to correlate recurring appointment series across Exchange mailboxes. crmCommon/RecurringAppointment
effectiveStartDate Actual start date of the recurring appointment series based on the specified start date and recurrence pattern. crmCommon/RecurringAppointment
dayOfMonth The day of the month on which the recurring appointment occurs. crmCommon/RecurringAppointment
statusCode Select the recurring appointment's status. crmCommon/RecurringAppointment
statusCode_display crmCommon/RecurringAppointment
startTime Start time of the recurring appointment series. crmCommon/RecurringAppointment
occurrences Number of appointment occurrences in a recurring appointment series. crmCommon/RecurringAppointment
isAllDayEvent Select whether the recurring appointment is an all-day event to make sure that the required resources are scheduled for the full day. crmCommon/RecurringAppointment
seriesStatus Indicates whether the recurring appointment series is active or inactive. crmCommon/RecurringAppointment
isNthMonthly Indicates whether the recurring appointment series should occur after every N months. Valid for monthly recurrence pattern only. crmCommon/RecurringAppointment
endTime End time of the associated activity. crmCommon/RecurringAppointment
daysOfWeekMask Bitmask that represents the days of the week on which the recurring appointment occurs. crmCommon/RecurringAppointment
description Type additional information to describe the recurring appointment, such as key talking points or objectives. crmCommon/RecurringAppointment
instance Specifies the recurring appointment series to occur on every Nth day of a month. Valid for monthly and yearly recurrence patterns only. crmCommon/RecurringAppointment
instance_display crmCommon/RecurringAppointment
deletedExceptionsList List of deleted instances of the recurring appointment series. crmCommon/RecurringAppointment
interval Number of units of a given recurrence type between occurrences. crmCommon/RecurringAppointment
duration Duration of the recurring appointment series in minutes. crmCommon/RecurringAppointment
monthOfYear Indicates the month of the year for the recurrence pattern. crmCommon/RecurringAppointment
monthOfYear_display crmCommon/RecurringAppointment
location Type the location where the recurring appointment will take place, such as a conference room or customer office. crmCommon/RecurringAppointment
patternEndType Select the type of end date for the recurring appointment, such as no end date or the number of occurrences. crmCommon/RecurringAppointment
patternEndType_display crmCommon/RecurringAppointment
transactionCurrencyId Choose the local currency for the record to make sure budgets are reported in the correct currency. crmCommon/RecurringAppointment
exchangeRate Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency. crmCommon/RecurringAppointment
processId Shows the ID of the process. crmCommon/RecurringAppointment
stageId Shows the ID of the stage. crmCommon/RecurringAppointment
traversedPath For internal use only. crmCommon/RecurringAppointment
isUnsafe For internal use only. crmCommon/RecurringAppointment
serviceId Unique identifier for an associated service. crmCommon/RecurringAppointment

createdOn

Date and time when the record was created.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameCreated On
descriptionDate and time when the record was created.
dataFormatdateTime
isNullabletrue
sourceNamecreatedon

Traits

List of traits for the createdOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated On
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time when the record was created.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdon"string

is.dataFormat.time
is.dataFormat.date

createdBy

Shows who created the record.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameCreated By
descriptionShows who created the record.
dataFormatguid
isNullabletrue
sourceNamecreatedby

Traits

List of traits for the createdBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated By
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows who created the record.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/service/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

modifiedOn

Date and time when the record was modified.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameModified On
descriptionDate and time when the record was modified.
dataFormatdateTime
isNullabletrue
sourceNamemodifiedon

Traits

List of traits for the modifiedOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.modify
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified On
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time when the record was modified.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedon"string

is.dataFormat.time
is.dataFormat.date

modifiedBy

Shows who last updated the record.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameModified By
descriptionShows who last updated the record.
dataFormatguid
isNullabletrue
sourceNamemodifiedby

Traits

List of traits for the modifiedBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified By
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows who last updated the record.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/service/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

createdOnBehalfBy

Shows who created the record on behalf of another user.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameCreated By (Delegate)
descriptionShows who created the record on behalf of another user.
dataFormatguid
isNullabletrue
sourceNamecreatedonbehalfby

Traits

List of traits for the createdOnBehalfBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated By (Delegate)
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows who created the record on behalf of another user.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/service/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdonbehalfby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

modifiedOnBehalfBy

Shows who last updated the record on behalf of another user.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameModified By (Delegate)
descriptionShows who last updated the record on behalf of another user.
dataFormatguid
isNullabletrue
sourceNamemodifiedonbehalfby

Traits

List of traits for the modifiedOnBehalfBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified By (Delegate)
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows who last updated the record on behalf of another user.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/service/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedonbehalfby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

overriddenCreatedOn

Date and time that the record was migrated.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameRecord Created On
descriptionDate and time that the record was migrated.
dataFormatdateTime
isNullabletrue
sourceNameoverriddencreatedon

Traits

List of traits for the overriddenCreatedOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecord Created On
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time that the record was migrated.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"overriddencreatedon"string

is.dataFormat.time
is.dataFormat.date

importSequenceNumber

Unique identifier of the data import or data migration that created this record.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameImport Sequence Number
descriptionUnique identifier of the data import or data migration that created this record.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNameimportsequencenumber

Traits

List of traits for the importSequenceNumber attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enImport Sequence Number
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the data import or data migration that created this record.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"importsequencenumber"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-2147483648"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

ownerId

Owner Id
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameOwner
descriptionOwner Id
dataFormatguid
sourceNameownerid

Traits

List of traits for the ownerId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwner
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwner Id
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/service/User.cdm.json/UsersystemUserId
/core/applicationCommon/Team.cdm.json/TeamteamId
entitya reference to the constant entity holding the list of entity references

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"ownerid"string

is.CDS.owner
contains a User or Team ID

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

ownerIdType

The type of owner, either User or Team.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameOwner Type
descriptionThe type of owner, either User or Team.
dataFormatstring
isReadOnlytrue
sourceNameowneridtype

Traits

List of traits for the ownerIdType attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.entityName
[deprecated] use the standalone 'means.entityName' trait instead.

means.entityName
a string value is the name of a CDM entity.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwner Type
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe type of owner, either User or Team.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.

is.readOnly
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"owneridtype"string

is.CDS.owner
contains a User or Team ID

is.dataFormat.character
is.dataFormat.array

owningBusinessUnit

Unique identifier for the business unit that owns the record
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameOwning Business Unit
descriptionUnique identifier for the business unit that owns the record
dataFormatguid
isNullabletrue
sourceNameowningbusinessunit

Traits

List of traits for the owningBusinessUnit attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwning Business Unit
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier for the business unit that owns the record
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/BusinessUnit.cdm.json/BusinessUnitbusinessUnitId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"owningbusinessunit"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

owningUser

Unique identifier of the user that owns the activity.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameOwning User
descriptionUnique identifier of the user that owns the activity.
dataFormatguid
isNullabletrue
sourceNameowninguser

Traits

List of traits for the owningUser attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwning User
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier for the user that owns the record.
enUnique identifier of the user that owns the activity.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/service/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"owninguser"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

owningTeam

Unique identifier for the team that owns the record.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameOwning Team
descriptionUnique identifier for the team that owns the record.
dataFormatguid
isNullabletrue
sourceNameowningteam

Traits

List of traits for the owningTeam attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwning Team
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier for the team that owns the record.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/Team.cdm.json/TeamteamId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"owningteam"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

timeZoneRuleVersionNumber

For internal use only.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameTime Zone Rule Version Number
descriptionFor internal use only.
dataFormatint32
maximumValue2147483647
minimumValue-1
isNullabletrue
sourceNametimezoneruleversionnumber

Traits

List of traits for the timeZoneRuleVersionNumber attribute are listed below.

is.dataFormat.integer
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTime Zone Rule Version Number
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFor internal use only.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"timezoneruleversionnumber"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-1"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

UTCConversionTimeZoneCode

Time zone code that was in use when the record was created.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameUTC Conversion Time Zone Code
descriptionTime zone code that was in use when the record was created.
dataFormatint32
maximumValue2147483647
minimumValue-1
isNullabletrue
sourceNameutcconversiontimezonecode

Traits

List of traits for the UTCConversionTimeZoneCode attribute are listed below.

is.dataFormat.integer
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUTC Conversion Time Zone Code
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTime zone code that was in use when the record was created.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"utcconversiontimezonecode"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-1"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

versionNumber

Version Number
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameVersion Number
descriptionVersion Number
dataFormatint64
isNullabletrue
sourceNameversionnumber

Traits

List of traits for the versionNumber attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
means.measurement.version
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enVersion Number
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enVersion Number
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"versionnumber"string

is.dataFormat.integer
is.dataFormat.big

activityId

Unique identifier of the activity.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameActivity
descriptionUnique identifier of the activity.
isPrimaryKeytrue
dataFormatguid
sourceNameactivityid

Traits

List of traits for the activityId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.identifiedBy
names a specifc identity attribute to use with an entity

ParameterValueData typeExplanation
attributeRecurringAppointment/(resolvedAttributes)/activityIdattribute

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActivity
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the activity.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferencesempty tableentitya reference to the constant entity holding the list of entity references

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"activityid"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

activityTypeCode

Type of activity.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameActivity Type
descriptionType of activity.
dataFormatstring
isReadOnlytrue
sourceNameactivitytypecode
defaultValue
languageTagdisplayTextattributeValue
enFaxnull
enPhone Callnull
enEmailnull
enLetternull
enAppointmentnull
enTasknull
enRecurring Appointmentnull
enQuick Campaignnull
enCampaign Activitynull
enCampaign Responsenull
enCase Resolutionnull
enService Activitynull
enOpportunity Closenull
enOrder Closenull
enQuote Closenull
enAlert Subscriptionnull
enInvite Redemptionnull
enPortal Commentnull

Traits

List of traits for the activityTypeCode attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.entityName
[deprecated] use the standalone 'means.entityName' trait instead.

means.entityName
a string value is the name of a CDM entity.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActivity Type
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enType of activity.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.

is.readOnly
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"activitytypecode"string

does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enFaxnull
enPhone Callnull
enEmailnull
enLetternull
enAppointmentnull
enTasknull
enRecurring Appointmentnull
enQuick Campaignnull
enCampaign Activitynull
enCampaign Responsenull
enCase Resolutionnull
enService Activitynull
enOpportunity Closenull
enOrder Closenull
enQuote Closenull
enAlert Subscriptionnull
enInvite Redemptionnull
enPortal Commentnull
any

is.dataFormat.character
is.dataFormat.array

isBilled

Information regarding whether the fax activity was billed as part of resolving a case.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameIs Billed
descriptionInformation regarding whether the fax activity was billed as part of resolving a case.
dataFormatboolean
isNullabletrue
sourceNameisbilled

Traits

List of traits for the isBilled attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIs Billed
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInformation regarding whether the activity was billed as part of resolving a case.
enInformation regarding whether the fax activity was billed as part of resolving a case.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isbilled"string

is.dataFormat.boolean

isRegularActivity

Information regarding whether the activity is a regular activity type or event type.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameIs Regular Activity
descriptionInformation regarding whether the activity is a regular activity type or event type.
dataFormatboolean
sourceNameisregularactivity

Traits

List of traits for the isRegularActivity attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIs Regular Activity
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInformation regarding whether the activity is a regular activity type or event type.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isregularactivity"string

is.dataFormat.boolean

isWorkflowCreated

Information regarding whether the activity was created from a workflow rule.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameIs Workflow Created
descriptionInformation regarding whether the activity was created from a workflow rule.
dataFormatboolean
isNullabletrue
sourceNameisworkflowcreated

Traits

List of traits for the isWorkflowCreated attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIs Workflow Created
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInformation regarding whether the activity was created from a workflow rule.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isworkflowcreated"string

is.dataFormat.boolean

priorityCode

Priority of the activity.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNamePriority
descriptionPriority of the activity.
dataFormatint32
isNullabletrue
sourceNameprioritycode
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enLow0
enNormal1
enHigh2

Traits

List of traits for the priorityCode attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enLow0
enNormal1
enHigh2
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPriority
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPriority of the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"prioritycode"string

is.dataFormat.integer

priorityCode_display

First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the priorityCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"priorityCode"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

regardingObjectId

Unique identifier of the object with which the activity is associated.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameRegarding
descriptionUnique identifier of the object with which the activity is associated.
dataFormatguid
isNullabletrue
sourceNameregardingobjectid

Traits

List of traits for the regardingObjectId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRegarding
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the object with which the activity is associated.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/KnowledgeBaseRecord.cdm.json/KnowledgeBaseRecordknowledgeBaseRecordId
/core/applicationCommon/foundationCommon/crmCommon/Account.cdm.json/AccountaccountId
/core/applicationCommon/foundationCommon/crmCommon/Contact.cdm.json/ContactcontactId
/core/applicationCommon/foundationCommon/KnowledgeArticle.cdm.json/KnowledgeArticleknowledgearticleId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"regardingobjectid"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

regardingObjectTypeCode

The name of the entity linked by regardingObjectId
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameRegarding Type
descriptionThe name of the entity linked by regardingObjectId
dataFormatstring
isReadOnlytrue
sourceNameregardingobjecttypecode

Traits

List of traits for the regardingObjectTypeCode attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.entityName
[deprecated] use the standalone 'means.entityName' trait instead.

means.entityName
a string value is the name of a CDM entity.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRegarding Type
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe name of the entity linked by regardingObjectId
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.

is.readOnly
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"regardingobjecttypecode"string

is.dataFormat.character
is.dataFormat.array

scheduledEnd

Scheduled end time of the activity.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameDue Date
descriptionScheduled end time of the activity.
dataFormatdateTime
isNullabletrue
sourceNamescheduledend

Traits

List of traits for the scheduledEnd attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDue Date
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enScheduled end time of the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"scheduledend"string

is.dataFormat.time
is.dataFormat.date

scheduledStart

Scheduled start time of the activity.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameStart Date
descriptionScheduled start time of the activity.
dataFormatdateTime
isNullabletrue
sourceNamescheduledstart

Traits

List of traits for the scheduledStart attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStart Date
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enScheduled start time of the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"scheduledstart"string

is.dataFormat.time
is.dataFormat.date

sortDate

Shows the date and time by which the activities are sorted.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameSort Date
descriptionShows the date and time by which the activities are sorted.
dataFormatdateTime
isNullabletrue
sourceNamesortdate

Traits

List of traits for the sortDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.ordered

ParameterValueData typeExplanation
attribute[RecurringAppointment/(resolvedAttributes)/sortDate](#sortDate)attribute

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSort Date
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows the date and time by which the activities are sorted.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"sortdate"string

is.dataFormat.time
is.dataFormat.date

subject

Subject associated with the activity.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameSubject
descriptionSubject associated with the activity.
dataFormatstring
maximumLength200
isNullabletrue
sourceNamesubject

Traits

List of traits for the subject attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"required"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSubject
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSubject associated with the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"subject"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"200"integer

is.dataFormat.character
is.dataFormat.array

category

Type a category to identify the activity type, such as lead outreach, customer follow-up, or service alert, to tie the eactivity to a business group or function.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameCategory
descriptionType a category to identify the activity type, such as lead outreach, customer follow-up, or service alert, to tie the eactivity to a business group or function.
dataFormatstring
maximumLength250
isNullabletrue
sourceNamecategory

Traits

List of traits for the category attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.category
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCategory
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enType a category to identify the activity type, such as lead outreach, customer follow-up, or service alert, to tie the eactivity to a business group or function.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"category"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"250"integer

is.dataFormat.character
is.dataFormat.array

subcategory

Type a subcategory to identify the activity type and relate the activity to a specific product, sales region, business group, or other function.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameSub-Category
descriptionType a subcategory to identify the activity type and relate the activity to a specific product, sales region, business group, or other function.
dataFormatstring
maximumLength250
isNullabletrue
sourceNamesubcategory

Traits

List of traits for the subcategory attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSub-Category
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enType a subcategory to identify the activity type and relate the activity to a specific product, sales region, business group, or other function.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"subcategory"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"250"integer

is.dataFormat.character
is.dataFormat.array

instanceTypeCode

Type of instance of a recurring series.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameRecurring Instance Type
descriptionType of instance of a recurring series.
dataFormatint32
sourceNameinstancetypecode
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enNot Recurring0
enRecurring Master1
enRecurring Instance2
enRecurring Exception3
enRecurring Future Exception4

Traits

List of traits for the instanceTypeCode attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enNot Recurring0
enRecurring Master1
enRecurring Instance2
enRecurring Exception3
enRecurring Future Exception4
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecurring Instance Type
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enType of instance of a recurring series.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"instancetypecode"string

is.dataFormat.integer

instanceTypeCode_display

First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the instanceTypeCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"instanceTypeCode"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

isMapiPrivate

For internal use only.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameIs Private
descriptionFor internal use only.
dataFormatboolean
isNullabletrue
sourceNameismapiprivate

Traits

List of traits for the isMapiPrivate attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIs Private
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFor internal use only.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"ismapiprivate"string

is.dataFormat.boolean

organizer

The user who is in charge of coordinating or leading the activity.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameOrganizer
descriptionThe user who is in charge of coordinating or leading the activity.
dataFormatguid
isNullabletrue
sourceNameorganizer

Traits

List of traits for the organizer attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.CDS.partyList
contains a link to ActivityParty to identify the set of party members

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOrganizer
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe user who is in charge of coordinating or leading the activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"organizer"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

requiredAttendees

Enter the account, contact, lead, user, or other equipment resources that are required to attend the recurring appointment.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameRequired Attendees
descriptionEnter the account, contact, lead, user, or other equipment resources that are required to attend the recurring appointment.
dataFormatguid
isNullabletrue
sourceNamerequiredattendees

Traits

List of traits for the requiredAttendees attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.CDS.partyList
contains a link to ActivityParty to identify the set of party members

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"multi"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRequired Attendees
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEnter the account, contact, lead, user, or other equipment resources that are required to attend the activity.
enEnter the account, contact, lead, user, or other equipment resources that are required to attend the appointment.
enEnter the account, contact, lead, user, or other equipment resources that are required to attend the recurring appointment.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"requiredattendees"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"53"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

optionalAttendees

Enter the account, contact, lead, user, or other equipment resources that are not needed at the recurring appointment, but can optionally attend.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameOptional Attendees
descriptionEnter the account, contact, lead, user, or other equipment resources that are not needed at the recurring appointment, but can optionally attend.
dataFormatguid
isNullabletrue
sourceNameoptionalattendees

Traits

List of traits for the optionalAttendees attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.CDS.partyList
contains a link to ActivityParty to identify the set of party members

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"multi"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOptional Attendees
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe account, contact, lead, user, or other equipment resources that are not needed at the activity, but can optionally attend.
enEnter the account, contact, lead, user, or other equipment resources that are not needed at the appointment, but can optionally attend.
enEnter the account, contact, lead, user, or other equipment resources that are not needed at the recurring appointment, but can optionally attend.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"optionalattendees"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"10"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

isWeekDayPattern

Indicates whether the weekly recurrence pattern is a daily weekday pattern. Valid for weekly recurrence pattern only.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameEvery Weekday
descriptionIndicates whether the weekly recurrence pattern is a daily weekday pattern. Valid for weekly recurrence pattern only.
dataFormatboolean
sourceNameisweekdaypattern

Traits

List of traits for the isWeekDayPattern attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEvery Weekday
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates whether the weekly recurrence pattern is a daily weekday pattern. Valid for weekly recurrence pattern only.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isweekdaypattern"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"1"integer

is.dataFormat.boolean

ruleId

Unique identifier of the recurrence rule that is associated with the recurring appointment series.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameRecurrence Rule
descriptionUnique identifier of the recurrence rule that is associated with the recurring appointment series.
dataFormatguid
isNullabletrue
sourceNameruleid

Traits

List of traits for the ruleId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecurrence Rule
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the recurrence rule that is associated with the recurring appointment series.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"ruleid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"2"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

isNthYearly

Indicates whether the recurring appointment series should occur after every N years. Valid for yearly recurrence pattern only.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameNth Yearly
descriptionIndicates whether the recurring appointment series should occur after every N years. Valid for yearly recurrence pattern only.
dataFormatboolean
sourceNameisnthyearly

Traits

List of traits for the isNthYearly attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enNth Yearly
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates whether the recurring appointment series should occur after every N years. Valid for yearly recurrence pattern only.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isnthyearly"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"4"integer

is.dataFormat.boolean

stateCode

Shows whether the recurring appointment is open, scheduled, completed, or canceled. Completed and canceled appointments are read-only and can't be edited.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameStatus
descriptionShows whether the recurring appointment is open, scheduled, completed, or canceled. Completed and canceled appointments are read-only and can't be edited.
dataFormatint32
sourceNamestatecode
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enOpen0
enCompleted1
enCanceled2
enScheduled3

Traits

List of traits for the stateCode attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enOpen0
enCompleted1
enCanceled2
enScheduled3
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

means.entityState
the attribute represents the current state of the entity.

ParameterValueData typeExplanation
attributeRecurringAppointment/(resolvedAttributes)/stateCodeattribute

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows whether the recurring appointment is open, scheduled, completed, or canceled. Completed and canceled appointments are read-only and can't be edited.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"statecode"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"5"integer

is.dataFormat.integer

stateCode_display

First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the stateCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"stateCode"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

groupId

Unique identifier of the recurring appointment series for which the recurrence information was updated.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameGroup Id
descriptionUnique identifier of the recurring appointment series for which the recurrence information was updated.
dataFormatguid
isNullabletrue
sourceNamegroupid

Traits

List of traits for the groupId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enGroup Id
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the recurring appointment series for which the recurrence information was updated.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"groupid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"8"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

lastExpandedInstanceDate

Date of last expanded instance of a recurring appointment series.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameLast Expanded Instance Date
descriptionDate of last expanded instance of a recurring appointment series.
dataFormatdateTime
isNullabletrue
sourceNamelastexpandedinstancedate

Traits

List of traits for the lastExpandedInstanceDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLast Expanded Instance Date
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate of last expanded instance of a recurring appointment series.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"lastexpandedinstancedate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"12"integer

is.dataFormat.time
is.dataFormat.date

effectiveEndDate

Actual end date of the recurring appointment series based on the specified end date and recurrence pattern.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameEffective End Date
descriptionActual end date of the recurring appointment series based on the specified end date and recurrence pattern.
dataFormatdateTime
isNullabletrue
sourceNameeffectiveenddate

Traits

List of traits for the effectiveEndDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEffective End Date
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActual end date of the recurring appointment series based on the specified end date and recurrence pattern.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"effectiveenddate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"13"integer

is.dataFormat.time
is.dataFormat.date

patternStartDate

Start date of the recurrence range.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameRecurrence Range Start
descriptionStart date of the recurrence range.
dataFormatdateTime
isNullabletrue
sourceNamepatternstartdate

Traits

List of traits for the patternStartDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"required"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecurrence Range Start
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStart date of the recurrence range.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"patternstartdate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"14"integer

is.dataFormat.time
is.dataFormat.date

isRegenerate

For internal use only.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameRegenerate
descriptionFor internal use only.
dataFormatboolean
sourceNameisregenerate

Traits

List of traits for the isRegenerate attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRegenerate
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFor internal use only.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isregenerate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"17"integer

is.dataFormat.boolean

firstDayOfWeek

First day of week for the recurrence pattern.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameFirst Day Of Week
descriptionFirst day of week for the recurrence pattern.
dataFormatint32
maximumValue6
minimumValue0
isNullabletrue
sourceNamefirstdayofweek

Traits

List of traits for the firstDayOfWeek attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFirst Day Of Week
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFirst day of week for the recurrence pattern.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"firstdayofweek"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"18"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"6"decimal

is.dataFormat.integer

outlookOwnerApptId

Unique identifier of the Microsoft Office Outlook recurring appointment series owner that correlates to the PR_OWNER_APPT_ID MAPI property.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameOutlook Recurring Appointment Master Owner
descriptionUnique identifier of the Microsoft Office Outlook recurring appointment series owner that correlates to the PR_OWNER_APPT_ID MAPI property.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNameoutlookownerapptid

Traits

List of traits for the outlookOwnerApptId attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOutlook Recurring Appointment Master Owner
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the Microsoft Office Outlook recurring appointment series owner that correlates to the PR_OWNER_APPT_ID MAPI property.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"outlookownerapptid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"22"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-2147483648"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

recurrencePatternType

Select the pattern type for the recurring appointment to indicate whether the appointment occurs daily, weekly, monthly, or yearly.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameRecurrence Frequency
descriptionSelect the pattern type for the recurring appointment to indicate whether the appointment occurs daily, weekly, monthly, or yearly.
dataFormatint32
sourceNamerecurrencepatterntype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enDaily0
enWeekly1
enMonthly2
enYearly3

Traits

List of traits for the recurrencePatternType attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enDaily0
enWeekly1
enMonthly2
enYearly3
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecurrence Frequency
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSelect the pattern type for the recurring appointment to indicate whether the appointment occurs daily, weekly, monthly, or yearly.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"recurrencepatterntype"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"23"integer

is.dataFormat.integer

recurrencePatternType_display

First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the recurrencePatternType_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"recurrencePatternType"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

nextExpansionInstanceDate

Date of the next expanded instance of a recurring appointment series.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameNext Expanded Instance Date
descriptionDate of the next expanded instance of a recurring appointment series.
dataFormatdateTime
isNullabletrue
sourceNamenextexpansioninstancedate

Traits

List of traits for the nextExpansionInstanceDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enNext Expanded Instance Date
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate of the next expanded instance of a recurring appointment series.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"nextexpansioninstancedate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"24"integer

is.dataFormat.time
is.dataFormat.date

expansionStateCode

State code to indicate whether the recurring appointment series is expanded fully or partially.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameExpansion State Code
descriptionState code to indicate whether the recurring appointment series is expanded fully or partially.
dataFormatint32
isNullabletrue
sourceNameexpansionstatecode
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enUnexpanded0
enPartial1
enFull2

Traits

List of traits for the expansionStateCode attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enUnexpanded0
enPartial1
enFull2
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enExpansion State Code
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enState code to indicate whether the recurring appointment series is expanded fully or partially.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"expansionstatecode"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"25"integer

is.dataFormat.integer

expansionStateCode_display

First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the expansionStateCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"expansionStateCode"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

patternEndDate

End date of the recurrence range.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameRecurrence Range End
descriptionEnd date of the recurrence range.
dataFormatdateTime
isNullabletrue
sourceNamepatternenddate

Traits

List of traits for the patternEndDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecurrence Range End
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEnd date of the recurrence range.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"patternenddate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"28"integer

is.dataFormat.time
is.dataFormat.date

globalObjectId

Unique Outlook identifier to correlate recurring appointment series across Exchange mailboxes.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameOutlook Recurring Appointment Master
descriptionUnique Outlook identifier to correlate recurring appointment series across Exchange mailboxes.
dataFormatstring
maximumLength300
isNullabletrue
sourceNameglobalobjectid

Traits

List of traits for the globalObjectId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOutlook Recurring Appointment Master
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique Outlook identifier to correlate recurring appointment series across Exchange mailboxes.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"globalobjectid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"30"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"300"integer

is.dataFormat.character
is.dataFormat.array

effectiveStartDate

Actual start date of the recurring appointment series based on the specified start date and recurrence pattern.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameEffective Start Date
descriptionActual start date of the recurring appointment series based on the specified start date and recurrence pattern.
dataFormatdateTime
isNullabletrue
sourceNameeffectivestartdate

Traits

List of traits for the effectiveStartDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEffective Start Date
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActual start date of the recurring appointment series based on the specified start date and recurrence pattern.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"effectivestartdate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"31"integer

is.dataFormat.time
is.dataFormat.date

dayOfMonth

The day of the month on which the recurring appointment occurs.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameDay Of Month
descriptionThe day of the month on which the recurring appointment occurs.
dataFormatint32
maximumValue31
minimumValue1
isNullabletrue
sourceNamedayofmonth

Traits

List of traits for the dayOfMonth attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDay Of Month
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe day of the month on which the recurring appointment occurs.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"dayofmonth"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"33"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"1"decimal
maximumValue"31"decimal

is.dataFormat.integer

statusCode

Select the recurring appointment's status.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameStatus Reason
descriptionSelect the recurring appointment's status.
dataFormatint32
isNullabletrue
sourceNamestatuscode
defaultValue
languageTagdisplayTextattributeValuecorrelatedValue
enFree10
enTentative20
enCompleted31
enCanceled42
enBusy53
enOut of Office63

Traits

List of traits for the statusCode attribute are listed below.

is.dataFormat.integer
is.constrainedList.correlated
the values of an attribute are taken from or looked up from a fixed list of possibilities that represent correlated status

does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValuecorrelatedValue
enFree10
enTentative20
enCompleted31
enCanceled42
enBusy53
enOut of Office63
any

is.correlatedWith
the attribute value is correlated with the sourceAttribute

ParameterValueData typeExplanation
sourceAttribute"stateCode"attributeName

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus Reason
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSelect the recurring appointment's status.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"statuscode"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"34"integer

is.dataFormat.integer

statusCode_display

First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the statusCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"statusCode"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

startTime

Start time of the recurring appointment series.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNamePattern Start Time
descriptionStart time of the recurring appointment series.
dataFormatdateTime
isNullabletrue
sourceNamestarttime

Traits

List of traits for the startTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPattern Start Time
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStart time of the recurring appointment series.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"starttime"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"36"integer

is.dataFormat.time
is.dataFormat.date

occurrences

Number of appointment occurrences in a recurring appointment series.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameOccurrences
descriptionNumber of appointment occurrences in a recurring appointment series.
dataFormatint32
maximumValue999
minimumValue1
isNullabletrue
sourceNameoccurrences

Traits

List of traits for the occurrences attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOccurrences
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enNumber of appointment occurrences in a recurring appointment series.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"occurrences"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"37"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"1"decimal
maximumValue"999"decimal

is.dataFormat.integer

isAllDayEvent

Select whether the recurring appointment is an all-day event to make sure that the required resources are scheduled for the full day.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameAll Day Event
descriptionSelect whether the recurring appointment is an all-day event to make sure that the required resources are scheduled for the full day.
dataFormatboolean
isNullabletrue
sourceNameisalldayevent

Traits

List of traits for the isAllDayEvent attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAll Day Event
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSelect whether the recurring appointment is an all-day event to make sure that the required resources are scheduled for the full day.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isalldayevent"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"40"integer

is.dataFormat.boolean

seriesStatus

Indicates whether the recurring appointment series is active or inactive.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameSeries Status
descriptionIndicates whether the recurring appointment series is active or inactive.
dataFormatboolean
isNullabletrue
sourceNameseriesstatus

Traits

List of traits for the seriesStatus attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSeries Status
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates whether the recurring appointment series is active or inactive.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"seriesstatus"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"41"integer

is.dataFormat.boolean

isNthMonthly

Indicates whether the recurring appointment series should occur after every N months. Valid for monthly recurrence pattern only.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameNth Monthly
descriptionIndicates whether the recurring appointment series should occur after every N months. Valid for monthly recurrence pattern only.
dataFormatboolean
sourceNameisnthmonthly

Traits

List of traits for the isNthMonthly attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enNth Monthly
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates whether the recurring appointment series should occur after every N months. Valid for monthly recurrence pattern only.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isnthmonthly"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"43"integer

is.dataFormat.boolean

endTime

End time of the associated activity.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNamePattern End Time
descriptionEnd time of the associated activity.
dataFormatdateTime
isNullabletrue
sourceNameendtime

Traits

List of traits for the endTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPattern End Time
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEnd time of the associated activity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"endtime"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"46"integer

is.dataFormat.time
is.dataFormat.date

daysOfWeekMask

Bitmask that represents the days of the week on which the recurring appointment occurs.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameDays Of Week Mask
descriptionBitmask that represents the days of the week on which the recurring appointment occurs.
dataFormatint32
maximumValue127
minimumValue1
isNullabletrue
sourceNamedaysofweekmask

Traits

List of traits for the daysOfWeekMask attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDays Of Week Mask
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBitmask that represents the days of the week on which the recurring appointment occurs.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"daysofweekmask"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"48"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"1"decimal
maximumValue"127"decimal

is.dataFormat.integer

description

Type additional information to describe the recurring appointment, such as key talking points or objectives.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameDescription
descriptionType additional information to describe the recurring appointment, such as key talking points or objectives.
dataFormatstring
maximumLength1048576
isNullabletrue
sourceNamedescription

Traits

List of traits for the description attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDescription
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enType additional information to describe the recurring appointment, such as key talking points or objectives.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"description"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"50"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"1048576"integer

is.dataFormat.character
is.dataFormat.array

instance

Specifies the recurring appointment series to occur on every Nth day of a month. Valid for monthly and yearly recurrence patterns only.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameInstance
descriptionSpecifies the recurring appointment series to occur on every Nth day of a month. Valid for monthly and yearly recurrence patterns only.
dataFormatint32
isNullabletrue
sourceNameinstance
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enFirst1
enSecond2
enThird3
enFourth4
enLast5

Traits

List of traits for the instance attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enFirst1
enSecond2
enThird3
enFourth4
enLast5
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInstance
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSpecifies the recurring appointment series to occur on every Nth day of a month. Valid for monthly and yearly recurrence patterns only.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"instance"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"54"integer

is.dataFormat.integer

instance_display

First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the instance_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"instance"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

deletedExceptionsList

List of deleted instances of the recurring appointment series.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameDeleted Appointments
descriptionList of deleted instances of the recurring appointment series.
dataFormatstring
maximumLength1073741823
isNullabletrue
sourceNamedeletedexceptionslist

Traits

List of traits for the deletedExceptionsList attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDeleted Appointments
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enList of deleted instances of the recurring appointment series.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"deletedexceptionslist"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"55"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"1073741823"integer

is.dataFormat.character
is.dataFormat.array

interval

Number of units of a given recurrence type between occurrences.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameInterval
descriptionNumber of units of a given recurrence type between occurrences.
dataFormatint32
maximumValue1000
minimumValue1
isNullabletrue
sourceNameinterval

Traits

List of traits for the interval attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInterval
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enNumber of units of a given recurrence type between occurrences.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"interval"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"58"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"1"decimal
maximumValue"1000"decimal

is.dataFormat.integer

duration

Duration of the recurring appointment series in minutes.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameDuration
descriptionDuration of the recurring appointment series in minutes.
dataFormatint32
maximumValue2147483647
minimumValue0
isNullabletrue
sourceNameduration

Traits

List of traits for the duration attribute are listed below.

is.dataFormat.integer
means.measurement.duration
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDuration
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDuration of the recurring appointment series in minutes.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"duration"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"59"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

monthOfYear

Indicates the month of the year for the recurrence pattern.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameMonth Of Year
descriptionIndicates the month of the year for the recurrence pattern.
dataFormatint32
isNullabletrue
sourceNamemonthofyear
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enInvalid Month Of Year0
enJanuary1
enFebruary2
enMarch3
enApril4
enMay5
enJune6
enJuly7
enAugust8
enSeptember9
enOctober10
enNovember11
enDecember12

Traits

List of traits for the monthOfYear attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enInvalid Month Of Year0
enJanuary1
enFebruary2
enMarch3
enApril4
enMay5
enJune6
enJuly7
enAugust8
enSeptember9
enOctober10
enNovember11
enDecember12
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enMonth Of Year
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates the month of the year for the recurrence pattern.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"monthofyear"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"60"integer

is.dataFormat.integer

monthOfYear_display

First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the monthOfYear_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"monthOfYear"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

location

Type the location where the recurring appointment will take place, such as a conference room or customer office.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameLocation
descriptionType the location where the recurring appointment will take place, such as a conference room or customer office.
dataFormatstring
maximumLength200
isNullabletrue
sourceNamelocation

Traits

List of traits for the location attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLocation
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enType the location where the recurring appointment will take place, such as a conference room or customer office.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"location"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"61"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"200"integer

is.dataFormat.character
is.dataFormat.array

patternEndType

Select the type of end date for the recurring appointment, such as no end date or the number of occurrences.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNamePattern End Type
descriptionSelect the type of end date for the recurring appointment, such as no end date or the number of occurrences.
dataFormatint32
sourceNamepatternendtype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enNo End Date1
enOccurrences2
enPattern End Date3

Traits

List of traits for the patternEndType attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enNo End Date1
enOccurrences2
enPattern End Date3
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPattern End Type
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSelect the type of end date for the recurring appointment, such as no end date or the number of occurrences.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"patternendtype"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"95"integer

is.dataFormat.integer

patternEndType_display

First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the patternEndType_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"patternEndType"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

transactionCurrencyId

Choose the local currency for the record to make sure budgets are reported in the correct currency.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameCurrency
descriptionChoose the local currency for the record to make sure budgets are reported in the correct currency.
dataFormatguid
isNullabletrue
sourceNametransactioncurrencyid

Traits

List of traits for the transactionCurrencyId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCurrency
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enChoose the local currency for the record to make sure budgets are reported in the correct currency.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/Currency.cdm.json/CurrencytransactionCurrencyId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"transactioncurrencyid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"105"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

exchangeRate

Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameExchange Rate
descriptionShows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
dataFormatdecimal
maximumValue100000000000
minimumValue1E-10
isNullabletrue
sourceNameexchangerate

Traits

List of traits for the exchangeRate attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enExchange Rate
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"exchangerate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"107"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"1E-10"decimal
maximumValue"100000000000"decimal

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

processId

Shows the ID of the process.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameProcess
descriptionShows the ID of the process.
dataFormatguid
isNullabletrue
sourceNameprocessid

Traits

List of traits for the processId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enProcess
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows the ID of the process.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"processid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"110"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

stageId

Shows the ID of the stage.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameProcess Stage
descriptionShows the ID of the stage.
dataFormatguid
isNullabletrue
sourceNamestageid

Traits

List of traits for the stageId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enProcess Stage
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows the ID of the stage.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"stageid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"111"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

traversedPath

For internal use only.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameTraversed Path
descriptionFor internal use only.
dataFormatstring
maximumLength1250
isNullabletrue
sourceNametraversedpath

Traits

List of traits for the traversedPath attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTraversed Path
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFor internal use only.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"traversedpath"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"112"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"1250"integer

is.dataFormat.character
is.dataFormat.array

isUnsafe

For internal use only.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameIsUnsafe
descriptionFor internal use only.
dataFormatint32
maximumValue2147483647
minimumValue0
isNullabletrue
sourceNameisunsafe

Traits

List of traits for the isUnsafe attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIsUnsafe
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFor internal use only.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isunsafe"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"115"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

serviceId

Unique identifier for an associated service.
First included in: crmCommon/RecurringAppointment (this entity)

Properties

NameValue
displayNameService
descriptionUnique identifier for an associated service.
dataFormatguid
isNullabletrue
sourceNameserviceid

Traits

List of traits for the serviceId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enService
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier for an associated service.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/service/Service.cdm.json/ServiceserviceId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"serviceid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"10000"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array