rest api for oracle sales cloud release 10

8/20/2019 REST API for Oracle Sales Cloud Release 10

http://slidepdf.com/reader/full/rest-api-for-oracle-sales-cloud-release-10 1/30

Sort by

REST API for Oracle Sales Cloud Release 10

All REST Endpoints

Accounts

The account resource is used to view, create, and update accounts.

Task Method Path

Create a note (op-crmCommonApi-resources-

11.1.10-accounts-{PartyNumber}-child-

Note-post.html)

POST /crmCommonApi/resources/11.1.10/accounts

/{PartyNumber}/child/Note

Create a primary address (op-crmCommonApi-

resources-11.1.10-accounts-{PartyNumber}-

child-PrimaryAddress-post.html)


/{PartyNumber}/child/PrimaryAddress

Create a relationship (op-crmCommonApi-


child-Relationship-post.html)


/{PartyNumber}/child/Relationship

Create a sales team member

(op-crmCommonApi-resources-11.1.10-

accounts-{PartyNumber}-child-

SalesTeamMember-post.html)


/{PartyNumber}/child/SalesTeamMember

Create an account (op-crmCommonApi-

resources-11.1.10-accounts-post.html)


Create an address (op-crmCommonApi-


child-Address-post.html)


/{PartyNumber}/child/Address

Create an address purpose


accounts-{PartyNumber}-child-Address-

{AddressNumber}-child-AddressPurpose-

post.html)


/{PartyNumber}/child/Address/{AddressNumber}

/child/AddressPurpose

Delete a note (op-crmCommonApi-resources-


Note-{NoteId}-delete.html)

DELETE /crmCommonApi/resources/11.1.10/accounts

/{PartyNumber}/child/Note/{NoteId}

Path Method Group by APITask

T API for Oracle Sales Cloud Release 10 http://carson.oraclecorp.com:5000/client/fusionapps/sales-r10/html/res...

30 26-Nov-15 1:36 AM



Task Method Path

Delete a primary address (op-crmCommonApi-


child-PrimaryAddress-{AddressNumber}-

delete.html)



/{AddressNumber}

Delete a sales team member



SalesTeamMember-{SalesTeamMemberId}-

delete.html)



/{SalesTeamMemberId}

Delete an account (op-crmCommonApi-


delete.html)


/{PartyNumber}

Delete an address (op-crmCommonApi-


child-Address-{AddressNumber}-delete.html)



Delete an address purpose




{AddressPurposeId}-delete.html)



/child/AddressPurpose/{AddressPurposeId}

Get a note (op-crmCommonApi-resources-


Note-{NoteId}-get.html)

GET /crmCommonApi/resources/11.1.10/accounts


Get a primary address (op-crmCommonApi-



get.html)



/{AddressNumber}

Get a sales team member (op-crmCommonApi-


child-SalesTeamMember-

{SalesTeamMemberId}-get.html)




Get all accounts (op-crmCommonApi-

resources-11.1.10-accounts-get.html)


Get all address purposes (op-crmCommonApi-


child-Address-{AddressNumber}-child-

AddressPurpose-get.html)




Get all addresses (op-crmCommonApi-


child-Address-get.html)



Get all notes (op-crmCommonApi-resources-


Note-get.html)




30 26-Nov-15 1:36 AM



Task Method Path

Get all primary addresses (op-crmCommonApi-


child-PrimaryAddress-get.html)



Get all relationships (op-crmCommonApi-


child-Relationship-get.html)



Get all sales team members



SalesTeamMember-get.html)



Get an account (op-crmCommonApi-resources-

11.1.10-accounts-{PartyNumber}-get.html)


/{PartyNumber}

Get an address (op-crmCommonApi-resources-

11.1.10-accounts-{PartyNumber}-child-Address-

{AddressNumber}-get.html)



Get an address purpose (op-crmCommonApi-



AddressPurpose-{AddressPurposeId}-get.html)




Update a note (op-crmCommonApi-resources-


Note-{NoteId}-patch.html)

PATCH /crmCommonApi/resources/11.1.10/accounts


Update a primary address (op-crmCommonApi-



patch.html)



/{AddressNumber}

Update a sales team member




patch.html)




Update an account (op-crmCommonApi-


patch.html)


/{PartyNumber}

Update an address (op-crmCommonApi-


child-Address-{AddressNumber}-patch.html)



Update an address purpose




{AddressPurposeId}-patch.html)





30 26-Nov-15 1:36 AM



Activities

The activity resource is used to view, create, and update task and appointment information.

Task Method Path

Create an activity (op-salesApi-resources-

11.1.10-activities-post.html)POST /salesApi/resources/11.1.10/activities

Create an activity assignee (op-salesApi-

resources-11.1.10-activities-{ActivityNumber}-

child-ActivityAssignee-post.html)

POST /salesApi/resources/11.1.10/activities

/{ActivityNumber}/child/ActivityAssignee

Create an activity contact (op-salesApi-


child-ActivityContact-post.html)


/{ActivityNumber}/child/ActivityContact

Create an activity note (op-salesApi-resources-

11.1.10-activities-{ActivityNumber}-child-

Note-post.html)


/{ActivityNumber}/child/Note

Create an activity objective (op-salesApi-


child-ActivityObjectives-post.html)


