All REST Endpoints

Accounts
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on.
Create an account
Method: post
Path: /services/rest/connect/v1.4/accounts
Delete an account
Method: delete
Path: /services/rest/connect/v1.4/accounts/{id}
Get an account
Method: get
Path: /services/rest/connect/v1.4/accounts/{id}
Get multiple accounts
Method: get
Path: /services/rest/connect/v1.4/accounts
Update an account
Method: patch
Path: /services/rest/connect/v1.4/accounts/{id}
Analytics Report Results
The analytics report results that supports the execution of analytics reports in Oracle B2C Service.
Create an analytics report result
Method: post
Path: /services/rest/connect/v1.4/analyticsReportResults
Analytics Reports
The analytics report definition that provides descriptions of a report's output columns, search criteria, and other components.
Get an analytics report
Method: get
Path: /services/rest/connect/v1.4/analyticsReports/{id}
Get multiple analytics reports
Method: get
Path: /services/rest/connect/v1.4/analyticsReports
Answer Versions
The versioned instance of an answer. Answers are solutions to common customer support questions. These questions and answers are maintained in the Oracle B2C Service knowledge base.
Delete an answer version
Method: delete
Path: /services/rest/connect/v1.4/answerVersions/{id}
Get an answer version
Method: get
Path: /services/rest/connect/v1.4/answerVersions/{id}
Get multiple answer versions
Method: get
Path: /services/rest/connect/v1.4/answerVersions
Update an answer version
Method: patch
Path: /services/rest/connect/v1.4/answerVersions/{id}
Answers
The knowledge base information that provides solutions to the common customer support questions.
Create an answer
Method: post
Path: /services/rest/connect/v1.4/answers
Delete an answer
Method: delete
Path: /services/rest/connect/v1.4/answers/{id}
Get an answer
Method: get
Path: /services/rest/connect/v1.4/answers/{id}
Get multiple answers
Method: get
Path: /services/rest/connect/v1.4/answers
Update an answer
Method: patch
Path: /services/rest/connect/v1.4/answers/{id}
Asset Statuses
The status of the assets, namely product and services that are registered and tracked in Oracle B2C Service. The default asset statuses are active, retired, and unregistered.
Get an asset status
Method: get
Path: /services/rest/connect/v1.4/assetStatuses/{id}
Get multiple asset statuses
Method: get
Path: /services/rest/connect/v1.4/assetStatuses
Assets
The product or service associated with an organization's customers.
Create an asset
Method: post
Path: /services/rest/connect/v1.4/assets
Delete an asset
Method: delete
Path: /services/rest/connect/v1.4/assets/{id}
Get an asset
Method: get
Path: /services/rest/connect/v1.4/assets/{id}
Get multiple assets
Method: get
Path: /services/rest/connect/v1.4/assets
Update an asset
Method: patch
Path: /services/rest/connect/v1.4/assets/{id}
Bulk Extract Results
The results of bulk extracts containing information about the object records retrieved from Oracle B2C Service.
Delete a bulk extract result
Method: delete
Path: /services/rest/connect/v1.4/bulkExtractResults/{id}
Get a bulk extract result
Method: get
Path: /services/rest/connect/v1.4/bulkExtractResults/{id}
Get multiple bulk extract results
Method: get
Path: /services/rest/connect/v1.4/bulkExtractResults
Bulk Extracts
The parameters of the bulk extract job.
Create a bulk extract
Method: post
Path: /services/rest/connect/v1.4/bulkExtracts
Delete a bulk extract
Method: delete
Path: /services/rest/connect/v1.4/bulkExtracts/{id}
Get a bulk extract
Method: get
Path: /services/rest/connect/v1.4/bulkExtracts/{id}
Get multiple bulk extracts
Method: get
Path: /services/rest/connect/v1.4/bulkExtracts
Update a bulk extract
Method: patch
Path: /services/rest/connect/v1.4/bulkExtracts/{id}
Campaigns
The information on email marketing campaigns created in Oracle B2C Service Outreach Cloud Service.
Get a campaign
Method: get
Path: /services/rest/connect/v1.4/campaigns/{id}
Get multiple campaigns
Method: get
Path: /services/rest/connect/v1.4/campaigns
Channel Types
The social channels tracked in contact records when storing social account user names and associating social monitor incidents to contacts.
Get a channel type
Method: get
Path: /services/rest/connect/v1.4/channelTypes/{id}
Get multiple channel types
Method: get
Path: /services/rest/connect/v1.4/channelTypes
Chats
The real-time, two-way dialog between a customer and one or more chat agents.
Get a chat
Method: get
Path: /services/rest/connect/v1.4/chats/{id}
Get multiple chats
Method: get
Path: /services/rest/connect/v1.4/chats
Configurations
The information about the configuration settings within Oracle B2C Service.
Get a configuration
Method: get
Path: /services/rest/connect/v1.4/configurations/{id}
Get multiple configurations
Method: get
Path: /services/rest/connect/v1.4/configurations
Contact Marketing Rosters
The information about the contact lists used in audiences in Oracle B2C Service Outreach Cloud Service.
Create a contact marketing roster
Method: post
Path: /services/rest/connect/v1.4/contactMarketingRosters
Delete a contact marketing roster
Method: delete
Path: /services/rest/connect/v1.4/contactMarketingRosters/{id}
Get a contact marketing roster
Method: get
Path: /services/rest/connect/v1.4/contactMarketingRosters/{id}
Get multiple contact marketing rosters
Method: get
Path: /services/rest/connect/v1.4/contactMarketingRosters
Update a contact marketing roster
Method: patch
Path: /services/rest/connect/v1.4/contactMarketingRosters/{id}
Contacts
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status.
Create a contact
Method: post
Path: /services/rest/connect/v1.4/contacts
Delete a contact
Method: delete
Path: /services/rest/connect/v1.4/contacts/{id}
Get a contact
Method: get
Path: /services/rest/connect/v1.4/contacts/{id}
Get multiple contacts
Method: get
Path: /services/rest/connect/v1.4/contacts
Reset password for a contact
Method: post
Path: /services/rest/connect/v1.4/contacts/{id}/resetPassword
Send a contact through a campaign flow starting at the specified entry point.
Method: post
Path: /services/rest/connect/v1.4/contacts/{id}/executeMarketingFlow
Send a transactional mailing to a contact
Method: post
Path: /services/rest/connect/v1.4/contacts/{id}/sendMailing
Update a contact
Method: patch
Path: /services/rest/connect/v1.4/contacts/{id}
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.
Create a country
Method: post
Path: /services/rest/connect/v1.4/countries
Delete a country
Method: delete
Path: /services/rest/connect/v1.4/countries/{id}
Get a country
Method: get
Path: /services/rest/connect/v1.4/countries/{id}
Get multiple countries
Method: get
Path: /services/rest/connect/v1.4/countries
Update a country
Method: patch
Path: /services/rest/connect/v1.4/countries/{id}
Event Subscriptions
The event-based subscription management object that allows external applications to discover objects that can be subscribed.
Create an event subscription
Method: post
Path: /services/rest/connect/v1.4/eventSubscriptions
Delete an event subscription
Method: delete
Path: /services/rest/connect/v1.4/eventSubscriptions/{id}
Get an event subscription
Method: get
Path: /services/rest/connect/v1.4/eventSubscriptions/{id}
Get multiple event subscriptions
Method: get
Path: /services/rest/connect/v1.4/eventSubscriptions
Update an event subscription
Method: patch
Path: /services/rest/connect/v1.4/eventSubscriptions/{id}
Holidays
The list of holidays in your organization.
Create a holiday
Method: post
Path: /services/rest/connect/v1.4/holidays
Delete a holiday
Method: delete
Path: /services/rest/connect/v1.4/holidays/{id}
Get a holiday
Method: get
Path: /services/rest/connect/v1.4/holidays/{id}
Get multiple holidays
Method: get
Path: /services/rest/connect/v1.4/holidays
Update a holiday
Method: patch
Path: /services/rest/connect/v1.4/holidays/{id}
Incident Response
The activity on an incident, including the original question, agent response and updates, customer updates, records of conversations, and internal notes about the incident.
Create an incident response
Method: post
Path: /services/rest/connect/v1.4/incidentResponse
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. Incidents can also be added by agents when they work with customers by phone, fax, or mail.
Create an incident
Method: post
Path: /services/rest/connect/v1.4/incidents
Delete an incident
Method: delete
Path: /services/rest/connect/v1.4/incidents/{id}
Get an incident
Method: get
Path: /services/rest/connect/v1.4/incidents/{id}
Get multiple incidents
Method: get
Path: /services/rest/connect/v1.4/incidents
Update an incident
Method: patch
Path: /services/rest/connect/v1.4/incidents/{id}
Mailboxes
The mailbox used for collecting email inquiries sent by customers, responses to mailings, and bounced messages.
Get a mailbox
Method: get
Path: /services/rest/connect/v1.4/mailboxes/{id}
Get multiple mailboxes
Method: get
Path: /services/rest/connect/v1.4/mailboxes
Marketing Mailboxes
The mailbox used to send and receive emails and process bounced messages.
Get a marketing mailbox
Method: get
Path: /services/rest/connect/v1.4/marketingMailboxes/{id}
Get multiple marketing mailboxes
Method: get
Path: /services/rest/connect/v1.4/marketingMailboxes
Message Bases
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.
Get a message base
Method: get
Path: /services/rest/connect/v1.4/messageBases/{id}
Get multiple message bases
Method: get
Path: /services/rest/connect/v1.4/messageBases
Named ID Hierarchies
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.
Get a named ID hierarchy
Method: get
Path: /services/rest/connect/v1.4/namedIDHierarchies/{fullyQualifiedPath}/{id}
Get all named ID hierarchy values
Method: get
Path: /services/rest/connect/v1.4/namedIDHierarchies/{fullyQualifiedPath}
Get all resources having named ID hierarchies
Method: get
Path: /services/rest/connect/v1.4/namedIDHierarchies/
Named IDs
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.
Get a named ID
Method: get
Path: /services/rest/connect/v1.4/namedIDs/{fullyQualifiedPath}/{id}
Get all named ID values
Method: get
Path: /services/rest/connect/v1.4/namedIDs/{fullyQualifiedPath}
Get all resources having named IDs
Method: get
Path: /services/rest/connect/v1.4/namedIDs/
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.
Create an opportunity
Method: post
Path: /services/rest/connect/v1.4/opportunities
Delete an opportunity
Method: delete
Path: /services/rest/connect/v1.4/opportunities/{id}
Get an opportunity
Method: get
Path: /services/rest/connect/v1.4/opportunities/{id}
Get multiple opportunities
Method: get
Path: /services/rest/connect/v1.4/opportunities
Update an opportunity
Method: patch
Path: /services/rest/connect/v1.4/opportunities/{id}
Opportunity Statuses
The information about the default and custom opportunity statuses and their corresponding types. The default opportunity statuses are Lead, Reject, Active, Closed, Lost, Inactive, and Dead.
Get an opportunity status
Method: get
Path: /services/rest/connect/v1.4/opportunityStatuses/{id}
Get multiple opportunity statuses
Method: get
Path: /services/rest/connect/v1.4/opportunityStatuses
Organizations
The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base.
Create an organization
Method: post
Path: /services/rest/connect/v1.4/organizations
Delete an organization
Method: delete
Path: /services/rest/connect/v1.4/organizations/{id}
Get an organization
Method: get
Path: /services/rest/connect/v1.4/organizations/{id}
Get multiple organizations
Method: get
Path: /services/rest/connect/v1.4/organizations
Update an organization
Method: patch
Path: /services/rest/connect/v1.4/organizations/{id}
Purchased Products
The information about a purchased product.
Create a purchased product
Method: post
Path: /services/rest/connect/v1.4/purchasedProducts
Delete a purchased product
Method: delete
Path: /services/rest/connect/v1.4/purchasedProducts/{id}
Get a purchased product
Method: get
Path: /services/rest/connect/v1.4/purchasedProducts/{id}
Get multiple purchased products
Method: get
Path: /services/rest/connect/v1.4/purchasedProducts
Update a purchased product
Method: patch
Path: /services/rest/connect/v1.4/purchasedProducts/{id}
Query Results
The results from ROQL query.
Get an array of ROQL results
Method: get
Path: /services/rest/connect/v1.4/queryResults
SSO Token References
The Single Sign On (SSO) token used for authentication.
Get an SSO token reference
Method: get
Path: /services/rest/connect/v1.4/sSOTokenReferences/{id}
Get multiple SSO token references
Method: get
Path: /services/rest/connect/v1.4/sSOTokenReferences
Update an SSO token reference
Method: patch
Path: /services/rest/connect/v1.4/sSOTokenReferences/{id}
Sales Products
The items or services sold by an organization. Sales products are available to customers through quotes and promotions.
Create a sales product
Method: post
Path: /services/rest/connect/v1.4/salesProducts
Delete a sales product
Method: delete
Path: /services/rest/connect/v1.4/salesProducts/{id}
Get a sales product
Method: get
Path: /services/rest/connect/v1.4/salesProducts/{id}
Get multiple sales products
Method: get
Path: /services/rest/connect/v1.4/salesProducts
Update a sales product
Method: patch
Path: /services/rest/connect/v1.4/salesProducts/{id}
Sales Territories
The specific geographical sales region. Sales representatives can be assigned specific territories for opportunity assignment.
Create a sales territory
Method: post
Path: /services/rest/connect/v1.4/salesTerritories
Delete a sales territory
Method: delete
Path: /services/rest/connect/v1.4/salesTerritories/{id}
Get a sales territory
Method: get
Path: /services/rest/connect/v1.4/salesTerritories/{id}
Get multiple sales territories
Method: get
Path: /services/rest/connect/v1.4/salesTerritories
Update a sales territory
Method: patch
Path: /services/rest/connect/v1.4/salesTerritories/{id}
Service Categories
The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.
Create a service category
Method: post
Path: /services/rest/connect/v1.4/serviceCategories
Delete a service category
Method: delete
Path: /services/rest/connect/v1.4/serviceCategories/{id}
Get a service category
Method: get
Path: /services/rest/connect/v1.4/serviceCategories/{id}
Get multiple service categories
Method: get
Path: /services/rest/connect/v1.4/serviceCategories
Update a service category
Method: patch
Path: /services/rest/connect/v1.4/serviceCategories/{id}
Service Dispositions
The hierarchical service disposition that provides an option for classifying and recording how incidents are ultimately resolved.
Create a service disposition
Method: post
Path: /services/rest/connect/v1.4/serviceDispositions
Delete a service disposition
Method: delete
Path: /services/rest/connect/v1.4/serviceDispositions/{id}
Get a service disposition
Method: get
Path: /services/rest/connect/v1.4/serviceDispositions/{id}
Get multiple service dispositions
Method: get
Path: /services/rest/connect/v1.4/serviceDispositions
Update a service disposition
Method: patch
Path: /services/rest/connect/v1.4/serviceDispositions/{id}
Service Mailboxes
The email box dedicated to collect email inquiries sent by customers.
Get a service mailbox
Method: get
Path: /services/rest/connect/v1.4/serviceMailboxes/{id}
Get multiple service mailboxes
Method: get
Path: /services/rest/connect/v1.4/serviceMailboxes
Service Products
The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base.
Create a service product
Method: post
Path: /services/rest/connect/v1.4/serviceProducts
Delete a service product
Method: delete
Path: /services/rest/connect/v1.4/serviceProducts/{id}
Get a service product
Method: get
Path: /services/rest/connect/v1.4/serviceProducts/{id}
Get multiple service products
Method: get
Path: /services/rest/connect/v1.4/serviceProducts
Update a service product
Method: patch
Path: /services/rest/connect/v1.4/serviceProducts/{id}
Site Interfaces
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.
Get a site interface
Method: get
Path: /services/rest/connect/v1.4/siteInterfaces/{id}
Get multiple site interfaces
Method: get
Path: /services/rest/connect/v1.4/siteInterfaces
Standard Contents
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.
Create a standard content
Method: post
Path: /services/rest/connect/v1.4/standardContents
Delete a standard content
Method: delete
Path: /services/rest/connect/v1.4/standardContents/{id}
Get a standard content
Method: get
Path: /services/rest/connect/v1.4/standardContents/{id}
Get multiple standard contents
Method: get
Path: /services/rest/connect/v1.4/standardContents
Update a standard content
Method: patch
Path: /services/rest/connect/v1.4/standardContents/{id}
Tasks
The information about an action or an activity scheduled to be completed within a specified time. Tasks can be standalone or they can be associated with answers, campaigns, contacts, documents, incidents, mailings, opportunities, organizations, surveys, and stages in a sales strategy.
Create a task
Method: post
Path: /services/rest/connect/v1.4/tasks
Delete a task
Method: delete
Path: /services/rest/connect/v1.4/tasks/{id}
Get a task
Method: get
Path: /services/rest/connect/v1.4/tasks/{id}
Get multiple tasks
Method: get
Path: /services/rest/connect/v1.4/tasks
Update a task
Method: patch
Path: /services/rest/connect/v1.4/tasks/{id}
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. When the variable is inserted in the body of the answer or in a chat response, it is replaced with the value specified in the variable.
Create a variable
Method: post
Path: /services/rest/connect/v1.4/variables
Delete a variable
Method: delete
Path: /services/rest/connect/v1.4/variables/{id}
Get a variable
Method: get
Path: /services/rest/connect/v1.4/variables/{id}
Get multiple variables
Method: get
Path: /services/rest/connect/v1.4/variables
Update a variable
Method: patch
Path: /services/rest/connect/v1.4/variables/{id}