Oracle Service Cloud Connector Objects

NameDescription
AccountGroupsThe language-specific strings used for localization of fields.
AccountGroupsDescriptionsThe language-specific string used for localization.
AccountGroupsNamesThe language-specific strings used for localization of fields.
AccountsThe account represents a staff member in Oracle B2C Service.
AccountsEmailsThe email address and its associated information.
AccountsPhonesThe details related to the phone number.
AnalyticsReportsThe analytics report definition that provides descriptions of a report's output columns, search criteria, and other components.
AnalyticsReportsFiltersThe filters used for running an analytics report.
AnalyticsReportsNamesThe language-specific strings used for localization of fields.
AnswersThe knowledge base information that provides solutions to the common customer support questions.
AnswersCategoriesThe hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.
AnswersCommonAttachmentsThe file attachment shared by sibling answers.
AnswersCommonAttachmentsNamesThe language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
AnswersFileAttachmentsThe file attachment shared by answers.
AnswersNotesThe note text associated with the objects such as contacts and organizations.
AnswersProductsThe hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.
AnswersRelatedAnswersThe knowledge base information that provides solutions to the common customer support questions.
AnswersSiblingAnswersThe knowledge base information that provides solutions to the common customer support questions.
AnswerVersionsThe versioned instance of an answer. Answers are solutions to common customer support questions.
AnswerVersionsCategoriesThe hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.
AnswerVersionsCommonAttachmentsThe file attachment shared by sibling answers.
AnswerVersionsCommonAttachmentsNamesThe language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
AnswerVersionsFileAttachmentsThe file attachment shared by answers.
AnswerVersionsNotesThe note text associated with the objects such as contacts and organizations.
AnswerVersionsProductsThe hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.
AnswerVersionsRelatedAnswersThe link to related answers.
AssetsThe product or service associated with an organization's customers.
AssetsSLAInstancesThe instance of a Service Level Agreement (SLA).
AssetStatusesThe status of the assets, namely product and services that are registered and tracked in Oracle B2C Service.
AssetStatusesNamesThe language-specific strings used for localization of fields.
CampaignsThe information on email marketing campaigns created in Oracle B2C Service Outreach Cloud Service.
ChannelTypesThe social channels tracked in contact records when storing social account user names and associating social monitor incidents to contacts.
ChannelTypesNamesThe language-specific strings used for localization of fields.
ChatsThe real-time, two-way dialog between a customer and one or more chat agents.
ConfigurationsThe information about the configuration settings within Oracle B2C Service.
ContactMarketingRostersThe information about the contact lists used in audiences in Oracle Service Cloud Outreach Cloud Service.
ContactsThe customers or end users of Oracle B2C Service site.
ContactsChannelUsernamesThe user name of the channel.
ContactsEmailsThe email address and its associated information.
ContactsFileAttachmentsThe file attachment that includes additional fields used for attachments to various classes.
ContactsNotesThe note text associated with the objects such as contacts and organizations.
ContactsOpenIDAccountsThe OpenID related information for the contact.
ContactsPhonesThe details related to the phone number.
CountriesThe details about the countries and provinces which are used to maintain accurate address information for the organizations and contacts in Oracle B2C Service.
CountriesNamesThe language-specific strings used for localization of fields.
CountriesProvincesThe information about the provinces in the Countries/Provinces customizable menu.
CountriesProvincesNamesThe language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
EventSubscriptionsThe event-based subscription management object that allows external applications to discover objects that can be subscribed.
HolidaysThe list of holidays in your organization.
HolidaysAdminVisibleInterfacesThe named ID that can be included in a list.
IncidentsThe question or the request for help submitted by a customer through the Ask a Question page, email, a chat session, site or answer feedback, or from an external source using the API.
IncidentsBilledMinutesThe work time applied to incidents through the Time Billed feature.
IncidentsFileAttachmentsThe file attachment that includes fields specific to incidents.
IncidentsMilestoneInstancesThe milestone instances associated with incidents.
IncidentsThreadsThe incident discussion thread entry.
MailboxesThe mailbox used for collecting email inquiries sent by customers, responses to mailings, and bounced messages.
MarketingMailboxesThe mailbox used to send and receive emails and process bounced messages.
MessageBasesThe editable text string that allows international language support and customization of headings, labels, buttons, and other text in the administration interface and customer portal. It also applies to email messages and notifications.
NamedIDsAn ID which has an associated name string. These IDs can be set by either value or name.
OpportunitiesThe information about a specific sale or a pending deal with a contact or an organization that is tracked and maintained in the Oracle B2C Service knowledge base.
OpportunitiesFileAttachmentsThe file attachment that includes additional fields used for attachments to various classes.
OpportunitiesNotesThe note text associated with the objects such as contacts and organizations.
OpportunitiesOtherContactsThe secondary contact associated with the opportunity.
OpportunitiesQuotesThe sales quote associated with an opportunity.
OpportunitiesQuotesFileAttachmentsThe file that is attached or associated with another object.
OpportunitiesQuotesLineItemsThe product line item in a quote.
OpportunityStatusesThe information about the default and custom opportunity statuses and their corresponding types.
OpportunityStatusesNamesThe language-specific strings used for localization of fields.
OrganizationsThe company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base.
OrganizationsAddressesThe physical address of the organization.
OrganizationsFileAttachmentsThe file attachment that includes additional fields used for attachments to various classes.
OrganizationsNotesThe note text associated with the objects such as contacts and organizations.
PurchasedProductsThe information about a purchased product.
SalesProductsThe items or services sold by an organization.
SalesProductsAdminVisibleInterfacesThe named ID that can be included in a list.
SalesProductsDescriptionsThe language-specific string used for localization.
SalesProductsNamesThe language-specific strings used for localization of fields.
SalesProductsSchedulesThe price schedule for a sales product.
SalesTerritoriesThe specific geographical sales region. Sales representatives can be assigned specific territories for opportunity assignment.
SalesTerritoriesAdminVisibleInterfacesThe named ID that can be included in a list.
SalesTerritoriesNamesThe language-specific strings used for localization of fields.
ServiceCategoriesThe hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.
ServiceCategoriesAdminVisibleInterfacesThe named ID that can be included in a list.
ServiceCategoriesDescriptionsThe language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
ServiceCategoriesEndUserVisibleInterfacesThe named ID that can be included in a list.
ServiceCategoriesNamesThe language-specific strings used for localization of fields.
ServiceCategoriesProductLinksThe product linking for a category or a disposition.
ServiceDispositionsThe hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved.
ServiceDispositionsAdminVisibleInterfacesThe named ID that can be included in a list.
serviceDispositionsDescriptionsThe language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
ServiceDispositionsNamesThe language-specific strings used for localization of fields.
ServiceDispositionsProductLinksThe product linking for a category or a disposition.
ServiceMailboxesThe email box dedicated to collect email inquiries sent by customers.
ServiceProductsThe hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.
ServiceProductsAdminVisibleInterfacesThe named ID that can be included in a list.
ServiceProductsCategoryLinksThe category linking for a product.
ServiceProductsDescriptionsThe language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
ServiceProductsDispositionLinksThe disposition linking for a product.
ServiceProductsEndUserVisibleInterfacesThe named ID that can be included in a list.
ServiceProductsNamesThe language-specific strings used for localization of fields.
SiteInterfacesThe console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base.
StandardContentsThe preformed text or HTML content that can be sent to customers when responding to incidents, appended to responses by a business rule, or sent by an agent during a chat session.
StandardContentsAdminVisibleInterfacesThe named ID that can be included in a list.
StandardContentsContentValuesThe standard content value with a data type and a formatted data value.
TasksThe information about an action or an activity scheduled to be completed within a specified time.
TasksFileAttachmentsThe file attachment that includes additional fields used for attachments to various classes.
TasksNotesThe note text associated with the objects such as contacts and organizations.
VariablesA shortcut defined for a larger string that can be inserted in the body of an answer or inserted inline during a chat session.
VariablesInterfaceValuesThe interface-specific value of a variable.
NameTypeReadOnlyReferencesFilterOnlyDescription
IdLongFalseNoThe unique identifier of the account group .
LookupNameStringFalseNoThe name used to look up the account group.
NameLongFalseNoThe name of the account group in the language of the current interface.
DisplayOrderLongFalseNoThe order in which this account group is displayed relative to other members of the same group.
UpdatedTimeStringFalseNoThe date and time when the account group was last updated.
CreatedTimeStringFalseNoThe date and time when the account group was created
AttributesCustomerCareAccessBooleanFalseNoThe customer care access group.
DescriptionsStringFalseYesThe list of descriptions, one for each supported language.
NamesStringFalseYesThe list of names, one for each supported language.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AccountGroupIdLongFalseNoThe unique identifier of the Account Groups.
LabelTextStringFalseNoThe label text.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AccountGroupIdLongFalseNoThe unique identifier of the Account Groups.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CountryIdLongFalseNoId of country. The default country identifier.
CountrylookUpNameStringFalseNoLookUpName of country. The default country identifier.
CreatedTimeDatetimeTrueNoThe date and time when the account was created. This attribute is read-only.
DisplayNameStringFalseNoThe display name of the account.
DisplayOrderIntFalseNoThe order in which this staff account is displayed relative to other members of the same group.
EmailNotificationIdLongFalseNoId of emailNotification. The format the staff member prefers for email notifications.
EmailNotificationlookUpNameStringFalseNoLookUpName of emailNotification. The format the staff member prefers for email notifications.
Id [KEY]LongTrueNoThe unique identifier of the account.
LoginStringFalseNoThe user name used for authentication.
LookupNameStringTrueNoThe name used to look up the account.
ManagerIdLongFalseNoId of manager. The manager of the staff member.
ManagerlookUpNameStringFalseNoLookUpName of manager. The manager of the staff member.
NewPasswordStringFalseNoThe new password for authentication. It is stored with a one-way encryption in the system. This attribute is write-only.
NotificationPendingBoolTrueNoIndicates whether any notifications are pending. This attribute does not have a default value and is read-only.
PasswordExpirationTimeDatetimeTrueNoThe date and time when the password is set to expire. This attribute is read-only.
ProfileIdLongFalseNoId of profile. The profile to which the staff account is assigned.
ProfilelookUpNameStringFalseNoLookUpName of profile. The profile to which the staff account is assigned.
SignatureStringFalseNoThe email signature of the account.
StaffGroupIdLongFalseNoId of staffGroup. The group to which the staff member is assigned.
StaffGrouplookUpNameStringFalseNoLookUpName of staffGroup. The group to which the staff member is assigned.
UpdatedTimeDatetimeTrueNoThe date and time when the account was last updated. This attribute is read-only.
AttributesaccountLockedBoolFalseNoIndicates whether the account is temporarily locked. For example, you may lock a staff member's account who has taken a leave of absence. An account automatically gets locked if the staff member has exceeded the number of invalid login attempts or if the password has expired. The default value is false.
AttributescanModifyEmailSignatureBoolFalseNoIndicates whether the staff member can modify the email signature. The default value is false.
AttributesforcePasswordChangeBoolFalseNoIndicates whether the staff member must change the password at the next login. The value remains true until the staff member changes the password. The default value is false.
AttributesinfrequentUserBoolFalseNoIndicates whether the staff member is considered as an infrequent user seat, as opposed to a full seat. The default value is false.
AttributespasswordNeverExpiresBoolFalseNoIndicates whether the staff member's account password never expires. This setting overrides system-wide password expiration configurations. The default value is false.
AttributespermanentlyDisabledBoolFalseNoIndicates whether the staff member's account is permanently disabled. For example, an account is permanently disabled when a staff member leaves your organization. A disabled account appears in the tree of the Staff Accounts management console if Show Disabled setting is enabled, but you cannot deselect the Permanently Disable check box if you edit the account. You can reuse the login name of a permanently disabled account for a different account. The default value is false.
AttributesstaffAssignmentDisabledBoolFalseNoIndicates whether the staff member's account cannot be assigned to incidents, answers, opportunities, and tasks. The default value is false.
AttributesviewsReportsDisabledBoolFalseNoIndicates whether the staff member's account cannot be included in the list for filters in reports. The default value is false.
AttributesvirtualAccountBoolTrueNoIndicates whether the staff member's account is virtual. The default value is false. This attribute is read-only.
NamefirstStringFalseNoThe first name of the person.
NamelastStringFalseNoThe surname or last name of the person.
NameFuriganafirstStringFalseNoThe first name of the person.
NameFuriganalastStringFalseNoThe surname or last name of the person.
SalesSettingsdefaultCurrencyIdLongFalseNoId of defaultCurrency. The default currency ID.
SalesSettingsdefaultCurrencylookUpNameStringFalseNoLookUpName of defaultCurrency. The default currency ID.
SalesSettingsterritoryIdLongFalseNoId of territory. The sales territory ID.
SalesSettingsterritorylookUpNameStringFalseNoLookUpName of territory. The sales territory ID.
ServiceSettingsscreenPopPortIntFalseNoThe port number assigned for screen-pop alerts for the staff account. It is used in Citrix and Terminal Services environments where there are multiple agents logged in to different sessions on the same machine.
emailsStringFalseYesThe list of email addresses.
phonesStringFalseYesThe list of phone numbers.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AccountsIdLongFalseNoId of Accounts.
AddressStringFalseNoThe string value of the email address.
AddressTypeIdLongFalseNoId of addressType. The type of address, such as Primary or Alt1. This is the key for the list entry.
AddressTypelookUpNameStringFalseNoLookUpName of addressType. The type of address, such as Primary or Alt1. This is the key for the list entry.
CertificateStringFalseNoThe associated public email certificate used to encrypt outgoing emails.
InvalidBoolFalseNoIndicates whether the email address is disabled.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AccountsIdLongFalseNoId of Accounts.
NumberStringFalseNoThe free-form phone number including non-numeric characters. For example, 1 (406) 522-4200.
PhoneTypeIdLongFalseNoId of phoneType. The type of phone number such as Home, Mobile, Office, and so on. This is the key for the list entry.
PhoneTypelookUpNameStringFalseNoLookUpName of phoneType. The type of phone number such as Home, Mobile, Office, and so on. This is the key for the list entry.
RawNumberStringFalseNoThe automatically populated numeric string derived by excluding the non-numeric characters from the value of the Number attribute. For example, if the Number attribute has a value of 1 (406) 522-4200, this field is populated as 14065224200. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeFalseNoThe date and time when the analytics report was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the analytics report definition.
LookupNameStringFalseNoThe name used to look up the analytics report definition.
NameStringFalseNoThe name of the report in the language of the current interface. This attribute is read-only.
UpdatedTimeDatetimeFalseNoThe date and time when the analytics report was last updated. This attribute is read-only.
columnsStringFalseYesThe columns defined in the report.
filtersStringFalseYesThe filters defined on the report.
namesStringFalseYesThe list of language-specific display names.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnalyticsReportsIdLongFalseNoId of analytics report
NameStringFalseNoName of filter
ValuesStringFalseNoValues of filter

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnalyticsReportsIdLongFalseNoId of AnalyticsReports.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdminLastAccessTimeDatetimeTrueNoThe date and time when the answer was last accessed by an administrator. This attribute is read-only.
AnswerTypeIdLongFalseNoId of answerType. The type of storage for answer information.
AnswerTypelookUpNameStringFalseNoLookUpName of answerType. The type of storage for answer information.
AnswerVersionIdLongTrueNoId of answerVersion. The versioned instance of the answer. This attribute is read-only.
AnswerVersionlookUpNameStringTrueNoLookUpName of answerVersion. The versioned instance of the answer. This attribute is read-only.
AssignedSiblingIdLongFalseNoId of assignedSibling. Another answer with which this answer should be associated.
AssignedSiblinglookUpNameStringFalseNoLookUpName of assignedSibling. Another answer with which this answer should be associated.
CreatedTimeDatetimeTrueNoThe date and time when the answer was created. This attribute is read-only.
ExpiresDateDateFalseNoThe date when the answer expires and is set to review status.
GuidedAssistanceIdLongTrueNoId of guidedAssistance. The Guided Assistance guide.
GuidedAssistancelookUpNameStringTrueNoLookUpName of guidedAssistance. The Guided Assistance guide.
Id [KEY]LongTrueNoThe unique identifier of the answer.
KeywordsStringFalseNoThe list of space separated keywords associated with an answer.
LanguageIdLongFalseNoId of language. The language used for the answer text.
LanguagelookUpNameStringFalseNoLookUpName of language. The language used for the answer text.
LastAccessTimeDatetimeTrueNoThe date and time when the answer was last accessed. This attribute is read-only.
LastNotificationTimeDatetimeTrueNoThe date and time when the last notification was generated. This attribute is read-only.
LookupNameStringTrueNoThe name used to look up the answer.
NameStringTrueNoThe string version of the answer ID, which is used as the reference number of the answer. This attribute is read-only.
NextNotificationTimeDatetimeFalseNoThe date and time when the next earliest notification will be sent.
OriginalReferenceNumberStringFalseNoThe reference number of the incident that was proposed to create this answer. The reference number is common for all the sibling answers.
PositionInListIdLongFalseNoId of positionInList. This attribute is used to initialize and/or force this answer to a particular ranking in the search results.
PositionInListlookUpNameStringFalseNoLookUpName of positionInList. This attribute is used to initialize and/or force this answer to a particular ranking in the search results.
PublishOnDateDateFalseNoThe date when the answer will be published and made available to users.
QuestionStringFalseNoThe question or the description of the answer.
SolutionStringFalseNoThe solution or the answer portion of the answer.
SpecialResponseStringFalseNoThe special response of the answer.
SummaryStringFalseNoThe title or short summary of the answer.
URLStringFalseNoThe URL which returns the answer, if the answer type is URL.
UpdatedByAccountIdLongTrueNoId of updatedByAccount. The staff account who last edited the answer. This attribute is read-only.
UpdatedByAccountlookUpNameStringTrueNoLookUpName of updatedByAccount. The staff account who last edited the answer. This attribute is read-only.
UpdatedTimeDatetimeTrueNoThe date and time when the answer was last updated. This attribute is read-only.
AssignedToaccountIdLongFalseNoId of account. The staff account.
AssignedToaccountlookUpNameStringFalseNoLookUpName of account. The staff account.
AssignedTostaffGroupIdLongFalseNoId of staffGroup. The staff group. The caller should assign the staff group when assigning to an account.
AssignedTostaffGrouplookUpNameStringFalseNoLookUpName of staffGroup. The staff group. The caller should assign the staff group when assigning to an account.
BannerimportanceFlagIdLongFalseNoId of importanceFlag. The importance of the banner.
BannerimportanceFlaglookUpNameStringFalseNoLookUpName of importanceFlag. The importance of the banner.
BannertextStringFalseNoThe description of a flag.
BannerupdatedByAccountIdLongTrueNoId of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedByAccountlookUpNameStringTrueNoLookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedTimeDatetimeTrueNoThe date and time when the banner was last updated. This attribute is read-only.
StatusWithTypestatusIdLongFalseNoId of status. The current status.
StatusWithTypestatuslookUpNameStringFalseNoLookUpName of status. The current status.
StatusWithTypestatusTypeIdLongTrueNoId of statusType. The associated status type. This attribute is read-only.
StatusWithTypestatusTypelookUpNameStringTrueNoLookUpName of statusType. The associated status type. This attribute is read-only.
VersionDetaildraftNoteStringFalseNoThe draft note for the answer version.
VersionDetaildraftTimeDatetimeFalseNoThe date and time when the draft answer version was created.
VersionDetailpublishNoteStringFalseNoThe published note for the answer version.
VersionDetailpublishedTimeDatetimeFalseNoThe date and time when the draft answer version was published.
VersionDetailstateIdLongFalseNoId of state. The state of the version.
VersionDetailstatelookUpNameStringFalseNoLookUpName of state. The state of the version.
VersionDetailunpublishedTimeDatetimeFalseNoThe date and time when the answer version was unpublished.
categoriesStringFalseYesThe hierarchical service category.
commonAttachmentsStringFalseYesThe file attachments common to all sibling answers.
fileAttachmentsStringFalseYesThe list of file attachments.
notesStringFalseYesThe list of discussion threads.
productsStringFalseYesThe products common to all sibling answers.
relatedAnswersStringFalseYesThe related answers linked to this answer.
siblingAnswersStringFalseYesThe sibling answers with which this answer is associated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoriesId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
CategoriesLookUpNameStringFalseNoThe name used to look up the object.
AnswersIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
AnswersLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnswersIdLongFalseNoId of Answers.
ContentTypeStringFalseNoThe MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
CreatedTimeDatetimeFalseNoThe date and time when the file was associated with the answer. This attribute is read-only.
DataStringFalseNoThe Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
DisabledBoolFalseNoIndicates whether the file attachment is hidden when the associated answer is viewed. If the Private flag is not set, this flag hides the file attachment. This attribute does not have a default value.
FileNameStringFalseNoThe name of the file when saving it to the disk.
FormDataStringFalseNo
Id [KEY]LongFalseNoThe unique identifier of the file attachment.
PrivateBoolFalseNoIndicates whether the file attachment is hidden from the end users. This attribute does not have a default value.
SizeIntFalseNoThe size of the file in bytes. This attribute is read-only.
URLStringFalseNoThe URL to access this file.
UpdatedTimeDatetimeFalseNoThe date and time when the file was last updated. This attribute is read-only.
namesStringFalseYesThe list of language specific display names.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnswersIdLongFalseNoId of Answers.
CommonAttachmentsIdLongFalseNoId of CommonAttachments.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnswersIdLongFalseNoId of Answers.
ContentTypeStringFalseNoThe MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
CreatedTimeDatetimeFalseNoThe date and time when the file was associated with the answer. This attribute is read-only.
DataStringFalseNoThe Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
DescriptionStringFalseNoThe description for the contents of the file attachment.
DisabledBoolFalseNoIndicates whether the file attachment should be hidden when the associated answer is viewed. If the Private flag is not set, this flag hides the file attachment. This attribute does not have a default value.
FileNameStringFalseNoThe name of the file when saving it to the disk.
FormDataStringFalseNoThe HTML form which is used to upload file attachments.
Id [KEY]LongFalseNoThe unique identifier of the file attachment.
IndexedBoolFalseNoIndicates whether the file attachment's contents are included in the keyword indexing of the answer. This attribute does not have a default value.
NameStringFalseNoThe short display name of the file attachment.
PrivateBoolFalseNoIndicates whether the file attachment is hidden from the end users. The default value is false.
SizeIntFalseNoThe size of the file in bytes. This attribute is read-only.
URLStringFalseNoThe URL to access the file.
UpdatedTimeDatetimeFalseNoThe date and time when the file was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnswersIdLongFalseNoId of Answers.
ChannelIdLongFalseNoId of channel. The channel through which the note was created.
ChannellookUpNameStringFalseNoLookUpName of channel. The channel through which the note was created.
CreatedByAccountIdLongFalseNoId of createdByAccount. The staff member account that created the note.
CreatedByAccountlookUpNameStringFalseNoLookUpName of createdByAccount. The staff member account that created the note.
CreatedTimeDatetimeFalseNoThe date and time when the note was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the note.
TextStringFalseNoThe text content in the note.
UpdatedByAccountIdLongFalseNoId of updatedByAccount. The staff member account that updated the note.
UpdatedByAccountlookUpNameStringFalseNoLookUpName of updatedByAccount. The staff member account that updated the note.
UpdatedTimeDatetimeFalseNoThe date and time when the note was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ProductsId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
ProductsLookUpNameStringFalseNoThe name used to look up the object.
AnswersIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
AnswersLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnswersIdLongFalseNoId of Answers.
LearnedStrengthIntFalseNoThe relative relatedness of the linked answers.
ManualStrengthIntFalseNoThe static strength of the link.
SimilarityStrengthIntFalseNoThe strength of the link calculated by the link-clustering algorithms based on the content similarity of the answers.
ToAnswerIdLongFalseNoId of toAnswer. The answer to which this answer is linked. It is usually an answer that was viewed after this answer. This is the key for the list entry.
ToAnswerlookUpNameStringFalseNoLookUpName of toAnswer. The answer to which this answer is linked. It is usually an answer that was viewed after this answer. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
SiblingAnswersId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
SiblingAnswersLookUpNameStringFalseNoThe name used to look up the object.
AnswersIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
AnswersLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdminLastAccessTimeDatetimeTrueNoThe date and time when the answer version was last accessed by an administrator. This attribute is read-only.
AnswerIdLongTrueNoId of answer. The live answer related to this answer version.
AnswerlookUpNameStringTrueNoLookUpName of answer. The live answer related to this answer version.
AnswerTypeIdLongFalseNoId of answerType. The type of storage for answer version information.
AnswerTypelookUpNameStringFalseNoLookUpName of answerType. The type of storage for answer version information.
CreatedTimeDatetimeTrueNoThe date and time when the answer version was created. This attribute is read-only.
ExpiresDateDateFalseNoThe date when the answer version expires and is set to review status.
GuidedAssistanceIdLongTrueNoId of guidedAssistance. The Guided Assistance guide.
GuidedAssistancelookUpNameStringTrueNoLookUpName of guidedAssistance. The Guided Assistance guide.
Id [KEY]LongTrueNoThe unique identifier of the answer version.
KeywordsStringFalseNoThe list of space separated keywords associated with an answer version.
LanguageIdLongFalseNoId of language. The language used for the answer text.
LanguagelookUpNameStringFalseNoLookUpName of language. The language used for the answer text.
LastAccessTimeDatetimeTrueNoThe date and time when the answer version was last accessed. This attribute is read-only.
LastNotificationTimeDatetimeTrueNoThe date and time when the last notification was generated. This attribute is read-only.
LookupNameStringTrueNoThe name used to look up the answer version.
NameStringTrueNoThe string version of the answer ID, which is used as the reference number of the answer version. This attribute is read-only.
NextNotificationTimeDatetimeFalseNoThe date and time when the next notification will be sent.
OriginalReferenceNumberStringFalseNoThe reference number of the incident that was proposed to create this answer. The reference number is common for all the sibling answers.
PositionInListIdLongFalseNoId of positionInList. This attribute is used to initialize and/or force this answer to a particular ranking in the search results.
PositionInListlookUpNameStringFalseNoLookUpName of positionInList. This attribute is used to initialize and/or force this answer to a particular ranking in the search results.
PublishOnDateDateFalseNoThe date when the answer version will be published and made available to users.
QuestionStringFalseNoThe question or the description of the answer version.
SolutionStringFalseNoThe solution or the answer portion of this version of the answer.
SpecialResponseStringFalseNoThe special response of this version of the answer.
SummaryStringFalseNoThe title or short summary of the answer version.
URLStringFalseNoThe URL which returns this version of the answer, if the answer type is URL.
UpdatedByAccountIdLongTrueNoId of updatedByAccount. The staff account who last edited the answer version. This attribute is read-only.
UpdatedByAccountlookUpNameStringTrueNoLookUpName of updatedByAccount. The staff account who last edited the answer version. This attribute is read-only.
UpdatedTimeDatetimeTrueNoThe date and time when the answer version was last updated. This attribute is read-only.
AssignedToaccountIdLongFalseNoId of account. The staff account.
AssignedToaccountlookUpNameStringFalseNoLookUpName of account. The staff account.
AssignedTostaffGroupIdLongFalseNoId of staffGroup. The staff group. The caller should assign the staff group when assigning to an account.
AssignedTostaffGrouplookUpNameStringFalseNoLookUpName of staffGroup. The staff group. The caller should assign the staff group when assigning to an account.
BannerimportanceFlagIdLongFalseNoId of importanceFlag. The importance of the banner.
BannerimportanceFlaglookUpNameStringFalseNoLookUpName of importanceFlag. The importance of the banner.
BannertextStringFalseNoThe description of a flag.
BannerupdatedByAccountIdLongTrueNoId of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedByAccountlookUpNameStringTrueNoLookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedTimeDatetimeTrueNoThe date and time when the banner was last updated. This attribute is read-only.
StatusWithTypestatusIdLongFalseNoId of status. The current status.
StatusWithTypestatuslookUpNameStringFalseNoLookUpName of status. The current status.
StatusWithTypestatusTypeIdLongTrueNoId of statusType. The associated status type. This attribute is read-only.
StatusWithTypestatusTypelookUpNameStringTrueNoLookUpName of statusType. The associated status type. This attribute is read-only.
VersionDetaildraftNoteStringFalseNoThe draft note for the answer version.
VersionDetaildraftTimeDatetimeFalseNoThe date and time when the draft answer version was created.
VersionDetailpublishNoteStringFalseNoThe published note for the answer version.
VersionDetailpublishedTimeDatetimeFalseNoThe date and time when the draft answer version was published.
VersionDetailstateIdLongFalseNoId of state. The state of the version.
VersionDetailstatelookUpNameStringFalseNoLookUpName of state. The state of the version.
VersionDetailunpublishedTimeDatetimeFalseNoThe date and time when the answer version was unpublished.
categoriesStringFalseYesThe categories common to all sibling answers.
commonAttachmentsStringFalseYesThe file attachments common to all sibling answers.
fileAttachmentsStringFalseYesThe list of file attachments.
notesStringFalseYesThe list of discussion threads.
productsStringFalseYesThe products common to all sibling answers.
relatedAnswersStringFalseYesThe related answers linked to this answer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CategoriesId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
CategoriesLookUpNameStringFalseNoThe name used to look up the object.
AnswerVersionsIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
AnswerVersionsLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnswerVersionsIdLongFalseNoId of AnswerVersions.
ContentTypeStringFalseNoThe MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
CreatedTimeDatetimeFalseNoThe date and time when the file was associated with the answer. This attribute is read-only.
DataStringFalseNoThe Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
DisabledBoolFalseNoIndicates whether the file attachment is hidden when the associated answer is viewed. If the Private flag is not set, this flag hides the file attachment. This attribute does not have a default value.
FileNameStringFalseNoThe name of the file when saving it to the disk.
FormDataStringFalseNoThe form data.
Id [KEY]LongFalseNoThe unique identifier of the file attachment.
PrivateBoolFalseNoIndicates whether the file attachment is hidden from the end users. This attribute does not have a default value.
SizeIntFalseNoThe size of the file in bytes. This attribute is read-only.
URLStringFalseNoThe URL to access this file.
UpdatedTimeDatetimeFalseNoThe date and time when the file was last updated. This attribute is read-only.
namesStringFalseYesThe list of language specific display names.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnswerVersionsIdLongFalseNoThe Id of AnswerVersions.
CommonAttachmentsIdLongFalseNoThe Id of CommonAttachments.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnswerVersionsIdLongFalseNoThe Id of Answer Version.
ContentTypeStringFalseNoThe MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
CreatedTimeDatetimeFalseNoThe date and time when the file was associated with the answer. This attribute is read-only.
DataStringFalseNoThe Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
DescriptionStringFalseNoThe description for the contents of the file attachment.
DisabledBoolFalseNoIndicates whether the file attachment should be hidden when the associated answer is viewed. If the Private flag is not set, this flag hides the file attachment. This attribute does not have a default value.
FileNameStringFalseNoThe name of the file when saving it to the disk.
FormDataStringFalseNoThe HTML form which is used to upload file attachments.
Id [KEY]LongFalseNoThe unique identifier of the file attachment.
IndexedBoolFalseNoIndicates whether the file attachment's contents are included in the keyword indexing of the answer. This attribute does not have a default value.
NameStringFalseNoThe short display name of the file attachment.
PrivateBoolFalseNoIndicates whether the file attachment is hidden from the end users. The default value is false.
SizeIntFalseNoThe size of the file in bytes. This attribute is read-only.
URLStringFalseNoThe URL to access the file.
UpdatedTimeDatetimeFalseNoThe date and time when the file was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnswerVersionsIdLongFalseNoId of the answer version.
ChannelIdLongFalseNoId of channel. The channel through which the note was created.
ChannellookUpNameStringFalseNoLookUpName of channel. The channel through which the note was created.
CreatedByAccountIdLongFalseNoId of createdByAccount. The staff member account that created the note.
CreatedByAccountlookUpNameStringFalseNoLookUpName of createdByAccount. The staff member account that created the note.
CreatedTimeDatetimeFalseNoThe date and time when the note was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the note.
TextStringFalseNoThe text content in the note.
UpdatedByAccountIdLongFalseNoId of updatedByAccount. The staff member account that updated the note.
UpdatedByAccountlookUpNameStringFalseNoLookUpName of updatedByAccount. The staff member account that updated the note.
UpdatedTimeDatetimeFalseNoThe date and time when the note was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ProductsId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
ProductsLookUpNameStringFalseNoThe name used to look up the object.
AnswerVersionsIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
AnswerVersionsLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AnswerVersionsIdLongFalseNoThe unique identifier of the answer version.
LearnedStrengthIntFalseNoThe relative relatedness of the linked answers.
ManualStrengthIntFalseNoThe static strength of the link.
SimilarityStrengthIntFalseNoThe strength of the link calculated by the link-clustering algorithms based on the content similarity of the answers.
ToAnswerIdLongFalseNoId of toAnswer. The answer to which this answer is linked. It is usually an answer that was viewed after this answer. This is the key for the list entry.
ToAnswerlookUpNameStringFalseNoLookUpName of toAnswer. The answer to which this answer is linked. It is usually an answer that was viewed after this answer. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContactIdLongFalseNoId of contact. The contact associated with the asset.
ContactlookUpNameStringFalseNoLookUpName of contact. The contact associated with the asset.
CreatedTimeDatetimeTrueNoThe date and time when the asset was created. This attribute is read-only.
DescriptionStringFalseNoThe description of the asset.
Id [KEY]LongTrueNoThe unique identifier of the asset.
InstalledDateDateFalseNoThe date when the asset was installed.
LookupNameStringTrueNoThe name used to look up the asset.
NameStringFalseNoThe name of the asset used as the lookupName for the asset object.
OrganizationIdLongFalseNoId of organization. The organization associated with the asset.
OrganizationlookUpNameStringFalseNoLookUpName of organization. The organization associated with the asset.
ProductIdLongFalseNoId of product. The product associated with the asset.
ProductlookUpNameStringFalseNoLookUpName of product. The product associated with the asset.
PurchasedDateDateFalseNoThe date when the asset was purchased.
RetiredDateDateFalseNoThe date when the asset was retired.
SerialNumberStringFalseNoThe serial number of the asset.
UpdatedTimeDatetimeTrueNoThe date and time when the asset was last updated. This attribute is read-only.
PricecurrencyIdLongFalseNoId of currency. The ID of the currency.
PricecurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
PriceexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
PriceexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
PricevalueStringFalseNoThe value of the currency.
StatusWithTypestatusIdLongFalseNoId of status. The current status.
StatusWithTypestatuslookUpNameStringFalseNoLookUpName of status. The current status.
StatusWithTypestatusTypeIdLongTrueNoId of statusType. The associated status type. This attribute is read-only.
StatusWithTypestatusTypelookUpNameStringTrueNoLookUpName of statusType. The associated status type. This attribute is read-only.
sLAInstancesStringFalseYesThe SLA instances associated with the asset.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AssetsIdLongFalseNoThe unique identifier of the asset.
ActiveDateDateFalseNoThe date when the instance became active.
ExpireDateDateFalseNoThe date when the instance is scheduled to expire.
Id [KEY]LongFalseNoThe unique identifier of the SLAInstance.
NameOfSLAIdLongFalseNoId of nameOfSLA. The SLA from which the instance was created.
NameOfSLAlookUpNameStringFalseNoLookUpName of nameOfSLA. The SLA from which the instance was created.
RemainingFromCSRIntFalseNoThe number of remaining CSR incidents.
RemainingFromChatIntFalseNoThe number of remaining chat incidents.
RemainingFromEmailIntFalseNoThe number of remaining email incidents.
RemainingFromWebIntFalseNoThe number of remaining web self-service incidents.
RemainingTotalIntFalseNoThe total number of remaining incidents.
SLASetIntFalseNoThe SLA set from which the instance was created.
StateOfSLAIdLongFalseNoId of stateOfSLA. The current state of the SLA. The supported values are Inactive, Active, Expired, or Disabled.
StateOfSLAlookUpNameStringFalseNoLookUpName of stateOfSLA. The current state of the SLA. The supported values are Inactive, Active, Expired, or Disabled.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeFalseNoThe date and time when the asset status was created. This attribute is read-only.
DisplayOrderIntFalseNoThe display position relative to other asset statuses.
Id [KEY]LongFalseNoThe unique identifier of the asset status.
LookupNameStringFalseNoThe name used to look up the asset status.
NameStringFalseNoThe name of the asset status in the language of the current interface.
StatusTypeIdLongFalseNoId of statusType. The type associated with the status.
StatusTypelookUpNameStringFalseNoLookUpName of statusType. The type associated with the status.
UpdatedTimeDatetimeFalseNoThe date and time when the asset status was last updated. This attribute is read-only.
namesStringFalseYesThe list of names, one for each supported language.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AssetStatusesIdLongFalseNoThe unique identifier of the asset statuses version.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ActualLeadsIntFalseNoThe number of actual leads generated from the campaign.
ActualOpportunitiesIntFalseNoThe number of actual opportunities generated from the campaign.
AssignedToAccountIdLongFalseNoId of assignedToAccount. The staff member assigned to the campaign.
AssignedToAccountlookUpNameStringFalseNoLookUpName of assignedToAccount. The staff member assigned to the campaign.
CampaignEndTimeDatetimeFalseNoThe date and time when the campaign ends.
CampaignStartTimeDatetimeFalseNoThe date and time when the campaign begins.
CreatedByAccountIdLongFalseNoId of createdByAccount. The ID number of the staff member who created the campaign.
CreatedByAccountlookUpNameStringFalseNoLookUpName of createdByAccount. The ID number of the staff member who created the campaign.
CreatedTimeDatetimeFalseNoThe date and time when the campaign was created. This attribute is read-only.
ExpectedLeadsIntFalseNoThe number of expected leads generated from the campaign.
ExpectedOpportunitiesIntFalseNoThe number of expected opportunities generated from the campaign.
FlowIdLongFalseNoId of flow. The ID of the flow that the campaign is associated with.
FlowlookUpNameStringFalseNoLookUpName of flow. The ID of the flow that the campaign is associated with.
Id [KEY]LongFalseNoThe unique identifier of the campaign.
InterfaceIdLongFalseNoId of interface. The ID of the interface that the campaign is associated with.
InterfacelookUpNameStringFalseNoLookUpName of interface. The ID of the interface that the campaign is associated with.
IsSingleExecuteBoolFalseNoIndicates whether the contacts are allowed to flow through the recurring campaign only one time. This attribute does not have a default value.
LookupNameStringFalseNoThe name used to look up the campaign.
NameStringFalseNoThe name of the campaign.
ObjectivesSummaryStringFalseNoThe summary of the objectives specified for the campaign.
UpdatedByAccountIdLongFalseNoId of updatedByAccount. The ID of the staff member who last updated the campaign.
UpdatedByAccountlookUpNameStringFalseNoLookUpName of updatedByAccount. The ID of the staff member who last updated the campaign.
UpdatedTimeDatetimeFalseNoThe date and time when the campaign was last updated. This attribute is read-only.
ActualCostcurrencyIdLongFalseNoId of currency. The ID of the currency.
ActualCostcurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
ActualCostexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ActualCostexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ActualCostvalueStringFalseNoThe value of the currency.
ActualSalescurrencyIdLongFalseNoId of currency. The ID of the currency.
ActualSalescurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
ActualSalesexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ActualSalesexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ActualSalesvalueStringFalseNoThe value of the currency.
BudgetcurrencyIdLongFalseNoId of currency. The ID of the currency.
BudgetcurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
BudgetexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
BudgetexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
BudgetvalueStringFalseNoThe value of the currency.
ExpectedCostcurrencyIdLongFalseNoId of currency. The ID of the currency.
ExpectedCostcurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
ExpectedCostexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ExpectedCostexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ExpectedCostvalueStringFalseNoThe value of the currency.
ExpectedSalescurrencyIdLongFalseNoId of currency. The ID of the currency.
ExpectedSalescurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
ExpectedSalesexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ExpectedSalesexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ExpectedSalesvalueStringFalseNoThe value of the currency.
FolderidLongFalseNoID value
FolderlookupNameStringFalseNoName used to lookup this object

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContactVisibilityBoolFalseNoIndicates whether the channel is available in the ChannelUsername collection. This attribute does not have a default value and is read-only.
CreatedTimeDatetimeFalseNoThe date and time when the channel type was created. This attribute is read-only.
DisplayOrderIntFalseNoThe position of the channel type in the list of channels.
Id [KEY]LongFalseNoThe unique identifier of the channel type.
LookupNameStringFalseNoThe name used to look up the channel type.
NameStringFalseNoThe name of the channel type in the language of the current interface. This attribute is read-only.
UpdatedTimeDatetimeFalseNoThe date and time when the channel type was last updated. This attribute is read-only.
AttributescontactVisibilityBoolFalseNoIndicates whether the channel is visible to contacts. This attribute does not have a default value.
AttributesincomingBoolFalseNoIndicates whether it is an incoming channel. This attribute does not have a default value.
AttributesmonitoringBoolFalseNoIndicates whether it is a monitoring channel. This attribute does not have a default value.
AttributesoutgoingBoolFalseNoIndicates whether it is an outgoing channel. This attribute does not have a default value.
AttributessubscriptionBoolFalseNoIndicates whether it is a subscription channel. This attribute does not have a default value.
namesStringFalseYesThe list of names, one for each supported language.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ChannelTypesIdLongFalseNoThe unique identifier of the channel type.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeFalseNoThe date and time when the chat was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the chat.
LookupNameStringFalseNoThe name used to look up the chat.
QuestionStringFalseNoThe question that is used as the lookupName for the chat object.
UpdatedTimeDatetimeFalseNoThe date and time when the chat was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeFalseNoThe date and time when the configuration was created. This attribute is read-only.
DataTypeIdLongFalseNoId of dataType. The type of data that the configuration represents.
DataTypelookUpNameStringFalseNoLookUpName of dataType. The type of data that the configuration represents.
Id [KEY]LongFalseNoThe unique identifier of the configuration.
LookupNameStringFalseNoThe name used to look up the configuration.
NameStringFalseNoThe name of the configuration.
UpdatedTimeDatetimeFalseNoThe date and time when the configuration was last updated. This attribute is read-only.
ValueStringFalseNoThe string value of the configuration. The value is either a site value or the value associated with the interface. The configuration values are stored and fetched from a file cache.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CommentStringFalseNoThe description associated with the contact marketing roster.
CreatedByAccountIdLongTrueNoId of createdByAccount. The staff account who created the list.
CreatedByAccountlookUpNameStringTrueNoLookUpName of createdByAccount. The staff account who created the list.
CreatedTimeDatetimeTrueNoThe date and time when the contact marketing roster was created. This attribute is read-only.
Id [KEY]LongTrueNoThe unique identifier of the contact marketing roster.
InterfaceIdLongTrueNoId of interface. The interface the list is associated with.
InterfacelookUpNameStringTrueNoLookUpName of interface. The interface the list is associated with.
IsProofListBoolFalseNoIndicates whether the contact marketing roster is a proof list.
LookupNameStringTrueNoThe name used to look up the contact marketing roster.
NameStringFalseNoThe name of the contact marketing roster.
PurgeDataBoolFalseNoIndicates whether the contact marketing roster should be cleared periodically. The default value is false.
UpdatedByAccountIdLongTrueNoId of updatedByAccount. The staff account who last updated the list.
UpdatedByAccountlookUpNameStringTrueNoLookUpName of updatedByAccount. The staff account who last updated the list.
UpdatedTimeDatetimeTrueNoThe date and time when the contact marketing roster was last updated. This attribute is read-only.
LastCountStatisticslastCountIntTrueNoThe number of contacts in the contact marketing roster when the count was last calculated.
LastCountStatisticslastCountedTimeDatetimeTrueNoThe date and time when the contact marketing roster was last counted.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContactTypeIdLongFalseNoId of contactType. The ID of the contact type.
ContactTypelookUpNameStringFalseNoLookUpName of contactType. The ID of the contact type.
CreatedTimeDatetimeTrueNoThe date and time when the contact was created. This attribute is read-only.
DisabledBoolFalseNoIndicates whether the contact is disabled. The default value is false.
ExternalReferenceStringTrueNoThe external reference key of the contact.
Id [KEY]LongTrueNoThe unique identifier of the contact.
LoginStringFalseNoThe user name used for authentication.
LookupNameStringTrueNoThe name used to look up the contact.
NewPasswordStringFalseNoThe new password for authentication. It is stored with a one-way encryption in the system. This attribute is write-only.
OrganizationIdLongFalseNoId of organization. The organization to which the contact belongs.
OrganizationlookUpNameStringFalseNoLookUpName of organization. The organization to which the contact belongs.
PasswordEmailExpirationTimeDatetimeTrueNoThe date and time by when the contact must change the password after a reset has occurred. This attribute is read-only.
PasswordExpirationTimeDatetimeTrueNoThe date and time by when the password is set to expire. This attribute is read-only.
SourceIdLongTrueNoId of source. The creation source IDs. This attribute is read-only.
SourcelookUpNameStringTrueNoLookUpName of source. The creation source IDs. This attribute is read-only.
SupersededByIdLongTrueNoId of supersededBy. The superseding contact for the contact. This attribute is read-only.
SupersededBylookUpNameStringTrueNoLookUpName of supersededBy. The superseding contact for the contact. This attribute is read-only.
TitleStringFalseNoThe social or professional title of the contact. For example, Mrs., Dr., and so on.
UpdatedTimeDatetimeTrueNoThe date and time when the contact was last updated. This attribute is read-only.
AddresscityStringFalseNoThe name of the city.
AddresscountryIdLongFalseNoId of country. The ID of the country.
AddresscountrylookUpNameStringFalseNoLookUpName of country. The ID of the country.
AddresspostalCodeStringFalseNoThe postal code or the ZIP code.
AddressstateOrProvinceIdLongFalseNoId of stateOrProvince. The ID of the state or province.
AddressstateOrProvincelookUpNameStringFalseNoLookUpName of stateOrProvince. The ID of the state or province.
AddressstreetStringFalseNoThe street address.
BannerimportanceFlagIdLongFalseNoId of importanceFlag. The importance of the banner.
BannerimportanceFlaglookUpNameStringFalseNoLookUpName of importanceFlag. The importance of the banner.
BannertextStringFalseNoThe description of a flag.
BannerupdatedByAccountIdLongTrueNoId of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedByAccountlookUpNameStringTrueNoLookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedTimeDatetimeTrueNoThe date and time when the banner was last updated. This attribute is read-only.
CRMModulesmarketingBoolFalseNoIndicates whether the marketing module is applicable. The default value is true only if marketing module is enabled.
CRMModulessalesBoolFalseNoIndicates whether the sales module is applicable. The default value is true only if sales module is enabled.
CRMModulesserviceBoolFalseNoIndicates whether the service module is applicable. The default value is true only if service module is enabled.
MarketingSettingsemailFormatIdLongFalseNoId of emailFormat. The ID of preferred format for sending emails to the contact.
MarketingSettingsemailFormatlookUpNameStringFalseNoLookUpName of emailFormat. The ID of preferred format for sending emails to the contact.
MarketingSettingsmarketingOptInBoolFalseNoIndicates whether the contact has opted in for marketing mailing list. This attribute does not have a default value.
MarketingSettingsmarketingOrganizationNameStringFalseNoThe marketing organization name.
MarketingSettingsmarketingOrganizationNameAltStringFalseNoThe alternate name of the marketing organization.
MarketingSettingssurveyOptInBoolFalseNoIndicates whether the contact has opted in for providing feedback. This attribute does not have a default value.
NamefirstStringFalseNoThe first name of the person.
NamelastStringFalseNoThe surname or last name of the person.
NameFuriganafirstStringFalseNoThe first name of the person.
NameFuriganalastStringFalseNoThe surname or last name of the person.
SalesSettingsacquiredDateDateTrueNoThe date when the first opportunity associated with the contact was closed. This attribute is read-only.
SalesSettingssalesAccountIdLongFalseNoId of salesAccount. The ID of the staff account for the sales representative assigned to the contact.
SalesSettingssalesAccountlookUpNameStringFalseNoLookUpName of salesAccount. The ID of the staff account for the sales representative assigned to the contact.
channelUsernamesStringFalseYesThe list of usernames for the contact across different communication channels.
emailsStringFalseYesThe list of email addresses.
fileAttachmentsStringFalseYesThe list of file attachments.
notesStringFalseYesThe list of notes associated with the contact.
openIDAccountsStringFalseYesThe list of OpenID URLs associated with the contact.
phonesStringFalseYesThe list of phone numbers.
contactListsStringFalseYesThe contact lists in which the contact is included.
answerNotificationsStringFalseYesThe answer notifications to which the contact is subscribed.
categoryNotificationsStringFalseYesThe category notifications to which the contact is subscribed.
productNotificationsStringFalseYesThe product notifications to which the contact is subscribed.
sLAInstancesStringFalseYesThe SLA instances associated with the contact. This attribute is read-only for versions 1 and 1.1.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContactsIdLongFalseNoThe unique identifier of the contact.
ChannelTypeIdLongFalseNoId of channelType. The associated communication channel. This is the key for the list entry.
ChannelTypelookUpNameStringFalseNoLookUpName of channelType. The associated communication channel. This is the key for the list entry.
UserNumberStringFalseNoThe user number ID for this communication channel. It is a string with a value between 0 and 9.
UsernameStringFalseNoThe user name for this communication channel.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContactsIdLongFalseNoThe unique identifier of the contact.
AddressStringFalseNoThe string value of the email address.
AddressTypeIdLongFalseNoId of addressType. The type of address, such as Primary or Alt1. This is the key for the list entry.
AddressTypelookUpNameStringFalseNoLookUpName of addressType. The type of address, such as Primary or Alt1. This is the key for the list entry.
CertificateStringFalseNoThe associated public email certificate used to encrypt outgoing emails.
InvalidBoolFalseNoIndicates whether the email address is disabled.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContactsIdLongFalseNoThe unique identifier of the contact.
ContentTypeStringFalseNoThe MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
CreatedTimeDatetimeFalseNoThe date and time when the file was associated with the object. This attribute is read-only.
DataStringFalseNoThe Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
DescriptionStringFalseNoThe description for the contents of the file attachment.
FileNameStringFalseNoThe name of the file when saving it to the disk.
FormDataStringFalseNoThe HTML form which is used to upload file attachments.
Id [KEY]LongFalseNoThe unique identifier of the file attachment.
NameStringFalseNoThe short display name of the file attachment.
SizeIntFalseNoThe size of the file in bytes. This attribute is read-only.
URLStringFalseNoThe URL to access this file.
UpdatedTimeDatetimeFalseNoThe date and time when the file attachment was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContactsIdLongFalseNoThe unique identifier of the contact.
ChannelIdLongFalseNoId of channel. The channel through which the note was created.
ChannellookUpNameStringFalseNoLookUpName of channel. The channel through which the note was created.
CreatedByAccountIdLongFalseNoId of createdByAccount. The staff member account that created the note.
CreatedByAccountlookUpNameStringFalseNoLookUpName of createdByAccount. The staff member account that created the note.
CreatedTimeDatetimeFalseNoThe date and time when the note was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the note.
TextStringFalseNoThe text content in the note.
UpdatedByAccountIdLongFalseNoId of updatedByAccount. The staff member account that updated the note.
UpdatedByAccountlookUpNameStringFalseNoLookUpName of updatedByAccount. The staff member account that updated the note.
UpdatedTimeDatetimeFalseNoThe date and time when the note was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContactsIdLongFalseNoThe unique identifier of the contact.
Id [KEY]LongFalseNoThe unique identifier for the list entry.
URLStringFalseNoThe unique authentication URL for the OpenIDAccount item.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContactsIdLongFalseNoThe unique identifier of the contact.
NumberStringFalseNoThe free-form phone number including non-numeric characters. For example, 1 (406) 522-4200.
PhoneTypeIdLongFalseNoId of phoneType. The type of phone number such as Home, Mobile, Office, and so on. This is the key for the list entry.
PhoneTypelookUpNameStringFalseNoLookUpName of phoneType. The type of phone number such as Home, Mobile, Office, and so on. This is the key for the list entry.
RawNumberStringFalseNoThe automatically populated numeric string derived by excluding the non-numeric characters from the value of the Number attribute. For example, if the Number attribute has a value of 1 (406) 522-4200, this field is populated as 14065224200. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AbbreviationStringFalseNoThe two or three character abbreviation for the country. For example, USA.
CreatedTimeDatetimeTrueNoThe date and time when the country was created. This attribute is read-only.
DisplayOrderIntFalseNoThe position of the country in the Countries/Provinces tree and drop-down menu.
ISOCodeStringFalseNoThe ISO 3166 country code.
Id [KEY]LongTrueNoThe unique identifier of the country.
LookupNameStringTrueNoThe name used to look up the country.
NameStringTrueNoA list of labels or names used for this country on each unique interface.
PhoneCodeStringFalseNoThe international telephone code for the country. This is used by the Click-to-Dial feature.
PhoneMaskStringFalseNoThe string having twice the number of characters in the phone number. Two characters are needed to represent every digit or character in the phone number. The first character of the mask describes the target character and the second constrains its type.
PostalMaskStringFalseNoThe string having twice the number of characters in the target postal code. Two characters are needed to represent every digit or character in the postal code. The first character of the mask describes the target character and the second constrains its type.
UpdatedTimeDatetimeTrueNoThe date and time when the country was last updated. This attribute is read-only.
namesStringFalseYesThe name of the country in the language of the current interface. This attribute is read-only.
provincesStringFalseYesA list of states or provinces associated with this country.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CountriesIdLongFalseNoThe unique identifier of the country.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CountriesIdLongFalseNoThe unique identifier of the country.
DisplayOrderIntFalseNoThe display position relative to other provinces associated with the same country.
Id [KEY]LongFalseNoThe unique identifier of the province.
NameStringFalseNoThe name of the province in the language of the current interface. This attribute is read-only.
namesStringFalseYesThe list of names or labels for the province for each available language.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CountriesIdLongFalseNoThe unique identifier of the country.
ProvincesIdLongFalseNoThe unique identifier of the province.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ClassStringFalseNoThe string which represents the type of object in the ObjectShapeXML.
CreatedTimeDatetimeTrueNoThe date and time when the event subscription was created. This attribute is read-only.
EndPointStringFalseNoThe URL to post the notification event. Note: If an endpoint is registered as a callback, it should contain the fully qualified domain name. For example:
EventTypeIdLongFalseNoId of eventType. The types of event such as Create, Update, or Destroy.
EventTypelookUpNameStringFalseNoLookUpName of eventType. The types of event such as Create, Update, or Destroy.
Id [KEY]LongTrueNoThe unique identifier of the event subscription.
IntegrationUserIdLongFalseNoId of integrationUser. The credentials and connection method to use for the event subscription.
IntegrationUserlookUpNameStringFalseNoLookUpName of integrationUser. The credentials and connection method to use for the event subscription.
LookupNameStringTrueNoThe name used to look up the event subscription.
NameStringFalseNoThe unique name of the event subscription.
ObjectShapeXmlStringFalseNoThe shape of the template object used to send the notification.
ObjectVersionIdLongFalseNoId of objectVersion. The Connect version of the object to be sent in the notification.
ObjectVersionlookUpNameStringFalseNoLookUpName of objectVersion. The Connect version of the object to be sent in the notification.
StatusIdLongFalseNoId of status. The status of the event subscription.
StatuslookUpNameStringFalseNoLookUpName of status. The status of the event subscription.
UpdatedTimeDatetimeTrueNoThe date and time when the event subscription was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeTrueNoThe date and time when the holiday was created. This attribute is read-only.
DisplayOrderIntFalseNoThe display position relative to other holidays.
HolidayDateDateFalseNoThe date the holiday falls on. The maximum allowed value of the date is 12/31/2032.
Id [KEY]LongTrueNoThe unique identifier of the holiday.
LookupNameStringTrueNoThe name used to look up the holiday.
NameStringFalseNoThe name of the holiday.
UpdatedTimeDatetimeTrueNoThe date and time when the holiday was last updated. This attribute is read-only.
adminVisibleInterfacesStringFalseYesThe list of interfaces on which the holiday is available for administration use.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdminVisibleInterfacesId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
AdminVisibleInterfacesLookUpNameStringFalseNoThe name used to look up the object.
HolidaysIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
HolidaysLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AssetIdLongFalseNoId of asset. The ID of the associated asset.
AssetlookUpNameStringFalseNoLookUpName of asset. The ID of the associated asset.
CategoryIdLongFalseNoId of category. The service category.
CategorylookUpNameStringFalseNoLookUpName of category. The service category.
ChannelIdLongFalseNoId of channel. The channel used in the creation of the most recent thread.
ChannellookUpNameStringFalseNoLookUpName of channel. The channel used in the creation of the most recent thread.
ChatQueueIdLongFalseNoId of chatQueue. The chat queue to which the incident is assigned. This attribute is read-only.
ChatQueuelookUpNameStringFalseNoLookUpName of chatQueue. The chat queue to which the incident is assigned. This attribute is read-only.
ClosedTimeDatetimeTrueNoThe date and time when the incident was closed. This attribute is read-only.
CreatedByAccountIdLongTrueNoId of createdByAccount. The staff member who created the incident.
CreatedByAccountlookUpNameStringTrueNoLookUpName of createdByAccount. The staff member who created the incident.
CreatedTimeDatetimeTrueNoThe date and time when the incident was created. This attribute is read-only.
DispositionIdLongFalseNoId of disposition. The service disposition.
DispositionlookUpNameStringFalseNoLookUpName of disposition. The service disposition.
Id [KEY]LongTrueNoThe unique identifier of the incident.
InitialResponseDueTimeDatetimeTrueNoThe due date that is required to conform to the SLA. If SLAs have not been implemented, this would apply to the default response requirements. This attribute is read-only.
InitialSolutionTimeDatetimeTrueNoThe date and time when a response was sent to the customer for a status change other than 'unresolved'. This attribute is read-only.
InterfaceIdLongFalseNoId of interface. The ID of the associated interface.
InterfacelookUpNameStringFalseNoLookUpName of interface. The ID of the associated interface.
LanguageIdLongFalseNoId of language. The ID of the associated language.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the associated language.
LastResponseTimeDatetimeTrueNoThe date and time when the last response was sent to the contact. This attribute is read-only.
LastSurveyScoreIntTrueNoThe score of the last survey of the incident. This attribute is read-only.
LookupNameStringTrueNoThe name used to look up the incident.
MailboxIdLongFalseNoId of mailbox. The ID of the mailbox from which incident was created.
MailboxlookUpNameStringFalseNoLookUpName of mailbox. The ID of the mailbox from which incident was created.
MailingIdLongTrueNoId of mailing. The ID of the associated marketing outbound email. This attribute is read-only.
MailinglookUpNameStringTrueNoLookUpName of mailing. The ID of the associated marketing outbound email. This attribute is read-only.
OrganizationIdLongFalseNoId of organization. The ID of the associated organization.
OrganizationlookUpNameStringFalseNoLookUpName of organization. The ID of the associated organization.
PrimaryContactIdLongFalseNoId of primaryContact. The primary contact.
PrimaryContactlookUpNameStringFalseNoLookUpName of primaryContact. The primary contact.
ProductIdLongFalseNoId of product. The service product.
ProductlookUpNameStringFalseNoLookUpName of product. The service product.
QueueIdLongFalseNoId of queue. The queue to which the incident is assigned.
QueuelookUpNameStringFalseNoLookUpName of queue. The queue to which the incident is assigned.
ReferenceNumberStringTrueNoThe reference number generated when the incident was created. It is also referred as the incident name.
ResolutionIntervalIntTrueNoThe number of minutes taken to resolve the incident past the SLA's resolution requirement. This attribute is read-only.
ResponseEmailAddressTypeIdLongFalseNoId of responseEmailAddressType. The type of address that is used for incident responses, such as Primary or Alt1 .
ResponseEmailAddressTypelookUpNameStringFalseNoLookUpName of responseEmailAddressType. The type of address that is used for incident responses, such as Primary or Alt1 .
ResponseIntervalIntTrueNoThe number of minutes taken to respond to the incident past the SLA's response requirement. This attribute is read-only.
SeverityIdLongFalseNoId of severity. The assigned severity level.
SeveritylookUpNameStringFalseNoLookUpName of severity. The assigned severity level.
SmartSenseCustomerIntTrueNoThe emotive index calculated from the contact-generated threads. This attribute is read-only.
SmartSenseStaffIntTrueNoThe emotive index calculated from the staff-generated threads. This attribute is read-only.
SourceIdLongTrueNoId of source. The creation source IDs. This attribute is read-only.
SourcelookUpNameStringTrueNoLookUpName of source. The creation source IDs. This attribute is read-only.
SubjectStringFalseNoThe short description of the incident.
UpdatedTimeDatetimeTrueNoThe date and time when the incident was last updated. This attribute is read-only.
AssignedToaccountIdLongFalseNoId of account. The staff account.
AssignedToaccountlookUpNameStringFalseNoLookUpName of account. The staff account.
AssignedTostaffGroupIdLongFalseNoId of staffGroup. The staff group. The caller should assign the staff group when assigning to an account.
AssignedTostaffGrouplookUpNameStringFalseNoLookUpName of staffGroup. The staff group. The caller should assign the staff group when assigning to an account.
BannerimportanceFlagIdLongFalseNoId of importanceFlag. The importance of the banner.
BannerimportanceFlaglookUpNameStringFalseNoLookUpName of importanceFlag. The importance of the banner.
BannertextStringFalseNoThe description of a flag.
BannerupdatedByAccountIdLongTrueNoId of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedByAccountlookUpNameStringTrueNoLookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedTimeDatetimeTrueNoThe date and time when the banner was last updated. This attribute is read-only.
SLAInstanceactiveDateDateTrueNoThe date when the instance became active.
SLAInstanceexpireDateDateTrueNoThe date when the instance is scheduled to expire. This attribute is read-only.
SLAInstanceidLongTrueNoThe unique identifier of the SLAInstance.
SLAInstancenameOfSLAIdLongFalseNoId of nameOfSLA. The SLA from which the instance was created.
SLAInstancenameOfSLAlookUpNameStringFalseNoLookUpName of nameOfSLA. The SLA from which the instance was created.
SLAInstanceremainingFromCSRIntTrueNoThe remaining number of CSR incidents. This attribute is read-only.
SLAInstanceremainingFromChatIntTrueNoThe remaining number of chat incidents. This attribute is read-only.
SLAInstanceremainingFromEmailIntTrueNoThe remaining number of email incidents. This attribute is read-only.
SLAInstanceremainingFromWebIntTrueNoThe remaining number of web self-service incidents. This attribute is read-only.
SLAInstanceremainingTotalIntTrueNoThe total number of remaining incidents. This attribute is read-only.
SLAInstancesLASetIntTrueNoThe SLA set from which the instance was created. This attribute is read-only.
SLAInstancestateOfSLAIdLongTrueNoId of stateOfSLA. The current state of the SLA. The supported values are Inactive, Active, Expired, or Disabled.
SLAInstancestateOfSLAlookUpNameStringTrueNoLookUpName of stateOfSLA. The current state of the SLA. The supported values are Inactive, Active, Expired, or Disabled.
StatusWithTypestatusIdLongFalseNoId of status. The current status.
StatusWithTypestatuslookUpNameStringFalseNoLookUpName of status. The current status.
StatusWithTypestatusTypeIdLongTrueNoId of statusType. The associated status type. This attribute is read-only.
StatusWithTypestatusTypelookUpNameStringTrueNoLookUpName of statusType. The associated status type. This attribute is read-only.
billedMinutesStringFalseYesThe list of time-billed entries that are used for tracking work on the incident.
fileAttachmentsStringFalseYesThe list of file attachments.
milestoneInstancesStringFalseYesThe list of milestone instances associated with the incident. This attribute is read-only.
otherContactsStringFalseYesThe list of secondary contacts.
threadsStringFalseYesThe list of customer and staff discussion threads or notes. New entries can be added to the list and existing threads updated. It is not possible to remove discussion threads retroactively.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IncidentsIdLongFalseNoThe unique identifier of the incident.
AccountIdLongFalseNoId of account. The staff member who billed the time. This is part of the key for the list entry.
AccountlookUpNameStringFalseNoLookUpName of account. The staff member who billed the time. This is part of the key for the list entry.
BillTimeDatetimeFalseNoThe date and time when the work was performed. This is part of the key for the list entry.
BillableTaskIdLongFalseNoId of billableTask. The associated billable task.
BillableTasklookUpNameStringFalseNoLookUpName of billableTask. The associated billable task.
CommentStringFalseNoThe comments associated with the timeBilled record.
Id [KEY]LongFalseNoThe unique identifier of the timeBilled record.
MinutesIntFalseNoThe number of minutes billed.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IncidentsIdLongFalseNoThe unique identifier of the incident.
ContentTypeStringFalseNoThe MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
CreatedTimeDatetimeFalseNoThe date and time when the file was associated with the incident. This attribute is read-only.
DataStringFalseNoThe Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
DescriptionStringFalseNoThe description for the contents of the file attachment.
FileNameStringFalseNoThe name of the file when saving it to the disk.
FormDataStringFalseNoThe HTML form which is used to upload file attachments.
Id [KEY]LongFalseNoThe unique identifier of the file attachment.
NameStringFalseNoThe short display name of the file attachment.
PrivateBoolFalseNoIndicates whether the file attachment is hidden from the end users. This attribute does not have a default value.
SizeIntFalseNoThe size of the file in bytes. This attribute is read-only.
URLStringFalseNoThe URL to access this file.
UpdatedTimeDatetimeFalseNoThe date and time when the file was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IncidentsIdLongFalseNoThe unique identifier of the incident.
MilestoneIdLongFalseNoId of milestone. The ID of the associated milestone.
MilestonelookUpNameStringFalseNoLookUpName of milestone. The ID of the associated milestone.
ResolutionDueTimeDatetimeFalseNoThe date and time when the associated resolution milestone is due.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IncidentsIdLongFalseNoThe unique identifier of the incident.
AccountIdLongFalseNoId of account. The associated staff account. This attribute is read-only.
AccountlookUpNameStringFalseNoLookUpName of account. The associated staff account. This attribute is read-only.
ChannelIdLongFalseNoId of channel. The associated communication channel.
ChannellookUpNameStringFalseNoLookUpName of channel. The associated communication channel.
ContactIdLongFalseNoId of contact. The associated contact.
ContactlookUpNameStringFalseNoLookUpName of contact. The associated contact.
ContentTypeIdLongFalseNoId of contentType. The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
ContentTypelookUpNameStringFalseNoLookUpName of contentType. The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
CreatedTimeDatetimeFalseNoThe date and time when the thread was created. This attribute is read-only.
DisplayOrderIntFalseNoThe relative display order for the threads with the same created time. This attribute is read-only.
EntryTypeIdLongFalseNoId of entryType. The entry type.
EntryTypelookUpNameStringFalseNoLookUpName of entryType. The entry type.
Id [KEY]LongFalseNoThe unique identifier of the thread. It cannot be used for delete operations.
MailHeaderStringFalseNoThe mail header information for a contact submitting the thread by email.
TextStringFalseNoThe entry text in the thread.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeFalseNoThe date and time when the mailbox was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the mailbox.
InterfaceIdLongFalseNoId of interface. The interface that the mailbox is associated with.
InterfacelookUpNameStringFalseNoLookUpName of interface. The interface that the mailbox is associated with.
IsDefaultBoolFalseNoIndicates whether the mailbox is the default mailbox for the interface. This attribute does not have a default value.
LookupNameStringFalseNoThe name used to look up the mailbox.
NameStringFalseNoThe name of the mailbox.
TypeIdLongFalseNoId of type. The module the mailbox is associated with.
TypelookUpNameStringFalseNoLookUpName of type. The module the mailbox is associated with.
UpdatedTimeDatetimeFalseNoThe date and time when the mailbox was last updated. This attribute is read-only.
IncomingEmailSettingsforceReplyBetweenLinesBoolFalseNoIndicates whether the Force Reply Between the Lines feature is enabled for outgoing emails from the mailbox. This attribute does not have a default value.
IncomingEmailSettingsforwardRejectMessageAddressStringFalseNoThe address to which rejected messages are sent.
IncomingEmailSettingsisEnabledBoolFalseNoIndicates whether incoming email option is enabled. This attribute does not have a default value.
OutgoingEmailSettingsdisplayNameStringFalseNoThe display name used in the outgoing emails from the mailbox.
OutgoingEmailSettingsfriendlyFromAddressStringFalseNoThe from address used to brand outgoing emails as friendly.
OutgoingEmailSettingsfromAddressStringFalseNoThe from address on the outgoing email.
OutgoingEmailSettingsisEnabledBoolFalseNoIndicates whether outgoing email is enabled. This attribute does not have a default value.
OutgoingEmailSettingsreplyToAddressStringFalseNoThe reply-to-address on the outgoing email.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeFalseNoThe date and time when the marketing mailbox was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the marketing mailbox.
InterfaceIdLongFalseNoId of interface. The interface that the mailbox is associated with.
InterfacelookUpNameStringFalseNoLookUpName of interface. The interface that the mailbox is associated with.
IsDefaultBoolFalseNoIndicates whether the mailbox is the default mailbox for the interface. This attribute does not have a default value.
LookupNameStringFalseNoThe name used to look up the marketing mailbox.
NameStringFalseNoThe name of the marketing mailbox.
TypeIdLongFalseNoId of type. The module the mailbox is associated with.
TypelookUpNameStringFalseNoLookUpName of type. The module the mailbox is associated with.
UpdatedTimeDatetimeFalseNoThe date and time when the marketing mailbox was last updated. This attribute is read-only.
IncomingEmailSettingsforceReplyBetweenLinesBoolFalseNoIndicates whether the Force Reply Between the Lines feature is enabled for outgoing emails from the mailbox. This attribute does not have a default value.
IncomingEmailSettingsforwardRejectMessageAddressStringFalseNoThe address to which rejected messages are sent.
IncomingEmailSettingsisEnabledBoolFalseNoIndicates whether incoming email option is enabled. This attribute does not have a default value.
OutgoingEmailSettingsdisplayNameStringFalseNoThe display name used in the outgoing emails from the mailbox.
OutgoingEmailSettingsfriendlyFromAddressStringFalseNoThe from address used to brand outgoing emails as friendly.
OutgoingEmailSettingsfromAddressStringFalseNoThe from address on the outgoing email.
OutgoingEmailSettingsisEnabledBoolFalseNoIndicates whether outgoing email is enabled. This attribute does not have a default value.
OutgoingEmailSettingsreplyToAddressStringFalseNoThe reply-to-address on the outgoing email.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeFalseNoThe date and time when the message base was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the message base.
LookupNameStringFalseNoThe name used to look up the message base.
NameStringFalseNoThe name of the message base.
UpdatedTimeDatetimeFalseNoThe date and time when the message base was last updated. This attribute is read-only.
UsageIdLongFalseNoId of usage. The type of data the message base represents.
UsagelookUpNameStringFalseNoLookUpName of usage. The type of data the message base represents.
ValueStringFalseNoThe string value of the message base.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TableNameStringFalseNoTable Name
ColumnNameStringFalseNoColumn Name
IdLongFalseNoId of namedId
LookUpNameStringFalseNoLookUpName of NamedId

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AssignedToAccountIdLongFalseNoId of assignedToAccount. The sales representative assigned to the account.
AssignedToAccountlookUpNameStringFalseNoLookUpName of assignedToAccount. The sales representative assigned to the account.
CampaignIdLongTrueNoId of campaign. The campaign that created the opportunity, where applicable. This value and the survey are mutually exclusive; one or both must be null. This attribute is read-only.
CampaignlookUpNameStringTrueNoLookUpName of campaign. The campaign that created the opportunity, where applicable. This value and the survey are mutually exclusive; one or both must be null. This attribute is read-only.
ClosedTimeDatetimeFalseNoThe date and time when the opportunity was closed.
CreatedTimeDatetimeTrueNoThe date and time when the opportunity was created. This attribute is read-only.
ForecastCloseDateDateFalseNoThe date when the opportunity is estimated to close.
Id [KEY]LongTrueNoThe unique identifier of the opportunity.
InitialContactDateDateFalseNoThe date when the sales representative made the initial contact with the organization.
InterfaceIdLongFalseNoId of interface. The interface with which the opportunity is associated.
InterfacelookUpNameStringFalseNoLookUpName of interface. The interface with which the opportunity is associated.
LeadRejectDateTimeDatetimeFalseNoThe date and time when the lead was rejected.
LeadRejectDescriptionStringFalseNoThe summary or description provided when the lead was rejected.
LeadRejectReasonIdLongFalseNoId of leadRejectReason. The reason the lead was rejected.
LeadRejectReasonlookUpNameStringFalseNoLookUpName of leadRejectReason. The reason the lead was rejected.
LookupNameStringTrueNoThe name used to look up the opportunity.
LostTimeDatetimeFalseNoThe date and time when the opportunity was lost.
ManagerCommitBoolFalseNoThe committed status of the manager-forecasted value. The default value is false.
NameStringFalseNoThe name of the opportunity.
OrganizationIdLongFalseNoId of organization. The associated organization.
OrganizationlookUpNameStringFalseNoLookUpName of organization. The associated organization.
RecallTimeDatetimeFalseNoThe date and time when the opportunity was recalled.
SalesRepresentativeCommitBoolFalseNoIndicates whether the sales representative-forecasted value is committed. The default value is false.
SourceIdLongTrueNoId of source. The creation source IDs. This attribute is read-only.
SourcelookUpNameStringTrueNoLookUpName of source. The creation source IDs. This attribute is read-only.
SummaryStringFalseNoThe brief summary of the opportunity.
SurveyIdLongTrueNoId of survey. The survey that created the opportunity, where applicable. This value and the campaign are mutually exclusive; one or both must be null. This attribute is read-only.
SurveylookUpNameStringTrueNoLookUpName of survey. The survey that created the opportunity, where applicable. This value and the campaign are mutually exclusive; one or both must be null. This attribute is read-only.
TerritoryIdLongFalseNoId of territory. The associated sales territory.
TerritorylookUpNameStringFalseNoLookUpName of territory. The associated sales territory.
UpdatedTimeDatetimeTrueNoThe date and time when the opportunity was last updated. This attribute is read-only.
WinLossDescriptionStringFalseNoThe description of how the opportunity was won or lost.
WinLossReasonIdLongFalseNoId of winLossReason. The reason for winning or losing.
WinLossReasonlookUpNameStringFalseNoLookUpName of winLossReason. The reason for winning or losing.
BannerimportanceFlagIdLongFalseNoId of importanceFlag. The importance of the banner.
BannerimportanceFlaglookUpNameStringFalseNoLookUpName of importanceFlag. The importance of the banner.
BannertextStringFalseNoThe description of a flag.
BannerupdatedByAccountIdLongTrueNoId of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedByAccountlookUpNameStringTrueNoLookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedTimeDatetimeTrueNoThe date and time when the banner was last updated. This attribute is read-only.
ClosedValuecurrencyIdLongFalseNoId of currency. The ID of the currency.
ClosedValuecurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
ClosedValueexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ClosedValueexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ClosedValuevalueStringFalseNoThe value of the currency.
CostOfSalecurrencyIdLongFalseNoId of currency. The ID of the currency.
CostOfSalecurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
CostOfSaleexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
CostOfSaleexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
CostOfSalevalueStringFalseNoThe value of the currency.
ManagerValuecurrencyIdLongFalseNoId of currency. The ID of the currency.
ManagerValuecurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
ManagerValueexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ManagerValueexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ManagerValuevalueStringFalseNoThe value of the currency.
PrimaryContactcontactIdLongFalseNoId of contact. The ID of the contact.
PrimaryContactcontactlookUpNameStringFalseNoLookUpName of contact. The ID of the contact.
PrimaryContactcontactRoleIdLongFalseNoId of contactRole. The role of the contact in the opportunity process.
PrimaryContactcontactRolelookUpNameStringFalseNoLookUpName of contactRole. The role of the contact in the opportunity process.
ReturnValuecurrencyIdLongFalseNoId of currency. The ID of the currency.
ReturnValuecurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
ReturnValueexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ReturnValueexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
ReturnValuevalueStringFalseNoThe value of the currency.
SalesRepresentativeValuecurrencyIdLongFalseNoId of currency. The ID of the currency.
SalesRepresentativeValuecurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
SalesRepresentativeValueexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
SalesRepresentativeValueexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
SalesRepresentativeValuevalueStringFalseNoThe value of the currency.
StageWithStrategystageIdLongFalseNoId of stage. The current stage.
StageWithStrategystagelookUpNameStringFalseNoLookUpName of stage. The current stage.
StageWithStrategystrategyIdLongTrueNoId of strategy. The associated strategy. This attribute is read-only.
StageWithStrategystrategylookUpNameStringTrueNoLookUpName of strategy. The associated strategy. This attribute is read-only.
StatusWithTypestatusIdLongFalseNoId of status. The current status.
StatusWithTypestatuslookUpNameStringFalseNoLookUpName of status. The current status.
StatusWithTypestatusTypeIdLongTrueNoId of statusType. The associated status type. This attribute is read-only.
StatusWithTypestatusTypelookUpNameStringTrueNoLookUpName of statusType. The associated status type. This attribute is read-only.
fileAttachmentsStringFalseYesThe list of file attachments.
notesStringFalseYesThe list of associated notes.
otherContactsStringFalseYesThe other non-primary associated contacts.
quotesStringFalseYesThe list of sales quotes.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OpportunitiesIdLongFalseNoThe unique identifier of the opportunity.
ContentTypeStringFalseNoThe MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
CreatedTimeDatetimeFalseNoThe date and time when the file was associated with the object. This attribute is read-only.
DataStringFalseNoThe Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
DescriptionStringFalseNoThe description for the contents of the file attachment.
FileNameStringFalseNoThe name of the file when saving it to the disk.
FormDataStringFalseNoThe HTML form which is used to upload file attachments.
Id [KEY]LongFalseNoThe unique identifier of the file attachment.
NameStringFalseNoThe short display name of the file attachment.
SizeIntFalseNoThe size of the file in bytes. This attribute is read-only.
URLStringFalseNoThe URL to access this file.
UpdatedTimeDatetimeFalseNoThe date and time when the file attachment was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OpportunitiesIdLongFalseNoThe unique identifier of the opportunity.
ChannelIdLongFalseNoId of channel. The channel through which the note was created.
ChannellookUpNameStringFalseNoLookUpName of channel. The channel through which the note was created.
CreatedByAccountIdLongFalseNoId of createdByAccount. The staff member account that created the note.
CreatedByAccountlookUpNameStringFalseNoLookUpName of createdByAccount. The staff member account that created the note.
CreatedTimeDatetimeFalseNoThe date and time when the note was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the note.
TextStringFalseNoThe text content in the note.
UpdatedByAccountIdLongFalseNoId of updatedByAccount. The staff member account that updated the note.
UpdatedByAccountlookUpNameStringFalseNoLookUpName of updatedByAccount. The staff member account that updated the note.
UpdatedTimeDatetimeFalseNoThe date and time when the note was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OpportunitiesIdLongFalseNoThe unique identifier of the opportunity.
ContactIdLongFalseNoId of contact. The ID of the contact. This is the key for the list entry.
ContactlookUpNameStringFalseNoLookUpName of contact. The ID of the contact. This is the key for the list entry.
ContactRoleIdLongFalseNoId of contactRole. The role of the contact in the opportunity process.
ContactRolelookUpNameStringFalseNoLookUpName of contactRole. The role of the contact in the opportunity process.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OpportunitiesIdLongFalseNoThe unique identifier of the opportunity.
CommentStringFalseNoThe comment text for the quote.
CreatedTimeDatetimeFalseNoThe date and time when the quote was created.
DiscountPercentIntFalseNoThe discount percentage for the quote.
ForecastedBoolFalseNoIndicates whether the quote has been forecasted. The default value is false.
Id [KEY]LongFalseNoThe unique identifier of the quote. This is the key for the list entry.
NameStringFalseNoThe descriptive name of the quote.
OfferEndTimeDatetimeFalseNoThe date and time when the quoted offer ends.
OfferStartTimeDatetimeFalseNoThe date and time when the quoted offer starts.
PriceScheduleIdLongFalseNoId of priceSchedule. The effective price schedule.
PriceSchedulelookUpNameStringFalseNoLookUpName of priceSchedule. The effective price schedule.
SentTimeDatetimeFalseNoThe date and time when the quote was sent.
SentToStringFalseNoThe email addresses of the contact to whom the quote was sent. This attribute is read-only.
StatusIdLongFalseNoId of status. The current status.
StatuslookUpNameStringFalseNoLookUpName of status. The current status.
TemplateIdLongFalseNoId of template. The template used to generate the quote.
TemplatelookUpNameStringFalseNoLookUpName of template. The template used to generate the quote.
UpdatedTimeDatetimeFalseNoThe date and time when the quote was last updated. This attribute is read-only.
AdjustedTotalcurrencyIdLongFalseNoId of currency. The ID of the currency.
AdjustedTotalcurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
AdjustedTotalexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
AdjustedTotalexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
AdjustedTotalvalueStringFalseNoThe value of the currency.
TotalcurrencyIdLongFalseNoId of currency. The ID of the currency.
TotalcurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
TotalexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
TotalexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
TotalvalueStringFalseNoThe value of the currency.
fileAttachmentsStringFalseYesThe list of file attachments for the quote.
lineItemsStringFalseYesThe list of individual product line items that make up the quote.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OpportunitiesIdLongFalseNoThe unique identifier of the opportunity.
QuotesIdLongFalseNo
ContentTypeStringFalseNoThe MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
CreatedTimeDatetimeFalseNoThe date and time when the file was associated with the object. This attribute is read-only.
DataStringFalseNoThe Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
FileNameStringFalseNoThe name of the file when saving it to the disk.
FormDataStringFalseNoThe HTML form which is used to upload file attachments.
Id [KEY]LongFalseNoThe unique identifier of the file attachment.
SizeIntFalseNoThe size of the file in bytes. This attribute is read-only.
URLStringFalseNoThe URL to access the file.
UpdatedTimeDatetimeFalseNoThe date and time when the file was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OpportunitiesIdLongFalseNoThe unique identifier of the opportunity.
QuotesIdLongFalseNoThe unique identifier of the quote.
AdjustedDescriptionStringFalseNoThe edited product description in the product line item.
AdjustedNameStringFalseNoThe edited product name in the product line item.
AdjustedPartNumberStringFalseNoThe edited product part number in the product line item.
CommentStringFalseNoThe comments associated with a product line item in the quote.
DiscountPercentIntFalseNoThe discount applied to the adjusted price of the product line item.
DisplayOrderIntFalseNoThe position of the line item in the quote.
Id [KEY]LongFalseNoThe unique identifier of the product line item in the quote. This is the key for the list entry.
OriginalDescriptionStringFalseNoThe original product description. This attribute is read-only.
OriginalNameStringFalseNoThe original product name. This attribute is read-only.
OriginalPartNumberStringFalseNoThe original product part number. This attribute is read-only.
ProductIdLongFalseNoId of product. The ID of the sales product.
ProductlookUpNameStringFalseNoLookUpName of product. The ID of the sales product.
QuantityIntFalseNoThe product quantity in the line item.
AdjustedPricecurrencyIdLongFalseNoId of currency. The ID of the currency.
AdjustedPricecurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
AdjustedPriceexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
AdjustedPriceexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
AdjustedPricevalueStringFalseNoThe value of the currency.
AdjustedTotalcurrencyIdLongFalseNoId of currency. The ID of the currency.
AdjustedTotalcurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
AdjustedTotalexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
AdjustedTotalexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
AdjustedTotalvalueStringFalseNoThe value of the currency.
OriginalPricecurrencyIdLongFalseNoId of currency. The ID of the currency.
OriginalPricecurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
OriginalPriceexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
OriginalPriceexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
OriginalPricevalueStringFalseNoThe value of the currency.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeFalseNoThe date and time when the opportunity status was created. This attribute is read-only.
DisplayOrderIntFalseNoThe position of the opportunity status in the folder list.
Id [KEY]LongFalseNoThe unique identifier of the opportunity status.
LookupNameStringFalseNoThe name used to look up the opportunity status.
NameStringFalseNoThe name of the opportunity status in the language of the current interface.
StatusTypeIdLongFalseNoId of statusType. The current status and associated status type.
StatusTypelookUpNameStringFalseNoLookUpName of statusType. The current status and associated status type.
UpdatedTimeDatetimeFalseNoThe date and time when the opportunity status was last updated. This attribute is read-only.
namesStringFalseYesThe list of names, one for each supported language.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OpportunityStatusesIdLongFalseNoThe unique identifier of the opportunity.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeTrueNoThe date and time when the organization was created. This attribute is read-only.
ExternalReferenceStringTrueNoThe external reference key of the organization.
Id [KEY]LongTrueNoThe unique identifier of the organization.
IndustryIdLongFalseNoId of industry. The industry with which the organization is associated.
IndustrylookUpNameStringFalseNoLookUpName of industry. The industry with which the organization is associated.
LoginStringFalseNoThe user name used for authentication.
LookupNameStringTrueNoThe name used to look up the organization.
NameStringFalseNoThe business name of the organization.
NameFuriganaStringFalseNoThe Furigana reading aid for the Name field. This field is used in the workspaces of the Agent Console and is only available if the site has at least one Japanese interface.
NewPasswordStringFalseNoThe write-only field used to set the authentication password. It is stored in a non-plaintext form in the system.
NumberOfEmployeesIntFalseNoThe number of employees in the organization.
ParentIdLongFalseNoId of parent. The parent organization.
ParentlookUpNameStringFalseNoLookUpName of parent. The parent organization.
SourceIdLongTrueNoId of source. The creation source IDs. This attribute is read-only.
SourcelookUpNameStringTrueNoLookUpName of source. The creation source IDs. This attribute is read-only.
SupersededByIdLongTrueNoId of supersededBy. The superseding organization for the organization. This attribute is read-only.
SupersededBylookUpNameStringTrueNoLookUpName of supersededBy. The superseding organization for the organization. This attribute is read-only.
UpdatedTimeDatetimeTrueNoThe date and time when the organization was last updated. This attribute is read-only.
BannerimportanceFlagIdLongFalseNoId of importanceFlag. The importance of the banner.
BannerimportanceFlaglookUpNameStringFalseNoLookUpName of importanceFlag. The importance of the banner.
BannertextStringFalseNoThe description of a flag.
BannerupdatedByAccountIdLongTrueNoId of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedByAccountlookUpNameStringTrueNoLookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.
BannerupdatedTimeDatetimeTrueNoThe date and time when the banner was last updated. This attribute is read-only.
CRMModulesmarketingBoolFalseNoIndicates whether the marketing module is applicable. The default value is true only if marketing module is enabled.
CRMModulessalesBoolFalseNoIndicates whether the sales module is applicable. The default value is true only if sales module is enabled.
CRMModulesserviceBoolFalseNoIndicates whether the service module is applicable. The default value is true only if service module is enabled.
SalesSettingsacquiredDateDateTrueNoThe date when the first opportunity associated with the organization was closed. This attribute is read-only.
SalesSettingssalesAccountIdLongFalseNoId of salesAccount. The sales representative assigned to the account.
SalesSettingssalesAccountlookUpNameStringFalseNoLookUpName of salesAccount. The sales representative assigned to the account.
SalesSettingstotalRevenuecurrencyIdLongFalseNoId of currency. The ID of the currency.
SalesSettingstotalRevenuecurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
SalesSettingstotalRevenueexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
SalesSettingstotalRevenueexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
SalesSettingstotalRevenuevalueStringFalseNoThe value of the currency.
addressesStringFalseYesThe list of associated addresses.
fileAttachmentsStringFalseYesThe list of file attachments.
notesStringFalseYesThe list of associated notes.
sLAInstancesStringFalseYesThe Service Level Agreement (SLA) instances associated with the organization. This attribute is read-only for versions 1 and 1.1.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrganizationsIdLongFalseNoThe unique identifier of the organization.
AddressTypeIdLongFalseNoId of addressType. The type of address, such as mailing, street, and so on. This is the key for the list entry.
AddressTypelookUpNameStringFalseNoLookUpName of addressType. The type of address, such as mailing, street, and so on. This is the key for the list entry.
CityStringFalseNoThe name of the city.
CountryIdLongFalseNoId of country. The ID of the country.
CountrylookUpNameStringFalseNoLookUpName of country. The ID of the country.
PostalCodeStringFalseNoThe postal code or ZIP code.
StateOrProvinceIdLongFalseNoId of stateOrProvince. The ID of the state or province.
StateOrProvincelookUpNameStringFalseNoLookUpName of stateOrProvince. The ID of the state or province.
StreetStringFalseNoThe street address.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrganizationsIdLongFalseNoThe unique identifier of the organization.
ContentTypeStringFalseNoThe MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
CreatedTimeDatetimeFalseNoThe date and time when the file was associated with the object. This attribute is read-only.
DataStringFalseNoThe Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
DescriptionStringFalseNoThe description for the contents of the file attachment.
FileNameStringFalseNoThe name of the file when saving it to the disk.
FormDataStringFalseNoThe HTML form which is used to upload file attachments.
Id [KEY]LongFalseNoThe unique identifier of the file attachment.
NameStringFalseNoThe short display name of the file attachment.
SizeIntFalseNoThe size of the file in bytes. This attribute is read-only.
URLStringFalseNoThe URL to access this file.
UpdatedTimeDatetimeFalseNoThe date and time when the file attachment was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrganizationsIdLongFalseNoThe unique identifier of the organization.
ChannelIdLongFalseNoId of channel. The channel through which the note was created.
ChannellookUpNameStringFalseNoLookUpName of channel. The channel through which the note was created.
CreatedByAccountIdLongFalseNoId of createdByAccount. The staff member account that created the note.
CreatedByAccountlookUpNameStringFalseNoLookUpName of createdByAccount. The staff member account that created the note.
CreatedTimeDatetimeFalseNoThe date and time when the note was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the note.
TextStringFalseNoThe text content in the note.
UpdatedByAccountIdLongFalseNoId of updatedByAccount. The staff member account that updated the note.
UpdatedByAccountlookUpNameStringFalseNoLookUpName of updatedByAccount. The staff member account that updated the note.
UpdatedTimeDatetimeFalseNoThe date and time when the note was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CampaignIdLongFalseNoId of campaign. The campaign associated with the purchased product.
CampaignlookUpNameStringFalseNoLookUpName of campaign. The campaign associated with the purchased product.
CommentStringFalseNoThe comments or notes associated with the line item.
ContactIdLongFalseNoId of contact. The contact associated with the purchased product.
ContactlookUpNameStringFalseNoLookUpName of contact. The contact associated with the purchased product.
CreatedTimeDatetimeTrueNoThe date and time when the purchased product was created. This attribute is read-only.
FinalizedByAccountIdLongFalseNoId of finalizedByAccount. The account associated with the purchased product.
FinalizedByAccountlookUpNameStringFalseNoLookUpName of finalizedByAccount. The account associated with the purchased product.
Id [KEY]LongTrueNoThe unique identifier of the purchased product.
LicenseEndTimeDatetimeFalseNoThe end date of the license.
LicenseStartTimeDatetimeFalseNoThe start date of the license.
LookupNameStringTrueNoThe name used to look up the purchased product.
MailingIdLongFalseNoId of mailing. The associated mailing.
MailinglookUpNameStringFalseNoLookUpName of mailing. The associated mailing.
OpportunityIdLongFalseNoId of opportunity. The opportunity associated with the purchased product.
OpportunitylookUpNameStringFalseNoLookUpName of opportunity. The opportunity associated with the purchased product.
OrganizationIdLongFalseNoId of organization. The organization associated with the purchased product.
OrganizationlookUpNameStringFalseNoLookUpName of organization. The organization associated with the purchased product.
PurchaseTimeDatetimeFalseNoThe date and time of the purchase.
SalesProductIdLongFalseNoId of salesProduct. The sales product associated with the purchased product.
SalesProductlookUpNameStringFalseNoLookUpName of salesProduct. The sales product associated with the purchased product.
SerialNumberStringFalseNoThe serial number of the purchased product.
UpdatedTimeDatetimeTrueNoThe date and time when the purchased product was last updated. This attribute is read-only.
PricecurrencyIdLongFalseNoId of currency. The ID of the currency.
PricecurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
PriceexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
PriceexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
PricevalueStringFalseNoThe value of the currency.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AcceptCountIntFalseNoThe number of times an offer for the sales product was accepted through offer advisor.
CreatedTimeDatetimeTrueNoThe date and time when the sales product was created. This attribute is read-only.
DisplayOrderIntFalseNoThe display position of the sales product within the folder list in the product catalog.
ExcludeFromOfferAdvisorBoolFalseNoIndicates whether the product is excluded from the offer advisor. This attribute does not have a default value.
Id [KEY]LongTrueNoThe unique identifier of the sales product.
LookupNameStringTrueNoThe name used to look up the sales product.
NameStringTrueNoThe name of the product in the language of the current interface. This attribute is read-only.
PartNumberStringFalseNoThe text string which identifies the product. For example, stock keeping unit (SKU) or model number.
RespondCountIntFalseNoThe number of times the product was offered through the offer advisor.
ServiceProductIdLongFalseNoId of serviceProduct. The service product.
ServiceProductlookUpNameStringFalseNoLookUpName of serviceProduct. The service product.
UpdatedTimeDatetimeTrueNoThe date and time when the sales product was last updated. This attribute is read-only.
AttributesdisabledBoolFalseNoIndicates whether the product is temporarily disabled and will not be displayed. The default value is false.
AttributeshasSerialNumberBoolFalseNoIndicates whether the product has a serial number. The default value is false.
AttributesisSalesProductBoolFalseNoIndicates whether the product is a sales product. The default value is true.
AttributesisServiceProductBoolFalseNoIndicates whether the product is a service product. The default value is false.
FolderidLongFalseNoID value
FolderlookupNameStringFalseNoName used to lookup this object
adminVisibleInterfacesStringFalseYesThe list of interfaces on which the sales product is visible.
descriptionsStringFalseYesThe list of descriptions, one for each supported language.
namesStringFalseYesThe list of names, one for each supported language.
schedulesStringFalseYesThe list of associated price schedules.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdminVisibleInterfacesId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
AdminVisibleInterfacesLookUpNameStringFalseNoThe name used to look up the object.
SalesProductsIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
SalesProductsLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
SalesProductsIdLongFalseNoThe unique identifier of the sales product.
LabelTextStringFalseNoThe label text.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
SalesProductsIdLongFalseNoThe unique identifier of the sales product.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
SalesProductsIdLongFalseNoThe unique identifier of the sales product.
CommentStringFalseNoThe comments or notes associated with the sales product schedule.
ScheduleIdLongFalseNoId of schedule. The ID of the schedule. This is part of the key for the list entry.
SchedulelookUpNameStringFalseNoLookUpName of schedule. The ID of the schedule. This is part of the key for the list entry.
ScheduleEndDateDateFalseNoThe date when the schedule ends.
ScheduleStartDateDateFalseNoThe date when the schedule starts. This is part of the key for the list entry.
PricecurrencyIdLongFalseNoId of currency. The ID of the currency.
PricecurrencylookUpNameStringFalseNoLookUpName of currency. The ID of the currency.
PriceexchangeRateIdLongFalseNoId of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
PriceexchangeRatelookUpNameStringFalseNoLookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies.
PricevalueStringFalseNoThe value of the currency.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CommentStringFalseNoThe comments or notes associated with the sales territory.
CreatedTimeDatetimeTrueNoThe date and time when the sales territory was created. This attribute is read-only.
DisabledBoolFalseNoIndicates whether a sales territory is disabled. The default value is false.
DisplayOrderIntFalseNoThe display position of the sales territory relative to other members of the same group.
Id [KEY]LongTrueNoThe unique identifier of the sales territory.
LookupNameStringTrueNoThe name used to look up the sales territory.
NameStringTrueNoThe name of the sales territory in the language of the current interface. This attribute is read-only.
ParentIdLongFalseNoId of parent. The parent sales territory in the hierarchy.
ParentlookUpNameStringFalseNoLookUpName of parent. The parent sales territory in the hierarchy.
UpdatedTimeDatetimeTrueNoThe date and time when the sales territory was last updated. This attribute is read-only.
adminVisibleInterfacesStringFalseYesThe list of interfaces on which the category is available for administration use.
namesStringFalseYesThe list of names, one for each supported language.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdminVisibleInterfacesId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
AdminVisibleInterfacesLookUpNameStringFalseNoThe name used to look up the object.
SalesTerritoriesIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
SalesTerritoriesLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
SalesTerritoriesIdLongFalseNoThe unique identifier of the sales territory.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeTrueNoThe date and time when the service category was created. This attribute is read-only.
DisplayOrderIntFalseNoThe display position of the service category relative to other categories with the same parent.
Id [KEY]LongTrueNoThe unique identifier of the service category.
LookupNameStringTrueNoThe name used to look up the service category.
NameStringTrueNoThe name of the service category in the language of the current interface. This attribute is read-only.
ParentIdLongFalseNoId of parent. The parent category in the hierarchy.
ParentlookUpNameStringFalseNoLookUpName of parent. The parent category in the hierarchy.
UpdatedTimeDatetimeTrueNoThe date and time when the service category was last updated. This attribute is read-only.
adminVisibleInterfacesStringFalseYesThe list of interfaces on which the category is available for administration use.
descriptionsStringFalseYesThe list of descriptions, one for each supported language.
endUserVisibleInterfacesStringFalseYesThe list of interfaces on which the category is available for end user use.
namesStringFalseYesThe list of names, one for each supported language.
productLinksStringFalseYesThe category to product linking.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdminVisibleInterfacesId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
AdminVisibleInterfacesLookUpNameStringFalseNoThe name used to look up the object.
ServiceCategoriesIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
ServiceCategoriesLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceCategoriesIdLongFalseNoId of ServiceCategories.
LabelTextStringFalseNoThe label text.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
EndUserVisibleInterfacesId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
EndUserVisibleInterfacesLookUpNameStringFalseNoThe name used to look up the object.
ServiceCategoriesIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
ServiceCategoriesLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceCategoriesIdLongFalseNoThe unique identifier of the service category.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceCategoriesIdLongFalseNoId of ServiceCategories.
ServiceProductIdLongFalseNoId of serviceProduct. The ID of the service product. This is the key for the list entry.
ServiceProductlookUpNameStringFalseNoLookUpName of serviceProduct. The ID of the service product. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeTrueNoThe date and time when the service disposition was created. This attribute is read-only.
DisplayOrderIntFalseNoThe display position of the service disposition relative to other dispositions with the same parent.
Id [KEY]LongTrueNoThe unique identifier of the service disposition.
LookupNameStringTrueNoThe name used to look up the service disposition.
NameStringTrueNoThe name of the service disposition in the language of the current interface. This attribute is read-only.
ParentIdLongFalseNoId of parent. The parent disposition in the hierarchy.
ParentlookUpNameStringFalseNoLookUpName of parent. The parent disposition in the hierarchy.
UpdatedTimeDatetimeTrueNoThe date and time when the service disposition was last updated. This attribute is read-only.
adminVisibleInterfacesStringFalseYesThe list of interfaces on which the disposition is available for administration use.
descriptionsStringFalseYesThe list of descriptions, one for each supported language.
namesStringFalseYesThe list of names, one for each supported language.
productLinksStringFalseYesThe disposition to product linking.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdminVisibleInterfacesId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
AdminVisibleInterfacesLookUpNameStringFalseNoThe name used to look up the object.
ServiceDispositionsIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
ServiceDispositionsLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceDispositionsIdLongFalseNoId of ServiceDispositions.
LabelTextStringFalseNoThe label text.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceDispositionsIdLongFalseNoId of ServiceDispositions.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceDispositionsIdLongFalseNoId of ServiceDispositions.
ServiceProductIdLongFalseNoId of serviceProduct. The ID of the service product. This is the key for the list entry.
ServiceProductlookUpNameStringFalseNoLookUpName of serviceProduct. The ID of the service product. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeFalseNoThe date and time when the service mailbox was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the service mailbox.
InterfaceIdLongFalseNoId of interface. The interface that the mailbox is associated with.
InterfacelookUpNameStringFalseNoLookUpName of interface. The interface that the mailbox is associated with.
IsDefaultBoolFalseNoIndicates whether the mailbox is the default mailbox for the interface. This attribute does not have a default value.
LookupNameStringFalseNoThe name used to look up the service mailbox.
NameStringFalseNoThe name of the service mailbox in the language of the current interface.
TypeIdLongFalseNoId of type. The module the mailbox is associated with.
TypelookUpNameStringFalseNoLookUpName of type. The module the mailbox is associated with.
UpdatedTimeDatetimeFalseNoThe date and time when the service mailbox was last updated. This attribute is read-only.
IncomingEmailSettingsforceReplyBetweenLinesBoolFalseNoIndicates whether the Force Reply Between the Lines feature is enabled for outgoing emails from the mailbox. This attribute does not have a default value.
IncomingEmailSettingsforwardRejectMessageAddressStringFalseNoThe address to which rejected messages are sent.
IncomingEmailSettingsisEnabledBoolFalseNoIndicates whether incoming email option is enabled. This attribute does not have a default value.
OutgoingEmailSettingsdisplayNameStringFalseNoThe display name used in the outgoing emails from the mailbox.
OutgoingEmailSettingsfriendlyFromAddressStringFalseNoThe from address used to brand outgoing emails as friendly.
OutgoingEmailSettingsfromAddressStringFalseNoThe from address on the outgoing email.
OutgoingEmailSettingsisEnabledBoolFalseNoIndicates whether outgoing email is enabled. This attribute does not have a default value.
OutgoingEmailSettingsreplyToAddressStringFalseNoThe reply-to-address on the outgoing email.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeTrueNoThe date and time when the service product was created. This attribute is read-only.
DisplayOrderIntFalseNoThe display position of the service product relative to other products with the same parent.
Id [KEY]LongTrueNoThe unique identifier of the service product.
LookupNameStringTrueNoThe name used to look up the service product.
NameStringTrueNoThe name of the service product in the language of the current interface.
ParentIdLongFalseNoId of parent. The parent product in the hierarchy.
ParentlookUpNameStringFalseNoLookUpName of parent. The parent product in the hierarchy.
UpdatedTimeDatetimeTrueNoThe date and time when the service product was last updated. This attribute is read-only.
adminVisibleInterfacesStringFalseYesThe list of interfaces on which the category is available for administration use.
categoryLinksStringFalseYesThe product to category linking.
descriptionsStringFalseYesThe list of descriptions, one for each supported language.
dispositionLinksStringFalseYesThe product to disposition linking.
endUserVisibleInterfacesStringFalseYesThe list of interfaces on which the category is available for end user use.
namesStringFalseYesThe list of names, one for each supported language.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdminVisibleInterfacesId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
AdminVisibleInterfacesLookUpNameLongFalseNoThe unique identifier of the object. This is the key for the list entry.
ServiceProductsLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceProductsIdLongFalseNoId of serviceProducts.
ServiceCategoryIdLongFalseNoId of serviceCategory. The ID of the service category. This is the key for the list entry.
ServiceCategorylookUpNameStringFalseNoLookUpName of serviceCategory. The ID of the service category. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceProductsIdLongFalseNoId of ServiceProducts.
LabelTextStringFalseNoThe label text.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceProductsIdLongFalseNoId of ServiceProducts.
ServiceDispositionIdLongFalseNoId of serviceDisposition. The ID of the service disposition. This is the key for the list entry.
ServiceDispositionlookUpNameStringFalseNoLookUpName of serviceDisposition. The ID of the service disposition. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
EndUserVisibleInterfacesId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
EndUserVisibleInterfacesLookUpNameStringFalseNoThe name used to look up the object.
ServiceProductsIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
ServiceProductsLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceProductsIdLongFalseNoName of ServiceProducts.
LabelTextStringFalseNoThe language-specific label text. The value cannot be null or empty.
LanguageIdLongFalseNoId of language. The ID of the language. This is the key for the list entry.
LanguagelookUpNameStringFalseNoLookUpName of language. The ID of the language. This is the key for the list entry.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeFalseNoThe date and time when the site interface was created. This attribute is read-only.
DisplayNameStringFalseNoThe display name of the site interface.
Id [KEY]LongFalseNoThe unique identifier of the site interface.
LanguageIdLongFalseNoId of language. The language associated with the interface.
LanguagelookUpNameStringFalseNoLookUpName of language. The language associated with the interface.
LookupNameStringFalseNoThe name used to look up the site interface.
NameStringFalseNoThe name of the site interface.
UpdatedTimeDatetimeFalseNoThe date and time when the site interface was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CommentStringFalseNoThe comments associated with the standard content object.
CreatedTimeDatetimeTrueNoThe date and time when the standard content was created. This attribute is read-only.
DisplayOrderIntFalseNoThe display position of the standard content relative to other standard content objects with the same parent.
HotKeyStringFalseNoThe assigned shortcut key for inserting the standard content.
Id [KEY]LongTrueNoThe unique identifier of the standard content object.
LookupNameStringTrueNoThe name used to look up the standard content object.
NameStringFalseNoThe name of the standard content object.
UpdatedTimeDatetimeTrueNoThe date and time when the standard content was last updated. This attribute is read-only.
AttributesdisplayRightToLeftBoolFalseNoIndicates whether the content presentation is from right to left. The default value is false.
FolderidLongFalseNoID value
FolderlookupNameStringFalseNoName used to lookup this object
UsagechatTextBoolFalseNoIndicates whether the content is used in a chat session. The default value is false.
UsagechatURLBoolFalseNoIndicates whether the content is used in the URL of a chat session. The default value is false.
UsageincidentTextBoolFalseNoIndicates whether the content is used in an incident. The default value is false.
UsageruleTextBoolFalseNoIndicates whether the content is used in a rule. The default value is false.
adminVisibleInterfacesStringFalseYesThe list of interfaces on which the category is available for administration use.
contentValuesStringFalseYesThe list of the preformed content with entries for each content type.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdminVisibleInterfacesId [KEY]LongFalseNoThe unique identifier of the object. This is the key for the list entry.
AdminVisibleInterfacesLookUpNameStringFalseNoThe name used to look up the object.
StandardContentsIdLongFalseNoThe unique identifier of the object. This is the key for the list entry.
StandardContentsLookUpNameStringFalseNoThe name used to look up the object.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
StandardContentsIdLongFalseNoId of StandardContents.
ContentTypeIdLongFalseNoId of contentType. The content type of the data.
ContentTypelookUpNameStringFalseNoLookUpName of contentType. The content type of the data.
ValueStringFalseNoThe formatted data for the associated content type.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AssignedToAccountIdLongFalseNoId of assignedToAccount. The assigned staff account.
AssignedToAccountlookUpNameStringFalseNoLookUpName of assignedToAccount. The assigned staff account.
CompletedTimeDatetimeFalseNoThe date and time when the task was completed.
ContactIdLongFalseNoId of contact. The associated contact.
ContactlookUpNameStringFalseNoLookUpName of contact. The associated contact.
CreatedTimeDatetimeTrueNoThe date and time when the task was created. This attribute is read-only.
DueTimeDatetimeFalseNoThe date and time when the task is due.
Id [KEY]LongTrueNoThe unique identifier of the task.
LookupNameStringTrueNoThe name used to look up the task.
NameStringFalseNoThe name used to describe the task.
OrganizationIdLongFalseNoId of organization. The associated organization.
OrganizationlookUpNameStringFalseNoLookUpName of organization. The associated organization.
PercentCompleteIntFalseNoThe percentage of work completed.
PlannedCompletionTimeDatetimeFalseNoThe date and time when the task is planned for completion.
PriorityIdLongFalseNoId of priority. The relative priority.
PrioritylookUpNameStringFalseNoLookUpName of priority. The relative priority.
StartTimeDatetimeFalseNoThe date and time when the task started.
TaskTemplateIdLongFalseNoId of taskTemplate. The template for the business process.
TaskTemplatelookUpNameStringFalseNoLookUpName of taskTemplate. The template for the business process.
TaskTypeIdLongFalseNoId of taskType. The identifier of the task type, such as incident task. This works in conjunction with the inherit options to determine which associated object to inherit the data from.
TaskTypelookUpNameStringFalseNoLookUpName of taskType. The identifier of the task type, such as incident task. This works in conjunction with the inherit options to determine which associated object to inherit the data from.
UpdatedTimeDatetimeTrueNoThe date and time when the task was last updated. This attribute is read-only.
InheritinheritContactBoolFalseNoIndicates whether the task inherits contact value from the associated object. The default value is false.
InheritinheritOrganizationBoolFalseNoIndicates whether the task inherits organization value from the associated object. The default value is false.
InheritinheritStaffAssignmentBoolFalseNoIndicates whether the task inherits account value from the associated object. The default value is false.
MarketingSettingscampaignIdLongFalseNoId of campaign. The associated campaign.
MarketingSettingscampaignlookUpNameStringFalseNoLookUpName of campaign. The associated campaign.
MarketingSettingsdocumentIdLongFalseNoId of document. The associated marketing document.
MarketingSettingsdocumentlookUpNameStringFalseNoLookUpName of document. The associated marketing document.
MarketingSettingsmailingIdLongFalseNoId of mailing. The associated mailing.
MarketingSettingsmailinglookUpNameStringFalseNoLookUpName of mailing. The associated mailing.
MarketingSettingssurveyIdLongFalseNoId of survey. The associated survey.
MarketingSettingssurveylookUpNameStringFalseNoLookUpName of survey. The associated survey.
SalesSettingsopportunityIdLongFalseNoId of opportunity. The associated opportunity.
SalesSettingsopportunitylookUpNameStringFalseNoLookUpName of opportunity. The associated opportunity.
ServiceSettingsanswerIdLongFalseNoId of answer. The associated answer.
ServiceSettingsanswerlookUpNameStringFalseNoLookUpName of answer. The associated answer.
ServiceSettingsincidentIdLongFalseNoId of incident. The associated incident.
ServiceSettingsincidentlookUpNameStringFalseNoLookUpName of incident. The associated incident.
StatusWithTypestatusIdLongFalseNoId of status. The current status.
StatusWithTypestatuslookUpNameStringFalseNoLookUpName of status. The current status.
StatusWithTypestatusTypeIdLongTrueNoId of statusType. The associated status type. This attribute is read-only.
StatusWithTypestatusTypelookUpNameStringTrueNoLookUpName of statusType. The associated status type. This attribute is read-only.
fileAttachmentsStringFalseYesThe list of file attachments.
notesStringFalseYesThe list of discussion threads.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TasksIdLongFalseNoId of Tasks.
ContentTypeStringFalseNoThe MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
CreatedTimeDatetimeFalseNoThe date and time when the file was associated with the object. This attribute is read-only.
DataStringFalseNoThe Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
DescriptionStringFalseNoThe description for the contents of the file attachment.
FileNameStringFalseNoThe name of the file when saving it to the disk.
FormDataStringFalseNoThe HTML form which is used to upload file attachments.
Id [KEY]LongFalseNoThe unique identifier of the file attachment.
NameStringFalseNoThe short display name of the file attachment.
SizeIntFalseNoThe size of the file in bytes. This attribute is read-only.
URLStringFalseNoThe URL to access this file.
UpdatedTimeDatetimeFalseNoThe date and time when the file attachment was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TasksIdLongFalseNoId of Tasks.
ChannelIdLongFalseNoId of channel. The channel through which the note was created.
ChannellookUpNameStringFalseNoLookUpName of channel. The channel through which the note was created.
CreatedByAccountIdLongFalseNoId of createdByAccount. The staff member account that created the note.
CreatedByAccountlookUpNameStringFalseNoLookUpName of createdByAccount. The staff member account that created the note.
CreatedTimeDatetimeFalseNoThe date and time when the note was created. This attribute is read-only.
Id [KEY]LongFalseNoThe unique identifier of the note.
TextStringFalseNoThe text content in the note.
UpdatedByAccountIdLongFalseNoId of updatedByAccount. The staff member account that updated the note.
UpdatedByAccountlookUpNameStringFalseNoLookUpName of updatedByAccount. The staff member account that updated the note.
UpdatedTimeDatetimeFalseNoThe date and time when the note was last updated. This attribute is read-only.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreatedTimeDatetimeTrueNoThe date and time when the variable was created. This attribute is read-only.
DisplayOrderIntFalseNoThe position of the variable in the variable list.
Id [KEY]LongTrueNoThe unique identifier of the variable.
LookupNameStringTrueNoThe name used to look up the variable.
NameStringFalseNoThe name of the variable.
SearchIndexableBoolFalseNoIndicates whether the text is indexed for searching the customer portal. The default value is false.
UpdatedTimeDatetimeTrueNoThe date and time when the variable was last updated. This attribute is read-only.
FolderidLongFalseNoID value
FolderlookupNameStringFalseNoName used to lookup this object
interfaceValuesStringFalseYesThe list of values, one for each supported interface.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
VariablesIdLongFalseNoId of Variables.
InterfaceIdLongFalseNoId of interface. The interface of the site.
InterfacelookUpNameStringFalseNoLookUpName of interface. The interface of the site.
ValueStringFalseNoThe description of the interface.

Return to Top