/{ActivityNumber}/child/ActivityObjectives

Delete an activity (op-salesApi-resources-

11.1.10-activities-{ActivityNumber}-delete.html)

DELETE /salesApi/resources/11.1.10/activities

/{ActivityNumber}

Delete an activity assignee (op-salesApi-


child-ActivityAssignee-{ActivityAssigneeId}-delete.html)



/{ActivityAssigneeId}

Delete an activity contact (op-salesApi-


child-ActivityContact-{ActivityContactId}-

delete.html)



/{ActivityContactId}

Delete an activity note (op-salesApi-resources-




/{ActivityNumber}/child/Note/{NoteId}

Delete an activity objective (op-salesApi-


child-ActivityObjectives-{ActivityObjectivesId}-

delete.html)



/{ActivityObjectivesId}

Get all activities (op-salesApi-resources-

11.1.10-activities-get.html)

GET /salesApi/resources/11.1.10/activities

Get all activity assignees (op-salesApi-


child-ActivityAssignee-get.html)



Get all activity contacts (op-salesApi-


child-ActivityContact-get.html)




30 26-Nov-15 1:36 AM



Task Method Path

Get all activity notes (op-salesApi-resources-


Note-get.html)


/{ActivityNumber}/child/Note

Get all activity objectives (op-salesApi-


child-ActivityObjectives-get.html)



Get an activity (op-salesApi-resources-11.1.10-

activities-{ActivityNumber}-get.html)


/{ActivityNumber}

Get an activity assignee (op-salesApi-


child-ActivityAssignee-{ActivityAssigneeId}-

get.html)




Get an activity contact (op-salesApi-resources-


ActivityContact-{ActivityContactId}-get.html)




Get an activity note (op-salesApi-resources-





Get an activity objective (op-salesApi-



get.html)




Update an activity (op-salesApi-resources-

11.1.10-activities-{ActivityNumber}-patch.html)

PATCH /salesApi/resources/11.1.10/activities

/{ActivityNumber}

Update an activity assignee (op-salesApi-


child-ActivityAssignee-{ActivityAssigneeId}-

patch.html)




Update an activity contact (op-salesApi-


child-ActivityContact-{ActivityContactId}-

patch.html)




Update an activity note (op-salesApi-resources-





Update an activity objective (op-salesApi-



patch.html)




Competitors


30 26-Nov-15 1:36 AM



The competitor resource is used to view competitor details. A competitor is an organization that competes with the

deploying organization in the market for sales. The object stores competitor attributes such as SWOT analysis, the

products competitors sell, how they map to the deploying organization's products, win/loss reasons, and competitive

literature.

Task Method Path

Get a competitor (op-salesApi-resources-

11.1.10-competitors-{PartyId}-get.html) GET /salesApi/resources/11.1.10/competitors

/{PartyId}

Get all competitors (op-salesApi-resources-

11.1.10-competitors-get.html)

GET /salesApi/resources/11.1.10/competitors

Contacts

The contact resource is used to view, create, or modify a contact. A contact is a person in a defined relationship with

either an account or contact.

Task Method Path

Create a contact (op-crmCommonApi-

resources-11.1.10-contacts-post.html)

POST /crmCommonApi/resources/11.1.10/contacts


11.1.10-contacts-{PartyNumber}-child-

Note-post.html)




resources-11.1.10-contacts-{PartyNumber}-











contacts-{PartyNumber}-child-




Create an address (op-crmCommonApi-resources-11.1.10-contacts-{PartyNumber}-

child-Address-post.html)

POST /crmCommonApi/resources/11.1.10/contacts/{PartyNumber}/child/Address



contacts-{PartyNumber}-child-Address-


post.html)




Delete a contact (op-crmCommonApi-

resources-11.1.10-contacts-{PartyNumber}-delete.html)

DELETE /crmCommonApi/resources/11.1.10/contacts

/{PartyNumber}


30 26-Nov-15 1:36 AM



Task Method Path









delete.html)



/{AddressNumber}





delete.html)

















Get a contact (op-crmCommonApi-resources-

11.1.10-contacts-{PartyNumber}-get.html)GET /crmCommonApi/resources/11.1.10/contacts

/{PartyNumber}




GET /crmCommonApi/resources/11.1.10/contacts





get.html)



/{AddressNumber}













Get all contacts (op-crmCommonApi-resources-

11.1.10-contacts-get.html)




Note-get.html)




30 26-Nov-15 1:36 AM



Task Method Path






Get all purposes of an address




get.html)
















11.1.10-contacts-{PartyNumber}-child-Address-

{AddressNumber}-get.html)










Update a contact (op-crmCommonApi-


patch.html)

PATCH /crmCommonApi/resources/11.1.10/contacts

/{PartyNumber}









patch.html)



/{AddressNumber}





patch.html)










30 26-Nov-15 1:36 AM



Task Method Path









Deal Registrations

The deal registration resource is used to view, create, or modify a deal registration. Deal registration is a process by

which a partner user registers a business opportunity with the brand owner in order to become eligible for benefits,

such as exclusive rights to the opportunity, additional rebates, presales support, and so on.

Task Method Path

Create a deal product (op-salesApi-resources-

11.1.10-deals-{DealId}-child-DealProduct-

post.html)

