Cmdlets for Oracle Service Cloud

Build 24.0.9060

Contacts

The customers or end users of Oracle B2C Service site.

Table-Specific Information

SELECT

The cmdlet will use the Oracle Service Cloud API to process WHERE clause conditions built with =,!=,<,>,<=,>=,IN,NOT_IN,IS,IS_NOT,LIKE operators. The rest of the filters are executed client side within the cmdlet. 

SELECT * FROM Contacts WHERE id = 12
SELECT * FROM Contacts WHERE id > 15
SELECT * FROM Contacts WHERE lookUpName LIKE '%test'
SELECT * FROM Contacts WHERE id IN (12, 23, 123)
SELECT * FROM Contacts WHERE lookUpName IS NOT NULL

INSERT

Insert can be executed. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table. 

INSERT INTO Contacts (bannertext) VALUES ('Agent: Knowledge')

UPDATE

Update can be executed. The columns that are not read-only can be Updated. For example: 

UPDATE Contacts SET login = 'chris.fellows' WHERE namelast = 'Chase'

DELETE

Delete can be executed by specifying id in the WHERE Clause. For example: 

DELETE FROM Contacts WHERE id = '209'

Columns

Name Type ReadOnly Description
ContactTypeId Long False

Id of contactType. The ID of the contact type.

ContactTypelookUpName String False

LookUpName of contactType. The ID of the contact type.

CreatedTime Datetime True

The date and time when the contact was created. This attribute is read-only.

Disabled Bool False

Indicates whether the contact is disabled. The default value is false.

ExternalReference String True

The external reference key of the contact.

Id [KEY] Long True

The unique identifier of the contact.

Login String False

The user name used for authentication.

LookupName String True

The name used to look up the contact.

NewPassword String False

The new password for authentication. It is stored with a one-way encryption in the system. This attribute is write-only.

OrganizationId Long False

Id of organization. The organization to which the contact belongs.

OrganizationlookUpName String False

LookUpName of organization. The organization to which the contact belongs.

PasswordEmailExpirationTime Datetime True

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

The date and time by when the password is set to expire. This attribute is read-only.

SourceId Long True

Id of source. The creation source IDs. This attribute is read-only.

SourcelookUpName String True

LookUpName of source. The creation source IDs. This attribute is read-only.

SupersededById Long True

Id of supersededBy. The superseding contact for the contact. This attribute is read-only.

SupersededBylookUpName String True

LookUpName of supersededBy. The superseding contact for the contact. This attribute is read-only.

Title String False

The social or professional title of the contact. For example, Mrs., Dr., and so on.

UpdatedTime Datetime True

The date and time when the contact was last updated. This attribute is read-only.

Addresscity String False

The name of the city.

AddresscountryId Long False

Id of country. The ID of the country.

AddresscountrylookUpName String False

LookUpName of country. The ID of the country.

AddresspostalCode String False

The postal code or the ZIP code.

AddressstateOrProvinceId Long False

Id of stateOrProvince. The ID of the state or province.

AddressstateOrProvincelookUpName String False

LookUpName of stateOrProvince. The ID of the state or province.

Addressstreet String False

The street address.

BannerimportanceFlagId Long False

Id of importanceFlag. The importance of the banner.

BannerimportanceFlaglookUpName String False

LookUpName of importanceFlag. The importance of the banner.

Bannertext String False

The description of a flag.

BannerupdatedByAccountId Long True

Id of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.

BannerupdatedByAccountlookUpName String True

LookUpName of updatedByAccount. The staff account that most recently updated the banner flag and/or text. This attribute is read-only.

BannerupdatedTime Datetime True

The date and time when the banner was last updated. This attribute is read-only.

CRMModulesmarketing Bool False

Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled.

CRMModulessales Bool False

Indicates whether the sales module is applicable. The default value is true only if sales module is enabled.

CRMModulesservice Bool False

Indicates whether the service module is applicable. The default value is true only if service module is enabled.

MarketingSettingsemailFormatId Long False

Id of emailFormat. The ID of preferred format for sending emails to the contact.

MarketingSettingsemailFormatlookUpName String False

LookUpName of emailFormat. The ID of preferred format for sending emails to the contact.

MarketingSettingsmarketingOptIn Bool False

Indicates whether the contact has opted in for marketing mailing list. This attribute does not have a default value.

MarketingSettingsmarketingOrganizationName String False

The marketing organization name.

MarketingSettingsmarketingOrganizationNameAlt String False

The alternate name of the marketing organization.

MarketingSettingssurveyOptIn Bool False

Indicates whether the contact has opted in for providing feedback. This attribute does not have a default value.

Namefirst String False

The first name of the person.

Namelast String False

The surname or last name of the person.

NameFuriganafirst String False

The first name of the person.

NameFuriganalast String False

The surname or last name of the person.

SalesSettingsacquiredDate Date True

The date when the first opportunity associated with the contact was closed. This attribute is read-only.

SalesSettingssalesAccountId Long False

Id of salesAccount. The ID of the staff account for the sales representative assigned to the contact.

SalesSettingssalesAccountlookUpName String False

LookUpName of salesAccount. The ID of the staff account for the sales representative assigned to the contact.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
channelUsernames String

The list of usernames for the contact across different communication channels.

emails String

The list of email addresses.

fileAttachments String

The list of file attachments.

notes String

The list of notes associated with the contact.

openIDAccounts String

The list of OpenID URLs associated with the contact.

phones String

The list of phone numbers.

contactLists String

The contact lists in which the contact is included.

answerNotifications String

The answer notifications to which the contact is subscribed.

categoryNotifications String

The category notifications to which the contact is subscribed.

productNotifications String

The product notifications to which the contact is subscribed.

sLAInstances String

The SLA instances associated with the contact. This attribute is read-only for versions 1 and 1.1.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060