All REST Endpoints

accounts
An account generated for a staff member in the system. Staff accounts are used by CSRs, sales agents, site administrators, etc.
Create an instance of accounts
Method: post
Path: /services/rest/connect/v1.4/accounts
Delete an instance of accounts
Method: delete
Path: /services/rest/connect/latest/accounts/{id}
Retrieve an instance of accounts
Method: get
Path: /services/rest/connect/latest/accounts/{id}
Retrieve collection of accounts
Method: get
Path: /services/rest/connect/v1.4/accounts
Update an instance of accounts
Method: patch
Path: /services/rest/connect/latest/accounts/{id}
analyticsReportResults
Run an analyticsReports
Create an instance of analyticsReportResults
Method: post
Path: /services/rest/connect/v1.4/analyticsReportResults
analyticsReports
An Analytics Report Definition
Retrieve an instance of analyticsReports
Method: get
Path: /services/rest/connect/latest/analyticsReports/{id}
Retrieve collection of analyticsReports
Method: get
Path: /services/rest/connect/v1.4/analyticsReports
answerVersions
A versioned instance of an answer. Customer questions and answers maintained in the Knowledge Base
Retrieve an instance of answerVersions
Method: get
Path: /services/rest/connect/latest/answerVersions/{id}
Retrieve collection of answerVersions
Method: get
Path: /services/rest/connect/v1.4/answerVersions
answers
Customer questions and answers maintained in the Knowledge Base
Create an instance of answers
Method: post
Path: /services/rest/connect/v1.4/answers
Delete an instance of answers
Method: delete
Path: /services/rest/connect/latest/answers/{id}
Retrieve an instance of answers
Method: get
Path: /services/rest/connect/latest/answers/{id}
Retrieve collection of answers
Method: get
Path: /services/rest/connect/v1.4/answers
Update an instance of answers
Method: patch
Path: /services/rest/connect/latest/answers/{id}
assetStatuses
Status and associated status type for an Asset.
Retrieve an instance of assetStatuses
Method: get
Path: /services/rest/connect/latest/assetStatuses/{id}
Retrieve collection of assetStatuses
Method: get
Path: /services/rest/connect/v1.4/assetStatuses
assets
Representation of a business asset.
Create an instance of assets
Method: post
Path: /services/rest/connect/v1.4/assets
Delete an instance of assets
Method: delete
Path: /services/rest/connect/latest/assets/{id}
Retrieve an instance of assets
Method: get
Path: /services/rest/connect/latest/assets/{id}
Retrieve collection of assets
Method: get
Path: /services/rest/connect/v1.4/assets
Update an instance of assets
Method: patch
Path: /services/rest/connect/latest/assets/{id}
campaigns
Contains information on email marketing campaigns created in Oracle Service Cloud Outreach Cloud Service.
Retrieve an instance of campaigns
Method: get
Path: /services/rest/connect/latest/campaigns/{id}
Retrieve collection of campaigns
Method: get
Path: /services/rest/connect/v1.4/campaigns
channelTypes
Channel Type
Retrieve an instance of channelTypes
Method: get
Path: /services/rest/connect/latest/channelTypes/{id}
Retrieve collection of channelTypes
Method: get
Path: /services/rest/connect/v1.4/channelTypes
chats
Representation of a chat.
Retrieve an instance of chats
Method: get
Path: /services/rest/connect/latest/chats/{id}
Retrieve collection of chats
Method: get
Path: /services/rest/connect/v1.4/chats
configurations
Contains information about configuration settings within the system.
Retrieve an instance of configurations
Method: get
Path: /services/rest/connect/latest/configurations/{id}
Retrieve collection of configurations
Method: get
Path: /services/rest/connect/v1.4/configurations
contacts
Customers or end users of a site
Create an instance of contacts
Method: post
Path: /services/rest/connect/v1.4/contacts
Delete an instance of contacts
Method: delete
Path: /services/rest/connect/latest/contacts/{id}
Reset password for a contact resource
Method: post
Path: /services/rest/connect/v1.4/contacts/{id}/resetPassword
Retrieve an instance of contacts
Method: get
Path: /services/rest/connect/latest/contacts/{id}
Retrieve collection of contacts
Method: get
Path: /services/rest/connect/v1.4/contacts
Sends a contact through a campaign flow starting at the specified entry point
Method: post
Path: /services/rest/connect/v1.4/contacts/{id}/executeMarketingFlow
Sends a transactional mailing to the Contact
Method: post
Path: /services/rest/connect/v1.4/contacts/{id}/sendMailing
Update an instance of contacts
Method: patch
Path: /services/rest/connect/latest/contacts/{id}
countries
Represents a country object defined in the system.
Create an instance of countries
Method: post
Path: /services/rest/connect/v1.4/countries
Delete an instance of countries
Method: delete
Path: /services/rest/connect/latest/countries/{id}
Retrieve an instance of countries
Method: get
Path: /services/rest/connect/latest/countries/{id}
Retrieve collection of countries
Method: get
Path: /services/rest/connect/v1.4/countries
Update an instance of countries
Method: patch
Path: /services/rest/connect/latest/countries/{id}
eventSubscriptions
An event-based subscription management object
Create an instance of eventSubscriptions
Method: post
Path: /services/rest/connect/v1.4/eventSubscriptions
Delete an instance of eventSubscriptions
Method: delete
Path: /services/rest/connect/latest/eventSubscriptions/{id}
Retrieve an instance of eventSubscriptions
Method: get
Path: /services/rest/connect/latest/eventSubscriptions/{id}
Retrieve collection of eventSubscriptions
Method: get
Path: /services/rest/connect/v1.4/eventSubscriptions
Update an instance of eventSubscriptions
Method: patch
Path: /services/rest/connect/latest/eventSubscriptions/{id}
holidays
Contains information on holidays used by the system.
Create an instance of holidays
Method: post
Path: /services/rest/connect/v1.4/holidays
Delete an instance of holidays
Method: delete
Path: /services/rest/connect/latest/holidays/{id}
Retrieve an instance of holidays
Method: get
Path: /services/rest/connect/latest/holidays/{id}
Retrieve collection of holidays
Method: get
Path: /services/rest/connect/v1.4/holidays
Update an instance of holidays
Method: patch
Path: /services/rest/connect/latest/holidays/{id}
incidents
Customer incident or issue
Create an instance of incidents
Method: post
Path: /services/rest/connect/v1.4/incidents
Delete an instance of incidents
Method: delete
Path: /services/rest/connect/latest/incidents/{id}
Retrieve an instance of incidents
Method: get
Path: /services/rest/connect/latest/incidents/{id}
Retrieve collection of incidents
Method: get
Path: /services/rest/connect/v1.4/incidents
Update an instance of incidents
Method: patch
Path: /services/rest/connect/latest/incidents/{id}
mailboxes
An email box used by the system that is dedicated to collecting email inquiries sent by customers, responses to mailings, and bounced messages.
Retrieve an instance of mailboxes
Method: get
Path: /services/rest/connect/latest/mailboxes/{id}
Retrieve collection of mailboxes
Method: get
Path: /services/rest/connect/v1.4/mailboxes
marketingMailboxes
An email box specified in the system and used to send and receive email and process bounced messages in the system.
Retrieve an instance of marketingMailboxes
Method: get
Path: /services/rest/connect/latest/marketingMailboxes/{id}
Retrieve collection of marketingMailboxes
Method: get
Path: /services/rest/connect/v1.4/marketingMailboxes
messageBases
Contains information about the message base within the system.
Retrieve an instance of messageBases
Method: get
Path: /services/rest/connect/latest/messageBases/{id}
Retrieve collection of messageBases
Method: get
Path: /services/rest/connect/v1.4/messageBases
namedIDHierarchies
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Retrieve a namedIDHierarchy
Method: get
Path: /services/rest/connect/v1.4/namedIDHierarchies/{fullyQualifiedPath}/{id}
Retrieve collection of resources having namedIDHierarchies
Method: get
Path: /services/rest/connect/v1.4/namedIDHierarchies/
Retrieve collection of values for namedIDHierarchies.
Method: get
Path: /services/rest/connect/v1.4/namedIDHierarchies/{fullyQualifiedPath}
namedIDs
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Retrieve a namedID
Method: get
Path: /services/rest/connect/v1.4/namedIDs/{fullyQualifiedPath}/{id}
Retrieve collection of resources having namedIDs
Method: get
Path: /services/rest/connect/v1.4/namedIDs/
Retrieve collection of values for namedID.
Method: get
Path: /services/rest/connect/v1.4/namedIDs/{fullyQualifiedPath}
opportunities
Sales opportunity with a contact or organization
Create an instance of opportunities
Method: post
Path: /services/rest/connect/v1.4/opportunities
Delete an instance of opportunities
Method: delete
Path: /services/rest/connect/latest/opportunities/{id}
Retrieve an instance of opportunities
Method: get
Path: /services/rest/connect/latest/opportunities/{id}
Retrieve collection of opportunities
Method: get
Path: /services/rest/connect/v1.4/opportunities
Update an instance of opportunities
Method: patch
Path: /services/rest/connect/latest/opportunities/{id}
opportunityStatuses
The default and custom opportunity statuses and their corresponding types
Retrieve an instance of opportunityStatuses
Method: get
Path: /services/rest/connect/latest/opportunityStatuses/{id}
Retrieve collection of opportunityStatuses
Method: get
Path: /services/rest/connect/v1.4/opportunityStatuses
organizations
Business organization
Create an instance of organizations
Method: post
Path: /services/rest/connect/v1.4/organizations
Delete an instance of organizations
Method: delete
Path: /services/rest/connect/latest/organizations/{id}
Retrieve an instance of organizations
Method: get
Path: /services/rest/connect/latest/organizations/{id}
Retrieve collection of organizations
Method: get
Path: /services/rest/connect/v1.4/organizations
Update an instance of organizations
Method: patch
Path: /services/rest/connect/latest/organizations/{id}
purchasedProducts
Information about a purchased product.
Create an instance of purchasedProducts
Method: post
Path: /services/rest/connect/v1.4/purchasedProducts
Delete an instance of purchasedProducts
Method: delete
Path: /services/rest/connect/latest/purchasedProducts/{id}
Retrieve an instance of purchasedProducts
Method: get
Path: /services/rest/connect/latest/purchasedProducts/{id}
Retrieve collection of purchasedProducts
Method: get
Path: /services/rest/connect/v1.4/purchasedProducts
Update an instance of purchasedProducts
Method: patch
Path: /services/rest/connect/latest/purchasedProducts/{id}
queryResults
Results from ROQL query
Get an array of ROQL results
Method: get
Path: /services/rest/connect/v1.4/queryResults
sSOTokenReferences
Encapsulates the Single Sign On token
Retrieve an instance of sSOTokenReferences
Method: get
Path: /services/rest/connect/latest/sSOTokenReferences/{id}
Retrieve collection of sSOTokenReferences
Method: get
Path: /services/rest/connect/v1.4/sSOTokenReferences
salesProducts
Product available to customers and organizations through quotes or offer advisor
Create an instance of salesProducts
Method: post
Path: /services/rest/connect/v1.4/salesProducts
Delete an instance of salesProducts
Method: delete
Path: /services/rest/connect/latest/salesProducts/{id}
Retrieve an instance of salesProducts
Method: get
Path: /services/rest/connect/latest/salesProducts/{id}
Retrieve collection of salesProducts
Method: get
Path: /services/rest/connect/v1.4/salesProducts
Update an instance of salesProducts
Method: patch
Path: /services/rest/connect/latest/salesProducts/{id}
salesTerritories
A specific geographical sales region
Create an instance of salesTerritories
Method: post
Path: /services/rest/connect/v1.4/salesTerritories
Delete an instance of salesTerritories
Method: delete
Path: /services/rest/connect/latest/salesTerritories/{id}
Retrieve an instance of salesTerritories
Method: get
Path: /services/rest/connect/latest/salesTerritories/{id}
Retrieve collection of salesTerritories
Method: get
Path: /services/rest/connect/v1.4/salesTerritories
Update an instance of salesTerritories
Method: patch
Path: /services/rest/connect/latest/salesTerritories/{id}
serviceCategories
Hierarchical service category
Create an instance of serviceCategories
Method: post
Path: /services/rest/connect/v1.4/serviceCategories
Delete an instance of serviceCategories
Method: delete
Path: /services/rest/connect/latest/serviceCategories/{id}
Retrieve an instance of serviceCategories
Method: get
Path: /services/rest/connect/latest/serviceCategories/{id}
Retrieve collection of serviceCategories
Method: get
Path: /services/rest/connect/v1.4/serviceCategories
Update an instance of serviceCategories
Method: patch
Path: /services/rest/connect/latest/serviceCategories/{id}
serviceDispositions
Hierarchical service disposition
Create an instance of serviceDispositions
Method: post
Path: /services/rest/connect/v1.4/serviceDispositions
Delete an instance of serviceDispositions
Method: delete
Path: /services/rest/connect/latest/serviceDispositions/{id}
Retrieve an instance of serviceDispositions
Method: get
Path: /services/rest/connect/latest/serviceDispositions/{id}
Retrieve collection of serviceDispositions
Method: get
Path: /services/rest/connect/v1.4/serviceDispositions
Update an instance of serviceDispositions
Method: patch
Path: /services/rest/connect/latest/serviceDispositions/{id}
serviceMailboxes
An email box specified in the system and dedicated to collecting email inquiries sent by customers.
Retrieve an instance of serviceMailboxes
Method: get
Path: /services/rest/connect/latest/serviceMailboxes/{id}
Retrieve collection of serviceMailboxes
Method: get
Path: /services/rest/connect/v1.4/serviceMailboxes
serviceProducts
Hierarchical service product
Create an instance of serviceProducts
Method: post
Path: /services/rest/connect/v1.4/serviceProducts
Delete an instance of serviceProducts
Method: delete
Path: /services/rest/connect/latest/serviceProducts/{id}
Retrieve an instance of serviceProducts
Method: get
Path: /services/rest/connect/latest/serviceProducts/{id}
Retrieve collection of serviceProducts
Method: get
Path: /services/rest/connect/v1.4/serviceProducts
Update an instance of serviceProducts
Method: patch
Path: /services/rest/connect/latest/serviceProducts/{id}
siteInterfaces
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name.
Retrieve an instance of siteInterfaces
Method: get
Path: /services/rest/connect/latest/siteInterfaces/{id}
Retrieve collection of siteInterfaces
Method: get
Path: /services/rest/connect/v1.4/siteInterfaces
standardContents
Preformed text or html content.
Create an instance of standardContents
Method: post
Path: /services/rest/connect/v1.4/standardContents
Delete an instance of standardContents
Method: delete
Path: /services/rest/connect/latest/standardContents/{id}
Retrieve an instance of standardContents
Method: get
Path: /services/rest/connect/latest/standardContents/{id}
Retrieve collection of standardContents
Method: get
Path: /services/rest/connect/v1.4/standardContents
Update an instance of standardContents
Method: patch
Path: /services/rest/connect/latest/standardContents/{id}
tasks
Task information
Create an instance of tasks
Method: post
Path: /services/rest/connect/v1.4/tasks
Delete an instance of tasks
Method: delete
Path: /services/rest/connect/latest/tasks/{id}
Retrieve an instance of tasks
Method: get
Path: /services/rest/connect/latest/tasks/{id}
Retrieve collection of tasks
Method: get
Path: /services/rest/connect/v1.4/tasks
Update an instance of tasks
Method: patch
Path: /services/rest/connect/latest/tasks/{id}
variables
A variable is a predefined shortcut for entering information instead of a long string of text.
Create an instance of variables
Method: post
Path: /services/rest/connect/v1.4/variables
Delete an instance of variables
Method: delete
Path: /services/rest/connect/latest/variables/{id}
Retrieve an instance of variables
Method: get
Path: /services/rest/connect/latest/variables/{id}
Retrieve collection of variables
Method: get
Path: /services/rest/connect/v1.4/variables
Update an instance of variables
Method: patch
Path: /services/rest/connect/latest/variables/{id}