POST /salesApi/resources/11.1.10/deals/{DealId}/child

/DealProduct

Create a deal registration (op-salesApi-

resources-11.1.10-deals-post.html)POST /salesApi/resources/11.1.10/deals

Create a deal team member (op-salesApi-

resources-11.1.10-deals-{DealId}-child-

DealResources-post.html)


/DealResources

Create a product (op-salesApi-resources-

11.1.10-deals-{DealId}-child-products-post.html)


/products

Create a product group (op-salesApi-resources-

11.1.10-deals-{DealId}-child-productGroups-

post.html)


/productGroups

Delete a deal product (op-salesApi-resources-


{DealProdId}-delete.html)

DELETE /salesApi/resources/11.1.10/deals/{DealId}/child

/DealProduct/{DealProdId}

Delete a deal team member (op-salesApi-


DealResources-{DealResourceId}-delete.html)


/DealResources/{DealResourceId}

Delete a product (op-salesApi-resources-

11.1.10-deals-{DealId}-child-products-

{productsId}-delete.html)


/products/{productsId}

Delete a product group (op-salesApi-resources-


{ProdGroupId}-delete.html)


/productGroups/{ProdGroupId}

Get a deal product (op-salesApi-resources-

11.1.10-deals-{DealId}-child-DealProduct-{DealProdId}-get.html)

GET /salesApi/resources/11.1.10/deals/{DealId}/child



30 26-Nov-15 1:36 AM



Task Method Path

Get a deal registration (op-salesApi-resources-

11.1.10-deals-{DealId}-get.html)

GET /salesApi/resources/11.1.10/deals/{DealId}

Get a deal team member (op-salesApi-


DealResources-{DealResourceId}-get.html)



Get a product (op-salesApi-resources-11.1.10-

deals-{DealId}-child-products-{productsId}-

get.html)



Get a product group (op-salesApi-resources-


{ProdGroupId}-get.html)



Get all deal products (op-salesApi-resources-


get.html)


/DealProduct

Get all deal registrations (op-salesApi-

resources-11.1.10-deals-get.html)

GET /salesApi/resources/11.1.10/deals

Get all deal team members (op-salesApi-


DealResources-get.html)


/DealResources

Get all opportunities (op-salesApi-resources-

11.1.10-deals-{DealId}-child-

MatchedOpportunity-get.html)


/MatchedOpportunity

Get all product groups (op-salesApi-resources-


get.html)


/productGroups

Get all products (op-salesApi-resources-

11.1.10-deals-{DealId}-child-products-get.html)


/products

Update a deal product (op-salesApi-resources-


{DealProdId}-patch.html)

PATCH /salesApi/resources/11.1.10/deals/{DealId}/child


Update a deal registration (op-salesApi-

resources-11.1.10-deals-{DealId}-patch.html)

PATCH /salesApi/resources/11.1.10/deals/{DealId}

Update a deal team member (op-salesApi-


DealResources-{DealResourceId}-patch.html)



Update a product (op-salesApi-resources-

11.1.10-deals-{DealId}-child-products-

{productsId}-patch.html)




f 30 26-Nov-15 1:36 AM



Task Method Path

Update a product group (op-salesApi-


productGroups-{ProdGroupId}-patch.html)



Forecasts

The forecasts resource is used to view or modify a forecast territory.

Task Method Path

Get a forecast item (op-salesApi-resources-

11.1.10-territoryForecasts-

{ForecastParticipantId}-child-

ForecastItemDetail-{ForecastItemId}-get.html)

GET /salesApi/resources/11.1.10/territoryForecasts

/{ForecastParticipantId}/child

/ForecastItemDetail/{ForecastItemId}

Get a forecast product (op-salesApi-resources-


{ForecastParticipantId}-child-forecastProducts-

{FcstProductId}-get.html)


/{ForecastParticipantId}/child/forecastProducts

/{FcstProductId}

Get a territory forecast (op-salesApi-resources-


{ForecastParticipantId}-get.html)


/{ForecastParticipantId}

Get all forecast items (op-salesApi-resources-



ForecastItemDetail-get.html)



/ForecastItemDetail

Get all forecast products (op-salesApi-

resources-11.1.10-territoryForecasts-


get.html)



Get all territory forecasts (op-salesApi-

resources-11.1.10-territoryForecasts-get.html)GET /salesApi/resources/11.1.10/territoryForecasts

Update a forecast item (op-salesApi-resources-



ForecastItemDetail-{ForecastItemId}-

patch.html)

PATCH /salesApi/resources/11.1.10/territoryForecasts


/ForecastItemDetail/{ForecastItemId}

Update a forecast product (op-salesApi-



{FcstProductId}-patch.html)



/{FcstProductId}

Update a terri tory forecast (op-salesApi-


{ForecastParticipantId}-patch.html)


/{ForecastParticipantId}


f 30 26-Nov-15 1:36 AM



Households

The household resource is used to view, create, and update a household. Household is a group that has a

relationship with either an account or a contact. A household object includes attributes that are used to store values

while creating or updating a household. You can use the child resources such as addresses, relationships,

addressPurposes, salesTeamMembers, and primary addresses to manage child entities of the household object.

Task Method Path

Create a household (op-crmCommonApi-

resources-11.1.10-households-post.html)POST /crmCommonApi/resources/11.1.10/households


