Oracle Service Cloud Connector Objects
Name | Description |
---|---|
AccountGroups | The language-specific strings used for localization of fields. |
AccountGroupsDescriptions | The language-specific string used for localization. |
AccountGroupsNames | The language-specific strings used for localization of fields. |
Accounts | The account represents a staff member in Oracle B2C Service. |
AccountsEmails | The email address and its associated information. |
AccountsPhones | The details related to the phone number. |
AnalyticsReports | The analytics report definition that provides descriptions of a report's output columns, search criteria, and other components. |
AnalyticsReportsFilters | The filters used for running an analytics report. |
AnalyticsReportsNames | The language-specific strings used for localization of fields. |
Answers | The knowledge base information that provides solutions to the common customer support questions. |
AnswersCategories | The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. |
AnswersCommonAttachments | The file attachment shared by sibling answers. |
AnswersCommonAttachmentsNames | The 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. |
AnswersFileAttachments | The file attachment shared by answers. |
AnswersNotes | The note text associated with the objects such as contacts and organizations. |
AnswersProducts | The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. |
AnswersRelatedAnswers | The knowledge base information that provides solutions to the common customer support questions. |
AnswersSiblingAnswers | The knowledge base information that provides solutions to the common customer support questions. |
AnswerVersions | The versioned instance of an answer. Answers are solutions to common customer support questions. |
AnswerVersionsCategories | The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. |
AnswerVersionsCommonAttachments | The file attachment shared by sibling answers. |
AnswerVersionsCommonAttachmentsNames | The 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. |
AnswerVersionsFileAttachments | The file attachment shared by answers. |
AnswerVersionsNotes | The note text associated with the objects such as contacts and organizations. |
AnswerVersionsProducts | The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. |
AnswerVersionsRelatedAnswers | The link to related answers. |
Assets | The product or service associated with an organization's customers. |
AssetsSLAInstances | The instance of a Service Level Agreement (SLA). |
AssetStatuses | The status of the assets, namely product and services that are registered and tracked in Oracle B2C Service. |
AssetStatusesNames | The language-specific strings used for localization of fields. |
Campaigns | The information on email marketing campaigns created in Oracle B2C Service Outreach Cloud Service. |
ChannelTypes | The social channels tracked in contact records when storing social account user names and associating social monitor incidents to contacts. |
ChannelTypesNames | The language-specific strings used for localization of fields. |
Chats | The real-time, two-way dialog between a customer and one or more chat agents. |
Configurations | The information about the configuration settings within Oracle B2C Service. |
ContactMarketingRosters | The information about the contact lists used in audiences in Oracle Service Cloud Outreach Cloud Service. |
Contacts | The customers or end users of Oracle B2C Service site. |
ContactsChannelUsernames | The user name of the channel. |
ContactsEmails | The email address and its associated information. |
ContactsFileAttachments | The file attachment that includes additional fields used for attachments to various classes. |
ContactsNotes | The note text associated with the objects such as contacts and organizations. |
ContactsOpenIDAccounts | The OpenID related information for the contact. |
ContactsPhones | The details related to the phone number. |
Countries | The details about the countries and provinces which are used to maintain accurate address information for the organizations and contacts in Oracle B2C Service. |
CountriesNames | The language-specific strings used for localization of fields. |
CountriesProvinces | The information about the provinces in the Countries/Provinces customizable menu. |
CountriesProvincesNames | The 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. |
EventSubscriptions | The event-based subscription management object that allows external applications to discover objects that can be subscribed. |
Holidays | The list of holidays in your organization. |
HolidaysAdminVisibleInterfaces | The named ID that can be included in a list. |
Incidents | The 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. |
IncidentsBilledMinutes | The work time applied to incidents through the Time Billed feature. |
IncidentsFileAttachments | The file attachment that includes fields specific to incidents. |
IncidentsMilestoneInstances | The milestone instances associated with incidents. |
IncidentsThreads | The incident discussion thread entry. |
Mailboxes | The mailbox used for collecting email inquiries sent by customers, responses to mailings, and bounced messages. |
MarketingMailboxes | The mailbox used to send and receive emails and process bounced messages. |
MessageBases | The 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. |
NamedIDs | An ID which has an associated name string. These IDs can be set by either value or name. |
Opportunities | The 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. |
OpportunitiesFileAttachments | The file attachment that includes additional fields used for attachments to various classes. |
OpportunitiesNotes | The note text associated with the objects such as contacts and organizations. |
OpportunitiesOtherContacts | The secondary contact associated with the opportunity. |
OpportunitiesQuotes | The sales quote associated with an opportunity. |
OpportunitiesQuotesFileAttachments | The file that is attached or associated with another object. |
OpportunitiesQuotesLineItems | The product line item in a quote. |
OpportunityStatuses | The information about the default and custom opportunity statuses and their corresponding types. |
OpportunityStatusesNames | The language-specific strings used for localization of fields. |
Organizations | The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. |
OrganizationsAddresses | The physical address of the organization. |
OrganizationsFileAttachments | The file attachment that includes additional fields used for attachments to various classes. |
OrganizationsNotes | The note text associated with the objects such as contacts and organizations. |
PurchasedProducts | The information about a purchased product. |
SalesProducts | The items or services sold by an organization. |
SalesProductsAdminVisibleInterfaces | The named ID that can be included in a list. |
SalesProductsDescriptions | The language-specific string used for localization. |
SalesProductsNames | The language-specific strings used for localization of fields. |
SalesProductsSchedules | The price schedule for a sales product. |
SalesTerritories | The specific geographical sales region. Sales representatives can be assigned specific territories for opportunity assignment. |
SalesTerritoriesAdminVisibleInterfaces | The named ID that can be included in a list. |
SalesTerritoriesNames | The language-specific strings used for localization of fields. |
ServiceCategories | The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. |
ServiceCategoriesAdminVisibleInterfaces | The named ID that can be included in a list. |
ServiceCategoriesDescriptions | The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field. |
ServiceCategoriesEndUserVisibleInterfaces | The named ID that can be included in a list. |
ServiceCategoriesNames | The language-specific strings used for localization of fields. |
ServiceCategoriesProductLinks | The product linking for a category or a disposition. |
ServiceDispositions | The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved. |
ServiceDispositionsAdminVisibleInterfaces | The named ID that can be included in a list. |
serviceDispositionsDescriptions | The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field. |
ServiceDispositionsNames | The language-specific strings used for localization of fields. |
ServiceDispositionsProductLinks | The product linking for a category or a disposition. |
ServiceMailboxes | The email box dedicated to collect email inquiries sent by customers. |
ServiceProducts | The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. |
ServiceProductsAdminVisibleInterfaces | The named ID that can be included in a list. |
ServiceProductsCategoryLinks | The category linking for a product. |
ServiceProductsDescriptions | The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field. |
ServiceProductsDispositionLinks | The disposition linking for a product. |
ServiceProductsEndUserVisibleInterfaces | The named ID that can be included in a list. |
ServiceProductsNames | The language-specific strings used for localization of fields. |
SiteInterfaces | The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. |
StandardContents | The 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. |
StandardContentsAdminVisibleInterfaces | The named ID that can be included in a list. |
StandardContentsContentValues | The standard content value with a data type and a formatted data value. |
Tasks | The information about an action or an activity scheduled to be completed within a specified time. |
TasksFileAttachments | The file attachment that includes additional fields used for attachments to various classes. |
TasksNotes | The note text associated with the objects such as contacts and organizations. |
Variables | A shortcut defined for a larger string that can be inserted in the body of an answer or inserted inline during a chat session. |
VariablesInterfaceValues | The interface-specific value of a variable. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | Long | False | No | The unique identifier of the account group . | |
LookupName | String | False | No | The name used to look up the account group. | |
Name | Long | False | No | The name of the account group in the language of the current interface. | |
DisplayOrder | Long | False | No | The order in which this account group is displayed relative to other members of the same group. | |
UpdatedTime | String | False | No | The date and time when the account group was last updated. | |
CreatedTime | String | False | No | The date and time when the account group was created | |
AttributesCustomerCareAccess | Boolean | False | No | The customer care access group. | |
Descriptions | String | False | Yes | The list of descriptions, one for each supported language. | |
Names | String | False | Yes | The list of names, one for each supported language. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AccountGroupId | Long | False | No | The unique identifier of the Account Groups. | |
LabelText | String | False | No | The label text. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AccountGroupId | Long | False | No | The unique identifier of the Account Groups. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CountryId | Long | False | No | Id of country. The default country identifier. | |
CountrylookUpName | String | False | No | LookUpName of country. The default country identifier. | |
CreatedTime | Datetime | True | No | The date and time when the account was created. This attribute is read-only. | |
DisplayName | String | False | No | The display name of the account. | |
DisplayOrder | Int | False | No | The order in which this staff account is displayed relative to other members of the same group. | |
EmailNotificationId | Long | False | No | Id of emailNotification. The format the staff member prefers for email notifications. | |
EmailNotificationlookUpName | String | False | No | LookUpName of emailNotification. The format the staff member prefers for email notifications. | |
Id [KEY] | Long | True | No | The unique identifier of the account. | |
Login | String | False | No | The user name used for authentication. | |
LookupName | String | True | No | The name used to look up the account. | |
ManagerId | Long | False | No | Id of manager. The manager of the staff member. | |
ManagerlookUpName | String | False | No | LookUpName of manager. The manager of the staff member. | |
NewPassword | String | False | No | The new password for authentication. It is stored with a one-way encryption in the system. This attribute is write-only. | |
NotificationPending | Bool | True | No | Indicates whether any notifications are pending. This attribute does not have a default value and is read-only. | |
PasswordExpirationTime | Datetime | True | No | The date and time when the password is set to expire. This attribute is read-only. | |
ProfileId | Long | False | No | Id of profile. The profile to which the staff account is assigned. | |
ProfilelookUpName | String | False | No | LookUpName of profile. The profile to which the staff account is assigned. | |
Signature | String | False | No | The email signature of the account. | |
StaffGroupId | Long | False | No | Id of staffGroup. The group to which the staff member is assigned. | |
StaffGrouplookUpName | String | False | No | LookUpName of staffGroup. The group to which the staff member is assigned. | |
UpdatedTime | Datetime | True | No | The date and time when the account was last updated. This attribute is read-only. | |
AttributesaccountLocked | Bool | False | No | Indicates 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. | |
AttributescanModifyEmailSignature | Bool | False | No | Indicates whether the staff member can modify the email signature. The default value is false. | |
AttributesforcePasswordChange | Bool | False | No | Indicates 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. | |
AttributesinfrequentUser | Bool | False | No | Indicates whether the staff member is considered as an infrequent user seat, as opposed to a full seat. The default value is false. | |
AttributespasswordNeverExpires | Bool | False | No | Indicates whether the staff member's account password never expires. This setting overrides system-wide password expiration configurations. The default value is false. | |
AttributespermanentlyDisabled | Bool | False | No | Indicates 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. | |
AttributesstaffAssignmentDisabled | Bool | False | No | Indicates whether the staff member's account cannot be assigned to incidents, answers, opportunities, and tasks. The default value is false. | |
AttributesviewsReportsDisabled | Bool | False | No | Indicates whether the staff member's account cannot be included in the list for filters in reports. The default value is false. | |
AttributesvirtualAccount | Bool | True | No | Indicates whether the staff member's account is virtual. The default value is false. This attribute is read-only. | |
Namefirst | String | False | No | The first name of the person. | |
Namelast | String | False | No | The surname or last name of the person. | |
NameFuriganafirst | String | False | No | The first name of the person. | |
NameFuriganalast | String | False | No | The surname or last name of the person. | |
SalesSettingsdefaultCurrencyId | Long | False | No | Id of defaultCurrency. The default currency ID. | |
SalesSettingsdefaultCurrencylookUpName | String | False | No | LookUpName of defaultCurrency. The default currency ID. | |
SalesSettingsterritoryId | Long | False | No | Id of territory. The sales territory ID. | |
SalesSettingsterritorylookUpName | String | False | No | LookUpName of territory. The sales territory ID. | |
ServiceSettingsscreenPopPort | Int | False | No | The 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. | |
emails | String | False | Yes | The list of email addresses. | |
phones | String | False | Yes | The list of phone numbers. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AccountsId | Long | False | No | Id of Accounts. | |
Address | String | False | No | The string value of the email address. | |
AddressTypeId | Long | False | No | Id of addressType. The type of address, such as Primary or Alt1. This is the key for the list entry. | |
AddressTypelookUpName | String | False | No | LookUpName of addressType. The type of address, such as Primary or Alt1. This is the key for the list entry. | |
Certificate | String | False | No | The associated public email certificate used to encrypt outgoing emails. | |
Invalid | Bool | False | No | Indicates whether the email address is disabled. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AccountsId | Long | False | No | Id of Accounts. | |
Number | String | False | No | The free-form phone number including non-numeric characters. For example, 1 (406) 522-4200. | |
PhoneTypeId | Long | False | No | Id of phoneType. The type of phone number such as Home, Mobile, Office, and so on. This is the key for the list entry. | |
PhoneTypelookUpName | String | False | No | LookUpName of phoneType. The type of phone number such as Home, Mobile, Office, and so on. This is the key for the list entry. | |
RawNumber | String | False | No | The 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. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | False | No | The date and time when the analytics report was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the analytics report definition. | |
LookupName | String | False | No | The name used to look up the analytics report definition. | |
Name | String | False | No | The name of the report in the language of the current interface. This attribute is read-only. | |
UpdatedTime | Datetime | False | No | The date and time when the analytics report was last updated. This attribute is read-only. | |
columns | String | False | Yes | The columns defined in the report. | |
filters | String | False | Yes | The filters defined on the report. | |
names | String | False | Yes | The list of language-specific display names. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnalyticsReportsId | Long | False | No | Id of analytics report | |
Name | String | False | No | Name of filter | |
Values | String | False | No | Values of filter |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnalyticsReportsId | Long | False | No | Id of AnalyticsReports. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AdminLastAccessTime | Datetime | True | No | The date and time when the answer was last accessed by an administrator. This attribute is read-only. | |
AnswerTypeId | Long | False | No | Id of answerType. The type of storage for answer information. | |
AnswerTypelookUpName | String | False | No | LookUpName of answerType. The type of storage for answer information. | |
AnswerVersionId | Long | True | No | Id of answerVersion. The versioned instance of the answer. This attribute is read-only. | |
AnswerVersionlookUpName | String | True | No | LookUpName of answerVersion. The versioned instance of the answer. This attribute is read-only. | |
AssignedSiblingId | Long | False | No | Id of assignedSibling. Another answer with which this answer should be associated. | |
AssignedSiblinglookUpName | String | False | No | LookUpName of assignedSibling. Another answer with which this answer should be associated. | |
CreatedTime | Datetime | True | No | The date and time when the answer was created. This attribute is read-only. | |
ExpiresDate | Date | False | No | The date when the answer expires and is set to review status. | |
GuidedAssistanceId | Long | True | No | Id of guidedAssistance. The Guided Assistance guide. | |
GuidedAssistancelookUpName | String | True | No | LookUpName of guidedAssistance. The Guided Assistance guide. | |
Id [KEY] | Long | True | No | The unique identifier of the answer. | |
Keywords | String | False | No | The list of space separated keywords associated with an answer. | |
LanguageId | Long | False | No | Id of language. The language used for the answer text. | |
LanguagelookUpName | String | False | No | LookUpName of language. The language used for the answer text. | |
LastAccessTime | Datetime | True | No | The date and time when the answer was last accessed. This attribute is read-only. | |
LastNotificationTime | Datetime | True | No | The date and time when the last notification was generated. This attribute is read-only. | |
LookupName | String | True | No | The name used to look up the answer. | |
Name | String | True | No | The string version of the answer ID, which is used as the reference number of the answer. This attribute is read-only. | |
NextNotificationTime | Datetime | False | No | The date and time when the next earliest notification will be sent. | |
OriginalReferenceNumber | String | False | No | The reference number of the incident that was proposed to create this answer. The reference number is common for all the sibling answers. | |
PositionInListId | Long | False | No | Id of positionInList. This attribute is used to initialize and/or force this answer to a particular ranking in the search results. | |
PositionInListlookUpName | String | False | No | LookUpName of positionInList. This attribute is used to initialize and/or force this answer to a particular ranking in the search results. | |
PublishOnDate | Date | False | No | The date when the answer will be published and made available to users. | |
Question | String | False | No | The question or the description of the answer. | |
Solution | String | False | No | The solution or the answer portion of the answer. | |
SpecialResponse | String | False | No | The special response of the answer. | |
Summary | String | False | No | The title or short summary of the answer. | |
URL | String | False | No | The URL which returns the answer, if the answer type is URL. | |
UpdatedByAccountId | Long | True | No | Id of updatedByAccount. The staff account who last edited the answer. This attribute is read-only. | |
UpdatedByAccountlookUpName | String | True | No | LookUpName of updatedByAccount. The staff account who last edited the answer. This attribute is read-only. | |
UpdatedTime | Datetime | True | No | The date and time when the answer was last updated. This attribute is read-only. | |
AssignedToaccountId | Long | False | No | Id of account. The staff account. | |
AssignedToaccountlookUpName | String | False | No | LookUpName of account. The staff account. | |
AssignedTostaffGroupId | Long | False | No | Id of staffGroup. The staff group. The caller should assign the staff group when assigning to an account. | |
AssignedTostaffGrouplookUpName | String | False | No | LookUpName of staffGroup. The staff group. The caller should assign the staff group when assigning to an account. | |
BannerimportanceFlagId | Long | False | No | Id of importanceFlag. The importance of the banner. | |
BannerimportanceFlaglookUpName | String | False | No | LookUpName of importanceFlag. The importance of the banner. | |
Bannertext | String | False | No | The description of a flag. | |
BannerupdatedByAccountId | Long | True | No | Id of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedByAccountlookUpName | String | True | No | LookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedTime | Datetime | True | No | The date and time when the banner was last updated. This attribute is read-only. | |
StatusWithTypestatusId | Long | False | No | Id of status. The current status. | |
StatusWithTypestatuslookUpName | String | False | No | LookUpName of status. The current status. | |
StatusWithTypestatusTypeId | Long | True | No | Id of statusType. The associated status type. This attribute is read-only. | |
StatusWithTypestatusTypelookUpName | String | True | No | LookUpName of statusType. The associated status type. This attribute is read-only. | |
VersionDetaildraftNote | String | False | No | The draft note for the answer version. | |
VersionDetaildraftTime | Datetime | False | No | The date and time when the draft answer version was created. | |
VersionDetailpublishNote | String | False | No | The published note for the answer version. | |
VersionDetailpublishedTime | Datetime | False | No | The date and time when the draft answer version was published. | |
VersionDetailstateId | Long | False | No | Id of state. The state of the version. | |
VersionDetailstatelookUpName | String | False | No | LookUpName of state. The state of the version. | |
VersionDetailunpublishedTime | Datetime | False | No | The date and time when the answer version was unpublished. | |
categories | String | False | Yes | The hierarchical service category. | |
commonAttachments | String | False | Yes | The file attachments common to all sibling answers. | |
fileAttachments | String | False | Yes | The list of file attachments. | |
notes | String | False | Yes | The list of discussion threads. | |
products | String | False | Yes | The products common to all sibling answers. | |
relatedAnswers | String | False | Yes | The related answers linked to this answer. | |
siblingAnswers | String | False | Yes | The sibling answers with which this answer is associated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CategoriesId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
CategoriesLookUpName | String | False | No | The name used to look up the object. | |
AnswersId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AnswersLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnswersId | Long | False | No | Id of Answers. | |
ContentType | String | False | No | The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
CreatedTime | Datetime | False | No | The date and time when the file was associated with the answer. This attribute is read-only. | |
Data | String | False | No | The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field. | |
Disabled | Bool | False | No | Indicates 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. | |
FileName | String | False | No | The name of the file when saving it to the disk. | |
FormData | String | False | No | ||
Id [KEY] | Long | False | No | The unique identifier of the file attachment. | |
Private | Bool | False | No | Indicates whether the file attachment is hidden from the end users. This attribute does not have a default value. | |
Size | Int | False | No | The size of the file in bytes. This attribute is read-only. | |
URL | String | False | No | The URL to access this file. | |
UpdatedTime | Datetime | False | No | The date and time when the file was last updated. This attribute is read-only. | |
names | String | False | Yes | The list of language specific display names. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnswersId | Long | False | No | Id of Answers. | |
CommonAttachmentsId | Long | False | No | Id of CommonAttachments. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnswersId | Long | False | No | Id of Answers. | |
ContentType | String | False | No | The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
CreatedTime | Datetime | False | No | The date and time when the file was associated with the answer. This attribute is read-only. | |
Data | String | False | No | The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field. | |
Description | String | False | No | The description for the contents of the file attachment. | |
Disabled | Bool | False | No | Indicates 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. | |
FileName | String | False | No | The name of the file when saving it to the disk. | |
FormData | String | False | No | The HTML form which is used to upload file attachments. | |
Id [KEY] | Long | False | No | The unique identifier of the file attachment. | |
Indexed | Bool | False | No | Indicates whether the file attachment's contents are included in the keyword indexing of the answer. This attribute does not have a default value. | |
Name | String | False | No | The short display name of the file attachment. | |
Private | Bool | False | No | Indicates whether the file attachment is hidden from the end users. The default value is false. | |
Size | Int | False | No | The size of the file in bytes. This attribute is read-only. | |
URL | String | False | No | The URL to access the file. | |
UpdatedTime | Datetime | False | No | The date and time when the file was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnswersId | Long | False | No | Id of Answers. | |
ChannelId | Long | False | No | Id of channel. The channel through which the note was created. | |
ChannellookUpName | String | False | No | LookUpName of channel. The channel through which the note was created. | |
CreatedByAccountId | Long | False | No | Id of createdByAccount. The staff member account that created the note. | |
CreatedByAccountlookUpName | String | False | No | LookUpName of createdByAccount. The staff member account that created the note. | |
CreatedTime | Datetime | False | No | The date and time when the note was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the note. | |
Text | String | False | No | The text content in the note. | |
UpdatedByAccountId | Long | False | No | Id of updatedByAccount. The staff member account that updated the note. | |
UpdatedByAccountlookUpName | String | False | No | LookUpName of updatedByAccount. The staff member account that updated the note. | |
UpdatedTime | Datetime | False | No | The date and time when the note was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ProductsId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
ProductsLookUpName | String | False | No | The name used to look up the object. | |
AnswersId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AnswersLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnswersId | Long | False | No | Id of Answers. | |
LearnedStrength | Int | False | No | The relative relatedness of the linked answers. | |
ManualStrength | Int | False | No | The static strength of the link. | |
SimilarityStrength | Int | False | No | The strength of the link calculated by the link-clustering algorithms based on the content similarity of the answers. | |
ToAnswerId | Long | False | No | Id 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. | |
ToAnswerlookUpName | String | False | No | LookUpName 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. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
SiblingAnswersId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
SiblingAnswersLookUpName | String | False | No | The name used to look up the object. | |
AnswersId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AnswersLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AdminLastAccessTime | Datetime | True | No | The date and time when the answer version was last accessed by an administrator. This attribute is read-only. | |
AnswerId | Long | True | No | Id of answer. The live answer related to this answer version. | |
AnswerlookUpName | String | True | No | LookUpName of answer. The live answer related to this answer version. | |
AnswerTypeId | Long | False | No | Id of answerType. The type of storage for answer version information. | |
AnswerTypelookUpName | String | False | No | LookUpName of answerType. The type of storage for answer version information. | |
CreatedTime | Datetime | True | No | The date and time when the answer version was created. This attribute is read-only. | |
ExpiresDate | Date | False | No | The date when the answer version expires and is set to review status. | |
GuidedAssistanceId | Long | True | No | Id of guidedAssistance. The Guided Assistance guide. | |
GuidedAssistancelookUpName | String | True | No | LookUpName of guidedAssistance. The Guided Assistance guide. | |
Id [KEY] | Long | True | No | The unique identifier of the answer version. | |
Keywords | String | False | No | The list of space separated keywords associated with an answer version. | |
LanguageId | Long | False | No | Id of language. The language used for the answer text. | |
LanguagelookUpName | String | False | No | LookUpName of language. The language used for the answer text. | |
LastAccessTime | Datetime | True | No | The date and time when the answer version was last accessed. This attribute is read-only. | |
LastNotificationTime | Datetime | True | No | The date and time when the last notification was generated. This attribute is read-only. | |
LookupName | String | True | No | The name used to look up the answer version. | |
Name | String | True | No | The string version of the answer ID, which is used as the reference number of the answer version. This attribute is read-only. | |
NextNotificationTime | Datetime | False | No | The date and time when the next notification will be sent. | |
OriginalReferenceNumber | String | False | No | The reference number of the incident that was proposed to create this answer. The reference number is common for all the sibling answers. | |
PositionInListId | Long | False | No | Id of positionInList. This attribute is used to initialize and/or force this answer to a particular ranking in the search results. | |
PositionInListlookUpName | String | False | No | LookUpName of positionInList. This attribute is used to initialize and/or force this answer to a particular ranking in the search results. | |
PublishOnDate | Date | False | No | The date when the answer version will be published and made available to users. | |
Question | String | False | No | The question or the description of the answer version. | |
Solution | String | False | No | The solution or the answer portion of this version of the answer. | |
SpecialResponse | String | False | No | The special response of this version of the answer. | |
Summary | String | False | No | The title or short summary of the answer version. | |
URL | String | False | No | The URL which returns this version of the answer, if the answer type is URL. | |
UpdatedByAccountId | Long | True | No | Id of updatedByAccount. The staff account who last edited the answer version. This attribute is read-only. | |
UpdatedByAccountlookUpName | String | True | No | LookUpName of updatedByAccount. The staff account who last edited the answer version. This attribute is read-only. | |
UpdatedTime | Datetime | True | No | The date and time when the answer version was last updated. This attribute is read-only. | |
AssignedToaccountId | Long | False | No | Id of account. The staff account. | |
AssignedToaccountlookUpName | String | False | No | LookUpName of account. The staff account. | |
AssignedTostaffGroupId | Long | False | No | Id of staffGroup. The staff group. The caller should assign the staff group when assigning to an account. | |
AssignedTostaffGrouplookUpName | String | False | No | LookUpName of staffGroup. The staff group. The caller should assign the staff group when assigning to an account. | |
BannerimportanceFlagId | Long | False | No | Id of importanceFlag. The importance of the banner. | |
BannerimportanceFlaglookUpName | String | False | No | LookUpName of importanceFlag. The importance of the banner. | |
Bannertext | String | False | No | The description of a flag. | |
BannerupdatedByAccountId | Long | True | No | Id of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedByAccountlookUpName | String | True | No | LookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedTime | Datetime | True | No | The date and time when the banner was last updated. This attribute is read-only. | |
StatusWithTypestatusId | Long | False | No | Id of status. The current status. | |
StatusWithTypestatuslookUpName | String | False | No | LookUpName of status. The current status. | |
StatusWithTypestatusTypeId | Long | True | No | Id of statusType. The associated status type. This attribute is read-only. | |
StatusWithTypestatusTypelookUpName | String | True | No | LookUpName of statusType. The associated status type. This attribute is read-only. | |
VersionDetaildraftNote | String | False | No | The draft note for the answer version. | |
VersionDetaildraftTime | Datetime | False | No | The date and time when the draft answer version was created. | |
VersionDetailpublishNote | String | False | No | The published note for the answer version. | |
VersionDetailpublishedTime | Datetime | False | No | The date and time when the draft answer version was published. | |
VersionDetailstateId | Long | False | No | Id of state. The state of the version. | |
VersionDetailstatelookUpName | String | False | No | LookUpName of state. The state of the version. | |
VersionDetailunpublishedTime | Datetime | False | No | The date and time when the answer version was unpublished. | |
categories | String | False | Yes | The categories common to all sibling answers. | |
commonAttachments | String | False | Yes | The file attachments common to all sibling answers. | |
fileAttachments | String | False | Yes | The list of file attachments. | |
notes | String | False | Yes | The list of discussion threads. | |
products | String | False | Yes | The products common to all sibling answers. | |
relatedAnswers | String | False | Yes | The related answers linked to this answer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CategoriesId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
CategoriesLookUpName | String | False | No | The name used to look up the object. | |
AnswerVersionsId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AnswerVersionsLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnswerVersionsId | Long | False | No | Id of AnswerVersions. | |
ContentType | String | False | No | The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
CreatedTime | Datetime | False | No | The date and time when the file was associated with the answer. This attribute is read-only. | |
Data | String | False | No | The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field. | |
Disabled | Bool | False | No | Indicates 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. | |
FileName | String | False | No | The name of the file when saving it to the disk. | |
FormData | String | False | No | The form data. | |
Id [KEY] | Long | False | No | The unique identifier of the file attachment. | |
Private | Bool | False | No | Indicates whether the file attachment is hidden from the end users. This attribute does not have a default value. | |
Size | Int | False | No | The size of the file in bytes. This attribute is read-only. | |
URL | String | False | No | The URL to access this file. | |
UpdatedTime | Datetime | False | No | The date and time when the file was last updated. This attribute is read-only. | |
names | String | False | Yes | The list of language specific display names. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnswerVersionsId | Long | False | No | The Id of AnswerVersions. | |
CommonAttachmentsId | Long | False | No | The Id of CommonAttachments. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnswerVersionsId | Long | False | No | The Id of Answer Version. | |
ContentType | String | False | No | The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
CreatedTime | Datetime | False | No | The date and time when the file was associated with the answer. This attribute is read-only. | |
Data | String | False | No | The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field. | |
Description | String | False | No | The description for the contents of the file attachment. | |
Disabled | Bool | False | No | Indicates 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. | |
FileName | String | False | No | The name of the file when saving it to the disk. | |
FormData | String | False | No | The HTML form which is used to upload file attachments. | |
Id [KEY] | Long | False | No | The unique identifier of the file attachment. | |
Indexed | Bool | False | No | Indicates whether the file attachment's contents are included in the keyword indexing of the answer. This attribute does not have a default value. | |
Name | String | False | No | The short display name of the file attachment. | |
Private | Bool | False | No | Indicates whether the file attachment is hidden from the end users. The default value is false. | |
Size | Int | False | No | The size of the file in bytes. This attribute is read-only. | |
URL | String | False | No | The URL to access the file. | |
UpdatedTime | Datetime | False | No | The date and time when the file was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnswerVersionsId | Long | False | No | Id of the answer version. | |
ChannelId | Long | False | No | Id of channel. The channel through which the note was created. | |
ChannellookUpName | String | False | No | LookUpName of channel. The channel through which the note was created. | |
CreatedByAccountId | Long | False | No | Id of createdByAccount. The staff member account that created the note. | |
CreatedByAccountlookUpName | String | False | No | LookUpName of createdByAccount. The staff member account that created the note. | |
CreatedTime | Datetime | False | No | The date and time when the note was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the note. | |
Text | String | False | No | The text content in the note. | |
UpdatedByAccountId | Long | False | No | Id of updatedByAccount. The staff member account that updated the note. | |
UpdatedByAccountlookUpName | String | False | No | LookUpName of updatedByAccount. The staff member account that updated the note. | |
UpdatedTime | Datetime | False | No | The date and time when the note was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ProductsId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
ProductsLookUpName | String | False | No | The name used to look up the object. | |
AnswerVersionsId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AnswerVersionsLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AnswerVersionsId | Long | False | No | The unique identifier of the answer version. | |
LearnedStrength | Int | False | No | The relative relatedness of the linked answers. | |
ManualStrength | Int | False | No | The static strength of the link. | |
SimilarityStrength | Int | False | No | The strength of the link calculated by the link-clustering algorithms based on the content similarity of the answers. | |
ToAnswerId | Long | False | No | Id 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. | |
ToAnswerlookUpName | String | False | No | LookUpName 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. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ContactId | Long | False | No | Id of contact. The contact associated with the asset. | |
ContactlookUpName | String | False | No | LookUpName of contact. The contact associated with the asset. | |
CreatedTime | Datetime | True | No | The date and time when the asset was created. This attribute is read-only. | |
Description | String | False | No | The description of the asset. | |
Id [KEY] | Long | True | No | The unique identifier of the asset. | |
InstalledDate | Date | False | No | The date when the asset was installed. | |
LookupName | String | True | No | The name used to look up the asset. | |
Name | String | False | No | The name of the asset used as the lookupName for the asset object. | |
OrganizationId | Long | False | No | Id of organization. The organization associated with the asset. | |
OrganizationlookUpName | String | False | No | LookUpName of organization. The organization associated with the asset. | |
ProductId | Long | False | No | Id of product. The product associated with the asset. | |
ProductlookUpName | String | False | No | LookUpName of product. The product associated with the asset. | |
PurchasedDate | Date | False | No | The date when the asset was purchased. | |
RetiredDate | Date | False | No | The date when the asset was retired. | |
SerialNumber | String | False | No | The serial number of the asset. | |
UpdatedTime | Datetime | True | No | The date and time when the asset was last updated. This attribute is read-only. | |
PricecurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
PricecurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
PriceexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
PriceexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
Pricevalue | String | False | No | The value of the currency. | |
StatusWithTypestatusId | Long | False | No | Id of status. The current status. | |
StatusWithTypestatuslookUpName | String | False | No | LookUpName of status. The current status. | |
StatusWithTypestatusTypeId | Long | True | No | Id of statusType. The associated status type. This attribute is read-only. | |
StatusWithTypestatusTypelookUpName | String | True | No | LookUpName of statusType. The associated status type. This attribute is read-only. | |
sLAInstances | String | False | Yes | The SLA instances associated with the asset. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AssetsId | Long | False | No | The unique identifier of the asset. | |
ActiveDate | Date | False | No | The date when the instance became active. | |
ExpireDate | Date | False | No | The date when the instance is scheduled to expire. | |
Id [KEY] | Long | False | No | The unique identifier of the SLAInstance. | |
NameOfSLAId | Long | False | No | Id of nameOfSLA. The SLA from which the instance was created. | |
NameOfSLAlookUpName | String | False | No | LookUpName of nameOfSLA. The SLA from which the instance was created. | |
RemainingFromCSR | Int | False | No | The number of remaining CSR incidents. | |
RemainingFromChat | Int | False | No | The number of remaining chat incidents. | |
RemainingFromEmail | Int | False | No | The number of remaining email incidents. | |
RemainingFromWeb | Int | False | No | The number of remaining web self-service incidents. | |
RemainingTotal | Int | False | No | The total number of remaining incidents. | |
SLASet | Int | False | No | The SLA set from which the instance was created. | |
StateOfSLAId | Long | False | No | Id of stateOfSLA. The current state of the SLA. The supported values are Inactive, Active, Expired, or Disabled. | |
StateOfSLAlookUpName | String | False | No | LookUpName of stateOfSLA. The current state of the SLA. The supported values are Inactive, Active, Expired, or Disabled. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | False | No | The date and time when the asset status was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The display position relative to other asset statuses. | |
Id [KEY] | Long | False | No | The unique identifier of the asset status. | |
LookupName | String | False | No | The name used to look up the asset status. | |
Name | String | False | No | The name of the asset status in the language of the current interface. | |
StatusTypeId | Long | False | No | Id of statusType. The type associated with the status. | |
StatusTypelookUpName | String | False | No | LookUpName of statusType. The type associated with the status. | |
UpdatedTime | Datetime | False | No | The date and time when the asset status was last updated. This attribute is read-only. | |
names | String | False | Yes | The list of names, one for each supported language. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AssetStatusesId | Long | False | No | The unique identifier of the asset statuses version. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ActualLeads | Int | False | No | The number of actual leads generated from the campaign. | |
ActualOpportunities | Int | False | No | The number of actual opportunities generated from the campaign. | |
AssignedToAccountId | Long | False | No | Id of assignedToAccount. The staff member assigned to the campaign. | |
AssignedToAccountlookUpName | String | False | No | LookUpName of assignedToAccount. The staff member assigned to the campaign. | |
CampaignEndTime | Datetime | False | No | The date and time when the campaign ends. | |
CampaignStartTime | Datetime | False | No | The date and time when the campaign begins. | |
CreatedByAccountId | Long | False | No | Id of createdByAccount. The ID number of the staff member who created the campaign. | |
CreatedByAccountlookUpName | String | False | No | LookUpName of createdByAccount. The ID number of the staff member who created the campaign. | |
CreatedTime | Datetime | False | No | The date and time when the campaign was created. This attribute is read-only. | |
ExpectedLeads | Int | False | No | The number of expected leads generated from the campaign. | |
ExpectedOpportunities | Int | False | No | The number of expected opportunities generated from the campaign. | |
FlowId | Long | False | No | Id of flow. The ID of the flow that the campaign is associated with. | |
FlowlookUpName | String | False | No | LookUpName of flow. The ID of the flow that the campaign is associated with. | |
Id [KEY] | Long | False | No | The unique identifier of the campaign. | |
InterfaceId | Long | False | No | Id of interface. The ID of the interface that the campaign is associated with. | |
InterfacelookUpName | String | False | No | LookUpName of interface. The ID of the interface that the campaign is associated with. | |
IsSingleExecute | Bool | False | No | Indicates whether the contacts are allowed to flow through the recurring campaign only one time. This attribute does not have a default value. | |
LookupName | String | False | No | The name used to look up the campaign. | |
Name | String | False | No | The name of the campaign. | |
ObjectivesSummary | String | False | No | The summary of the objectives specified for the campaign. | |
UpdatedByAccountId | Long | False | No | Id of updatedByAccount. The ID of the staff member who last updated the campaign. | |
UpdatedByAccountlookUpName | String | False | No | LookUpName of updatedByAccount. The ID of the staff member who last updated the campaign. | |
UpdatedTime | Datetime | False | No | The date and time when the campaign was last updated. This attribute is read-only. | |
ActualCostcurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
ActualCostcurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
ActualCostexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ActualCostexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ActualCostvalue | String | False | No | The value of the currency. | |
ActualSalescurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
ActualSalescurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
ActualSalesexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ActualSalesexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ActualSalesvalue | String | False | No | The value of the currency. | |
BudgetcurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
BudgetcurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
BudgetexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
BudgetexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
Budgetvalue | String | False | No | The value of the currency. | |
ExpectedCostcurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
ExpectedCostcurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
ExpectedCostexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ExpectedCostexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ExpectedCostvalue | String | False | No | The value of the currency. | |
ExpectedSalescurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
ExpectedSalescurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
ExpectedSalesexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ExpectedSalesexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ExpectedSalesvalue | String | False | No | The value of the currency. | |
Folderid | Long | False | No | ID value | |
FolderlookupName | String | False | No | Name used to lookup this object |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ContactVisibility | Bool | False | No | Indicates whether the channel is available in the ChannelUsername collection. This attribute does not have a default value and is read-only. | |
CreatedTime | Datetime | False | No | The date and time when the channel type was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The position of the channel type in the list of channels. | |
Id [KEY] | Long | False | No | The unique identifier of the channel type. | |
LookupName | String | False | No | The name used to look up the channel type. | |
Name | String | False | No | The name of the channel type in the language of the current interface. This attribute is read-only. | |
UpdatedTime | Datetime | False | No | The date and time when the channel type was last updated. This attribute is read-only. | |
AttributescontactVisibility | Bool | False | No | Indicates whether the channel is visible to contacts. This attribute does not have a default value. | |
Attributesincoming | Bool | False | No | Indicates whether it is an incoming channel. This attribute does not have a default value. | |
Attributesmonitoring | Bool | False | No | Indicates whether it is a monitoring channel. This attribute does not have a default value. | |
Attributesoutgoing | Bool | False | No | Indicates whether it is an outgoing channel. This attribute does not have a default value. | |
Attributessubscription | Bool | False | No | Indicates whether it is a subscription channel. This attribute does not have a default value. | |
names | String | False | Yes | The list of names, one for each supported language. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ChannelTypesId | Long | False | No | The unique identifier of the channel type. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | False | No | The date and time when the chat was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the chat. | |
LookupName | String | False | No | The name used to look up the chat. | |
Question | String | False | No | The question that is used as the lookupName for the chat object. | |
UpdatedTime | Datetime | False | No | The date and time when the chat was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | False | No | The date and time when the configuration was created. This attribute is read-only. | |
DataTypeId | Long | False | No | Id of dataType. The type of data that the configuration represents. | |
DataTypelookUpName | String | False | No | LookUpName of dataType. The type of data that the configuration represents. | |
Id [KEY] | Long | False | No | The unique identifier of the configuration. | |
LookupName | String | False | No | The name used to look up the configuration. | |
Name | String | False | No | The name of the configuration. | |
UpdatedTime | Datetime | False | No | The date and time when the configuration was last updated. This attribute is read-only. | |
Value | String | False | No | The 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. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Comment | String | False | No | The description associated with the contact marketing roster. | |
CreatedByAccountId | Long | True | No | Id of createdByAccount. The staff account who created the list. | |
CreatedByAccountlookUpName | String | True | No | LookUpName of createdByAccount. The staff account who created the list. | |
CreatedTime | Datetime | True | No | The date and time when the contact marketing roster was created. This attribute is read-only. | |
Id [KEY] | Long | True | No | The unique identifier of the contact marketing roster. | |
InterfaceId | Long | True | No | Id of interface. The interface the list is associated with. | |
InterfacelookUpName | String | True | No | LookUpName of interface. The interface the list is associated with. | |
IsProofList | Bool | False | No | Indicates whether the contact marketing roster is a proof list. | |
LookupName | String | True | No | The name used to look up the contact marketing roster. | |
Name | String | False | No | The name of the contact marketing roster. | |
PurgeData | Bool | False | No | Indicates whether the contact marketing roster should be cleared periodically. The default value is false. | |
UpdatedByAccountId | Long | True | No | Id of updatedByAccount. The staff account who last updated the list. | |
UpdatedByAccountlookUpName | String | True | No | LookUpName of updatedByAccount. The staff account who last updated the list. | |
UpdatedTime | Datetime | True | No | The date and time when the contact marketing roster was last updated. This attribute is read-only. | |
LastCountStatisticslastCount | Int | True | No | The number of contacts in the contact marketing roster when the count was last calculated. | |
LastCountStatisticslastCountedTime | Datetime | True | No | The date and time when the contact marketing roster was last counted. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ContactTypeId | Long | False | No | Id of contactType. The ID of the contact type. | |
ContactTypelookUpName | String | False | No | LookUpName of contactType. The ID of the contact type. | |
CreatedTime | Datetime | True | No | The date and time when the contact was created. This attribute is read-only. | |
Disabled | Bool | False | No | Indicates whether the contact is disabled. The default value is false. | |
ExternalReference | String | True | No | The external reference key of the contact. | |
Id [KEY] | Long | True | No | The unique identifier of the contact. | |
Login | String | False | No | The user name used for authentication. | |
LookupName | String | True | No | The name used to look up the contact. | |
NewPassword | String | False | No | The new password for authentication. It is stored with a one-way encryption in the system. This attribute is write-only. | |
OrganizationId | Long | False | No | Id of organization. The organization to which the contact belongs. | |
OrganizationlookUpName | String | False | No | LookUpName of organization. The organization to which the contact belongs. | |
PasswordEmailExpirationTime | Datetime | True | No | The date and time by when the contact must change the password after a reset has occurred. This attribute is read-only. | |
PasswordExpirationTime | Datetime | True | No | The date and time by when the password is set to expire. This attribute is read-only. | |
SourceId | Long | True | No | Id of source. The creation source IDs. This attribute is read-only. | |
SourcelookUpName | String | True | No | LookUpName of source. The creation source IDs. This attribute is read-only. | |
SupersededById | Long | True | No | Id of supersededBy. The superseding contact for the contact. This attribute is read-only. | |
SupersededBylookUpName | String | True | No | LookUpName of supersededBy. The superseding contact for the contact. This attribute is read-only. | |
Title | String | False | No | The social or professional title of the contact. For example, Mrs., Dr., and so on. | |
UpdatedTime | Datetime | True | No | The date and time when the contact was last updated. This attribute is read-only. | |
Addresscity | String | False | No | The name of the city. | |
AddresscountryId | Long | False | No | Id of country. The ID of the country. | |
AddresscountrylookUpName | String | False | No | LookUpName of country. The ID of the country. | |
AddresspostalCode | String | False | No | The postal code or the ZIP code. | |
AddressstateOrProvinceId | Long | False | No | Id of stateOrProvince. The ID of the state or province. | |
AddressstateOrProvincelookUpName | String | False | No | LookUpName of stateOrProvince. The ID of the state or province. | |
Addressstreet | String | False | No | The street address. | |
BannerimportanceFlagId | Long | False | No | Id of importanceFlag. The importance of the banner. | |
BannerimportanceFlaglookUpName | String | False | No | LookUpName of importanceFlag. The importance of the banner. | |
Bannertext | String | False | No | The description of a flag. | |
BannerupdatedByAccountId | Long | True | No | Id of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedByAccountlookUpName | String | True | No | LookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedTime | Datetime | True | No | The date and time when the banner was last updated. This attribute is read-only. | |
CRMModulesmarketing | Bool | False | No | Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled. | |
CRMModulessales | Bool | False | No | Indicates whether the sales module is applicable. The default value is true only if sales module is enabled. | |
CRMModulesservice | Bool | False | No | Indicates whether the service module is applicable. The default value is true only if service module is enabled. | |
MarketingSettingsemailFormatId | Long | False | No | Id of emailFormat. The ID of preferred format for sending emails to the contact. | |
MarketingSettingsemailFormatlookUpName | String | False | No | LookUpName of emailFormat. The ID of preferred format for sending emails to the contact. | |
MarketingSettingsmarketingOptIn | Bool | False | No | Indicates whether the contact has opted in for marketing mailing list. This attribute does not have a default value. | |
MarketingSettingsmarketingOrganizationName | String | False | No | The marketing organization name. | |
MarketingSettingsmarketingOrganizationNameAlt | String | False | No | The alternate name of the marketing organization. | |
MarketingSettingssurveyOptIn | Bool | False | No | Indicates whether the contact has opted in for providing feedback. This attribute does not have a default value. | |
Namefirst | String | False | No | The first name of the person. | |
Namelast | String | False | No | The surname or last name of the person. | |
NameFuriganafirst | String | False | No | The first name of the person. | |
NameFuriganalast | String | False | No | The surname or last name of the person. | |
SalesSettingsacquiredDate | Date | True | No | The date when the first opportunity associated with the contact was closed. This attribute is read-only. | |
SalesSettingssalesAccountId | Long | False | No | Id of salesAccount. The ID of the staff account for the sales representative assigned to the contact. | |
SalesSettingssalesAccountlookUpName | String | False | No | LookUpName of salesAccount. The ID of the staff account for the sales representative assigned to the contact. | |
channelUsernames | String | False | Yes | The list of usernames for the contact across different communication channels. | |
emails | String | False | Yes | The list of email addresses. | |
fileAttachments | String | False | Yes | The list of file attachments. | |
notes | String | False | Yes | The list of notes associated with the contact. | |
openIDAccounts | String | False | Yes | The list of OpenID URLs associated with the contact. | |
phones | String | False | Yes | The list of phone numbers. | |
contactLists | String | False | Yes | The contact lists in which the contact is included. | |
answerNotifications | String | False | Yes | The answer notifications to which the contact is subscribed. | |
categoryNotifications | String | False | Yes | The category notifications to which the contact is subscribed. | |
productNotifications | String | False | Yes | The product notifications to which the contact is subscribed. | |
sLAInstances | String | False | Yes | The SLA instances associated with the contact. This attribute is read-only for versions 1 and 1.1. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ContactsId | Long | False | No | The unique identifier of the contact. | |
ChannelTypeId | Long | False | No | Id of channelType. The associated communication channel. This is the key for the list entry. | |
ChannelTypelookUpName | String | False | No | LookUpName of channelType. The associated communication channel. This is the key for the list entry. | |
UserNumber | String | False | No | The user number ID for this communication channel. It is a string with a value between 0 and 9. | |
Username | String | False | No | The user name for this communication channel. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ContactsId | Long | False | No | The unique identifier of the contact. | |
Address | String | False | No | The string value of the email address. | |
AddressTypeId | Long | False | No | Id of addressType. The type of address, such as Primary or Alt1. This is the key for the list entry. | |
AddressTypelookUpName | String | False | No | LookUpName of addressType. The type of address, such as Primary or Alt1. This is the key for the list entry. | |
Certificate | String | False | No | The associated public email certificate used to encrypt outgoing emails. | |
Invalid | Bool | False | No | Indicates whether the email address is disabled. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ContactsId | Long | False | No | The unique identifier of the contact. | |
ContentType | String | False | No | The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
CreatedTime | Datetime | False | No | The date and time when the file was associated with the object. This attribute is read-only. | |
Data | String | False | No | The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field. | |
Description | String | False | No | The description for the contents of the file attachment. | |
FileName | String | False | No | The name of the file when saving it to the disk. | |
FormData | String | False | No | The HTML form which is used to upload file attachments. | |
Id [KEY] | Long | False | No | The unique identifier of the file attachment. | |
Name | String | False | No | The short display name of the file attachment. | |
Size | Int | False | No | The size of the file in bytes. This attribute is read-only. | |
URL | String | False | No | The URL to access this file. | |
UpdatedTime | Datetime | False | No | The date and time when the file attachment was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ContactsId | Long | False | No | The unique identifier of the contact. | |
ChannelId | Long | False | No | Id of channel. The channel through which the note was created. | |
ChannellookUpName | String | False | No | LookUpName of channel. The channel through which the note was created. | |
CreatedByAccountId | Long | False | No | Id of createdByAccount. The staff member account that created the note. | |
CreatedByAccountlookUpName | String | False | No | LookUpName of createdByAccount. The staff member account that created the note. | |
CreatedTime | Datetime | False | No | The date and time when the note was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the note. | |
Text | String | False | No | The text content in the note. | |
UpdatedByAccountId | Long | False | No | Id of updatedByAccount. The staff member account that updated the note. | |
UpdatedByAccountlookUpName | String | False | No | LookUpName of updatedByAccount. The staff member account that updated the note. | |
UpdatedTime | Datetime | False | No | The date and time when the note was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ContactsId | Long | False | No | The unique identifier of the contact. | |
Id [KEY] | Long | False | No | The unique identifier for the list entry. | |
URL | String | False | No | The unique authentication URL for the OpenIDAccount item. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ContactsId | Long | False | No | The unique identifier of the contact. | |
Number | String | False | No | The free-form phone number including non-numeric characters. For example, 1 (406) 522-4200. | |
PhoneTypeId | Long | False | No | Id of phoneType. The type of phone number such as Home, Mobile, Office, and so on. This is the key for the list entry. | |
PhoneTypelookUpName | String | False | No | LookUpName of phoneType. The type of phone number such as Home, Mobile, Office, and so on. This is the key for the list entry. | |
RawNumber | String | False | No | The 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. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Abbreviation | String | False | No | The two or three character abbreviation for the country. For example, USA. | |
CreatedTime | Datetime | True | No | The date and time when the country was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The position of the country in the Countries/Provinces tree and drop-down menu. | |
ISOCode | String | False | No | The ISO 3166 country code. | |
Id [KEY] | Long | True | No | The unique identifier of the country. | |
LookupName | String | True | No | The name used to look up the country. | |
Name | String | True | No | A list of labels or names used for this country on each unique interface. | |
PhoneCode | String | False | No | The international telephone code for the country. This is used by the Click-to-Dial feature. | |
PhoneMask | String | False | No | The 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. | |
PostalMask | String | False | No | The 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. | |
UpdatedTime | Datetime | True | No | The date and time when the country was last updated. This attribute is read-only. | |
names | String | False | Yes | The name of the country in the language of the current interface. This attribute is read-only. | |
provinces | String | False | Yes | A list of states or provinces associated with this country. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CountriesId | Long | False | No | The unique identifier of the country. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CountriesId | Long | False | No | The unique identifier of the country. | |
DisplayOrder | Int | False | No | The display position relative to other provinces associated with the same country. | |
Id [KEY] | Long | False | No | The unique identifier of the province. | |
Name | String | False | No | The name of the province in the language of the current interface. This attribute is read-only. | |
names | String | False | Yes | The list of names or labels for the province for each available language. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CountriesId | Long | False | No | The unique identifier of the country. | |
ProvincesId | Long | False | No | The unique identifier of the province. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Class | String | False | No | The string which represents the type of object in the ObjectShapeXML. | |
CreatedTime | Datetime | True | No | The date and time when the event subscription was created. This attribute is read-only. | |
EndPoint | String | False | No | The 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: | |
EventTypeId | Long | False | No | Id of eventType. The types of event such as Create, Update, or Destroy. | |
EventTypelookUpName | String | False | No | LookUpName of eventType. The types of event such as Create, Update, or Destroy. | |
Id [KEY] | Long | True | No | The unique identifier of the event subscription. | |
IntegrationUserId | Long | False | No | Id of integrationUser. The credentials and connection method to use for the event subscription. | |
IntegrationUserlookUpName | String | False | No | LookUpName of integrationUser. The credentials and connection method to use for the event subscription. | |
LookupName | String | True | No | The name used to look up the event subscription. | |
Name | String | False | No | The unique name of the event subscription. | |
ObjectShapeXml | String | False | No | The shape of the template object used to send the notification. | |
ObjectVersionId | Long | False | No | Id of objectVersion. The Connect version of the object to be sent in the notification. | |
ObjectVersionlookUpName | String | False | No | LookUpName of objectVersion. The Connect version of the object to be sent in the notification. | |
StatusId | Long | False | No | Id of status. The status of the event subscription. | |
StatuslookUpName | String | False | No | LookUpName of status. The status of the event subscription. | |
UpdatedTime | Datetime | True | No | The date and time when the event subscription was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | True | No | The date and time when the holiday was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The display position relative to other holidays. | |
HolidayDate | Date | False | No | The date the holiday falls on. The maximum allowed value of the date is 12/31/2032. | |
Id [KEY] | Long | True | No | The unique identifier of the holiday. | |
LookupName | String | True | No | The name used to look up the holiday. | |
Name | String | False | No | The name of the holiday. | |
UpdatedTime | Datetime | True | No | The date and time when the holiday was last updated. This attribute is read-only. | |
adminVisibleInterfaces | String | False | Yes | The list of interfaces on which the holiday is available for administration use. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AdminVisibleInterfacesId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AdminVisibleInterfacesLookUpName | String | False | No | The name used to look up the object. | |
HolidaysId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
HolidaysLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AssetId | Long | False | No | Id of asset. The ID of the associated asset. | |
AssetlookUpName | String | False | No | LookUpName of asset. The ID of the associated asset. | |
CategoryId | Long | False | No | Id of category. The service category. | |
CategorylookUpName | String | False | No | LookUpName of category. The service category. | |
ChannelId | Long | False | No | Id of channel. The channel used in the creation of the most recent thread. | |
ChannellookUpName | String | False | No | LookUpName of channel. The channel used in the creation of the most recent thread. | |
ChatQueueId | Long | False | No | Id of chatQueue. The chat queue to which the incident is assigned. This attribute is read-only. | |
ChatQueuelookUpName | String | False | No | LookUpName of chatQueue. The chat queue to which the incident is assigned. This attribute is read-only. | |
ClosedTime | Datetime | True | No | The date and time when the incident was closed. This attribute is read-only. | |
CreatedByAccountId | Long | True | No | Id of createdByAccount. The staff member who created the incident. | |
CreatedByAccountlookUpName | String | True | No | LookUpName of createdByAccount. The staff member who created the incident. | |
CreatedTime | Datetime | True | No | The date and time when the incident was created. This attribute is read-only. | |
DispositionId | Long | False | No | Id of disposition. The service disposition. | |
DispositionlookUpName | String | False | No | LookUpName of disposition. The service disposition. | |
Id [KEY] | Long | True | No | The unique identifier of the incident. | |
InitialResponseDueTime | Datetime | True | No | The 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. | |
InitialSolutionTime | Datetime | True | No | The date and time when a response was sent to the customer for a status change other than 'unresolved'. This attribute is read-only. | |
InterfaceId | Long | False | No | Id of interface. The ID of the associated interface. | |
InterfacelookUpName | String | False | No | LookUpName of interface. The ID of the associated interface. | |
LanguageId | Long | False | No | Id of language. The ID of the associated language. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the associated language. | |
LastResponseTime | Datetime | True | No | The date and time when the last response was sent to the contact. This attribute is read-only. | |
LastSurveyScore | Int | True | No | The score of the last survey of the incident. This attribute is read-only. | |
LookupName | String | True | No | The name used to look up the incident. | |
MailboxId | Long | False | No | Id of mailbox. The ID of the mailbox from which incident was created. | |
MailboxlookUpName | String | False | No | LookUpName of mailbox. The ID of the mailbox from which incident was created. | |
MailingId | Long | True | No | Id of mailing. The ID of the associated marketing outbound email. This attribute is read-only. | |
MailinglookUpName | String | True | No | LookUpName of mailing. The ID of the associated marketing outbound email. This attribute is read-only. | |
OrganizationId | Long | False | No | Id of organization. The ID of the associated organization. | |
OrganizationlookUpName | String | False | No | LookUpName of organization. The ID of the associated organization. | |
PrimaryContactId | Long | False | No | Id of primaryContact. The primary contact. | |
PrimaryContactlookUpName | String | False | No | LookUpName of primaryContact. The primary contact. | |
ProductId | Long | False | No | Id of product. The service product. | |
ProductlookUpName | String | False | No | LookUpName of product. The service product. | |
QueueId | Long | False | No | Id of queue. The queue to which the incident is assigned. | |
QueuelookUpName | String | False | No | LookUpName of queue. The queue to which the incident is assigned. | |
ReferenceNumber | String | True | No | The reference number generated when the incident was created. It is also referred as the incident name. | |
ResolutionInterval | Int | True | No | The number of minutes taken to resolve the incident past the SLA's resolution requirement. This attribute is read-only. | |
ResponseEmailAddressTypeId | Long | False | No | Id of responseEmailAddressType. The type of address that is used for incident responses, such as Primary or Alt1 . | |
ResponseEmailAddressTypelookUpName | String | False | No | LookUpName of responseEmailAddressType. The type of address that is used for incident responses, such as Primary or Alt1 . | |
ResponseInterval | Int | True | No | The number of minutes taken to respond to the incident past the SLA's response requirement. This attribute is read-only. | |
SeverityId | Long | False | No | Id of severity. The assigned severity level. | |
SeveritylookUpName | String | False | No | LookUpName of severity. The assigned severity level. | |
SmartSenseCustomer | Int | True | No | The emotive index calculated from the contact-generated threads. This attribute is read-only. | |
SmartSenseStaff | Int | True | No | The emotive index calculated from the staff-generated threads. This attribute is read-only. | |
SourceId | Long | True | No | Id of source. The creation source IDs. This attribute is read-only. | |
SourcelookUpName | String | True | No | LookUpName of source. The creation source IDs. This attribute is read-only. | |
Subject | String | False | No | The short description of the incident. | |
UpdatedTime | Datetime | True | No | The date and time when the incident was last updated. This attribute is read-only. | |
AssignedToaccountId | Long | False | No | Id of account. The staff account. | |
AssignedToaccountlookUpName | String | False | No | LookUpName of account. The staff account. | |
AssignedTostaffGroupId | Long | False | No | Id of staffGroup. The staff group. The caller should assign the staff group when assigning to an account. | |
AssignedTostaffGrouplookUpName | String | False | No | LookUpName of staffGroup. The staff group. The caller should assign the staff group when assigning to an account. | |
BannerimportanceFlagId | Long | False | No | Id of importanceFlag. The importance of the banner. | |
BannerimportanceFlaglookUpName | String | False | No | LookUpName of importanceFlag. The importance of the banner. | |
Bannertext | String | False | No | The description of a flag. | |
BannerupdatedByAccountId | Long | True | No | Id of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedByAccountlookUpName | String | True | No | LookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedTime | Datetime | True | No | The date and time when the banner was last updated. This attribute is read-only. | |
SLAInstanceactiveDate | Date | True | No | The date when the instance became active. | |
SLAInstanceexpireDate | Date | True | No | The date when the instance is scheduled to expire. This attribute is read-only. | |
SLAInstanceid | Long | True | No | The unique identifier of the SLAInstance. | |
SLAInstancenameOfSLAId | Long | False | No | Id of nameOfSLA. The SLA from which the instance was created. | |
SLAInstancenameOfSLAlookUpName | String | False | No | LookUpName of nameOfSLA. The SLA from which the instance was created. | |
SLAInstanceremainingFromCSR | Int | True | No | The remaining number of CSR incidents. This attribute is read-only. | |
SLAInstanceremainingFromChat | Int | True | No | The remaining number of chat incidents. This attribute is read-only. | |
SLAInstanceremainingFromEmail | Int | True | No | The remaining number of email incidents. This attribute is read-only. | |
SLAInstanceremainingFromWeb | Int | True | No | The remaining number of web self-service incidents. This attribute is read-only. | |
SLAInstanceremainingTotal | Int | True | No | The total number of remaining incidents. This attribute is read-only. | |
SLAInstancesLASet | Int | True | No | The SLA set from which the instance was created. This attribute is read-only. | |
SLAInstancestateOfSLAId | Long | True | No | Id of stateOfSLA. The current state of the SLA. The supported values are Inactive, Active, Expired, or Disabled. | |
SLAInstancestateOfSLAlookUpName | String | True | No | LookUpName of stateOfSLA. The current state of the SLA. The supported values are Inactive, Active, Expired, or Disabled. | |
StatusWithTypestatusId | Long | False | No | Id of status. The current status. | |
StatusWithTypestatuslookUpName | String | False | No | LookUpName of status. The current status. | |
StatusWithTypestatusTypeId | Long | True | No | Id of statusType. The associated status type. This attribute is read-only. | |
StatusWithTypestatusTypelookUpName | String | True | No | LookUpName of statusType. The associated status type. This attribute is read-only. | |
billedMinutes | String | False | Yes | The list of time-billed entries that are used for tracking work on the incident. | |
fileAttachments | String | False | Yes | The list of file attachments. | |
milestoneInstances | String | False | Yes | The list of milestone instances associated with the incident. This attribute is read-only. | |
otherContacts | String | False | Yes | The list of secondary contacts. | |
threads | String | False | Yes | The 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. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
IncidentsId | Long | False | No | The unique identifier of the incident. | |
AccountId | Long | False | No | Id of account. The staff member who billed the time. This is part of the key for the list entry. | |
AccountlookUpName | String | False | No | LookUpName of account. The staff member who billed the time. This is part of the key for the list entry. | |
BillTime | Datetime | False | No | The date and time when the work was performed. This is part of the key for the list entry. | |
BillableTaskId | Long | False | No | Id of billableTask. The associated billable task. | |
BillableTasklookUpName | String | False | No | LookUpName of billableTask. The associated billable task. | |
Comment | String | False | No | The comments associated with the timeBilled record. | |
Id [KEY] | Long | False | No | The unique identifier of the timeBilled record. | |
Minutes | Int | False | No | The number of minutes billed. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
IncidentsId | Long | False | No | The unique identifier of the incident. | |
ContentType | String | False | No | The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
CreatedTime | Datetime | False | No | The date and time when the file was associated with the incident. This attribute is read-only. | |
Data | String | False | No | The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field. | |
Description | String | False | No | The description for the contents of the file attachment. | |
FileName | String | False | No | The name of the file when saving it to the disk. | |
FormData | String | False | No | The HTML form which is used to upload file attachments. | |
Id [KEY] | Long | False | No | The unique identifier of the file attachment. | |
Name | String | False | No | The short display name of the file attachment. | |
Private | Bool | False | No | Indicates whether the file attachment is hidden from the end users. This attribute does not have a default value. | |
Size | Int | False | No | The size of the file in bytes. This attribute is read-only. | |
URL | String | False | No | The URL to access this file. | |
UpdatedTime | Datetime | False | No | The date and time when the file was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
IncidentsId | Long | False | No | The unique identifier of the incident. | |
MilestoneId | Long | False | No | Id of milestone. The ID of the associated milestone. | |
MilestonelookUpName | String | False | No | LookUpName of milestone. The ID of the associated milestone. | |
ResolutionDueTime | Datetime | False | No | The date and time when the associated resolution milestone is due. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
IncidentsId | Long | False | No | The unique identifier of the incident. | |
AccountId | Long | False | No | Id of account. The associated staff account. This attribute is read-only. | |
AccountlookUpName | String | False | No | LookUpName of account. The associated staff account. This attribute is read-only. | |
ChannelId | Long | False | No | Id of channel. The associated communication channel. | |
ChannellookUpName | String | False | No | LookUpName of channel. The associated communication channel. | |
ContactId | Long | False | No | Id of contact. The associated contact. | |
ContactlookUpName | String | False | No | LookUpName of contact. The associated contact. | |
ContentTypeId | Long | False | No | Id of contentType. The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
ContentTypelookUpName | String | False | No | LookUpName of contentType. The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
CreatedTime | Datetime | False | No | The date and time when the thread was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The relative display order for the threads with the same created time. This attribute is read-only. | |
EntryTypeId | Long | False | No | Id of entryType. The entry type. | |
EntryTypelookUpName | String | False | No | LookUpName of entryType. The entry type. | |
Id [KEY] | Long | False | No | The unique identifier of the thread. It cannot be used for delete operations. | |
MailHeader | String | False | No | The mail header information for a contact submitting the thread by email. | |
Text | String | False | No | The entry text in the thread. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | False | No | The date and time when the mailbox was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the mailbox. | |
InterfaceId | Long | False | No | Id of interface. The interface that the mailbox is associated with. | |
InterfacelookUpName | String | False | No | LookUpName of interface. The interface that the mailbox is associated with. | |
IsDefault | Bool | False | No | Indicates whether the mailbox is the default mailbox for the interface. This attribute does not have a default value. | |
LookupName | String | False | No | The name used to look up the mailbox. | |
Name | String | False | No | The name of the mailbox. | |
TypeId | Long | False | No | Id of type. The module the mailbox is associated with. | |
TypelookUpName | String | False | No | LookUpName of type. The module the mailbox is associated with. | |
UpdatedTime | Datetime | False | No | The date and time when the mailbox was last updated. This attribute is read-only. | |
IncomingEmailSettingsforceReplyBetweenLines | Bool | False | No | Indicates whether the Force Reply Between the Lines feature is enabled for outgoing emails from the mailbox. This attribute does not have a default value. | |
IncomingEmailSettingsforwardRejectMessageAddress | String | False | No | The address to which rejected messages are sent. | |
IncomingEmailSettingsisEnabled | Bool | False | No | Indicates whether incoming email option is enabled. This attribute does not have a default value. | |
OutgoingEmailSettingsdisplayName | String | False | No | The display name used in the outgoing emails from the mailbox. | |
OutgoingEmailSettingsfriendlyFromAddress | String | False | No | The from address used to brand outgoing emails as friendly. | |
OutgoingEmailSettingsfromAddress | String | False | No | The from address on the outgoing email. | |
OutgoingEmailSettingsisEnabled | Bool | False | No | Indicates whether outgoing email is enabled. This attribute does not have a default value. | |
OutgoingEmailSettingsreplyToAddress | String | False | No | The reply-to-address on the outgoing email. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | False | No | The date and time when the marketing mailbox was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the marketing mailbox. | |
InterfaceId | Long | False | No | Id of interface. The interface that the mailbox is associated with. | |
InterfacelookUpName | String | False | No | LookUpName of interface. The interface that the mailbox is associated with. | |
IsDefault | Bool | False | No | Indicates whether the mailbox is the default mailbox for the interface. This attribute does not have a default value. | |
LookupName | String | False | No | The name used to look up the marketing mailbox. | |
Name | String | False | No | The name of the marketing mailbox. | |
TypeId | Long | False | No | Id of type. The module the mailbox is associated with. | |
TypelookUpName | String | False | No | LookUpName of type. The module the mailbox is associated with. | |
UpdatedTime | Datetime | False | No | The date and time when the marketing mailbox was last updated. This attribute is read-only. | |
IncomingEmailSettingsforceReplyBetweenLines | Bool | False | No | Indicates whether the Force Reply Between the Lines feature is enabled for outgoing emails from the mailbox. This attribute does not have a default value. | |
IncomingEmailSettingsforwardRejectMessageAddress | String | False | No | The address to which rejected messages are sent. | |
IncomingEmailSettingsisEnabled | Bool | False | No | Indicates whether incoming email option is enabled. This attribute does not have a default value. | |
OutgoingEmailSettingsdisplayName | String | False | No | The display name used in the outgoing emails from the mailbox. | |
OutgoingEmailSettingsfriendlyFromAddress | String | False | No | The from address used to brand outgoing emails as friendly. | |
OutgoingEmailSettingsfromAddress | String | False | No | The from address on the outgoing email. | |
OutgoingEmailSettingsisEnabled | Bool | False | No | Indicates whether outgoing email is enabled. This attribute does not have a default value. | |
OutgoingEmailSettingsreplyToAddress | String | False | No | The reply-to-address on the outgoing email. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | False | No | The date and time when the message base was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the message base. | |
LookupName | String | False | No | The name used to look up the message base. | |
Name | String | False | No | The name of the message base. | |
UpdatedTime | Datetime | False | No | The date and time when the message base was last updated. This attribute is read-only. | |
UsageId | Long | False | No | Id of usage. The type of data the message base represents. | |
UsagelookUpName | String | False | No | LookUpName of usage. The type of data the message base represents. | |
Value | String | False | No | The string value of the message base. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
TableName | String | False | No | Table Name | |
ColumnName | String | False | No | Column Name | |
Id | Long | False | No | Id of namedId | |
LookUpName | String | False | No | LookUpName of NamedId |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AssignedToAccountId | Long | False | No | Id of assignedToAccount. The sales representative assigned to the account. | |
AssignedToAccountlookUpName | String | False | No | LookUpName of assignedToAccount. The sales representative assigned to the account. | |
CampaignId | Long | True | No | Id 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. | |
CampaignlookUpName | String | True | No | LookUpName 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. | |
ClosedTime | Datetime | False | No | The date and time when the opportunity was closed. | |
CreatedTime | Datetime | True | No | The date and time when the opportunity was created. This attribute is read-only. | |
ForecastCloseDate | Date | False | No | The date when the opportunity is estimated to close. | |
Id [KEY] | Long | True | No | The unique identifier of the opportunity. | |
InitialContactDate | Date | False | No | The date when the sales representative made the initial contact with the organization. | |
InterfaceId | Long | False | No | Id of interface. The interface with which the opportunity is associated. | |
InterfacelookUpName | String | False | No | LookUpName of interface. The interface with which the opportunity is associated. | |
LeadRejectDateTime | Datetime | False | No | The date and time when the lead was rejected. | |
LeadRejectDescription | String | False | No | The summary or description provided when the lead was rejected. | |
LeadRejectReasonId | Long | False | No | Id of leadRejectReason. The reason the lead was rejected. | |
LeadRejectReasonlookUpName | String | False | No | LookUpName of leadRejectReason. The reason the lead was rejected. | |
LookupName | String | True | No | The name used to look up the opportunity. | |
LostTime | Datetime | False | No | The date and time when the opportunity was lost. | |
ManagerCommit | Bool | False | No | The committed status of the manager-forecasted value. The default value is false. | |
Name | String | False | No | The name of the opportunity. | |
OrganizationId | Long | False | No | Id of organization. The associated organization. | |
OrganizationlookUpName | String | False | No | LookUpName of organization. The associated organization. | |
RecallTime | Datetime | False | No | The date and time when the opportunity was recalled. | |
SalesRepresentativeCommit | Bool | False | No | Indicates whether the sales representative-forecasted value is committed. The default value is false. | |
SourceId | Long | True | No | Id of source. The creation source IDs. This attribute is read-only. | |
SourcelookUpName | String | True | No | LookUpName of source. The creation source IDs. This attribute is read-only. | |
Summary | String | False | No | The brief summary of the opportunity. | |
SurveyId | Long | True | No | Id 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. | |
SurveylookUpName | String | True | No | LookUpName 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. | |
TerritoryId | Long | False | No | Id of territory. The associated sales territory. | |
TerritorylookUpName | String | False | No | LookUpName of territory. The associated sales territory. | |
UpdatedTime | Datetime | True | No | The date and time when the opportunity was last updated. This attribute is read-only. | |
WinLossDescription | String | False | No | The description of how the opportunity was won or lost. | |
WinLossReasonId | Long | False | No | Id of winLossReason. The reason for winning or losing. | |
WinLossReasonlookUpName | String | False | No | LookUpName of winLossReason. The reason for winning or losing. | |
BannerimportanceFlagId | Long | False | No | Id of importanceFlag. The importance of the banner. | |
BannerimportanceFlaglookUpName | String | False | No | LookUpName of importanceFlag. The importance of the banner. | |
Bannertext | String | False | No | The description of a flag. | |
BannerupdatedByAccountId | Long | True | No | Id of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedByAccountlookUpName | String | True | No | LookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedTime | Datetime | True | No | The date and time when the banner was last updated. This attribute is read-only. | |
ClosedValuecurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
ClosedValuecurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
ClosedValueexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ClosedValueexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ClosedValuevalue | String | False | No | The value of the currency. | |
CostOfSalecurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
CostOfSalecurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
CostOfSaleexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
CostOfSaleexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
CostOfSalevalue | String | False | No | The value of the currency. | |
ManagerValuecurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
ManagerValuecurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
ManagerValueexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ManagerValueexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ManagerValuevalue | String | False | No | The value of the currency. | |
PrimaryContactcontactId | Long | False | No | Id of contact. The ID of the contact. | |
PrimaryContactcontactlookUpName | String | False | No | LookUpName of contact. The ID of the contact. | |
PrimaryContactcontactRoleId | Long | False | No | Id of contactRole. The role of the contact in the opportunity process. | |
PrimaryContactcontactRolelookUpName | String | False | No | LookUpName of contactRole. The role of the contact in the opportunity process. | |
ReturnValuecurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
ReturnValuecurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
ReturnValueexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ReturnValueexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
ReturnValuevalue | String | False | No | The value of the currency. | |
SalesRepresentativeValuecurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
SalesRepresentativeValuecurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
SalesRepresentativeValueexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
SalesRepresentativeValueexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
SalesRepresentativeValuevalue | String | False | No | The value of the currency. | |
StageWithStrategystageId | Long | False | No | Id of stage. The current stage. | |
StageWithStrategystagelookUpName | String | False | No | LookUpName of stage. The current stage. | |
StageWithStrategystrategyId | Long | True | No | Id of strategy. The associated strategy. This attribute is read-only. | |
StageWithStrategystrategylookUpName | String | True | No | LookUpName of strategy. The associated strategy. This attribute is read-only. | |
StatusWithTypestatusId | Long | False | No | Id of status. The current status. | |
StatusWithTypestatuslookUpName | String | False | No | LookUpName of status. The current status. | |
StatusWithTypestatusTypeId | Long | True | No | Id of statusType. The associated status type. This attribute is read-only. | |
StatusWithTypestatusTypelookUpName | String | True | No | LookUpName of statusType. The associated status type. This attribute is read-only. | |
fileAttachments | String | False | Yes | The list of file attachments. | |
notes | String | False | Yes | The list of associated notes. | |
otherContacts | String | False | Yes | The other non-primary associated contacts. | |
quotes | String | False | Yes | The list of sales quotes. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
OpportunitiesId | Long | False | No | The unique identifier of the opportunity. | |
ContentType | String | False | No | The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
CreatedTime | Datetime | False | No | The date and time when the file was associated with the object. This attribute is read-only. | |
Data | String | False | No | The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field. | |
Description | String | False | No | The description for the contents of the file attachment. | |
FileName | String | False | No | The name of the file when saving it to the disk. | |
FormData | String | False | No | The HTML form which is used to upload file attachments. | |
Id [KEY] | Long | False | No | The unique identifier of the file attachment. | |
Name | String | False | No | The short display name of the file attachment. | |
Size | Int | False | No | The size of the file in bytes. This attribute is read-only. | |
URL | String | False | No | The URL to access this file. | |
UpdatedTime | Datetime | False | No | The date and time when the file attachment was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
OpportunitiesId | Long | False | No | The unique identifier of the opportunity. | |
ChannelId | Long | False | No | Id of channel. The channel through which the note was created. | |
ChannellookUpName | String | False | No | LookUpName of channel. The channel through which the note was created. | |
CreatedByAccountId | Long | False | No | Id of createdByAccount. The staff member account that created the note. | |
CreatedByAccountlookUpName | String | False | No | LookUpName of createdByAccount. The staff member account that created the note. | |
CreatedTime | Datetime | False | No | The date and time when the note was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the note. | |
Text | String | False | No | The text content in the note. | |
UpdatedByAccountId | Long | False | No | Id of updatedByAccount. The staff member account that updated the note. | |
UpdatedByAccountlookUpName | String | False | No | LookUpName of updatedByAccount. The staff member account that updated the note. | |
UpdatedTime | Datetime | False | No | The date and time when the note was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
OpportunitiesId | Long | False | No | The unique identifier of the opportunity. | |
ContactId | Long | False | No | Id of contact. The ID of the contact. This is the key for the list entry. | |
ContactlookUpName | String | False | No | LookUpName of contact. The ID of the contact. This is the key for the list entry. | |
ContactRoleId | Long | False | No | Id of contactRole. The role of the contact in the opportunity process. | |
ContactRolelookUpName | String | False | No | LookUpName of contactRole. The role of the contact in the opportunity process. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
OpportunitiesId | Long | False | No | The unique identifier of the opportunity. | |
Comment | String | False | No | The comment text for the quote. | |
CreatedTime | Datetime | False | No | The date and time when the quote was created. | |
DiscountPercent | Int | False | No | The discount percentage for the quote. | |
Forecasted | Bool | False | No | Indicates whether the quote has been forecasted. The default value is false. | |
Id [KEY] | Long | False | No | The unique identifier of the quote. This is the key for the list entry. | |
Name | String | False | No | The descriptive name of the quote. | |
OfferEndTime | Datetime | False | No | The date and time when the quoted offer ends. | |
OfferStartTime | Datetime | False | No | The date and time when the quoted offer starts. | |
PriceScheduleId | Long | False | No | Id of priceSchedule. The effective price schedule. | |
PriceSchedulelookUpName | String | False | No | LookUpName of priceSchedule. The effective price schedule. | |
SentTime | Datetime | False | No | The date and time when the quote was sent. | |
SentTo | String | False | No | The email addresses of the contact to whom the quote was sent. This attribute is read-only. | |
StatusId | Long | False | No | Id of status. The current status. | |
StatuslookUpName | String | False | No | LookUpName of status. The current status. | |
TemplateId | Long | False | No | Id of template. The template used to generate the quote. | |
TemplatelookUpName | String | False | No | LookUpName of template. The template used to generate the quote. | |
UpdatedTime | Datetime | False | No | The date and time when the quote was last updated. This attribute is read-only. | |
AdjustedTotalcurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
AdjustedTotalcurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
AdjustedTotalexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
AdjustedTotalexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
AdjustedTotalvalue | String | False | No | The value of the currency. | |
TotalcurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
TotalcurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
TotalexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
TotalexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
Totalvalue | String | False | No | The value of the currency. | |
fileAttachments | String | False | Yes | The list of file attachments for the quote. | |
lineItems | String | False | Yes | The list of individual product line items that make up the quote. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
OpportunitiesId | Long | False | No | The unique identifier of the opportunity. | |
QuotesId | Long | False | No | ||
ContentType | String | False | No | The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
CreatedTime | Datetime | False | No | The date and time when the file was associated with the object. This attribute is read-only. | |
Data | String | False | No | The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field. | |
FileName | String | False | No | The name of the file when saving it to the disk. | |
FormData | String | False | No | The HTML form which is used to upload file attachments. | |
Id [KEY] | Long | False | No | The unique identifier of the file attachment. | |
Size | Int | False | No | The size of the file in bytes. This attribute is read-only. | |
URL | String | False | No | The URL to access the file. | |
UpdatedTime | Datetime | False | No | The date and time when the file was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
OpportunitiesId | Long | False | No | The unique identifier of the opportunity. | |
QuotesId | Long | False | No | The unique identifier of the quote. | |
AdjustedDescription | String | False | No | The edited product description in the product line item. | |
AdjustedName | String | False | No | The edited product name in the product line item. | |
AdjustedPartNumber | String | False | No | The edited product part number in the product line item. | |
Comment | String | False | No | The comments associated with a product line item in the quote. | |
DiscountPercent | Int | False | No | The discount applied to the adjusted price of the product line item. | |
DisplayOrder | Int | False | No | The position of the line item in the quote. | |
Id [KEY] | Long | False | No | The unique identifier of the product line item in the quote. This is the key for the list entry. | |
OriginalDescription | String | False | No | The original product description. This attribute is read-only. | |
OriginalName | String | False | No | The original product name. This attribute is read-only. | |
OriginalPartNumber | String | False | No | The original product part number. This attribute is read-only. | |
ProductId | Long | False | No | Id of product. The ID of the sales product. | |
ProductlookUpName | String | False | No | LookUpName of product. The ID of the sales product. | |
Quantity | Int | False | No | The product quantity in the line item. | |
AdjustedPricecurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
AdjustedPricecurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
AdjustedPriceexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
AdjustedPriceexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
AdjustedPricevalue | String | False | No | The value of the currency. | |
AdjustedTotalcurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
AdjustedTotalcurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
AdjustedTotalexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
AdjustedTotalexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
AdjustedTotalvalue | String | False | No | The value of the currency. | |
OriginalPricecurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
OriginalPricecurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
OriginalPriceexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
OriginalPriceexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
OriginalPricevalue | String | False | No | The value of the currency. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | False | No | The date and time when the opportunity status was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The position of the opportunity status in the folder list. | |
Id [KEY] | Long | False | No | The unique identifier of the opportunity status. | |
LookupName | String | False | No | The name used to look up the opportunity status. | |
Name | String | False | No | The name of the opportunity status in the language of the current interface. | |
StatusTypeId | Long | False | No | Id of statusType. The current status and associated status type. | |
StatusTypelookUpName | String | False | No | LookUpName of statusType. The current status and associated status type. | |
UpdatedTime | Datetime | False | No | The date and time when the opportunity status was last updated. This attribute is read-only. | |
names | String | False | Yes | The list of names, one for each supported language. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
OpportunityStatusesId | Long | False | No | The unique identifier of the opportunity. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | True | No | The date and time when the organization was created. This attribute is read-only. | |
ExternalReference | String | True | No | The external reference key of the organization. | |
Id [KEY] | Long | True | No | The unique identifier of the organization. | |
IndustryId | Long | False | No | Id of industry. The industry with which the organization is associated. | |
IndustrylookUpName | String | False | No | LookUpName of industry. The industry with which the organization is associated. | |
Login | String | False | No | The user name used for authentication. | |
LookupName | String | True | No | The name used to look up the organization. | |
Name | String | False | No | The business name of the organization. | |
NameFurigana | String | False | No | The 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. | |
NewPassword | String | False | No | The write-only field used to set the authentication password. It is stored in a non-plaintext form in the system. | |
NumberOfEmployees | Int | False | No | The number of employees in the organization. | |
ParentId | Long | False | No | Id of parent. The parent organization. | |
ParentlookUpName | String | False | No | LookUpName of parent. The parent organization. | |
SourceId | Long | True | No | Id of source. The creation source IDs. This attribute is read-only. | |
SourcelookUpName | String | True | No | LookUpName of source. The creation source IDs. This attribute is read-only. | |
SupersededById | Long | True | No | Id of supersededBy. The superseding organization for the organization. This attribute is read-only. | |
SupersededBylookUpName | String | True | No | LookUpName of supersededBy. The superseding organization for the organization. This attribute is read-only. | |
UpdatedTime | Datetime | True | No | The date and time when the organization was last updated. This attribute is read-only. | |
BannerimportanceFlagId | Long | False | No | Id of importanceFlag. The importance of the banner. | |
BannerimportanceFlaglookUpName | String | False | No | LookUpName of importanceFlag. The importance of the banner. | |
Bannertext | String | False | No | The description of a flag. | |
BannerupdatedByAccountId | Long | True | No | Id of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedByAccountlookUpName | String | True | No | LookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only. | |
BannerupdatedTime | Datetime | True | No | The date and time when the banner was last updated. This attribute is read-only. | |
CRMModulesmarketing | Bool | False | No | Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled. | |
CRMModulessales | Bool | False | No | Indicates whether the sales module is applicable. The default value is true only if sales module is enabled. | |
CRMModulesservice | Bool | False | No | Indicates whether the service module is applicable. The default value is true only if service module is enabled. | |
SalesSettingsacquiredDate | Date | True | No | The date when the first opportunity associated with the organization was closed. This attribute is read-only. | |
SalesSettingssalesAccountId | Long | False | No | Id of salesAccount. The sales representative assigned to the account. | |
SalesSettingssalesAccountlookUpName | String | False | No | LookUpName of salesAccount. The sales representative assigned to the account. | |
SalesSettingstotalRevenuecurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
SalesSettingstotalRevenuecurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
SalesSettingstotalRevenueexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
SalesSettingstotalRevenueexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
SalesSettingstotalRevenuevalue | String | False | No | The value of the currency. | |
addresses | String | False | Yes | The list of associated addresses. | |
fileAttachments | String | False | Yes | The list of file attachments. | |
notes | String | False | Yes | The list of associated notes. | |
sLAInstances | String | False | Yes | The Service Level Agreement (SLA) instances associated with the organization. This attribute is read-only for versions 1 and 1.1. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
OrganizationsId | Long | False | No | The unique identifier of the organization. | |
AddressTypeId | Long | False | No | Id of addressType. The type of address, such as mailing, street, and so on. This is the key for the list entry. | |
AddressTypelookUpName | String | False | No | LookUpName of addressType. The type of address, such as mailing, street, and so on. This is the key for the list entry. | |
City | String | False | No | The name of the city. | |
CountryId | Long | False | No | Id of country. The ID of the country. | |
CountrylookUpName | String | False | No | LookUpName of country. The ID of the country. | |
PostalCode | String | False | No | The postal code or ZIP code. | |
StateOrProvinceId | Long | False | No | Id of stateOrProvince. The ID of the state or province. | |
StateOrProvincelookUpName | String | False | No | LookUpName of stateOrProvince. The ID of the state or province. | |
Street | String | False | No | The street address. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
OrganizationsId | Long | False | No | The unique identifier of the organization. | |
ContentType | String | False | No | The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
CreatedTime | Datetime | False | No | The date and time when the file was associated with the object. This attribute is read-only. | |
Data | String | False | No | The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field. | |
Description | String | False | No | The description for the contents of the file attachment. | |
FileName | String | False | No | The name of the file when saving it to the disk. | |
FormData | String | False | No | The HTML form which is used to upload file attachments. | |
Id [KEY] | Long | False | No | The unique identifier of the file attachment. | |
Name | String | False | No | The short display name of the file attachment. | |
Size | Int | False | No | The size of the file in bytes. This attribute is read-only. | |
URL | String | False | No | The URL to access this file. | |
UpdatedTime | Datetime | False | No | The date and time when the file attachment was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
OrganizationsId | Long | False | No | The unique identifier of the organization. | |
ChannelId | Long | False | No | Id of channel. The channel through which the note was created. | |
ChannellookUpName | String | False | No | LookUpName of channel. The channel through which the note was created. | |
CreatedByAccountId | Long | False | No | Id of createdByAccount. The staff member account that created the note. | |
CreatedByAccountlookUpName | String | False | No | LookUpName of createdByAccount. The staff member account that created the note. | |
CreatedTime | Datetime | False | No | The date and time when the note was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the note. | |
Text | String | False | No | The text content in the note. | |
UpdatedByAccountId | Long | False | No | Id of updatedByAccount. The staff member account that updated the note. | |
UpdatedByAccountlookUpName | String | False | No | LookUpName of updatedByAccount. The staff member account that updated the note. | |
UpdatedTime | Datetime | False | No | The date and time when the note was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CampaignId | Long | False | No | Id of campaign. The campaign associated with the purchased product. | |
CampaignlookUpName | String | False | No | LookUpName of campaign. The campaign associated with the purchased product. | |
Comment | String | False | No | The comments or notes associated with the line item. | |
ContactId | Long | False | No | Id of contact. The contact associated with the purchased product. | |
ContactlookUpName | String | False | No | LookUpName of contact. The contact associated with the purchased product. | |
CreatedTime | Datetime | True | No | The date and time when the purchased product was created. This attribute is read-only. | |
FinalizedByAccountId | Long | False | No | Id of finalizedByAccount. The account associated with the purchased product. | |
FinalizedByAccountlookUpName | String | False | No | LookUpName of finalizedByAccount. The account associated with the purchased product. | |
Id [KEY] | Long | True | No | The unique identifier of the purchased product. | |
LicenseEndTime | Datetime | False | No | The end date of the license. | |
LicenseStartTime | Datetime | False | No | The start date of the license. | |
LookupName | String | True | No | The name used to look up the purchased product. | |
MailingId | Long | False | No | Id of mailing. The associated mailing. | |
MailinglookUpName | String | False | No | LookUpName of mailing. The associated mailing. | |
OpportunityId | Long | False | No | Id of opportunity. The opportunity associated with the purchased product. | |
OpportunitylookUpName | String | False | No | LookUpName of opportunity. The opportunity associated with the purchased product. | |
OrganizationId | Long | False | No | Id of organization. The organization associated with the purchased product. | |
OrganizationlookUpName | String | False | No | LookUpName of organization. The organization associated with the purchased product. | |
PurchaseTime | Datetime | False | No | The date and time of the purchase. | |
SalesProductId | Long | False | No | Id of salesProduct. The sales product associated with the purchased product. | |
SalesProductlookUpName | String | False | No | LookUpName of salesProduct. The sales product associated with the purchased product. | |
SerialNumber | String | False | No | The serial number of the purchased product. | |
UpdatedTime | Datetime | True | No | The date and time when the purchased product was last updated. This attribute is read-only. | |
PricecurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
PricecurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
PriceexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
PriceexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
Pricevalue | String | False | No | The value of the currency. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AcceptCount | Int | False | No | The number of times an offer for the sales product was accepted through offer advisor. | |
CreatedTime | Datetime | True | No | The date and time when the sales product was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The display position of the sales product within the folder list in the product catalog. | |
ExcludeFromOfferAdvisor | Bool | False | No | Indicates whether the product is excluded from the offer advisor. This attribute does not have a default value. | |
Id [KEY] | Long | True | No | The unique identifier of the sales product. | |
LookupName | String | True | No | The name used to look up the sales product. | |
Name | String | True | No | The name of the product in the language of the current interface. This attribute is read-only. | |
PartNumber | String | False | No | The text string which identifies the product. For example, stock keeping unit (SKU) or model number. | |
RespondCount | Int | False | No | The number of times the product was offered through the offer advisor. | |
ServiceProductId | Long | False | No | Id of serviceProduct. The service product. | |
ServiceProductlookUpName | String | False | No | LookUpName of serviceProduct. The service product. | |
UpdatedTime | Datetime | True | No | The date and time when the sales product was last updated. This attribute is read-only. | |
Attributesdisabled | Bool | False | No | Indicates whether the product is temporarily disabled and will not be displayed. The default value is false. | |
AttributeshasSerialNumber | Bool | False | No | Indicates whether the product has a serial number. The default value is false. | |
AttributesisSalesProduct | Bool | False | No | Indicates whether the product is a sales product. The default value is true. | |
AttributesisServiceProduct | Bool | False | No | Indicates whether the product is a service product. The default value is false. | |
Folderid | Long | False | No | ID value | |
FolderlookupName | String | False | No | Name used to lookup this object | |
adminVisibleInterfaces | String | False | Yes | The list of interfaces on which the sales product is visible. | |
descriptions | String | False | Yes | The list of descriptions, one for each supported language. | |
names | String | False | Yes | The list of names, one for each supported language. | |
schedules | String | False | Yes | The list of associated price schedules. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AdminVisibleInterfacesId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AdminVisibleInterfacesLookUpName | String | False | No | The name used to look up the object. | |
SalesProductsId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
SalesProductsLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
SalesProductsId | Long | False | No | The unique identifier of the sales product. | |
LabelText | String | False | No | The label text. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
SalesProductsId | Long | False | No | The unique identifier of the sales product. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
SalesProductsId | Long | False | No | The unique identifier of the sales product. | |
Comment | String | False | No | The comments or notes associated with the sales product schedule. | |
ScheduleId | Long | False | No | Id of schedule. The ID of the schedule. This is part of the key for the list entry. | |
SchedulelookUpName | String | False | No | LookUpName of schedule. The ID of the schedule. This is part of the key for the list entry. | |
ScheduleEndDate | Date | False | No | The date when the schedule ends. | |
ScheduleStartDate | Date | False | No | The date when the schedule starts. This is part of the key for the list entry. | |
PricecurrencyId | Long | False | No | Id of currency. The ID of the currency. | |
PricecurrencylookUpName | String | False | No | LookUpName of currency. The ID of the currency. | |
PriceexchangeRateId | Long | False | No | Id of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
PriceexchangeRatelookUpName | String | False | No | LookUpName of exchangeRate. The exchange rate in effect when the value was set. This is used to convert the value to other currencies. | |
Pricevalue | String | False | No | The value of the currency. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Comment | String | False | No | The comments or notes associated with the sales territory. | |
CreatedTime | Datetime | True | No | The date and time when the sales territory was created. This attribute is read-only. | |
Disabled | Bool | False | No | Indicates whether a sales territory is disabled. The default value is false. | |
DisplayOrder | Int | False | No | The display position of the sales territory relative to other members of the same group. | |
Id [KEY] | Long | True | No | The unique identifier of the sales territory. | |
LookupName | String | True | No | The name used to look up the sales territory. | |
Name | String | True | No | The name of the sales territory in the language of the current interface. This attribute is read-only. | |
ParentId | Long | False | No | Id of parent. The parent sales territory in the hierarchy. | |
ParentlookUpName | String | False | No | LookUpName of parent. The parent sales territory in the hierarchy. | |
UpdatedTime | Datetime | True | No | The date and time when the sales territory was last updated. This attribute is read-only. | |
adminVisibleInterfaces | String | False | Yes | The list of interfaces on which the category is available for administration use. | |
names | String | False | Yes | The list of names, one for each supported language. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AdminVisibleInterfacesId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AdminVisibleInterfacesLookUpName | String | False | No | The name used to look up the object. | |
SalesTerritoriesId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
SalesTerritoriesLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
SalesTerritoriesId | Long | False | No | The unique identifier of the sales territory. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | True | No | The date and time when the service category was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The display position of the service category relative to other categories with the same parent. | |
Id [KEY] | Long | True | No | The unique identifier of the service category. | |
LookupName | String | True | No | The name used to look up the service category. | |
Name | String | True | No | The name of the service category in the language of the current interface. This attribute is read-only. | |
ParentId | Long | False | No | Id of parent. The parent category in the hierarchy. | |
ParentlookUpName | String | False | No | LookUpName of parent. The parent category in the hierarchy. | |
UpdatedTime | Datetime | True | No | The date and time when the service category was last updated. This attribute is read-only. | |
adminVisibleInterfaces | String | False | Yes | The list of interfaces on which the category is available for administration use. | |
descriptions | String | False | Yes | The list of descriptions, one for each supported language. | |
endUserVisibleInterfaces | String | False | Yes | The list of interfaces on which the category is available for end user use. | |
names | String | False | Yes | The list of names, one for each supported language. | |
productLinks | String | False | Yes | The category to product linking. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AdminVisibleInterfacesId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AdminVisibleInterfacesLookUpName | String | False | No | The name used to look up the object. | |
ServiceCategoriesId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
ServiceCategoriesLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ServiceCategoriesId | Long | False | No | Id of ServiceCategories. | |
LabelText | String | False | No | The label text. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
EndUserVisibleInterfacesId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
EndUserVisibleInterfacesLookUpName | String | False | No | The name used to look up the object. | |
ServiceCategoriesId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
ServiceCategoriesLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ServiceCategoriesId | Long | False | No | The unique identifier of the service category. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ServiceCategoriesId | Long | False | No | Id of ServiceCategories. | |
ServiceProductId | Long | False | No | Id of serviceProduct. The ID of the service product. This is the key for the list entry. | |
ServiceProductlookUpName | String | False | No | LookUpName of serviceProduct. The ID of the service product. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | True | No | The date and time when the service disposition was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The display position of the service disposition relative to other dispositions with the same parent. | |
Id [KEY] | Long | True | No | The unique identifier of the service disposition. | |
LookupName | String | True | No | The name used to look up the service disposition. | |
Name | String | True | No | The name of the service disposition in the language of the current interface. This attribute is read-only. | |
ParentId | Long | False | No | Id of parent. The parent disposition in the hierarchy. | |
ParentlookUpName | String | False | No | LookUpName of parent. The parent disposition in the hierarchy. | |
UpdatedTime | Datetime | True | No | The date and time when the service disposition was last updated. This attribute is read-only. | |
adminVisibleInterfaces | String | False | Yes | The list of interfaces on which the disposition is available for administration use. | |
descriptions | String | False | Yes | The list of descriptions, one for each supported language. | |
names | String | False | Yes | The list of names, one for each supported language. | |
productLinks | String | False | Yes | The disposition to product linking. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AdminVisibleInterfacesId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AdminVisibleInterfacesLookUpName | String | False | No | The name used to look up the object. | |
ServiceDispositionsId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
ServiceDispositionsLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ServiceDispositionsId | Long | False | No | Id of ServiceDispositions. | |
LabelText | String | False | No | The label text. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ServiceDispositionsId | Long | False | No | Id of ServiceDispositions. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ServiceDispositionsId | Long | False | No | Id of ServiceDispositions. | |
ServiceProductId | Long | False | No | Id of serviceProduct. The ID of the service product. This is the key for the list entry. | |
ServiceProductlookUpName | String | False | No | LookUpName of serviceProduct. The ID of the service product. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | False | No | The date and time when the service mailbox was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the service mailbox. | |
InterfaceId | Long | False | No | Id of interface. The interface that the mailbox is associated with. | |
InterfacelookUpName | String | False | No | LookUpName of interface. The interface that the mailbox is associated with. | |
IsDefault | Bool | False | No | Indicates whether the mailbox is the default mailbox for the interface. This attribute does not have a default value. | |
LookupName | String | False | No | The name used to look up the service mailbox. | |
Name | String | False | No | The name of the service mailbox in the language of the current interface. | |
TypeId | Long | False | No | Id of type. The module the mailbox is associated with. | |
TypelookUpName | String | False | No | LookUpName of type. The module the mailbox is associated with. | |
UpdatedTime | Datetime | False | No | The date and time when the service mailbox was last updated. This attribute is read-only. | |
IncomingEmailSettingsforceReplyBetweenLines | Bool | False | No | Indicates whether the Force Reply Between the Lines feature is enabled for outgoing emails from the mailbox. This attribute does not have a default value. | |
IncomingEmailSettingsforwardRejectMessageAddress | String | False | No | The address to which rejected messages are sent. | |
IncomingEmailSettingsisEnabled | Bool | False | No | Indicates whether incoming email option is enabled. This attribute does not have a default value. | |
OutgoingEmailSettingsdisplayName | String | False | No | The display name used in the outgoing emails from the mailbox. | |
OutgoingEmailSettingsfriendlyFromAddress | String | False | No | The from address used to brand outgoing emails as friendly. | |
OutgoingEmailSettingsfromAddress | String | False | No | The from address on the outgoing email. | |
OutgoingEmailSettingsisEnabled | Bool | False | No | Indicates whether outgoing email is enabled. This attribute does not have a default value. | |
OutgoingEmailSettingsreplyToAddress | String | False | No | The reply-to-address on the outgoing email. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | True | No | The date and time when the service product was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The display position of the service product relative to other products with the same parent. | |
Id [KEY] | Long | True | No | The unique identifier of the service product. | |
LookupName | String | True | No | The name used to look up the service product. | |
Name | String | True | No | The name of the service product in the language of the current interface. | |
ParentId | Long | False | No | Id of parent. The parent product in the hierarchy. | |
ParentlookUpName | String | False | No | LookUpName of parent. The parent product in the hierarchy. | |
UpdatedTime | Datetime | True | No | The date and time when the service product was last updated. This attribute is read-only. | |
adminVisibleInterfaces | String | False | Yes | The list of interfaces on which the category is available for administration use. | |
categoryLinks | String | False | Yes | The product to category linking. | |
descriptions | String | False | Yes | The list of descriptions, one for each supported language. | |
dispositionLinks | String | False | Yes | The product to disposition linking. | |
endUserVisibleInterfaces | String | False | Yes | The list of interfaces on which the category is available for end user use. | |
names | String | False | Yes | The list of names, one for each supported language. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AdminVisibleInterfacesId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AdminVisibleInterfacesLookUpName | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
ServiceProductsLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ServiceProductsId | Long | False | No | Id of serviceProducts. | |
ServiceCategoryId | Long | False | No | Id of serviceCategory. The ID of the service category. This is the key for the list entry. | |
ServiceCategorylookUpName | String | False | No | LookUpName of serviceCategory. The ID of the service category. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ServiceProductsId | Long | False | No | Id of ServiceProducts. | |
LabelText | String | False | No | The label text. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ServiceProductsId | Long | False | No | Id of ServiceProducts. | |
ServiceDispositionId | Long | False | No | Id of serviceDisposition. The ID of the service disposition. This is the key for the list entry. | |
ServiceDispositionlookUpName | String | False | No | LookUpName of serviceDisposition. The ID of the service disposition. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
EndUserVisibleInterfacesId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
EndUserVisibleInterfacesLookUpName | String | False | No | The name used to look up the object. | |
ServiceProductsId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
ServiceProductsLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ServiceProductsId | Long | False | No | Name of ServiceProducts. | |
LabelText | String | False | No | The language-specific label text. The value cannot be null or empty. | |
LanguageId | Long | False | No | Id of language. The ID of the language. This is the key for the list entry. | |
LanguagelookUpName | String | False | No | LookUpName of language. The ID of the language. This is the key for the list entry. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | False | No | The date and time when the site interface was created. This attribute is read-only. | |
DisplayName | String | False | No | The display name of the site interface. | |
Id [KEY] | Long | False | No | The unique identifier of the site interface. | |
LanguageId | Long | False | No | Id of language. The language associated with the interface. | |
LanguagelookUpName | String | False | No | LookUpName of language. The language associated with the interface. | |
LookupName | String | False | No | The name used to look up the site interface. | |
Name | String | False | No | The name of the site interface. | |
UpdatedTime | Datetime | False | No | The date and time when the site interface was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Comment | String | False | No | The comments associated with the standard content object. | |
CreatedTime | Datetime | True | No | The date and time when the standard content was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The display position of the standard content relative to other standard content objects with the same parent. | |
HotKey | String | False | No | The assigned shortcut key for inserting the standard content. | |
Id [KEY] | Long | True | No | The unique identifier of the standard content object. | |
LookupName | String | True | No | The name used to look up the standard content object. | |
Name | String | False | No | The name of the standard content object. | |
UpdatedTime | Datetime | True | No | The date and time when the standard content was last updated. This attribute is read-only. | |
AttributesdisplayRightToLeft | Bool | False | No | Indicates whether the content presentation is from right to left. The default value is false. | |
Folderid | Long | False | No | ID value | |
FolderlookupName | String | False | No | Name used to lookup this object | |
UsagechatText | Bool | False | No | Indicates whether the content is used in a chat session. The default value is false. | |
UsagechatURL | Bool | False | No | Indicates whether the content is used in the URL of a chat session. The default value is false. | |
UsageincidentText | Bool | False | No | Indicates whether the content is used in an incident. The default value is false. | |
UsageruleText | Bool | False | No | Indicates whether the content is used in a rule. The default value is false. | |
adminVisibleInterfaces | String | False | Yes | The list of interfaces on which the category is available for administration use. | |
contentValues | String | False | Yes | The list of the preformed content with entries for each content type. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AdminVisibleInterfacesId [KEY] | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
AdminVisibleInterfacesLookUpName | String | False | No | The name used to look up the object. | |
StandardContentsId | Long | False | No | The unique identifier of the object. This is the key for the list entry. | |
StandardContentsLookUpName | String | False | No | The name used to look up the object. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
StandardContentsId | Long | False | No | Id of StandardContents. | |
ContentTypeId | Long | False | No | Id of contentType. The content type of the data. | |
ContentTypelookUpName | String | False | No | LookUpName of contentType. The content type of the data. | |
Value | String | False | No | The formatted data for the associated content type. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AssignedToAccountId | Long | False | No | Id of assignedToAccount. The assigned staff account. | |
AssignedToAccountlookUpName | String | False | No | LookUpName of assignedToAccount. The assigned staff account. | |
CompletedTime | Datetime | False | No | The date and time when the task was completed. | |
ContactId | Long | False | No | Id of contact. The associated contact. | |
ContactlookUpName | String | False | No | LookUpName of contact. The associated contact. | |
CreatedTime | Datetime | True | No | The date and time when the task was created. This attribute is read-only. | |
DueTime | Datetime | False | No | The date and time when the task is due. | |
Id [KEY] | Long | True | No | The unique identifier of the task. | |
LookupName | String | True | No | The name used to look up the task. | |
Name | String | False | No | The name used to describe the task. | |
OrganizationId | Long | False | No | Id of organization. The associated organization. | |
OrganizationlookUpName | String | False | No | LookUpName of organization. The associated organization. | |
PercentComplete | Int | False | No | The percentage of work completed. | |
PlannedCompletionTime | Datetime | False | No | The date and time when the task is planned for completion. | |
PriorityId | Long | False | No | Id of priority. The relative priority. | |
PrioritylookUpName | String | False | No | LookUpName of priority. The relative priority. | |
StartTime | Datetime | False | No | The date and time when the task started. | |
TaskTemplateId | Long | False | No | Id of taskTemplate. The template for the business process. | |
TaskTemplatelookUpName | String | False | No | LookUpName of taskTemplate. The template for the business process. | |
TaskTypeId | Long | False | No | Id 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. | |
TaskTypelookUpName | String | False | No | LookUpName 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. | |
UpdatedTime | Datetime | True | No | The date and time when the task was last updated. This attribute is read-only. | |
InheritinheritContact | Bool | False | No | Indicates whether the task inherits contact value from the associated object. The default value is false. | |
InheritinheritOrganization | Bool | False | No | Indicates whether the task inherits organization value from the associated object. The default value is false. | |
InheritinheritStaffAssignment | Bool | False | No | Indicates whether the task inherits account value from the associated object. The default value is false. | |
MarketingSettingscampaignId | Long | False | No | Id of campaign. The associated campaign. | |
MarketingSettingscampaignlookUpName | String | False | No | LookUpName of campaign. The associated campaign. | |
MarketingSettingsdocumentId | Long | False | No | Id of document. The associated marketing document. | |
MarketingSettingsdocumentlookUpName | String | False | No | LookUpName of document. The associated marketing document. | |
MarketingSettingsmailingId | Long | False | No | Id of mailing. The associated mailing. | |
MarketingSettingsmailinglookUpName | String | False | No | LookUpName of mailing. The associated mailing. | |
MarketingSettingssurveyId | Long | False | No | Id of survey. The associated survey. | |
MarketingSettingssurveylookUpName | String | False | No | LookUpName of survey. The associated survey. | |
SalesSettingsopportunityId | Long | False | No | Id of opportunity. The associated opportunity. | |
SalesSettingsopportunitylookUpName | String | False | No | LookUpName of opportunity. The associated opportunity. | |
ServiceSettingsanswerId | Long | False | No | Id of answer. The associated answer. | |
ServiceSettingsanswerlookUpName | String | False | No | LookUpName of answer. The associated answer. | |
ServiceSettingsincidentId | Long | False | No | Id of incident. The associated incident. | |
ServiceSettingsincidentlookUpName | String | False | No | LookUpName of incident. The associated incident. | |
StatusWithTypestatusId | Long | False | No | Id of status. The current status. | |
StatusWithTypestatuslookUpName | String | False | No | LookUpName of status. The current status. | |
StatusWithTypestatusTypeId | Long | True | No | Id of statusType. The associated status type. This attribute is read-only. | |
StatusWithTypestatusTypelookUpName | String | True | No | LookUpName of statusType. The associated status type. This attribute is read-only. | |
fileAttachments | String | False | Yes | The list of file attachments. | |
notes | String | False | Yes | The list of discussion threads. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
TasksId | Long | False | No | Id of Tasks. | |
ContentType | String | False | No | The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. | |
CreatedTime | Datetime | False | No | The date and time when the file was associated with the object. This attribute is read-only. | |
Data | String | False | No | The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field. | |
Description | String | False | No | The description for the contents of the file attachment. | |
FileName | String | False | No | The name of the file when saving it to the disk. | |
FormData | String | False | No | The HTML form which is used to upload file attachments. | |
Id [KEY] | Long | False | No | The unique identifier of the file attachment. | |
Name | String | False | No | The short display name of the file attachment. | |
Size | Int | False | No | The size of the file in bytes. This attribute is read-only. | |
URL | String | False | No | The URL to access this file. | |
UpdatedTime | Datetime | False | No | The date and time when the file attachment was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
TasksId | Long | False | No | Id of Tasks. | |
ChannelId | Long | False | No | Id of channel. The channel through which the note was created. | |
ChannellookUpName | String | False | No | LookUpName of channel. The channel through which the note was created. | |
CreatedByAccountId | Long | False | No | Id of createdByAccount. The staff member account that created the note. | |
CreatedByAccountlookUpName | String | False | No | LookUpName of createdByAccount. The staff member account that created the note. | |
CreatedTime | Datetime | False | No | The date and time when the note was created. This attribute is read-only. | |
Id [KEY] | Long | False | No | The unique identifier of the note. | |
Text | String | False | No | The text content in the note. | |
UpdatedByAccountId | Long | False | No | Id of updatedByAccount. The staff member account that updated the note. | |
UpdatedByAccountlookUpName | String | False | No | LookUpName of updatedByAccount. The staff member account that updated the note. | |
UpdatedTime | Datetime | False | No | The date and time when the note was last updated. This attribute is read-only. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CreatedTime | Datetime | True | No | The date and time when the variable was created. This attribute is read-only. | |
DisplayOrder | Int | False | No | The position of the variable in the variable list. | |
Id [KEY] | Long | True | No | The unique identifier of the variable. | |
LookupName | String | True | No | The name used to look up the variable. | |
Name | String | False | No | The name of the variable. | |
SearchIndexable | Bool | False | No | Indicates whether the text is indexed for searching the customer portal. The default value is false. | |
UpdatedTime | Datetime | True | No | The date and time when the variable was last updated. This attribute is read-only. | |
Folderid | Long | False | No | ID value | |
FolderlookupName | String | False | No | Name used to lookup this object | |
interfaceValues | String | False | Yes | The list of values, one for each supported interface. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
VariablesId | Long | False | No | Id of Variables. | |
InterfaceId | Long | False | No | Id of interface. The interface of the site. | |
InterfacelookUpName | String | False | No | LookUpName of interface. The interface of the site. | |
Value | String | False | No | The description of the interface. |