11.1.10-households-{PartyNumber}-child-

Note-post.html)

POST /crmCommonApi/resources/11.1.10/households



resources-11.1.10-households-{PartyNumber}-











households-{PartyNumber}-child-




Create an address (op-crmCommonApi-

resources-11.1.10-households-{PartyNumber}-child-Address-post.html)





households-{PartyNumber}-child-Address-


post.html)




Delete a household (op-crmCommonApi-


delete.html)

DELETE /crmCommonApi/resources/11.1.10/households

/{PartyNumber}









delete.html)



/{AddressNumber}


f 30 26-Nov-15 1:36 AM



Task Method Path





delete.html)

















Get a household (op-crmCommonApi-


get.html)

GET /crmCommonApi/resources/11.1.10/households

/{PartyNumber}









get.html)



/{AddressNumber}








Get all address purposes (op-crmCommonApi-



AddressPurpose-get.html)









Get all households (op-crmCommonApi-

resources-11.1.10-households-get.html)




Note-get.html)









f 30 26-Nov-15 1:36 AM



Task Method Path














Address-{AddressNumber}-get.html)










Update a household (op-crmCommonApi-


patch.html)

PATCH /crmCommonApi/resources/11.1.10/households

/{PartyNumber}









patch.html)



/{AddressNumber}





patch.html)

















Opportunities


f 30 26-Nov-15 1:36 AM



The opportunities resource let view, create, and update an opportunity. An opportunity supports the full sales process,

from leads, to opportunities, to sales, to follow-up analytics. Within opportunities, sales organizations can capture a

wide variety of information related to an opportunity, such as account and the products to be sold.

Task Method Path

Create a note (op-salesApi-resources-11.1.10-

opportunities-{OptyNumber}-child-

Note-post.html)

POST /salesApi/resources/11.1.10/opportunities

/{OptyNumber}/child/Note

Create a territory for an opportunity revenue

(op-salesApi-resources-11.1.10-opportunities-

{OptyNumber}-child-ChildRevenue-{RevnId}-

child-RevenueTerritory-post.html)


/{OptyNumber}/child/ChildRevenue/{RevnId}

/child/RevenueTerritory

Create an opportunity (op-salesApi-resources-

11.1.10-opportunities-post.html)


Create an opportunity competitor (op-salesApi-

resources-11.1.10-opportunities-{OptyNumber}-

child-OpportunityCompetitor2-post.html)


/{OptyNumber}/child/OpportunityCompetitor2

Create an opportunity contact (op-salesApi-


child-OpportunityContact-post.html)


/{OptyNumber}/child/OpportunityContact

Create an opportunity lead (op-salesApi-


child-OpportunityLead-post.html)


/{OptyNumber}/child/OpportunityLead

Create an opportunity revenue (op-salesApi-


child-ChildRevenue-post.html)


/{OptyNumber}/child/ChildRevenue

Create an opportunity revenue partner


{OptyNumber}-child-RevenuePartnerPrimary-

post.html)


/{OptyNumber}/child/RevenuePartnerPrimary

Create an opportunity source (op-salesApi-


child-OpportunitySource1-post.html)


/{OptyNumber}/child/OpportunitySource1

Create an opportunity team member


{OptyNumber}-child-OpportunityResource-

post.html)


/{OptyNumber}/child/OpportunityResource

Delete a note (op-salesApi-resources-11.1.10-

opportunities-{OptyNumber}-child-Note-{NoteId}-

delete.html)

DELETE /salesApi/resources/11.1.10/opportunities

/{OptyNumber}/child/Note/{NoteId}

Delete an opportunity (op-salesApi-resources-11.1.10-opportunities-{OptyNumber}-

delete.html)

DELETE /salesApi/resources/11.1.10/opportunities/{OptyNumber}


f 30 26-Nov-15 1:36 AM



Task Method Path

Delete an opportunity competitor (op-salesApi-


child-OpportunityCompetitor2-

{OptyCompetitorId}-delete.html)



/{OptyCompetitorId}

Delete an opportunity contact (op-salesApi-


child-OpportunityContact-{OptyConId}-

delete.html)



/{OptyConId}

Delete an opportunity lead (op-salesApi-


child-OpportunityLead-{OpportunityLeadId}-

delete.html)



/{OpportunityLeadId}

Delete an opportunity revenue (op-salesApi-


child-ChildRevenue-{RevnId}-delete.html)



Delete an opportunity revenue partner



{RevnPartOrgPartyId}-delete.html)



/{RevnPartOrgPartyId}

Delete an opportunity revenue territory



child-RevenueTerritory-{RevenueTerritoryId}-

delete.html)



/child/RevenueTerritory/{RevenueTerritoryId}

Delete an opportunity source (op-salesApi-


child-OpportunitySource1-{OptySrcId}-

delete.html)



/{OptySrcId}

Delete an opportunity team member



{OptyResourceId}-delete.html)



/{OptyResourceId}

Get a note (op-salesApi-resources-11.1.10-


get.html)

GET /salesApi/resources/11.1.10/opportunities



opportunities-{OptyNumber}-child-

ChildRevenue-{RevnId}-child-products-

{productsId}-get.html)



/child/products/{productsId}


11.1.10-opportunities-{OptyNumber}-child-

ChildRevenue-{RevnId}-child-productGroups-




/child/productGroups/{ProdGroupId}


f 30 26-Nov-15 1:36 AM



Task Method Path

Get all notes (op-salesApi-resources-11.1.10-

opportunities-{OptyNumber}-child-Note-get.html)


/{OptyNumber}/child/Note


11.1.10-opportunities-get.html)


Get all opportunity competitors (op-salesApi-


child-OpportunityCompetitor2-get.html)



Get all opportunity contacts (op-salesApi-


child-OpportunityContact-get.html)



Get all opportunity leads (op-salesApi-


child-OpportunityLead-get.html)



Get all opportunity revenue partners



get.html)



Get all opportunity revenue territories



child-RevenueTerritory-get.html)



/child/RevenueTerritory

Get all opportunity revenues (op-salesApi-


child-ChildRevenue-get.html)


/{OptyNumber}/child/ChildRevenue

Get all opportunity sources (op-salesApi-


child-OpportunitySource1-get.html)



Get all opportunity team members (op-salesApi-


child-OpportunityResource-get.html)





ChildRevenue-{RevnId}-child-productGroups-

get.html)



/child/productGroups



ChildRevenue-{RevnId}-child-products-get.html)



/child/products

Get an opportunity (op-salesApi-resources-

11.1.10-opportunities-{OptyNumber}-get.html)


/{OptyNumber}


f 30 26-Nov-15 1:36 AM



Task Method Path

Get an opportunity competitor (op-salesApi-



{OptyCompetitorId}-get.html)



/{OptyCompetitorId}

Get an opportunity contact (op-salesApi-


child-OpportunityContact-{OptyConId}-get.html)



/{OptyConId}

Get an opportunity lead (op-salesApi-



get.html)




Get an opportunity revenue (op-salesApi-


child-ChildRevenue-{RevnId}-get.html)



Get an opportunity revenue partner



{RevnPartOrgPartyId}-get.html)




Get an opportunity revenue territory




get.html)




Get an opportunity source (op-salesApi-


child-OpportunitySource1-{OptySrcId}-get.html)



/{OptySrcId}

Get an opportunity team member (op-salesApi-


child-OpportunityResource-{OptyResourceId}-

get.html)



/{OptyResourceId}

Update a note (op-salesApi-resources-11.1.10-


patch.html)

PATCH /salesApi/resources/11.1.10/opportunities


Update an opportunity (op-salesApi-resources-

11.1.10-opportunities-{OptyNumber}-patch.html)


/{OptyNumber}

Update an opportunity competitor (op-salesApi-



{OptyCompetitorId}-patch.html)



/{OptyCompetitorId}

Update an opportunity contact (op-salesApi-


child-OpportunityContact-{OptyConId}-

patch.html)



/{OptyConId}


f 30 26-Nov-15 1:36 AM



Task Method Path

Update an opportunity lead (op-salesApi-



patch.html)




Update an opportunity revenue (op-salesApi-


child-ChildRevenue-{RevnId}-patch.html)



Update an opportunity revenue partner



{RevnPartOrgPartyId}-patch.html)




Update an opportunity revenue territory




patch.html)




Update an opportunity source (op-salesApi-


child-OpportunitySource1-{OptySrcId}-

patch.html)



/{OptySrcId}

Update an opportunity team member



{OptyResourceId}-patch.html)



/{OptyResourceId}

Partners

A partner resource is used to view, create, or modify a channel partner. A channel partner company works with your

organization to sell products and services. In Oracle Sales Cloud, a partner resource is different from an account

resource.

Task Method Path

Create a certification for a partner

(op-salesApi-resources-11.1.10-partners-

{CompanyNumber}-child-certifications-post.html)

POST /salesApi/resources/11.1.10/partners

/{CompanyNumber}/child/certifications

Create a geography for a partner (op-salesApi-

resources-11.1.10-partners-{CompanyNumber}-

child-geographies-post.html)


/{CompanyNumber}/child/geographies

Create a partner (op-salesApi-resources-

11.1.10-partners-post.html)


Create a partner account team member for a

partner (op-salesApi-resources-11.1.10-

partners-{CompanyNumber}-child-

accountTeamMembers-post.html)


/{CompanyNumber}/child/accountTeamMembers


f 30 26-Nov-15 1:36 AM



Task Method Path

Create a partner type (op-salesApi-resources-

11.1.10-partners-{CompanyNumber}-child-

types-post.html)


/{CompanyNumber}/child/types

Create a product specialty for a partner


{CompanyNumber}-child-productSpecialities-

post.html)


/{CompanyNumber}/child/productSpecialities

Create an expertise for a partner (op-salesApi-


child-expertises-post.html)


/{CompanyNumber}/child/expertises

Create an industry for a partner (op-salesApi-


child-industries-post.html)


/{CompanyNumber}/child/industries

Delete a certification for a partner (op-salesApi-


child-certifications-{PartnerMultivalLovId}-

delete.html)

DELETE /salesApi/resources/11.1.10/partners


/{PartnerMultivalLovId}

Delete a geography for a partner (op-salesApi-


child-geographies-{geographiesId}-delete.html)



/{geographiesId}

Delete a partner account team member for a



accountTeamMembers-

{PartnerAccountResourceId}-delete.html)



/{PartnerAccountResourceId}

Delete a partner type (op-salesApi-resources-


types-{typesId}-delete.html)


/{CompanyNumber}/child/types/{typesId}

Delete a product specialty for a partner



{productSpecialitiesId}-delete.html)



/{productSpecialitiesId}

Delete an expertise for a partner (op-salesApi-


child-expertises-{PartnerMultivalLovId}-

delete.html)




Delete an industry for a partner (op-salesApi-


child-industries-{industriesId}-delete.html)



/{industriesId}

Get a certification for a partner (op-salesApi-


child-certifications-{PartnerMultivalLovId}-

get.html)

GET /salesApi/resources/11.1.10/partners




f 30 26-Nov-15 1:36 AM



Task Method Path

Get a partner (op-salesApi-resources-11.1.10-

partners-{CompanyNumber}-get.html)


/{CompanyNumber}

Get a partner account team member for a



accountTeamMembers-

{PartnerAccountResourceId}-get.html)




Get a partner type (op-salesApi-resources-


types-{typesId}-get.html)



Get a product specialty for a partner



{productSpecialitiesId}-get.html)




Get all certifications for a partner (op-salesApi-


child-certifications-get.html)



Get all expertises for a partner (op-salesApi-


child-expertises-get.html)



Get all geographies for a partner (op-salesApi-


child-geographies-get.html)



Get all industries for a partner (op-salesApi-


child-industries-get.html)



Get all partner account team members for a



accountTeamMembers-get.html)



Get all partner types (op-salesApi-resources-


types-get.html)


/{CompanyNumber}/child/types

Get all partners (op-salesApi-resources-

11.1.10-partners-get.html)GET /salesApi/resources/11.1.10/partners

Get all product specialties for a partner



get.html)



Get an expertise for a partner (op-salesApi-


child-expertises-{PartnerMultivalLovId}-get.html)





f 30 26-Nov-15 1:36 AM



Task Method Path

Get an industry for a partner (op-salesApi-


child-industries-{industriesId}-get.html)



/{industriesId}

Get geography for a partner (op-salesApi-


child-geographies-{geographiesId}-get.html)



/{geographiesId}

Update a certification for a partner


{CompanyNumber}-child-certifications-

{PartnerMultivalLovId}-patch.html)

PATCH /salesApi/resources/11.1.10/partners



Update a partner (op-salesApi-resources-

11.1.10-partners-{CompanyNumber}-patch.html)


/{CompanyNumber}

Update a partner account team member for a



accountTeamMembers-

{PartnerAccountResourceId}-patch.html)




Update a partner type (op-salesApi-resources-


types-{typesId}-patch.html)



Update a product specialty for a partner



{productSpecialitiesId}-patch.html)




Update an expertise for a partner (op-salesApi-


child-expertises-{PartnerMultivalLovId}-

patch.html)




Update an industry for a partner (op-salesApi-


child-industries-{industriesId}-patch.html)



/{industriesId}

Update geography served for a partner


{CompanyNumber}-child-geographies-

{geographiesId}-patch.html)



/{geographiesId}

Payment Batches


f 30 26-Nov-15 1:36 AM



The payment batch resource is used to retrieve payment batch summary information. It is also used to retrieve the

details of paysheets and payment transactions within the context of a payment batch. A payment batch generates

paysheets for each incentive compensation participant who meets the payment batch selection criteria. A paysheet

contains and summarizes the payment transaction amounts. Payment transactions include the payable commission

and bonus incentives, payment plan draw and recovery amounts, and manual adjustments to the payable amount.

Task Method Path

Create a manual adjustment for a payment

batch (op-incentiveCompensationApi-

resources-11.1.10-paymentBatches-{PayrunId}-

child-paymentTransactions-post.html)

POST /incentiveCompensationApi/resources/11.1.10

/paymentBatches/{PayrunId}/child

/paymentTransactions

Create a manual adjustment for a payment



child-paysheets-{PaysheetId}-child-

paymentTransactions-post.html)


/paymentBatches/{PayrunId}/child/paysheets

/{PaysheetId}/child/paymentTransactions

Get a payment batch

(op-incentiveCompensationApi-resources-

11.1.10-paymentBatches-{PayrunId}-get.html)

GET /incentiveCompensationApi/resources/11.1.10

/paymentBatches/{PayrunId}

Get a payment transaction for a payment batch


11.1.10-paymentBatches-{PayrunId}-child-

paymentTransactions-{ParticipantPayId}-

get.html)



/paymentTransactions/{ParticipantPayId}

Get a payment transaction for a payment batch



paysheets-{PaysheetId}-child-


get.html)




/{ParticipantPayId}

Get a paysheet for a payment batch



paysheets-{PaysheetId}-get.html)



/{PaysheetId}

Get all payment batches


11.1.10-paymentBatches-get.html)


/paymentBatches

Get all payment transactions for a payment



child-paymentTransactions-get.html)




Get all payment transactions for a payment



child-paysheets-{PaysheetId}-child-

paymentTransactions-get.html)





f 30 26-Nov-15 1:36 AM



The paysheet resource is used to view the paysheet information. A payment batch generates paysheets for each

incentive compensation participant who meets the payment batch criteria. The paysheet contains the participant

payment transactions for the pay period. It provides summarized amounts, such as total calculated earnings, total

recoverable payment plan adjustments, and total payment amount.

Task Method Path

Create a manual adjustment for a paysheet


11.1.10-paysheets-{PaysheetId}-child-

paymentTransactions-post.html)


/paysheets/{PaysheetId}/child


Get a payment transaction for a paysheet




get.html)




Get a paysheet (op-incentiveCompensationApi-

resources-11.1.10-paysheets-{PaysheetId}-

get.html)


/paysheets/{PaysheetId}

Get all payment transactions for a paysheet



paymentTransactions-get.html)




Get all paysheets


11.1.10-paysheets-get.html)


/paysheets

Update a payment transaction hold for a

paysheet (op-incentiveCompensationApi-

resources-11.1.10-paysheets-{PaysheetId}-

child-paymentTransactions-{ParticipantPayId}-

patch.html)

PATCH /incentiveCompensationApi/resources/11.1.10



Program Enrollments

The program enrollments resource is used to view, create, or update partner enrollments in a program.

Task Method Path

Create a note for an enrollment (op-salesApi-

resources-11.1.10-programEnrollments-

{EnrollmentNumber}-child-Notes-post.html)

POST /salesApi/resources/11.1.10

/programEnrollments/{EnrollmentNumber}/child

/Notes

Create an enrollment (op-salesApi-resources-

11.1.10-programEnrollments-post.html)

POST /salesApi/resources/11.1.10

/programEnrollments

Delete a note for an enrollment (op-salesApi-


{EnrollmentNumber}-child-Notes-{NoteId}-

delete.html)

DELETE /salesApi/resources/11.1.10


/Notes/{NoteId}


f 30 26-Nov-15 1:36 AM



Task Method Path

Get a note for an enrollment (op-salesApi-



get.html)

GET /salesApi/resources/11.1.10


/Notes/{NoteId}

Get a partner program for the enrollment

(op-salesApi-resources-11.1.10-

programEnrollments-{EnrollmentNumber}-child-

PartnerProgram-{PartnerProgramId}-get.html)



/PartnerProgram/{PartnerProgramId}

Get all enrollments (op-salesApi-resources-

11.1.10-programEnrollments-get.html)


/programEnrollments

Get all notes for an enrollment (op-salesApi-


{EnrollmentNumber}-child-Notes-get.html)



/Notes

Get all the partner programs for the enrollment

(op-salesApi-resources-11.1.10-

programEnrollments-{EnrollmentNumber}-child-

PartnerProgram-get.html)



/PartnerProgram

Get an enrollment (op-salesApi-resources-

11.1.10-programEnrollments-

{EnrollmentNumber}-get.html)


/programEnrollments/{EnrollmentNumber}

Update a note for an enrollment (op-salesApi-



patch.html)

PATCH /salesApi/resources/11.1.10


/Notes/{NoteId}

Update an enrollment (op-salesApi-resources-

11.1.10-programEnrollments-

{EnrollmentNumber}-patch.html)

PATCH /salesApi/resources/11.1.10

/programEnrollments/{EnrollmentNumber}

Resources

The resources resoure is used to view, create, and update a resource. A resource is a person within the deploying

company who can be assigned work to accomplish business objectives, such as sales persons or partner members.

Task Method Path

Get a resource (op-crmCommonApi-resources-

11.1.10-resources-{PartyNumber}-get.html)GET /crmCommonApi/resources/11.1.10/resources

/{PartyNumber}

Get all resources (op-crmCommonApi-

resources-11.1.10-resources-get.html)

GET /crmCommonApi/resources/11.1.10/resources

Sales Leads


f 30 26-Nov-15 1:36 AM



The sales lead resource is used to view, create, or modify a lead. A lead is a transaction record created when a party

has expressed an interest in a product or service. It represents a selling opportunity.

Task Method Path

Create a note (op-salesApi-resources-11.1.10-

leads-{LeadId}-child-Note-post.html)

POST /salesApi/resources/11.1.10/leads/{LeadId}

/child/Note

Create a sales lead (op-salesApi-resources-

11.1.10-leads-post.html)

POST /salesApi/resources/11.1.10/leads

Create a sales lead contact (op-salesApi-

resources-11.1.10-leads-{LeadId}-child-

MklLeadTcMembers1-post.html)


/child/MklLeadTcMembers1

Create a sales lead product (op-salesApi-


MklProdAssoc1-post.html)


/child/MklProdAssoc1

Create a sales lead resource (op-salesApi-


MklLeadResources-post.html)


/child/MklLeadResources

Delete a note (op-salesApi-resources-11.1.10-

leads-{LeadId}-child-Note-{NoteId}-delete.html)

DELETE /salesApi/resources/11.1.10/leads/{LeadId}

/child/Note/{NoteId}

Delete a sales lead (op-salesApi-resources-

11.1.10-leads-{LeadId}-delete.html)


Delete a sales lead contact (op-salesApi-

resources-11.1.10-leads-{LeadId}-child-MklLeadTcMembers1-{LeadMemberId}-

delete.html)


/child/MklLeadTcMembers1/{LeadMemberId}

Delete a sales lead product (op-salesApi-


MklProdAssoc1-{LeadProductId}-delete.html)


/child/MklProdAssoc1/{LeadProductId}

Delete a sales lead resource (op-salesApi-


MklLeadResources-{LeadResourceId}-

delete.html)


/child/MklLeadResources/{LeadResourceId}

Get a note (op-salesApi-resources-11.1.10-

leads-{LeadId}-child-Note-{NoteId}-get.html)

GET /salesApi/resources/11.1.10/leads/{LeadId}



leads-{LeadId}-child-products-{productsId}-

get.html)


/child/products/{productsId}


11.1.10-leads-{LeadId}-child-productGroups-



/child/productGroups/{ProdGroupId}

Get a sales lead (op-salesApi-resources-

11.1.10-leads-{LeadId}-get.html)



f 30 26-Nov-15 1:36 AM



Task Method Path

Get a sales lead contact (op-salesApi-


MklLeadTcMembers1-{LeadMemberId}-get.html)



Get a sales lead product (op-salesApi-


MklProdAssoc1-{LeadProductId}-get.html)



Get a sales lead resource (op-salesApi-


MklLeadResources-{LeadResourceId}-get.html)



Get all notes (op-salesApi-resources-11.1.10-

leads-{LeadId}-child-Note-get.html)GET /salesApi/resources/11.1.10/leads/{LeadId}

/child/Note


11.1.10-leads-{LeadId}-child-LeadOpportunity-

get.html)


/child/LeadOpportunity


11.1.10-leads-{LeadId}-child-productGroups-

get.html)


/child/productGroups


11.1.10-leads-{LeadId}-child-products-get.html)


/child/products

Get all sales lead contacts (op-salesApi-


MklLeadTcMembers1-get.html)


/child/MklLeadTcMembers1

Get all sales lead products (op-salesApi-


MklProdAssoc1-get.html)


/child/MklProdAssoc1

Get all sales lead resources (op-salesApi-


MklLeadResources-get.html)


/child/MklLeadResources

Get all sales leads (op-salesApi-resources-

11.1.10-leads-get.html)

GET /salesApi/resources/11.1.10/leads

Get an opportunity (op-salesApi-resources-

11.1.10-leads-{LeadId}-child-LeadOpportunity-

{LeadNumber}-get.html)


/child/LeadOpportunity/{LeadNumber}

Update a note (op-salesApi-resources-11.1.10-

leads-{LeadId}-child-Note-{NoteId}-patch.html)

PATCH /salesApi/resources/11.1.10/leads/{LeadId}


Update a sales lead (op-salesApi-resources-

11.1.10-leads-{LeadId}-patch.html)PATCH /salesApi/resources/11.1.10/leads/{LeadId}


f 30 26-Nov-15 1:36 AM



Task Method Path

Update a sales lead contact (op-salesApi-


MklLeadTcMembers1-{LeadMemberId}-

patch.html)



Update a sales lead product (op-salesApi-


MklProdAssoc1-{LeadProductId}-patch.html)



Update a sales lead resource (op-salesApi-


MklLeadResources-{LeadResourceId}-

patch.html)



Sales Orders

The sales order resource is used to view, create, and update sales orders. A Sales Order captures quote and order

header information such as name, version, status and amount. It is used to get, create, update and delete a quote

and order.

Task Method Path

Create a quote (op-crmCommonApi-resources-

11.1.10-salesOrders-post.html)

POST /crmCommonApi/resources/11.1.10

/salesOrders

Delete a quote (op-crmCommonApi-resources-

11.1.10-salesOrders-{OrderHeaderId}-

delete.html)

DELETE /crmCommonApi/resources/11.1.10

/salesOrders/{OrderHeaderId}

Get a quote (op-crmCommonApi-resources-

11.1.10-salesOrders-{OrderHeaderId}-get.html)

GET /crmCommonApi/resources/11.1.10


Get all quotes (op-crmCommonApi-resources-

11.1.10-salesOrders-get.html)GET /crmCommonApi/resources/11.1.10

/salesOrders

Update a quote (op-crmCommonApi-resources-

11.1.10-salesOrders-{OrderHeaderId}-

patch.html)

PATCH /crmCommonApi/resources/11.1.10


Source Codes

The source code resource is used to track responses and leads generated by each marketing campaign execution,

which helps gauge the effectiveness of each initiative. A marketing source code is a unique identifier representing a

marketing campaign and its underlying execution.

Task Method Path

Get a source code (op-salesApi-resources-

11.1.10-sourcecodes-{SourceCodeId}-get.html)

GET /salesApi/resources/11.1.10/sourcecodes

/{SourceCodeId}

Get all source codes (op-salesApi-resources-

11.1.10-sourcecodes-get.html)

GET /salesApi/resources/11.1.10/sourcecodes


f 30 26-Nov-15 1:36 AM



About Oracle (http://www.oracle.com/corporate/index.html) | Contact Us (http://www.oracle.com/us/corporate/contact/index.html)

| Legal Notices (http://www.oracle.com/us/legal/index.html) | Terms of Use (http://www.oracle.com/us/legal/terms/index.html)

| Your Privacy Rights (http://www.oracle.com/us/legal/privacy/index.html)

Copyright © 2015, Oracle and/or its affiliates. All rights reserved.


rest api for oracle sales cloud release 10

Documents