REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

All REST Endpoints

Access Group Extension Rules

The access extension rules resource is used to view, create, update, and delete access extension rules. Access extension rules are used to extend the access defined for an object in an object sharing rule to a related object.

Create an access group extension rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroupExtensionRules
Delete an access group extension rule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/{AccExtRuleNumber}
Get all access group extension rules: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupExtensionRules
Get an access group extension rule: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/{AccExtRuleNumber}
Update an access group extension rule: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/{AccExtRuleNumber}

Access Group Extension Rules/Access Group Extension Rule Details

The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.

Create an access group extension rule detail: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/{AccExtRuleNumber}/child/accessGroupExtensionRuleDetails
Delete an access group extension rule detail: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/{AccExtRuleNumber}/child/accessGroupExtensionRuleDetails/{AccExtRuleDetailId}
Get all access group extension rule details: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/{AccExtRuleNumber}/child/accessGroupExtensionRuleDetails
Get an access group extension rule detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/{AccExtRuleNumber}/child/accessGroupExtensionRuleDetails/{AccExtRuleDetailId}
Update an access group extension rule detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/{AccExtRuleNumber}/child/accessGroupExtensionRuleDetails/{AccExtRuleDetailId}

Access Group Rules

The access group rules resource is used to view, create, update, and delete the access group rules. It allows the admin to provide access to an object's records.

Check rule publish status: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/action/isRulePublished
Create an access group rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules
Delete an access group rule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}
Delete and publish a rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/action/deleteAndPublishRule
Get all access group rules: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules
Get an access group rule: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}
Get global publish request status: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/action/getGlobalPublishRequestStatus
Publish a rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/action/publishRule
Submit global publish request: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/action/submitGlobalPublishRequest
Update an access group rule: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}

Access Group Rules/Access Group Rule Candidates

The access group rule candidates resource is used to view, create, update, and delete the access group candidates. It provides access group records associated with a rule.

Create an access group candidate: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidate
Delete an access group candidate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidate/{RuleCandidateNumber}
Delete candidate and publish rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidate/{RuleCandidateNumber}/action/deleteCandidateAndPublishRule
Get all access group candidates: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidate
Get an access group candidate: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidate/{RuleCandidateNumber}
Update an access group candidate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidate/{RuleCandidateNumber}

Access Group Rules/Access Group Rule Conditions

The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule.

Create an access group condition: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCondition
Delete an access group condition: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCondition/{RuleConditionNumber}
Get all access group conditions: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCondition
Get an access group condition: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCondition/{RuleConditionNumber}
Update an access group condition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCondition/{RuleConditionNumber}

Access Groups

The access groups resource is used to view, create, update, and delete access groups. An access group is a group of resources that are granted access to data. They are selected based on a specific membership rule or manually. Data access to specific objects and their records can be defined and implemented using groups.

Create an access group: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroups
Delete an access group: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}
Get all access groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroups
Get an access group: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}
Update an access group: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}

Access Groups/Access Group Members

The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group.

Create an access group member: Method: post
Path: /crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}/child/AccessGroupMembers
Delete an access group member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}/child/AccessGroupMembers/{AccessGroupMembersUniqID}
Get all access group members: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}/child/AccessGroupMembers
Get an access group member: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}/child/AccessGroupMembers/{AccessGroupMembersUniqID}

Accounts

The accounts resource is used to view, create, update, delete, and assign accounts. An account is an entity with whom you have a selling relationship.

Assign accounts: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/action/runAssignment
Create an account: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts
Delete an account: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}
Find duplicates: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/action/findDuplicates
Get all accounts: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts
Get an account: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}
Get information about financial customers - Internal: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/action/getFinancialCustomerInfo
Update an account: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}

Accounts/Account Attachments

The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.

Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Remove an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Replace an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Upload an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment

Accounts/Account Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Accounts/Account Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Accounts/Account Extension Bases

The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.

Create an account extension base: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase
Delete an account extension base: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase/{Id}
Get all account extension bases: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase
Get an account extension base: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase/{Id}
Update an account extension base: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase/{Id}

Accounts/Account Hierarchy

The account hierarchy summaries resource is used to view the account hierarchy information.

Get all account hierarchy summaries: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountHierarchySummary
Get an account hierarchy summary: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountHierarchySummary/{PartyId}

Accounts/Account Resources

Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Create a sales team member: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember
Delete a sales team member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get a sales team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get all sales team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember
Update a sales team member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}

Accounts/Account Rollups

The account rollups resource is used to view, create, update, and delete an account rollup.

Get all account rollups: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountRollup
Get an account rollup: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountRollup/{OrganizationProfileId}

Accounts/Account Team

The account team resource is used to view the team members and territory team members associated with an account.

Get all account team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountTeam
Get an account team member - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountTeam/{AccountTeamId}

Accounts/Additional Identifier

The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.

Create an additional identifier: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalIdentifier
Delete an additional identifier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Get all additional identifiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalIdentifier
Get an additional identifier: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Update an additional identifier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}

Accounts/Additional Names

The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.

Create an additional name: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName
Delete an additional name: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName/{NameId}
Get all additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName
Get an additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName/{NameId}
Update an additional name: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName/{NameId}

Accounts/Addresses

The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}

Accounts/Addresses/Address Locales

The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.

Create an address locale: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Delete an address locale: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Get all address locales: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Get an address locale: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Update an address locale: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}

Accounts/Addresses/Address Purposes

The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.

Create an address purpose: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose
Delete an address purpose: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}
Get all address purposes: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose
Get an address purpose: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}
Update an address purpose: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}

Accounts/Aux Classifications

The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.

Create a customer classification: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/CustomerClassification
Delete a customer classification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get a customer classification: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get all customer classifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/CustomerClassification
Update a customer classification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}

Accounts/Contact Points

The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint/{ContactPointId}

Accounts/Large Object (LOB) Attributes - D&B Business Report

The Dun & Bradstreet business information report.

Delete a D&B Business Report: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/enclosure/BusinessReport
Get a D&B Business Report: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/enclosure/BusinessReport
Replace a D&B Business Report: Method: put
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/enclosure/BusinessReport

Accounts/Notes

The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}

Accounts/Notes/Large Object (LOB) Attributes - Note Text

This is the column which will store the actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Accounts/Organization Contacts

The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.

Create an account contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact
Delete an account contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact/{AccountContactId}
Get all account contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact
Get an account contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact/{AccountContactId}
Update an account contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact/{AccountContactId}

Accounts/Primary Addresses

The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.

Create a primary address: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress
Delete a primary address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get a primary address: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get all primary addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress
Update a primary address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}

Accounts/Relationships

The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship/{RelationshipRecId}

Accounts/Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{accounts_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/action/generateSmartActions
Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{accounts_smartActions_Id}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/action/processMassAction

Accounts/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{accounts_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{accounts_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{accounts_smartActions_Id}/enclosure/ActionIntent

Accounts/Smart Actions/Smart Action REST Path Parameter Definitions

The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Get all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{accounts_smartActions_Id}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{accounts_smartActions_Id}/child/UserActionURLBinding/{accounts_smartActions_UserActionURLBinding_Id}

Accounts/Smart Actions/Smart Action REST Payload Definitions

The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Get all action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{accounts_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{accounts_smartActions_Id}/child/UserActionRequestPayload/{accounts_smartActions_UserActionRequestPayload_Id}

Accounts/Smart Actions/Smart Action User Interface Definitions

The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Get all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{accounts_smartActions_Id}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{accounts_smartActions_Id}/child/UserActionNavigation/{accounts_smartActions_UserActionNavigation_Id}

Accounts/Source System References

The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.

Create a source system reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference
Delete a source system reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference
Update a source system reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}

Action Bar Configurations

The action bar configuration resource is used to view and update action bar configurations.

Get a configuration: Method: get
Path: /crmRestApi/resources/11.13.18.05/sensingAgentConfigurations/{ConfigurationCode}
Get all configurations: Method: get
Path: /crmRestApi/resources/11.13.18.05/sensingAgentConfigurations
Update a configuration: Method: patch
Path: /crmRestApi/resources/11.13.18.05/sensingAgentConfigurations/{ConfigurationCode}

Action Bar Configurations/Large Object (LOB) Attributes - AdditionalContext

Delete an AdditionalContext: Method: delete
Path: /crmRestApi/resources/11.13.18.05/sensingAgentConfigurations/{ConfigurationCode}/enclosure/AdditionalContext
Get an AdditionalContext: Method: get
Path: /crmRestApi/resources/11.13.18.05/sensingAgentConfigurations/{ConfigurationCode}/enclosure/AdditionalContext
Replace an AdditionalContext: Method: put
Path: /crmRestApi/resources/11.13.18.05/sensingAgentConfigurations/{ConfigurationCode}/enclosure/AdditionalContext

Action Bar Synonyms

The sensing agent synonyms resource lets you view, create, update, and delete a sensing agent synonyms document. It's a document that describes the characteristics of the custom synonym definition.

Create a synonym: Method: post
Path: /crmRestApi/resources/11.13.18.05/sensingAgentSynonyms
Delete a synonym: Method: delete
Path: /crmRestApi/resources/11.13.18.05/sensingAgentSynonyms/{sensingAgentSynonymsUniqID}
Get a synonym: Method: get
Path: /crmRestApi/resources/11.13.18.05/sensingAgentSynonyms/{sensingAgentSynonymsUniqID}
Get all synonyms: Method: get
Path: /crmRestApi/resources/11.13.18.05/sensingAgentSynonyms
Update a synonym: Method: patch
Path: /crmRestApi/resources/11.13.18.05/sensingAgentSynonyms/{sensingAgentSynonymsUniqID}

Action Events

The action events resource is used to view and create details of the REST APIs called by external applications, if the REST API endpoint matches a certain pre-defined pattern. This is used to determine billing of the digital customer service application and to capture knowledge article usage.

Create an action event: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionEvents
Get all action events: Method: get
Path: /crmRestApi/resources/11.13.18.05/actionEvents
Get an action event: Method: get
Path: /crmRestApi/resources/11.13.18.05/actionEvents/{RequestActionCaptureId}
Update an action event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/actionEvents/{RequestActionCaptureId}

Action Plans

The action plans resource is used to view, create, update, and delete the details of an action plan created by an agent. An action plan is a series of steps or a sequence of events that may be required to carry out a certain task.

Add an action to a parent business object: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/action/addActionToObject
Adds adhoc actions to action plans: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/action/addAdhocActiontoActionPlan
Create an action plan: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans
Delete an action plan: Method: delete
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}
Get all action plans: Method: get
Path: /crmRestApi/resources/11.13.18.05/actionplans
Get an action plan: Method: get
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}
Get attribute mappings for the given action plan or action: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/action/getActionMappings
Get process access token: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/action/getProcessAccessToken
Recreates the underlying business object: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/action/recreateObjectForActionPlanAction
Refresh an action plan: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/action/refreshActionPlan
Refresh an action plan action: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/action/refreshActionPlanAction
Refresh an action plan through signals: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/action/processSignalObject
Update an action plan: Method: patch
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}
Update object details: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/action/updateObjectDetailsToPlan

Action Plans/Action Plan Actions

The actions plan actions resource is used to view, create, update, and delete the actions in an action plan. An action is a step or a sequence in an action plan.

Create an action plan action: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction
Delete an action plan action: Method: delete
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction/{ActionPlanActionId}
Get all action plan actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction
Get an action plan action: Method: get
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction/{ActionPlanActionId}
Update an action plan action: Method: patch
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction/{ActionPlanActionId}

Action Plans/Action Plan Actions/Action Plan Action Relations

The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.

Create an action plan action relation: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction/{ActionPlanActionId}/child/actionPlanActionRelation
Delete an action plan action relation: Method: delete
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction/{ActionPlanActionId}/child/actionPlanActionRelation/{RelationId}
Get all action plan action relations: Method: get
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction/{ActionPlanActionId}/child/actionPlanActionRelation
Get an action plan action relation: Method: get
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction/{ActionPlanActionId}/child/actionPlanActionRelation/{RelationId}
Update an action plan action relation: Method: patch
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction/{ActionPlanActionId}/child/actionPlanActionRelation/{RelationId}

Action Status Conditions

The action status conditions resource is used to view, create, update, and delete an action status condition. It contains the definitions of status conditions for the entity object of an action.

Create a status condition: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionstatusconditions
Delete a status condition: Method: delete
Path: /crmRestApi/resources/11.13.18.05/actionstatusconditions/{StatusConditionId}
Get a status condition: Method: get
Path: /crmRestApi/resources/11.13.18.05/actionstatusconditions/{StatusConditionId}
Get all status conditions: Method: get
Path: /crmRestApi/resources/11.13.18.05/actionstatusconditions
Update a status condition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/actionstatusconditions/{StatusConditionId}

Action Templates

The action templates resource is used to view, create, update, and delete the details for the action plan templates in the system. Action plan templates include multiple actions that must be carried out to complete a task.

Create an action plan template: Method: post
Path: /crmRestApi/resources/11.13.18.05/actiontemplates
Delete an action plan template: Method: delete
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}
Get all action plan templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/actiontemplates
Get an action plan template: Method: get
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}
Update an action plan template: Method: patch
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}

Action Templates/Template Actions

The template actions resource is used to view, create, update, and delete the associations of actions with action plan templates.

Create a template action: Method: post
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction
Delete a template action: Method: delete
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction/{TemplateActionId}
Get a template action: Method: get
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction/{TemplateActionId}
Get all template actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction
Update a template action: Method: patch
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction/{TemplateActionId}

Action Templates/Template Actions/Action Relations

The action relations resource is used to view, create, update, and delete the dependencies of actions on other actions in an action plan template.

Create an action relation: Method: post
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction/{TemplateActionId}/child/actionRelation
Delete an action relation: Method: delete
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction/{TemplateActionId}/child/actionRelation/{RelationId}
Get all action relations: Method: get
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction/{TemplateActionId}/child/actionRelation
Get an action relation: Method: get
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction/{TemplateActionId}/child/actionRelation/{RelationId}
Update an action relation: Method: patch
Path: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction/{TemplateActionId}/child/actionRelation/{RelationId}

Actions

The actions resource is used to view, create, update, and delete the details of all the actions in an action plan template. An action is a step or a sequence in an action plan template.

Create an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/actions
Delete an action: Method: delete
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/actions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}
Update an action: Method: patch
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}

Actions/Action Attributes

The action attributes resource is used to view, create, update, and delete the attributes that are set while creating or updating the related object of an action.

Create an action attribute: Method: post
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionAttribute
Delete an action attribute: Method: delete
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionAttribute/{ActionAttributeId}
Get all action attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionAttribute
Get an action attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionAttribute/{ActionAttributeId}
Update an action attribute: Method: patch
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionAttribute/{ActionAttributeId}

Actions/Action Conditions

The action conditions resource is used to view, create, update, and delete the definitions of the status mapping conditions for the related object of an action.

Create an action condition: Method: post
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionCondition
Delete an action condition: Method: delete
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionCondition/{ActionConditionId}
Get all action conditions: Method: get
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionCondition
Get an action condition: Method: get
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionCondition/{ActionConditionId}
Update an action condition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionCondition/{ActionConditionId}

Activities

The activities resource is used to view, create, update, and delete activity data. Activities keep track of things you plan to do, like a task or an appointment, or things that you have already completed, like logging a customer call.

Create activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/action/createActivitiesFromTemplate
Create an activity: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities
Create multiple activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/action/createMultipleActivitiesFromTemplate
Delete an activity: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}
Get all activities: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities
Get an activity: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}
Send notifications to resources: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/action/sendNotificationToResources
Update an activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}
Update an activity wrap up: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/action/updateActivityWrapup

Activities/Activity Assignees

The activity assignees resource is used to view, create, update, and delete the internal resources assigned to an activity.

Create an activity assignee: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee
Delete an activity assignee: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee/{ActivityAssigneeUniqID}
Get all activity assignees: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee
Get an activity assignee: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee/{ActivityAssigneeUniqID}
Update an activity assignee: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee/{ActivityAssigneeUniqID}

Activities/Activity Attachments

The activity attachments resource is used to view, create, update, and delete attachments of an activity. An attachment includes additional information about an activity.

Create an activity attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments
Delete an activity attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments/{AttachmentsUniqID}
Get all activity attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments
Get an activity attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments/{AttachmentsUniqID}
Update an activity attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments/{AttachmentsUniqID}

Activities/Activity Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Activities/Activity Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Activities/Activity Contacts

The activity contacts resource is used to view, create, update, and delete the contacts associated with an activity.

Create an activity contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityContact
Delete an activity contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityContact/{ActivityContactUniqID}
Get all activity contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityContact
Get an activity contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityContact/{ActivityContactUniqID}
Update an activity contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityContact/{ActivityContactUniqID}

Activities/Activity Objectives

The activity objectives resource is used to view, create, update, and delete the objective of an activity.

Create an activity objective: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityObjectives
Delete an activity objective: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityObjectives/{ObjectiveId}
Get all activity objectives: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityObjectives
Get an activity objective: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityObjectives/{ObjectiveId}
Update an activity objective: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityObjectives/{ObjectiveId}

Activities/Large Object (LOB) Attributes - Description

A text area for capturing information about the activity. The value should be Base64 encoded. You can use any base64 encoder to encode the text to Base64. If you want to provide text instead of base64 code, then you can use the endpoint enclosures endpoint. For example to update the description for activity ID 12345, use the endpoint /crmRestApi/resources/11.13.18.05/activities/12345/enclosure/ActivityDescription.

Delete a Description: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/enclosure/ActivityDescription
Get a Description: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/enclosure/ActivityDescription
Replace a Description: Method: put
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/enclosure/ActivityDescription

Activities/Large Object (LOB) Attributes - Meeting Minutes

The minutes of meeting of the activity. The value should be Base64 encoded. You can use any base64 encoder to encode the text to Base64. If you want to provide text instead of base64 code, then you can use the endpoint enclosures endpoint. For example to update the meeting minutes for activity ID 12345, use the endpoint /crmRestApi/resources/11.13.18.05/activities/12345/enclosure/ActivityMtgMinutes.

Delete a Meeting Minutes: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/enclosure/ActivityMtgMinutes
Get a Meeting Minutes: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/enclosure/ActivityMtgMinutes
Replace a Meeting Minutes: Method: put
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/enclosure/ActivityMtgMinutes

Activities/Large Object (LOB) Attributes - WebConferenceDetails

Delete a WebConferenceDetails: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/enclosure/WebConferenceDetails
Get a WebConferenceDetails: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/enclosure/WebConferenceDetails
Replace a WebConferenceDetails: Method: put
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/enclosure/WebConferenceDetails

Activities/Notes

The note resource is used to view, create, update, and delete notes associated with an activity. A note captures comments, information, or instructions related to an activity.

Create an activity note: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Note
Delete an activity note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Note/{NoteId}
Get all activity notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Note
Get an activity note: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Note/{NoteId}
Update an activity note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Note/{NoteId}

Activities/Notes/Large Object (LOB) Attributes - NoteTxt

Delete a NoteTxt: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a NoteTxt: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt: Method: put
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Activities/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{activities_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/action/generateSmartActions
Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{activities_smartActions_Id}
Get action evaluation attributes: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions
Get attributes: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/action/getAttributesForResource
Get entities: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/action/getEntities
Get object functions: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/action/getObjectFunctions
Process mass action: Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/action/processMassAction

Activities/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{activities_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{activities_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{activities_smartActions_Id}/enclosure/ActionIntent

Activities/Smart Actions/Smart Action REST Path Parameter Definitions

The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

GET all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{activities_smartActions_Id}/child/UserActionURLBinding
GET an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{activities_smartActions_Id}/child/UserActionURLBinding/{activities_smartActions_UserActionURLBinding_Id}

Activities/Smart Actions/Smart Action REST Payload Definitions

GET all action request payloads - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{activities_smartActions_Id}/child/UserActionRequestPayload
GET an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{activities_smartActions_Id}/child/UserActionRequestPayload/{activities_smartActions_UserActionRequestPayload_Id}

Activities/Smart Actions/Smart Action User Interface Definitions

The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

GET all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{activities_smartActions_Id}/child/UserActionNavigation
GET an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{activities_smartActions_Id}/child/UserActionNavigation/{activities_smartActions_UserActionNavigation_Id}

Activity Templates

The activity templates resource is used to view, create, update, and delete an activity template. This is used to capture template header and metadata information for activity template records.

Create an activity template: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates
Delete an activity template: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}
Get all activity templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates
Get an activity template: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}
Update an activity template: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}

Activity Templates/Activities

Activity

Create activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/action/createActivitiesFromTemplate
Create an activity: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity
Create multiple activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/action/createMultipleActivitiesFromTemplate
Delete an activity: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}
Get all activities: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity
Get an activity: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}
Send notifications to resources: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/action/sendNotificationToResources
Update an activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}
Update an activity wrap up: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/action/updateActivityWrapup

Activity Templates/Activities/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/Attachments/{AttachmentsUniqID}

Activity Templates/Activities/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Activity Templates/Activities/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Activity Templates/Activities/Large Object (LOB) Attributes - ActivityDescription

Delete an ActivityDescription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/enclosure/ActivityDescription
Get an ActivityDescription: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/enclosure/ActivityDescription
Replace an ActivityDescription: Method: put
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/enclosure/ActivityDescription

Activity Templates/Activities/Large Object (LOB) Attributes - ActivityMtgMinutes

Delete an ActivityMtgMinutes: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/enclosure/ActivityMtgMinutes
Get an ActivityMtgMinutes: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/enclosure/ActivityMtgMinutes
Replace an ActivityMtgMinutes: Method: put
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/enclosure/ActivityMtgMinutes

Activity Templates/Activities/Large Object (LOB) Attributes - WebConferenceDetails

Delete a WebConferenceDetails: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/enclosure/WebConferenceDetails
Get a WebConferenceDetails: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/enclosure/WebConferenceDetails
Replace a WebConferenceDetails: Method: put
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/enclosure/WebConferenceDetails

Activity Templates/Activities/Smart Actions

This VO stores the endpoint and security details for every user action.

Create an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions
Delete an action: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}
Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/action/generateSmartActions
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/action/processMassAction
Update an action: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}

Activity Templates/Activities/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/enclosure/ActionIntent

Activity Templates/Activities/Smart Actions/Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Create an action request payload definition: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionRequestPayload
Delete an action request payload definition: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionRequestPayload/{activityTemplates_Activity_smartActions_UserActionRequestPayload_Id}
Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionRequestPayload/{activityTemplates_Activity_smartActions_UserActionRequestPayload_Id}
Update an action request payload definition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionRequestPayload/{activityTemplates_Activity_smartActions_UserActionRequestPayload_Id}

Activity Templates/Activities/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Create an action navigation definition: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionNavigation
Create an action REST path parameter: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionURLBinding
Delete an action navigation definition: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionNavigation/{activityTemplates_Activity_smartActions_UserActionNavigation_Id}
Delete an action path parameter: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionURLBinding/{activityTemplates_Activity_smartActions_UserActionURLBinding_Id}
Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionNavigation/{activityTemplates_Activity_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionURLBinding/{activityTemplates_Activity_smartActions_UserActionURLBinding_Id}
Update an action navigation definition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionNavigation/{activityTemplates_Activity_smartActions_UserActionNavigation_Id}
Update an action path parameter: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{activityTemplates_Activity_smartActions_Id}/child/UserActionURLBinding/{activityTemplates_Activity_smartActions_UserActionURLBinding_Id}

Address Style Formats

The address style formats resource is used to view the different styles in which an address can be formatted. There are multiple address formats such as general address, rural address, military address, and so on. All responses for the address style formats resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds).

Get all address style formats: Method: get
Path: /crmRestApi/resources/11.13.18.05/addressStyleFormats
Get an address style format: Method: get
Path: /crmRestApi/resources/11.13.18.05/addressStyleFormats/{CountryCode}

Address Style Formats/Address Style Format Layouts

The address style format layouts resource is used to view the layout of an address format. The address format layout is determined using the components in the address and their position in the layout.

Get all address format layouts: Method: get
Path: /crmRestApi/resources/11.13.18.05/addressStyleFormats/{CountryCode}/child/AddressStyleFormatLayout
Get an address format layout: Method: get
Path: /crmRestApi/resources/11.13.18.05/addressStyleFormats/{CountryCode}/child/AddressStyleFormatLayout/{AddressStyleFormatLayoutUniqID}

Application Usage Insights

The Application Usage Insights resource is used to view historical data related to User Adoption.

Get interactions cumulative count for a parent object: Method: get
Path: /interactionscumulativegrowth
Get login count: Method: get
Path: /userloginmetrics
Get object count: Method: get
Path: /cumulativegrowth
Get object create count: Method: get
Path: /objectgrowthv2
Get summaries of metrics: Method: get
Path: /quickfacts
Get summaries of metrics: Method: get
Path: /quickfactsCustomObject
Get the 7-day and 30-day Simple Moving Average for click count: Method: get
Path: /appInsightsClicksSma
Get the 7-day and 30-day Simple Moving Average for login count: Method: get
Path: /appInsightsLoginSma
Get the 7-day and 30-day Simple Moving Average for object create count: Method: get
Path: /appInsightsObjectSma
Get the 7-day and 30-day Simple Moving Average for user session duration: Method: get
Path: /appInsightsSessionSma
Get the click count: Method: get
Path: /activity
Get the configured list of custom objects: Method: get
Path: /customobjects
Get the configured list of custom objects: Method: get
Path: /interactionObjectNames
Get the session duration: Method: get
Path: /usersessionmetrics
Get the top flows by click count: Method: get
Path: /popflows
Get the top flows by duration: Method: get
Path: /timespent
Saves the list of custom objects: Method: put
Path: /customobjects/operations/bulkset

Assets

The assets resource is used to view, create, update, and delete assets. An asset is a product or service owned by an account, contact, or household. An asset can be tangible, such as computers, computer parts, and so on, or intangible, such as licenses, software, and so on.

Create an asset: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets
Delete an asset: Method: delete
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}
Get all assets: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets
Get an asset: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}
Update an asset: Method: patch
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}

Assets/Asset Activities

The asset activities resource is used to view the activities of the asset. This is used to capture task and appointment information.

Create activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/action/createActivitiesFromTemplate
Create multiple activities from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/action/createMultipleActivitiesFromTemplate
Get all activities: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities
Get an activity: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/{ActivityId}
Send notifications to resources: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/action/sendNotificationToResources
Update an activity wrap up: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/action/updateActivityWrapup

Assets/Asset Activities/Large Object (LOB) Attributes - ActivityDescription

Delete an ActivityDescription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/{ActivityId}/enclosure/ActivityDescription
Get an ActivityDescription: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/{ActivityId}/enclosure/ActivityDescription
Replace an ActivityDescription: Method: put
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/{ActivityId}/enclosure/ActivityDescription

Assets/Asset Activities/Large Object (LOB) Attributes - ActivityMtgMinutes

Delete an ActivityMtgMinutes: Method: delete
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/{ActivityId}/enclosure/ActivityMtgMinutes
Get an ActivityMtgMinutes: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/{ActivityId}/enclosure/ActivityMtgMinutes
Replace an ActivityMtgMinutes: Method: put
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/{ActivityId}/enclosure/ActivityMtgMinutes

Assets/Asset Activities/Large Object (LOB) Attributes - WebConferenceDetails

Delete a WebConferenceDetails: Method: delete
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/{ActivityId}/enclosure/WebConferenceDetails
Get a WebConferenceDetails: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/{ActivityId}/enclosure/WebConferenceDetails
Replace a WebConferenceDetails: Method: put
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetActivities/{ActivityId}/enclosure/WebConferenceDetails

Assets/Asset Contacts

The asset contacts resource is used to view, create, update, and delete the contacts associated with an asset.

Create an asset contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetContacts
Delete an asset contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetContacts/{AssetContactId}
Get all asset contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetContacts
Get an asset contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetContacts/{AssetContactId}
Update an asset contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetContacts/{AssetContactId}

Assets/Asset Leads

The asset leads resource is used to view an asset 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.

Accept lead: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/acceptLead
Assign leads: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/runAssignment
Convert a lead to an opportunity: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/convertLeadToOpty
Get a sales lead: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/{assetLeadsUniqID}
Get all sales leads: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads
Rank leads: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/rankLead
Reject leads: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/rejectLead
Score leads: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetLeads/action/scoreLead

Assets/Asset Opportunities

The asset opportunities resource is used to view the opportunities of an asset. An opportunity is used by a sales organization to track information about a potential sale such as the sales account, key contacts, product interests, and potential revenues.

Assign matched opportunity: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetOpportunities/action/assignOpportunity
Copy matched opportunity: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetOpportunities/action/copyOpportunity
Create quote in Oracle CPQ Cloud: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetOpportunities/action/createQuote
Get all opportunities: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetOpportunities
Get an opportunity: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetOpportunities/{OptyId}

Assets/Asset Resources

Asset resources is used to view, create, update, and delete the team members associated with an asset.

Create an asset resource: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetResources
Delete an asset resource: Method: delete
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetResources/{AssetResourceId}
Get all asset resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetResources
Get an asset resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetResources/{AssetResourceId}
Update an asset resource: Method: patch
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetResources/{AssetResourceId}

Assets/Asset Service Requests

The asset service requests resource is used to view the service requests related to an asset. These are header level information about a request from a customer for service from the time the customer makes the request until the request is resolved. For example, if a customer has an issue with their laptop battery draining too fast, the details of the customer and the issue they are facing is stored in the service request header.

Copy service request attachments: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetServiceRequests/action/copySRAttachments
Get a service request: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetServiceRequests/{SrId}
Get all service requests: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetServiceRequests
Get service request milestone diagnostic: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetServiceRequests/{SrId}/action/processSrMilestones
Refresh service request milestone: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetServiceRequests/{SrId}/action/getSrMilestoneDiagnostics
Send an email to SR message recipients: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetServiceRequests/{SrId}/action/sendEmailForSrMessage

Assets/Attachments

The attachments resource is used to view, create, update, and delete attachments of an asset. An attachment includes additional information about an asset.

Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/attachments/{attachmentsUniqID}
Upload an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/attachments

Assets/Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Assets/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Assets/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{assets_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/action/generateSmartActions
Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{assets_smartActions_Id}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/action/processMassAction

Assets/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{assets_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{assets_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{assets_smartActions_Id}/enclosure/ActionIntent

Assets/Smart Actions/Smart Action REST Path Parameter Definitions

GET all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{assets_smartActions_Id}/child/UserActionURLBinding
GET an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{assets_smartActions_Id}/child/UserActionURLBinding/{assets_smartActions_UserActionURLBinding_Id}

Assets/Smart Actions/Smart Action REST Payload Definitions

GET all action request payloads - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{assets_smartActions_Id}/child/UserActionRequestPayload
GET an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{assets_smartActions_Id}/child/UserActionRequestPayload/{assets_smartActions_UserActionRequestPayload_Id}

Assets/Smart Actions/Smart Action User Interface Definitions

GET all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{assets_smartActions_Id}/child/UserActionNavigation
GET an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{assets_smartActions_Id}/child/UserActionNavigation/{assets_smartActions_UserActionNavigation_Id}

Attribute Predictions

The attribute predictions resource is used to view, create, update, and delete an attribute prediction.

Create an attribute prediction: Method: post
Path: /crmRestApi/resources/11.13.18.05/attributePredictions
Delete an attribute prediction: Method: delete
Path: /crmRestApi/resources/11.13.18.05/attributePredictions/{AttrPredictionId}
Get all attribute predictions: Method: get
Path: /crmRestApi/resources/11.13.18.05/attributePredictions
Get an attribute prediction: Method: get
Path: /crmRestApi/resources/11.13.18.05/attributePredictions/{AttrPredictionId}
Update an attribute prediction: Method: patch
Path: /crmRestApi/resources/11.13.18.05/attributePredictions/{AttrPredictionId}

Billing Adjustments

The billing adjustment resource is used to view, create, update, and delete a billing adjustment.

Create a billing adjustment: Method: post
Path: /crmRestApi/resources/11.13.18.05/billingAdjustments
Delete a billing adjustment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}
Get a billing adjustment: Method: get
Path: /crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}
Get all billing adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/billingAdjustments
Update a billing adjustment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}

Billing Adjustments/Billing Adjustment Events

The billing adjustment event resource is used to view, create, update, and delete a billing adjustment events.

Create a billing adjustment event: Method: post
Path: /crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}/child/billingAdjustmentEvents
Delete a billing adjustment event: Method: delete
Path: /crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}/child/billingAdjustmentEvents/{BillAdjustmentRequestEventsNumber}
Get a billing adjustment event: Method: get
Path: /crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}/child/billingAdjustmentEvents/{BillAdjustmentRequestEventsNumber}
Get all billing adjustment events: Method: get
Path: /crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}/child/billingAdjustmentEvents
Update a billing adjustment event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}/child/billingAdjustmentEvents/{BillAdjustmentRequestEventsNumber}

Budgets

The MDF budget resource is used to view, create, and update MDF budgets. A MDF budget contains details pertaining to monetary incentives for partners to execute marketing activities.

Create a MDF budget: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets
Delete a MDF budget: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}
Get a MDF budget: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}
Get all MDF budgets: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets
Update a MDF budget: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}

Budgets/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Attachments/{AttachmentsUniqID}

Budgets/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Budgets/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Budgets/Budget Countries

The budget countries resource is used to view, create, and update the list of partner countries to which budget can be allocated to.

Create a MDF budget country: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetCountries
Delete a MDF budget country: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetCountries/{BudgetCountryId}
Get a MDF budget country: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetCountries/{BudgetCountryId}
Get all MDF budget countries: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetCountries
Update a MDF budget country: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetCountries/{BudgetCountryId}

Budgets/Claims

The claim resource is used to view, create, and update a claim. A claim is a request for reimbursement of marketing expenses submitted by a partner.

Create a MDF claims against the budget: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Claim
Delete a MDF claim associated to the budget: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Claim/{ClaimCode}
Get a MDF claim associated to the budget: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Claim/{ClaimCode}
Get all MDF claims associated to the budget: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Claim
Update a MDF claim associated to the budget: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Claim/{ClaimCode}

Budgets/Fund Requests

The fund request resource is used view, create, and update fund requests. A fund request is a request for a portion of the budget to be allocated towards execution of certain marketing activities.

Create a MDF request for the budget: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/FundRequest
Delete a MDF request associated to the budget: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/FundRequest/{FundRequestCode}
Get a MDF request associated to the budget: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/FundRequest/{FundRequestCode}
Get all MDF requests associated to the budget: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/FundRequest
Update a MDF request associated to the budget: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/FundRequest/{FundRequestCode}

Budgets/MDF Budget Teams

The MDF budget team resource is used to view, create, and update MDF budget team members. A budget team member is a resource who is assigned to the MDF budget team and who has the appropriate visibility and access to the MDF budget record.

Create a MDF budget team member: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetTeam
Delete a MDF budget team member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetTeam/{BudgetTeamId}
Get a MDF budget team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetTeam/{BudgetTeamId}
Get all MDF budget team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetTeam
Update a MDF budget team member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetTeam/{BudgetTeamId}

Budgets/Notes

The note resource is used to capture comments, information, or instructions for an MDF budget.

Create a MDF budget note: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetNote
Delete a MDF budget note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetNote/{NoteId}
Get a MDF budget note: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetNote/{NoteId}
Get all notes for an MDF budget: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetNote
Update a MDF budget note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetNote/{NoteId}

Budgets/Notes/Large Object (LOB) Attributes - Note Text

The actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetNote/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetNote/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/BudgetNote/{NoteId}/enclosure/NoteTxt

Business Plans

The business plans resource is used to view, create, update, and delete business plans. A business plan represents a mutual commitment between two or more parties to work together in order to achieve common goals.

Create a business plan: Method: post
Path: /crmRestApi/resources/11.13.18.05/businessPlans
Delete a business plan: Method: delete
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}
Get a business plan: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}
Get all business plans: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans
Update a business plan: Method: patch
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}

Business Plans/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanAttachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanAttachments/{businessPlans_BusinessPlanAttachments_Id}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanAttachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanAttachments/{businessPlans_BusinessPlanAttachments_Id}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanAttachments/{businessPlans_BusinessPlanAttachments_Id}

Business Plans/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanAttachments/{businessPlans_BusinessPlanAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanAttachments/{businessPlans_BusinessPlanAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanAttachments/{businessPlans_BusinessPlanAttachments_Id}/enclosure/FileContents

Business Plans/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanAttachments/{businessPlans_BusinessPlanAttachments_Id}/enclosure/FileWebImage

Business Plans/Business Plan Resources

Business plan resources is used to view, create, update, and delete the team members associated with a business plan.

Create a business plan resource: Method: post
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource
Delete a business plan resource: Method: delete
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}
Get a business plan resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}
Get all business plan resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource
Update a business plan resource: Method: patch
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}

Business Plans/Notes

The notes resource is used to view, create, update, and delete notes associated with a business plan. A note captures comments, information, or instructions related to an business plan.

Create a business plan note: Method: post
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note
Delete a business plan note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note/{NoteId}
Get a business plan note: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note/{NoteId}
Get all business plan notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note
Update a business plan note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note/{NoteId}

Business Plans/Notes/Large Object (LOB) Attributes - Note Text

The actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note/{NoteId}/enclosure/NoteTxt

Business Plans/SWOTs

The SWOTs resource is used to view, create, update, and delete a business plan's strengths, weaknesses, opportunities, and threats.

Create a business plan SWOT: Method: post
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Swot
Delete a business plan SWOT: Method: delete
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Swot/{SWOTId}
Get a business plan SWOT: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Swot/{SWOTId}
Get all business plan SWOTs: Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Swot
Update a business plan SWOT: Method: patch
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Swot/{SWOTId}

Calculation Simulations

The calculation simulations resource is used to view, create, update, and delete all the related entities that perform a calculation simulation. The calculation simulation process begins when the simulation is created or updated with the Processing Status attribute set as "ORA_CN_READY".

Create a calculation simulation: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations
Delete a calculation simulation: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}
Get a calculation simulation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}
Get all calculation simulations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations
Update a calculation simulation: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}

Calculation Simulations/Simulation Earnings

The simulation earnings resource is used to view all the earnings in a calculation simulation.

Get a simulation earning: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Earnings/{EarningId}
Get all simulation earnings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Earnings

Calculation Simulations/Simulation Meause Results

The simulation measure results resource is used to view measure results of a calculation simulation.

Get a simulation measure result: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/MeasureResults/{MeasureResultId}
Get all simulation measure results: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/MeasureResults

Calculation Simulations/Simulation Transactions

The simulation transactions resource is used to view, create, update, and delete transactions associated with a calculation simulation.

Create a simulation transaction: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions
Delete a simulation transaction: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}
Get a simulation transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}
Get all simulation transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions
Update a simulation transaction: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}

Calculation Simulations/Simulation Transactions/Simulation Credits

The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.

Create a simulation credit: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits
Delete a simulation credit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits/{CreditId}
Get a simulation credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits/{CreditId}
Get all simulation credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits
Update a simulation credit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits/{CreditId}

Calculation Simulations/Simulation Transactions/Simulation Transaction Descriptive Flex Fields

The simulation transaction descriptive flex fields resource is used to view and create additional attributes of the transaction that are used during the simulation.

Create a simulation transaction descriptive flex field: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/SimulationTransactionDFF
Get a simulation transaction descriptive flex field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/SimulationTransactionDFF/{SimulationTransactionDFFUniqID}
Get all simulation transaction descriptive flex fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/SimulationTransactionDFF

Campaign Members

Intended for Eloqua use ONLY. A campaign member describes the relationship between an individual Lead or Contact and a specific Campaign. It tracks the changes in this relationship over time, and it's used for building marketing reports and dashboards. The resource isn't supported for non-Eloqua users.

Create a campaign member: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaignMembers
Delete a campaign member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/campaignMembers/{campaignMembersUniqID}
Get a campaign member: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaignMembers/{campaignMembersUniqID}
Get all campaign members: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaignMembers
Update a campaign member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/campaignMembers/{campaignMembersUniqID}

Campaigns

The campaigns resource is used to view, create, update, and delete campaigns. A campaign is an effort reach out to contacts and leads to convert them to a customer.

Create a campaign: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns
Delete a campaign: Method: delete
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}
Get a campaign: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}
Get all campaigns: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns
Update a campaign: Method: patch
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}

Campaigns/Campaign Account Attribution Criteria

The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign.

Create a campaign account attribution criterion: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccountAttributionCriteria
Delete a campaign account attribution criterion: Method: delete
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccountAttributionCriteria/{CampaignAccountAttrCriteriaId}
Get a campaign account attribution criterion: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccountAttributionCriteria/{CampaignAccountAttrCriteriaId}
Get all campaign account attribution criteria: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccountAttributionCriteria
Update a campaign account attribution criterion: Method: patch
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccountAttributionCriteria/{CampaignAccountAttrCriteriaId}

Campaigns/Campaign Account Attribution Criteria/Large Object (LOB) Attributes - CriteriaExpression

Delete a CriteriaExpression: Method: delete
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccountAttributionCriteria/{CampaignAccountAttrCriteriaId}/enclosure/CriteriaExpression
Get a CriteriaExpression: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccountAttributionCriteria/{CampaignAccountAttrCriteriaId}/enclosure/CriteriaExpression
Replace a CriteriaExpression: Method: put
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccountAttributionCriteria/{CampaignAccountAttrCriteriaId}/enclosure/CriteriaExpression

Campaigns/Campaign Accounts

The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign.

Create a campaign account: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccounts
Delete a campaign account: Method: delete
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccounts/{CampaignAccountsUniqID}
Get a campaign account: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccounts/{CampaignAccountsUniqID}
Get all campaign accounts: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccounts
Update a campaign account: Method: patch
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccounts/{CampaignAccountsUniqID}

Campaigns/Campaign Members

The campaign members resource is used to view the members associated with a sales campaign.

Get a campaign member: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/MktCampaignMembers/{MktCampaignMembersUniqID}
Get all campaign members: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/MktCampaignMembers

Campaigns/Campaign Products

The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign.

Create a campaign product: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignProducts
Delete a campaign product: Method: delete
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignProducts/{CampaignProductId}
Get a campaign product: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignProducts/{CampaignProductId}
Get all campaign products: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignProducts
Update a campaign product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignProducts/{CampaignProductId}

Campaigns/Campaign Rollups

The campaign rollup resource is used to view a campaign rollup.

Get a campaign rollup: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignRollup/{CampaignId}
Get all campaign rollups: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignRollup

Campaigns/Campaign Teams

The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign.

Create a campaign resource: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignTeam
Delete a campaign resource: Method: delete
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignTeam/{CampaignTeamId}
Get a campaign resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignTeam/{CampaignTeamId}
Get all campaign resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignTeam
Update a campaign resource: Method: patch
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignTeam/{CampaignTeamId}

Campaigns/Sales Contents

The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign.

Create a campaign sales content: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/SalesContents
Delete a campaign sales content: Method: delete
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/SalesContents/{SalesContentId}
Delete content: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/SalesContents/action/deleteContentAssociation
Get a campaign sales content: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/SalesContents/{SalesContentId}
Get all campaign sales contents: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/SalesContents
Mark content for deletion: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/SalesContents/action/markContentAssociationForDeletion
Rename content: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/SalesContents/action/renameContent
Update a campaign sales content: Method: patch
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/SalesContents/{SalesContentId}

Campaigns/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{campaigns_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/action/generateSmartActions
Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{campaigns_smartActions_Id}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/action/processMassAction

Campaigns/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{campaigns_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{campaigns_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{campaigns_smartActions_Id}/enclosure/ActionIntent

Campaigns/Smart Actions/Smart Action REST Path Parameter Definitions

Get all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{campaigns_smartActions_Id}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{campaigns_smartActions_Id}/child/UserActionURLBinding/{campaigns_smartActions_UserActionURLBinding_Id}

Campaigns/Smart Actions/Smart Action REST Payload Definitions

Get all action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{campaigns_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{campaigns_smartActions_Id}/child/UserActionRequestPayload/{campaigns_smartActions_UserActionRequestPayload_Id}

Campaigns/Smart Actions/Smart Action User Interface Definitions

Get all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{campaigns_smartActions_Id}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{campaigns_smartActions_Id}/child/UserActionNavigation/{campaigns_smartActions_UserActionNavigation_Id}

Cases

The cases resource is used to view, create, update, and delete the details and related information of a case across it's life cycle.

Assign case to a queue: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/action/assignQueue
Copy attachments to a case: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/action/copyCaseAttachments
Create a case: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases
Delete a case: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}
Get a case: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}
Get all cases: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases
Update a case: Method: patch
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}

Cases/Attachments

The attachments resource is used to view, create, update, and delete an attachment.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments/{AttachmentsUniqID}

Cases/Attachments/Attachment Previews

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments/{AttachmentsUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments/{AttachmentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

Cases/Attachments/Large Object (LOB) Attributes - Content

The content of the message that is not an attachment.

Delete a Content: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a Content: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a Content: Method: put
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Cases/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Cases/Case Contacts

The case contacts resource is used to view, create, update, and delete many-to-many relationships between cases and associated contacts.

Create a case contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseContacts
Delete a case contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseContacts/{CaseContactId}
Get a case contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseContacts/{CaseContactId}
Get all case contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseContacts
Update a case contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseContacts/{CaseContactId}

Cases/Case Households

The case households resource is used to view, create, update, and delete many-to-many relationships between cases and associated households.

Create a case household: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseHouseholds
Delete a case household: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseHouseholds/{CaseHouseholdId}
Get a case household: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseHouseholds/{CaseHouseholdId}
Get all case households: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseHouseholds
Update a case household: Method: patch
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseHouseholds/{CaseHouseholdId}

Cases/Case Messages

The case messages resource is used to view, create, update, and delete information about every communication update associated with the case.

Create a case message: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages
Delete a case message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}
Get a case message: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}
Get all case messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages
Update a case message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}

Cases/Case Messages/Attachments

The attachments resource is used to view, create, update, and delete an attachment.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments/{AttachmentsUniqID}

Cases/Case Messages/Attachments/Attachment Previews

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments/{AttachmentsUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments/{AttachmentsUniqID2}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

Cases/Case Messages/Attachments/Large Object (LOB) Attributes - Content

The content of the message that is not an attachment.

Delete a Content: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a Content: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a Content: Method: put
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Cases/Case Messages/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Cases/Case Messages/Large Object (LOB) Attributes - Content

The content of the message that is not an attachment.

Delete a Content: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/enclosure/Content
Get a Content: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/enclosure/Content
Replace a Content: Method: put
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseMessages/{MessageId}/enclosure/Content

Cases/Case Opportunities

The opportunities resources indicates the one-to-many relationships between the case and associated opportunities.

Create an opportunity: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseOpportunities
Delete an opportunity: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseOpportunities/{CaseOpportunityId}
Get all opportunities: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseOpportunities
Get an opportunity: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseOpportunities/{CaseOpportunityId}
Update an opportunity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseOpportunities/{CaseOpportunityId}

Cases/Case Resources

Case resources is used to view, create, update, and delete many-to-many relationships between cases and associated resources.

Create a case resource: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseResources
Delete a case resource: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseResources/{CaseResourceId}
Get a case resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseResources/{CaseResourceId}
Get all case resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseResources
Update a case resource: Method: patch
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseResources/{CaseResourceId}

Cases/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{cases_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/generateSmartActions
Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{cases_smartActions_Id}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/processMassAction

Cases/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{cases_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{cases_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{cases_smartActions_Id}/enclosure/ActionIntent

Cases/Smart Actions/Path Parameter Definitions

The path parameters definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Get all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{cases_smartActions_Id}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{cases_smartActions_Id}/child/UserActionURLBinding/{cases_smartActions_UserActionURLBinding_Id}

Cases/Smart Actions/Payload Definitions

Get all action request payloads - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{cases_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{cases_smartActions_Id}/child/UserActionRequestPayload/{cases_smartActions_UserActionRequestPayload_Id}

Cases/Smart Actions/User Interface Definitions

Get all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{cases_smartActions_Id}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{cases_smartActions_Id}/child/UserActionNavigation/{cases_smartActions_UserActionNavigation_Id}

Catalog Product Groups

The product groups resource is used to view the list of product groups associated to a specific usage code or mode. It has the option to filter records based on territory.

Create a product group - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups
Delete a product group - Not Supported: Method: delete
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}
Get a catalog product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}
Get all product groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups
Update a product group - Not Supported: Method: patch
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}

Catalog Product Groups/Attachments

The attachments resource is used to view the attachments of a product group. An attachment includes additional information about the product group.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/Attachments/{AttachmentsUniqID}

Catalog Product Groups/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Catalog Product Groups/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Catalog Product Groups/Translations

The product group resource is used to view the language code, the translated product group name and description, and the product group ID.

Create a product group translation - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/ProductGroupTranslation
Delete a product group translation - Not Supported: Method: delete
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/ProductGroupTranslation/{ProductGroupTranslationUniqID}
Get a product group translation: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/ProductGroupTranslation/{ProductGroupTranslationUniqID}
Get all product group translations: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/ProductGroupTranslation
Update a product group translation - Not Supported: Method: patch
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/ProductGroupTranslation/{ProductGroupTranslationUniqID}

Catalog Products Items

The product items resource is used to view the list of product items associated to a specific usage code or mode. It has the option to filter records based on territory.

Create a product item - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems
Delete a product item - Not Supported: Method: delete
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}
Get a product item: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}
Get all products: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems
Update a product item - Not Supported: Method: patch
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}

Catalog Products Items/Attachments

The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments/{AttachmentsUniqID}

Catalog Products Items/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Catalog Products Items/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Catalog Products Items/Item Translation

The product item resource is used to view the language code, the translated product group name and description, and the product group ID.

Create an item translation - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/ItemTranslation
Delete an item translation - Not Supported: Method: delete
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/ItemTranslation/{ItemTranslationUniqID}
Get all item translations: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/ItemTranslation
Get an item translation: Method: get
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/ItemTranslation/{ItemTranslationUniqID}
Update an item translation - Not Supported: Method: patch
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/ItemTranslation/{ItemTranslationUniqID}

Categories

The categories resource is used to view, create, update, and delete service object categories. Categories enables grouping service objects to enable easy identification and downstream reporting. For example, service requests can be categorized based on the type of service requested, such as the need for general information or help with installation, or the area in which support is required, such as billing or order tracking. Similarly, knowledge articles can be categorized based on the article's subject area, such as installation or order status.

Create a category: Method: post
Path: /crmRestApi/resources/11.13.18.05/categories
Delete a category: Method: delete
Path: /crmRestApi/resources/11.13.18.05/categories/{CategoryId}
Get a category: Method: get
Path: /crmRestApi/resources/11.13.18.05/categories/{CategoryId}
Get all categories: Method: get
Path: /crmRestApi/resources/11.13.18.05/categories
Update a category: Method: patch
Path: /crmRestApi/resources/11.13.18.05/categories/{CategoryId}

Channels

The channels resource is used to view, create, update, and delete the forms of communication by which you listen and respond to your customers. Channels refer to all the available sources of social messaging, incoming service requests and outgoing responses, that are monitored and processed. Some examples of channels are email, phone, twitter, and Facebook.

Create a channel: Method: post
Path: /crmRestApi/resources/11.13.18.05/channels
Delete a channel: Method: delete
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}
Get a channel: Method: get
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}
Get all channels: Method: get
Path: /crmRestApi/resources/11.13.18.05/channels
Update a channel: Method: patch
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}

Channels/Channel Resources

The channel resources is used to view, create, update, and delete the list of employees or partners, such as service representatives or service managers, who are associated with a service channel. If a resource is associated with a channel, then they can communicate with the customer using that channel.

Create a channel resource member: Method: post
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/resourceMembers
Delete a channel resource member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/resourceMembers/{ChannelResourceId}
Get a channel resource member: Method: get
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/resourceMembers/{ChannelResourceId}
Get all channel resource members: Method: get
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/resourceMembers
Update a channel resource member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/resourceMembers/{ChannelResourceId}

Channels/Sender Identification Priorities

The sender identification priorities resource is used to view, create, update, and delete identification priorities for channels.The sender identification priority is used to resolve a conflict if multiple party identifiers are found for a sender of a message.

Create a sender priority sequence: Method: post
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/senderIdentificationPriorities
Delete a sender priority sequence: Method: delete
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/senderIdentificationPriorities/{PrioritySequenceId}
Get all the sender priority sequences: Method: get
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/senderIdentificationPriorities
Get details of a sender priority sequence: Method: get
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/senderIdentificationPriorities/{PrioritySequenceId}
Update a sender priority sequence: Method: patch
Path: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/senderIdentificationPriorities/{PrioritySequenceId}

Chat Authentications

The chat authentications resource is used to authenticate the end user of a Chat Service.

Create a chat authentication: Method: post
Path: /crmRestApi/resources/11.13.18.05/chatAuthenticate
Get a chat authentication - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatAuthenticate/{authUserName}
Get all chat authentications - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatAuthenticate

Chat Conversations

The chat conversations resource is used to view messaging conversations between end-users and service specialists.

Get a chat conversation: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatConversations/{MessageId}
Get all chat conversations: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatConversations

Chat Conversations/Large Object (LOB) Attributes - MessageContent

Delete a MessageContent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/chatConversations/{MessageId}/enclosure/MessageContent
Get a MessageContent: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatConversations/{MessageId}/enclosure/MessageContent
Replace a MessageContent: Method: put
Path: /crmRestApi/resources/11.13.18.05/chatConversations/{MessageId}/enclosure/MessageContent

Chat Details

The chat details resource is used to view and update the attachments associated to a chat.

Get all chat details: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcChats
Get all chat details: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats
Get chat details: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}
Get chat details: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}
Update a chat detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}
Update a chat detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}

Chat Details/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment
Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}

Chat Details/Attachments/Attached Documents Descriptive Flexfield

The operations from the Chat Details/Attachments/Attached Documents Descriptive Flexfield category.

Create: Method: post
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Create: Method: post
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Get: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}
Get: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}
Get all: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Get all: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Update: Method: patch
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}
Update: Method: patch
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}

Chat Details/Attachments/Attachment Previews

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

Chat Details/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Chat Details/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcChats/{OsvcChatId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage
Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcConsumerChats/{EndUserSessionId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Chat Interactions

The chat interactions resource is used to view the list of end user's interactions of type chat. The resource can be accessed by the DCS authenticated users assigned to the ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACT role.

Create a chat interaction - Not supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/chatInteractions
Delete a chat interaction - Not supported: Method: delete
Path: /crmRestApi/resources/11.13.18.05/chatInteractions/{InteractionId}
Get a chat interaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatInteractions/{InteractionId}
Get all chat interactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatInteractions
Update a chat interaction - Not supported: Method: patch
Path: /crmRestApi/resources/11.13.18.05/chatInteractions/{InteractionId}

Chat Interactions/Transcripts

The transcripts resource is used to get the list of chat transcript messages for a chat interaction. The resource can be accessed by DCS authenticated users assigned to the ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACT role. The transcript can be accessed only by the DCS user that participated in the chat or by the manager of the DCS user who participated in the chat.

Create a transcript - Not supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/chatInteractions/{InteractionId}/child/transcript
Delete a transcript - Not supported: Method: delete
Path: /crmRestApi/resources/11.13.18.05/chatInteractions/{InteractionId}/child/transcript/{transcriptUniqID}
Get a transcript - Not supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatInteractions/{InteractionId}/child/transcript/{transcriptUniqID}
Get all transcripts: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatInteractions/{InteractionId}/child/transcript
Update a transcript - Not supported: Method: patch
Path: /crmRestApi/resources/11.13.18.05/chatInteractions/{InteractionId}/child/transcript/{transcriptUniqID}

Chat Transcripts

The chat transcripts resource is used to view transcripts of chat interactions that agents have had with customer contacts.

Delete a chat transcript: Method: post
Path: /crmRestApi/resources/11.13.18.05/chatTranscript/action/deleteChatTranscript
Get a chat transcript: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatTranscript/{chatTranscriptUniqID}
Get all chat transcripts: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatTranscript

Chat Transcripts/Large Object (LOB) Attributes - MessageContent

Delete a MessageContent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/chatTranscript/{chatTranscriptUniqID}/enclosure/MessageContent
Get a MessageContent: Method: get
Path: /crmRestApi/resources/11.13.18.05/chatTranscript/{chatTranscriptUniqID}/enclosure/MessageContent
Replace a MessageContent: Method: put
Path: /crmRestApi/resources/11.13.18.05/chatTranscript/{chatTranscriptUniqID}/enclosure/MessageContent

Claims

The claims resource is used to view, create, update, and delete requests for reimbursement of marketing expenses submitted by a partner.

Create an MDF claim: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfClaims
Delete an MDF claim: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}
Get all MDF claims: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims
Get an MDF claim: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}
Update an MDF claim: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}

Claims/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Attachments/{AttachmentsUniqID}

Claims/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Claims/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Claims/Claim Settlements

The claim settlements resource is used to view, create, update, and delete the payments made to partners as reimbursement for the marketing expenses incurred by that partner.

Create a claim settlement: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimSettlements
Delete a claim settlement: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimSettlements/{ClaimSettlementCode}
Get a claim settlement: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimSettlements/{ClaimSettlementCode}
Get all claim settlements: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimSettlements
Update a claim settlement: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimSettlements/{ClaimSettlementCode}

Claims/Claim Team Members

The claim team members resource is used to view, create, update, and delete a claim team member. A claim team member is a resource who is assigned to the MDF claim team, and who has the appropriate visibility and access to the MDF Claim record.

Create a claim team member: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimResource
Delete a claim team member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimResource/{ClaimResourceId}
Get a claim team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimResource/{ClaimResourceId}
Get all claim team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimResource
Update a claim team member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimResource/{ClaimResourceId}

Claims/Notes

The notes resource is used to view, create, update, and delete notes associated with a claim. A note captures comments, information, or instructions related to a claim.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Note/{NoteId}

Claims/Notes/Large Object (LOB) Attributes - Note Text

The actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Note/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Note/{NoteId}/enclosure/NoteTxt

Collaboration Actions

The collaboration resource lets you view, create, update, and delete a collaboration. The collaboration actions store details of the commands and actions that can be run from collaboration networks like Slack. For example, a collaboration between Slack users and CX Sales users to resolve an SR or a sales person getting opportunity details on the slack application.

Create a collaboration action: Method: post
Path: /crmRestApi/resources/11.13.18.05/collaborationActions
Delete a collaboration action: Method: delete
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}
Get a collaboration action: Method: get
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}
Get all collaboration actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/collaborationActions
Update a collaboration action: Method: patch
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}

Collaboration Actions/Action Attributes

The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.

Add an attributes to a collaboration action: Method: post
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/child/actionAttributes
Delete a collaboration action attribute: Method: delete
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/child/actionAttributes/{AttribId}
Get a collaboration action attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/child/actionAttributes/{AttribId}
Get all attributes of a collaboration action: Method: get
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/child/actionAttributes
Update a collaboration action attribute: Method: patch
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/child/actionAttributes/{AttribId}

Collaboration Actions/Large Object (LOB) Attributes - RequestPayload

Delete a RequestPayload: Method: delete
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/enclosure/RequestPayload
Get a RequestPayload: Method: get
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/enclosure/RequestPayload
Replace a RequestPayload: Method: put
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/enclosure/RequestPayload

Collaboration Actions/Large Object (LOB) Attributes - ResponsePayload

Delete a ResponsePayload: Method: delete
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/enclosure/ResponsePayload
Get a ResponsePayload: Method: get
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/enclosure/ResponsePayload
Replace a ResponsePayload: Method: put
Path: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/enclosure/ResponsePayload

Collaboration Recipients

The collaboration recipients resource is used to view channels and user members of the external collaboration networks so that a user can communicate with those channels and users.

Create a collaboration recipient: Method: post
Path: /crmRestApi/resources/11.13.18.05/collaborationRecipientLookups
Delete a collaboration recipient: Method: delete
Path: /crmRestApi/resources/11.13.18.05/collaborationRecipientLookups/{ResourceId}
Get a collaboration recipient: Method: get
Path: /crmRestApi/resources/11.13.18.05/collaborationRecipientLookups/{ResourceId}
Get all collaboration recipients: Method: get
Path: /crmRestApi/resources/11.13.18.05/collaborationRecipientLookups
Update a collaboration recipient: Method: patch
Path: /crmRestApi/resources/11.13.18.05/collaborationRecipientLookups/{ResourceId}

Collaborations

The collaborations resource is used to view and create collaborations for objects, such as opportunity. A collaboration is used to keep track of where the team members on the record can collaborate with each other. It currently supports collaborations in Microsoft Teams only.

Create a Collaboration in Microsoft Teams: Method: post
Path: /crmRestApi/resources/11.13.18.05/collaborations
Get a collaboration: Method: get
Path: /crmRestApi/resources/11.13.18.05/collaborations/{CollabId}
Get all collaborations: Method: get
Path: /crmRestApi/resources/11.13.18.05/collaborations

Compensation Estimation Insights

The compensation estimation insights resource is used to the view summary simulation results.

Get a compensation estimation insight: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/{SimulationId}
Get all compensation estimation insights: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights

Compensation Estimation Insights/Estimation Summary by Plan Components

The summary by plan components resource is used to view simulation results by plan component.

Get a summary by plan component: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/{SimulationId}/child/SummaryByPlanComponent/{SummaryByPlanComponentId}
Get all summaries by plan components: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/{SimulationId}/child/SummaryByPlanComponent

Compensation Plans

The compensation plans resource is used to create, update, or delete a compensation plan. It can also be used to display all the details of the compensation plans. A compensation plan is used to generate the earnings and payment details of a participant based on the performance measures defined. A new compensation plan can be created with a role assignment and/or plan component assignment. It can also be created individually where only a compensation plan is created and the association with other components needs to be done separately.

Create a compensation plan: Method: post
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans
Delete a compensation plan: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}
Get a compensation plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}
Get all compensation plans: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans
Update a compensation plan: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}

Compensation Plans/Assigned Participants

The assignments resource is used to view all the participants associated with a compensation plan. This includes participants that are assigned directly or assigned through incentive compensation roles. An assignments provides the dates when a participant became a part of a compensation plan. An active compensation plan and a participant need to exist before creating an assignment.

Get all assigned participants: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanAssignments
Get an assigned participant: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanAssignments/{SrpCompPlanId}

Compensation Plans/Assigned Participants/Large Object (LOB) Attributes - ViewPlanDocument

Delete a ViewPlanDocument: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanAssignments/{SrpCompPlanId}/enclosure/ViewPlanDocument
Get a ViewPlanDocument: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanAssignments/{SrpCompPlanId}/enclosure/ViewPlanDocument
Replace a ViewPlanDocument: Method: put
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanAssignments/{SrpCompPlanId}/enclosure/ViewPlanDocument

Compensation Plans/Compensation Plan - Descriptive Flex Fields

The descriptive flex fields resource is used to store user defined values for the compensation plan. A new API name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.

Create a descriptive flex field: Method: post
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/compensationPlansDFF
Get a descriptive flex field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/compensationPlansDFF/{CompPlanId}
Get all descriptive flex fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/compensationPlansDFF
Update a descriptive flex field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/compensationPlansDFF/{CompPlanId}

Compensation Plans/Compensation Plan - Plan Components

The plan components resource is used to create, update, or delete the association of a plan component with a compensation plan. It can also be used to display all the details of plan components under a compensation plan. A plan component resource links the plan component with the compensation and provides additional details at this level. A plan component needs to exist before creating this record.

Create a plan component: Method: post
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanComponents
Delete a plan component: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanComponents/{CompensationPlanComponentId}
Get a plan component: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanComponents/{CompensationPlanComponentId}
Get all plan components: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanComponents
Update a plan component: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanComponents/{CompensationPlanComponentId}

Compensation Plans/Compensation Plan - Roles

The roles resource is used to create, update, or delete the assignment of a role to a compensation plan. It is also be used to display all the details of roles assigned to a compensation plan. A roles resource links the Incentive Compensation role to a compensation plan and provides additional details at this level. A role needs to exist before creating this record. Only the plan administrator can assign a role to the compensation plan using this service.

Create a role: Method: post
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles
Delete a role: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles/{CompensationPlanRolesUniqID}
Get a role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles/{CompensationPlanRolesUniqID}
Get all roles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles
Update a role: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles/{CompensationPlanRolesUniqID}

Compensation Plans/Direct Assignment Requests

The direct assignment requests resource is used to view, create, and delete direct participant assignment requests. The resource can be used to request a new participant to be assigned to a plan, edit an existing participant assignment, or delete a participant assigned to a plan. The resource can also be used to delete a previously raised request. Once a request is created, the user must run the Deploy Compensation Plans process for it to apply. Once applied, this change can be seen in the Assignments resource.

Create a direct assignment request: Method: post
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanDirectAssignmentRequests
Delete a direct assignment request: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanDirectAssignmentRequests/{PlanDirectAssignmentRequestId}
Get a direct assignment request: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanDirectAssignmentRequests/{PlanDirectAssignmentRequestId}
Get all direct assignment requests: Method: get
Path: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanDirectAssignmentRequests

Competitors

The competitors resource is used to view the details of a competitor. A competitor is an organization that competes with the deploying organization for sales in the market. The resource 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.

Get a competitor: Method: get
Path: /crmRestApi/resources/11.13.18.05/competitors/{PartyId}
Get all competitors: Method: get
Path: /crmRestApi/resources/11.13.18.05/competitors

Competitors Accounts

The competitor accounts resource is used to view, create, and update a competitor account and manage competitor details. A competitor is an organization that competes with the deploying organization in the market for sales.

Create a competitor account: Method: post
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts
Get a competitor account: Method: get
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}
Get all competitor accounts: Method: get
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts
Update a competitor account: Method: patch
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}

Competitors Accounts/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}/child/Attachment/{AttachmentUniqID}

Competitors Accounts/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Competitors Accounts/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Contact Content Associations

The contact content associations resource is used to view contact content associations. It's used to view reference stories in the order they were attached to the Leads.

Get a contact content association: Method: get
Path: /crmRestApi/resources/11.13.18.05/contactContentAssociations/{ContentItemId}
Get all contact content associations: Method: get
Path: /crmRestApi/resources/11.13.18.05/contactContentAssociations

Contacts

The contacts resource is used to view, create, update, and delete a contact. A contact is an individual who is a customer or a prospect, or a contact for an existing customer or a consumer, or a contact that does not yet have an established business association with a customer or a consumer.

Create a contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts
Delete a contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}
Find duplicates: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/action/findDuplicates
Get a contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}
Get all contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts
Update a contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}

Contacts/Additional Identifiers

The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.

Create an additional identifier: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalIdentifier
Delete an additional identifier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Get all additional identifiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalIdentifier
Get an additional identifier: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Update an additional identifier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}

Contacts/Additional Names

The additional name resource is used to view, create, update, and delete additional names associated with a contact. The resource allows you to capture other names associated with a contact, such as a maiden name, or a brand name.

Create an additional name: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName
Delete an additional name: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName/{NameId}
Get all additional names: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName
Get an additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName/{NameId}
Update an additional name: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName/{NameId}

Contacts/Attachments

The contact picture attachments resource is used to view, create, update, or delete the contacts picture.

Get a contact's picture: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}
Get all contacts' pictures: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment
Remove a contact's picture: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}
Replace a contact's picture: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}
Upload a contact's picture: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment

Contacts/Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents

Contacts/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileWebImage

Contacts/Aux Classifications

The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the contacts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.

Create a customer classification: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/CustomerClassification
Delete a customer classification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get a customer classification: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get all customer classifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/CustomerClassification
Update a customer classification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}

Contacts/Contact Addresses

The contact addresses resource is used to view, create, update, and delete addresses of a contact. An address contains the detailed location information of a contact.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}

Contacts/Contact Addresses/Address Locales

The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.

Create an address locale: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Delete an address locale: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Get all address locales: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Get an address locale: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Update an address locale: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}

Contacts/Contact Addresses/Contact Address Purposes

The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.

Create an address purpose: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose
Delete an address purpose: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}
Get all purposes of an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose
Get an address purpose: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}
Update an address purpose: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}

Contacts/Contact Attachments

The contact attachments resource is used to view, create, update, and delete attachments of a contact. An attachment includes additional information about a contact.

Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Remove an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Replace an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Upload an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment

Contacts/Contact Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Contacts/Contact Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Contacts/Contact Points

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactPoint
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactPoint
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactPoint/{ContactPointId}

Contacts/Contact Primary Addresses

The primary addresses resource is used to view, create, update, and delete the primary addresses of the contacts. A primary address is the default communication address of a contact.

Create a primary address: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress
Delete a primary address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get a primary address: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get all primary addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress
Update a primary address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}

Contacts/Contact Rollups

The contact rollups resource is used to view a contact rollup.

Get a contact rollup: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactRollup/{PersonProfileId}
Get all contact rollups: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactRollup

Contacts/Notes

The note resource is used to view, create, update, and delete notes associated with a contact. A note captures comments, information, or instructions related to a contact.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}

Contacts/Notes/Large Object (LOB) Attributes - Note Text

The actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Contacts/Relationships

The relationships resource is used to view, create, and update contact relationships. A contact relationship is the interconnection between parties, such as employee or board member.

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Relationship
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Relationship
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Relationship/{RelationshipRecId}

Contacts/Sales Account Resources

Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Create a sales team member: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember
Delete a sales team member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get a sales team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get all sales team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember
Update a sales team member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}

Contacts/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{contacts_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/action/generateSmartActions
Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{contacts_smartActions_Id}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/action/processMassAction

Contacts/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{contacts_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{contacts_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{contacts_smartActions_Id}/enclosure/ActionIntent

Contacts/Smart Actions/Smart Action REST Path Parameter Definitions

Get all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{contacts_smartActions_Id}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{contacts_smartActions_Id}/child/UserActionURLBinding/{contacts_smartActions_UserActionURLBinding_Id}

Contacts/Smart Actions/Smart Action REST Payload Definitions

Get all action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{contacts_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{contacts_smartActions_Id}/child/UserActionRequestPayload/{contacts_smartActions_UserActionRequestPayload_Id}

Contacts/Smart Actions/Smart Action User Interface Definitions

Get all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{contacts_smartActions_Id}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{contacts_smartActions_Id}/child/UserActionNavigation/{contacts_smartActions_UserActionNavigation_Id}

Contacts/Source System References

The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.

Create a source system reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference
Delete a source system reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference
Update a source system reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}

Contests

Create a contest: Method: post
Path: /crmRestApi/resources/11.13.18.05/contests
Delete a contest: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}
Get a contest: Method: get
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}
Get all contests: Method: get
Path: /crmRestApi/resources/11.13.18.05/contests
Update a contest: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}

Contests/Contest History

Contest History

Create a contest history record: Method: post
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestHistory
Delete a contest history record: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestHistory/{ContestHistoryUniqID}
Get a contest history: Method: get
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestHistory/{ContestHistoryUniqID}
Get all contest history records: Method: get
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestHistory
Update a contest history record: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestHistory/{ContestHistoryUniqID}

Contests/Contest Resources

Contest Resources

Create a contest participant: Method: post
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestParticipants
Delete a contest participant: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestParticipants/{ContestResourceId}
Get a contest participant: Method: get
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestParticipants/{ContestResourceId}
Get all contest participants: Method: get
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestParticipants
Update a contest participant: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestParticipants/{ContestResourceId}

Contests/Contest Scores

Contest Scores

Create a contest score: Method: post
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestScores
Delete a contest score: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestScores/{ContestScoresUniqID}
Get a contest score: Method: get
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestScores/{ContestScoresUniqID}
Get all contest scores: Method: get
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestScores
Update a contest score: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestScores/{ContestScoresUniqID}

Contests/Contest Scores/Contest Score Details

Contest Score Details

Get a contest score detail record: Method: get
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestScores/{ContestScoresUniqID}/child/ContestScoreDetails/{ContestScoreDetailsUniqID}
Get all contest score details: Method: get
Path: /crmRestApi/resources/11.13.18.05/contests/{ContestNumber}/child/ContestScores/{ContestScoresUniqID}/child/ContestScoreDetails

Contract Asset Transactions

The contract asset transactions resource is used to view and create the asset transactions. The contract asset transaction object has details such as customer asset, transaction type, transaction date etc.

Create a contract asset transaction: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contractAssetTransactions
Get all contract asset transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contractAssetTransactions
Get contract asset transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contractAssetTransactions/{TransactionExecSequenceId}

Contract Asset Transactions/Contract Asset Transaction Details

The contract asset transaction details resource is used to view and create the asset transaction details. The contract asset transaction detail object has details such as customer asset, quantity etc.

Create a contract asset transaction detail: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contractAssetTransactions/{TransactionExecSequenceId}/child/ContractAssetTransactionDetail
Get a contract asset transaction detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contractAssetTransactions/{TransactionExecSequenceId}/child/ContractAssetTransactionDetail/{Id}
Get all contract asset transaction details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contractAssetTransactions/{TransactionExecSequenceId}/child/ContractAssetTransactionDetail

Contracts

The contracts resource is used to view the details of a contract. A contract is an agreement between two or more than two parties to fulfill an agreed scope of work.

Amend a contract: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/amend
Cancel a contract: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/cancel
Close a contract: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/close
Create a new version: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/createVersion
Create contracts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts
Delete a contract: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}
Duplicate a contract: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/duplicate
Get a contract: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}
Get all contracts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts
Hold a contract: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/applyHold
Preview a contract: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/preview
Remove hold on a contract: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/removeHold
Revert a contract amendment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/revertContract
Sign a contract: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/sign
Submit a contract for approval: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/submitForApproval
Update a contract: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}
Validate a contract: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/validateContract

Contracts/Bill Plans

The bill plans resource is used to view, create, update, and delete a bill plan. This includes bill plan name, invoice method, bill-to account number, bill-to contact, bill-to site, billing cycle, bill set, payment terms, invoice summarization options, currency conversions.

Create a bill plan: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan
Delete a bill plan: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}
Get a bill plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan
Get a bill plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}
Update a bill plan: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}

Contracts/Bill Plans/Bill Plan Flexfields

The bill plan fexfields resource is used to view, create, and update contract bill plan flexfield information.

Create a bill plan flexfield: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/BillPlanDescriptiveFlexField
Delete a bill plan flexfield: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/BillPlanDescriptiveFlexField/{BillPlanDescriptiveFlexFieldUniqID}
Get a bill plan flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/BillPlanDescriptiveFlexField/{BillPlanDescriptiveFlexFieldUniqID}
Get all bill plan flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/BillPlanDescriptiveFlexField
Update a bill plan flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/BillPlanDescriptiveFlexField/{BillPlanDescriptiveFlexFieldUniqID}

Contracts/Bill Plans/Bill Plan Translations

The bill plan translations resource is used to view and update contract bill plan translation information.

Get a bill plan translation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/BillPlanTranslation/{BillPlanTranslationUniqID}
Get all bill plan translations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/BillPlanTranslation
Update a bill plan translation: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/BillPlanTranslation/{BillPlanTranslationUniqID}

Contracts/Bill Plans/Job Assignment Overrides

The resource is used to view, create, update, delete job assignment override details

Create job assignment overrides: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobAssignmentOverride
Delete a job assignment override: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobAssignmentOverride/{JobAssignmentOverrideUniqID}
Get a job assignment override: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobAssignmentOverride/{JobAssignmentOverrideUniqID}
Get job assignment overrides: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobAssignmentOverride
Update a job assignment override: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobAssignmentOverride/{JobAssignmentOverrideUniqID}

Contracts/Bill Plans/Job Rate Overrides

The resource is used to view, create, update, delete job rate override details.

Create job rate overrides: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobRateOverride
Delete a job rate override: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobRateOverride/{JobRateOverrideUniqID}
Get a job rate override: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobRateOverride/{JobRateOverrideUniqID}
Get job rate overrides: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobRateOverride
Update a job rate override: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobRateOverride/{JobRateOverrideUniqID}

Contracts/Bill Plans/Job Title Overrides

The resource is used to view, create, update, delete job title override details.

Create job title overrides: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobTitleOverride
Delete a job title override: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobTitleOverride/{JobTitleOverrideUniqID}
Get a job title override: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobTitleOverride/{JobTitleOverrideUniqID}
Get all job title overrides: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobTitleOverride
Update a job title override: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/JobTitleOverride/{JobTitleOverrideUniqID}

Contracts/Bill Plans/Labor Multiplier Overrides

The resource is used to view, create, update, delete labor multiplier override details.

Create labor multiplier overrides: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/LaborMultiplierOverride
Delete a labor multiplier override: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/LaborMultiplierOverride/{LaborMultiplierOverrideUniqID}
Get a labor multiplier override: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/LaborMultiplierOverride/{LaborMultiplierOverrideUniqID}
Get labor multiplier overrides: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/LaborMultiplierOverride
Update a labor multiplier override: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/LaborMultiplierOverride/{LaborMultiplierOverrideUniqID}

Contracts/Bill Plans/Non Labor Rate Overrides

The resource is used to view, create, update, delete non labor multiplier override details.

Create non labor rate overrides: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/NonLaborRateOverride
Delete a non labor rate override: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/NonLaborRateOverride/{NonLaborRateOverrideUniqID}
Get a non labor rate override: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/NonLaborRateOverride/{NonLaborRateOverrideUniqID}
Get non labor rate overrides: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/NonLaborRateOverride
Update a non labor rate override: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/NonLaborRateOverride/{NonLaborRateOverrideUniqID}

Contracts/Bill Plans/Person Rate Overrides

The resource is used to view, create, update, delete person rate override details.

Create person rate overrides: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/PersonRateOverride
Delete a person rate override: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/PersonRateOverride/{PersonRateOverrideUniqID}
Get a person rate override: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/PersonRateOverride/{PersonRateOverrideUniqID}
Get person rate overrides: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/PersonRateOverride
Update a person rate override: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan/{BillPlanUniqID}/child/PersonRateOverride/{PersonRateOverrideUniqID}

Contracts/Billing Controls

The billing controls resource is used to view, create, update, and delete billing controls information. This includes the resource, hard limit, soft limit etc.

Create a billing control: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillingControl
Delete a billing control: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillingControl/{BillingControlUniqID}
Get a billing control: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillingControl/{BillingControlUniqID}
Get all billing controls: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillingControl
Update a billing control: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillingControl/{BillingControlUniqID}

Contracts/Contract Documents

The resource is used to view, create, update, delete documents of contract documents category. The information includes file name, title, description, category.

Create contract documents: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractDocuments
Delete a contract document: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractDocuments/{ContractDocumentsUniqID}
Get a contract document: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractDocuments/{ContractDocumentsUniqID}
Get all contract documents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractDocuments
Update a contract document: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractDocuments/{ContractDocumentsUniqID}

Contracts/Contract Documents/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractDocuments/{ContractDocumentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractDocuments/{ContractDocumentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractDocuments/{ContractDocumentsUniqID}/enclosure/FileContents

Contracts/Contract Documents/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractDocuments/{ContractDocumentsUniqID}/enclosure/FileWebImage

Contracts/Contract Header Flexfields

The contract header flex field resource is used to view, create, update contract header flex field information.

Create contract header flexfields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractHeaderFlexfieldVA
Delete a contract header flexfield: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractHeaderFlexfieldVA/{ContractId}
Get a contract header flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractHeaderFlexfieldVA/{ContractId}
Get all contract header flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractHeaderFlexfieldVA
Update a contract header flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractHeaderFlexfieldVA/{ContractId}

Contracts/Contract Header Translations

The resource is used to view, update contract header translation information.

Get a contract header translation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractHeaderTranslation/{ContractHeaderTranslationUniqID}
Get all contract header translations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractHeaderTranslation
Update contract header translation: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractHeaderTranslation/{ContractHeaderTranslationUniqID}

Contracts/Contract Lines

The contract line resource is used to view, create, update, delete contract line information. The line information includes name, description, start date, end date, line amount, ship-to account, ship-to site, warehouse.

Apply hold: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/action/applyHold
Cancel a contract line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/action/cancel
Close a contract line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/action/close
Create contract lines: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine
Delete a contract line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}
Get a contract line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}
Get all contract lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine
Refresh pricing terms: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/action/refreshPricingTerms
Remove hold: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/action/removeHold
Remove tiered adjustments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/action/removeTieredAdjustment
Update a contract line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}

Contracts/Contract Lines/Associated Projects

The resource is used to view, create, update, delete associated project information. This includes the project number, task number, percent complete, funded amount etc.

Create an associated project: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/AssociatedProject
Delete an associated project: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/AssociatedProject/{AssociatedProjectUniqID}
Get all associated projects: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/AssociatedProject
Get an associated project: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/AssociatedProject/{AssociatedProjectUniqID}
Update an associated project: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/AssociatedProject/{AssociatedProjectUniqID}

Contracts/Contract Lines/Billing Controls

The billing controls resource is used to view, create, update, and delete billing controls information. This includes the resource, hard limit, soft limit etc.

Create a billing control: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/BillingControl
Delete a billing control: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/BillingControl/{BillingControlUniqID}
Get a billing control: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/BillingControl/{BillingControlUniqID}
Get all billing controls: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/BillingControl
Update a billing control: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/BillingControl/{BillingControlUniqID}

Contracts/Contract Lines/Contract Line Flexfields

The resource is used to view, create, update contract line flex field information.

Create contract line flexfields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ContractAllLineDesFlexVA
Delete a contract line flexfield: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ContractAllLineDesFlexVA/{LineId2}
Get a contract line flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ContractAllLineDesFlexVA/{LineId2}
Get all contract line flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ContractAllLineDesFlexVA
Update a contract line flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ContractAllLineDesFlexVA/{LineId2}

Contracts/Contract Lines/Contract Line Internal Attributes

The contract line internal attributes resource is used to view, create, update, and delete internal contract line attributes.

Create a contract line internal attribute: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ProjectContractLineInternalAttributes
Get a contract line internal attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ProjectContractLineInternalAttributes/{ProjectContractLineInternalAttributesUniqID}
Get all contract line internal attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ProjectContractLineInternalAttributes
Update a contract line internal attribute: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ProjectContractLineInternalAttributes/{ProjectContractLineInternalAttributesUniqID}

Contracts/Contract Lines/Contract Line Translations

The resource is used to view, update contract line translation information.

Get a contract line translation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ContractLineTranslation/{ContractLineTranslationUniqID}
Get all contract line translations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ContractLineTranslation
Update a contract line translation: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ContractLineTranslation/{ContractLineTranslationUniqID}

Contracts/Contract Lines/Large Object (LOB) Attributes - SourceSystemAttributes

Delete a SourceSystemAttributes: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/enclosure/SourceSystemAttributes
Get a SourceSystemAttributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/enclosure/SourceSystemAttributes
Replace a SourceSystemAttributes: Method: put
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/enclosure/SourceSystemAttributes

Contracts/Contract Lines/Sales Credits

The resource is used to view, create, update, delete sales credit information at contract header and line level. This information includes sales person name, quota type, percent, start date and end date.

Create sales credits: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/SalesCredit
Delete a sales credit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/SalesCredit/{SalesCreditUniqID}
Get a sales credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/SalesCredit/{SalesCreditUniqID}
Get sales credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/SalesCredit
Update a sales credit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/SalesCredit/{SalesCreditUniqID}

Contracts/Contract Parties

The contract parties resource is used to view the details of a contract party. A party to a contract is one who holds the obligations and receives the benefits of a legally binding agreement.

Create contract parties: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty
Delete a contract party: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}
Get a contract party: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}
Get all contract parties: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty
Update a contract party: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}

Contracts/Contract Parties/Contract Party Contacts

The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.

Create contract party contacts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact
Delete a contract party contact: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact/{ContractPartyContactUniqID}
Get a contract party contact: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact/{ContractPartyContactUniqID}
Get all contract party contacts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact
Update a contract party contact: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact/{ContractPartyContactUniqID}

Contracts/Contract Parties/Contract Party Contacts/Contract Party Contact Flexfields

The contract party contact flex field resource is used to view, create, update contract party contact flex field information.

Create contract party contact flexfields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact/{ContractPartyContactUniqID}/child/ContractPartyContactFlexfieldVA
Delete a contract party contact flexfield: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact/{ContractPartyContactUniqID}/child/ContractPartyContactFlexfieldVA/{ContractPartyContactFlexfieldVAUniqID}
Get a contract party contact flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact/{ContractPartyContactUniqID}/child/ContractPartyContactFlexfieldVA/{ContractPartyContactFlexfieldVAUniqID}
Get all contract party contact flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact/{ContractPartyContactUniqID}/child/ContractPartyContactFlexfieldVA
Update a contract party contact flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact/{ContractPartyContactUniqID}/child/ContractPartyContactFlexfieldVA/{ContractPartyContactFlexfieldVAUniqID}

Contracts/Contract Parties/Contract Party Flexfields

The contract party flex fields is used to view, create, update contract party flex field information.

Create contract party flexfields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyFlexfieldVA
Delete a contract party flexfield: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyFlexfieldVA/{ContractPartyFlexfieldVAUniqID}
Get a contract party flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyFlexfieldVA/{ContractPartyFlexfieldVAUniqID}
Get all contract party flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyFlexfieldVA
Update a contract party flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyFlexfieldVA/{ContractPartyFlexfieldVAUniqID}

Contracts/External Shared Documents

The external shared documents resource is used to view, create, update, and delete documents of the external shared documents category. These are documents that have been shared on the contract by external users. The information includes the file name, title, description, and category.

Create an external shared document: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ExternalSharedDocuments
Delete an external shared document: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ExternalSharedDocuments/{ExternalSharedDocumentsUniqID}
Get all external shared documents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ExternalSharedDocuments
Get an external shared document: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ExternalSharedDocuments/{ExternalSharedDocumentsUniqID}
Update an external shared document: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ExternalSharedDocuments/{ExternalSharedDocumentsUniqID}

Contracts/External Shared Documents/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ExternalSharedDocuments/{ExternalSharedDocumentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ExternalSharedDocuments/{ExternalSharedDocumentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ExternalSharedDocuments/{ExternalSharedDocumentsUniqID}/enclosure/FileContents

Contracts/External Shared Documents/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ExternalSharedDocuments/{ExternalSharedDocumentsUniqID}/enclosure/FileWebImage

Contracts/Internal Shared Documents

The internal shared documents resource is used to view, create, update, and delete documents of the internal shared documents category. These are documents that have been shared on the contract by internal users. The information includes the file name, title, description, and category.

Create an internal shared document: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/InternalSharedDocuments
Delete an internal shared document: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/InternalSharedDocuments/{InternalSharedDocumentsUniqID}
Get all internal shared documents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/InternalSharedDocuments
Get an internal shared document: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/InternalSharedDocuments/{InternalSharedDocumentsUniqID}
Update an internal shared document: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/InternalSharedDocuments/{InternalSharedDocumentsUniqID}

Contracts/Internal Shared Documents/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/InternalSharedDocuments/{InternalSharedDocumentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/InternalSharedDocuments/{InternalSharedDocumentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/InternalSharedDocuments/{InternalSharedDocumentsUniqID}/enclosure/FileContents

Contracts/Internal Shared Documents/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/InternalSharedDocuments/{InternalSharedDocumentsUniqID}/enclosure/FileWebImage

Contracts/Related Documents

The resource is used to view, create, update, delete related contracts information.

Create related documents: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RelatedDocument
Delete a related document: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RelatedDocument/{Id}
Get a related document: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RelatedDocument/{Id}
Get related documents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RelatedDocument

Contracts/Revenue Plans

The resource is used to view, create, update, delete a revenue plan. This includes revenue plan name and revenue method.

Create revenue plans: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan
Delete a revenue plan: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}
Get a revenue plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}
Get revenue plans: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan
Update a revenue plan: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}

Contracts/Revenue Plans/Job Assignment Overrides

The resource is used to view, create, update, delete job assignment override details

Create job assignment overrides: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobAssignmentOverride
Delete a job assignment override: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobAssignmentOverride/{JobAssignmentOverrideUniqID}
Get a job assignment override: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobAssignmentOverride/{JobAssignmentOverrideUniqID}
Get job assignment overrides: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobAssignmentOverride
Update a job assignment override: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobAssignmentOverride/{JobAssignmentOverrideUniqID}

Contracts/Revenue Plans/Job Rate Overrides

The resource is used to view, create, update, delete job rate override details.

Create job rate overrides: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobRateOverride
Delete a job rate override: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobRateOverride/{JobRateOverrideUniqID}
Get a job rate override: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobRateOverride/{JobRateOverrideUniqID}
Get job rate overrides: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobRateOverride
Update a job rate override: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobRateOverride/{JobRateOverrideUniqID}

Contracts/Revenue Plans/Labor Multiplier Overrides

The resource is used to view, create, update, delete labor multiplier override details.

Create labor multiplier overrides: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/LaborMultiplierOverride
Delete a labor multiplier override: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/LaborMultiplierOverride/{LaborMultiplierOverrideUniqID}
Get a labor multiplier override: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/LaborMultiplierOverride/{LaborMultiplierOverrideUniqID}
Get labor multiplier overrides: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/LaborMultiplierOverride
Update a labor multiplier override: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/LaborMultiplierOverride/{LaborMultiplierOverrideUniqID}

Contracts/Revenue Plans/Non Labor Rate Overrides

The resource is used to view, create, update, delete non labor multiplier override details.

Create non labor rate overrides: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/NonLaborRateOverride
Delete a non labor rate override: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/NonLaborRateOverride/{NonLaborRateOverrideUniqID}
Get a non labor rate override: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/NonLaborRateOverride/{NonLaborRateOverrideUniqID}
Get non labor rate overrides: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/NonLaborRateOverride
Update a non labor rate override: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/NonLaborRateOverride/{NonLaborRateOverrideUniqID}

Contracts/Revenue Plans/Person Rate Overrides

The resource is used to view, create, update, delete person rate override details.

Create person rate overrides: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/PersonRateOverride
Delete a person rate override: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/PersonRateOverride/{PersonRateOverrideUniqID}
Get a person rate override: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/PersonRateOverride/{PersonRateOverrideUniqID}
Get person rate overrides: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/PersonRateOverride
Update a person rate override: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/PersonRateOverride/{PersonRateOverrideUniqID}

Contracts/Revenue Plans/Revenue Plan Flexfields

The revenue plan flexfields resource is used to view, create, update, and delete contract revenue plan flexfield information.

Create a revenue plan flexfield: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/RevenuePlanDescriptiveFlexField
Delete a revenue plan flexfield: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/RevenuePlanDescriptiveFlexField/{RevenuePlanDescriptiveFlexFieldUniqID}
Get a revenue plan flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/RevenuePlanDescriptiveFlexField/{RevenuePlanDescriptiveFlexFieldUniqID}
Get all revenue plan flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/RevenuePlanDescriptiveFlexField
Update a revenue plan flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/RevenuePlanDescriptiveFlexField/{RevenuePlanDescriptiveFlexFieldUniqID}

Contracts/Revenue Plans/Revenue Plan Translations

The revenue plan transactions resource is used to view and update contract revenue plan translation information.

Get a revenue plan translation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/RevenuePlanTranslation/{RevenuePlanTranslationUniqID}
Get all revenue plan translations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/RevenuePlanTranslation
Update a revenue plan translation: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/RevenuePlanTranslation/{RevenuePlanTranslationUniqID}

Contracts/Sales Credits

Create sales credits: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SalesCredit
Delete a sales credit: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SalesCredit/{SalesCreditUniqID}
Get a sales credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SalesCredit/{SalesCreditUniqID}
Get sales credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SalesCredit
Update a sales credit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SalesCredit/{SalesCreditUniqID}

Contracts/Sections

The resource is used to view the sections of the contract terms.

Get a section: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}
Get sections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section

Contracts/Sections/Clauses

The resource is used to view the clauses of the contract terms.

Get a clause: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/Clause/{ArticleId}
Get all clauses: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/Clause

Contracts/Sections/Clauses/Large Object (LOB) Attributes - ClauseTextInHTML

Get a ClauseTextInHTML: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/Clause/{ArticleId}/enclosure/ClauseTextInHTML

Contracts/Sections/Clauses/Large Object (LOB) Attributes - ClauseTextInWord

Get a ClauseTextInWord: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/Clause/{ArticleId}/enclosure/ClauseTextInWord

Contracts/Sections/Sub Sections

The resource is used to view the sub sections of the contract terms.

Get sub section: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/SubSection/{SubSectionUniqID}
Get sub sections: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/Section/{SectionUniqID}/child/SubSection

Contracts/Supporting Documents

The resource is used to view, create, update, delete documents of supporting documents category. The information includes file name, title, description, category.

Create supporting documents: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SupportingDocuments
Delete a supporting document: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SupportingDocuments/{SupportingDocumentsUniqID}
Get a supporting document: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SupportingDocuments/{SupportingDocumentsUniqID}
Get supporting documents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SupportingDocuments
Update a supporting document: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SupportingDocuments/{SupportingDocumentsUniqID}

Contracts/Supporting Documents/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SupportingDocuments/{SupportingDocumentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SupportingDocuments/{SupportingDocumentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SupportingDocuments/{SupportingDocumentsUniqID}/enclosure/FileContents

Contracts/Supporting Documents/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SupportingDocuments/{SupportingDocumentsUniqID}/enclosure/FileWebImage

Conversation Messages

The conversation messages resource is used to view, create, update, and delete the messages sent and received by the application.

Create a conversation message: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages
Create a conversation message for a business object: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/action/createConversationMessageForBusinessObject
Delete a conversation message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}
Get a conversation message: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}
Get all conversation messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages
Update a conversation message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}

Conversation Messages/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/attachments/{attachmentsUniqID}

Conversation Messages/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Conversation Messages/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Conversation Messages/Conversation Message Recipients

Message recipients.

Create a conversation message recipient: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/recipients
Delete a conversation message recipient: Method: delete
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/recipients/{RecipientId}
Get a conversation message recipient: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/recipients/{RecipientId}
Get all conversation message recipients: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/recipients

Conversation Messages/Large Object (LOB) Attributes - MessageContent

Delete a MessageContent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/enclosure/MessageContent
Get a MessageContent: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/enclosure/MessageContent
Replace a MessageContent: Method: put
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/enclosure/MessageContent

Conversation Messages/Smart Actions

This VO stores the endpoint and security details for every user action.

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{conversationMessages_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/action/generateSmartActions
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{conversationMessages_smartActions_Id}
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/action/processMassAction

Conversation Messages/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{conversationMessages_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{conversationMessages_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{conversationMessages_smartActions_Id}/enclosure/ActionIntent

Conversation Messages/Smart Actions/Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{conversationMessages_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{conversationMessages_smartActions_Id}/child/UserActionRequestPayload/{conversationMessages_smartActions_UserActionRequestPayload_Id}

Conversation Messages/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{conversationMessages_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{conversationMessages_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{conversationMessages_smartActions_Id}/child/UserActionNavigation/{conversationMessages_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{conversationMessages_smartActions_Id}/child/UserActionURLBinding/{conversationMessages_smartActions_UserActionURLBinding_Id}

Conversations

The conversations resource is used to view and update the conversations between multiple people.

Create a conversation: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversations
Delete a conversation: Method: delete
Path: /crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}
Get a conversation: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}
Get all conversations: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversations
Update a conversation: Method: patch
Path: /crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}

Conversations/Conversation References

Conversation references.

Create a conversation reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}/child/conversationReferences
Delete a conversation reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}/child/conversationReferences/{ReferenceId}
Get a conversation reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}/child/conversationReferences/{ReferenceId}
Get all conversation references: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}/child/conversationReferences
Update a conversation reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}/child/conversationReferences/{ReferenceId}

Copy Maps

The Copy Maps resource let you view copy maps. A copy map is a collection of entity and attribute mappings when data from one record is copied to another.

Get a copy map: Method: get
Path: /crmRestApi/resources/11.13.18.05/copyMaps/{XMLId}
Get all copy maps: Method: get
Path: /crmRestApi/resources/11.13.18.05/copyMaps

Credit Categories

The credit categories resource is used to view, create, update, and delete a credit category and its details. Credit categories provide the eligibility of a participant, a team, or a manager to receive credit for a transaction.

Create a credit category: Method: post
Path: /fscmRestApi/resources/11.13.18.05/creditCategories
Delete a credit category: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/creditCategories/{CreditCategoryId}
Get a credit category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/creditCategories/{CreditCategoryId}
Get all credit categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/creditCategories
Update a credit category: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/creditCategories/{CreditCategoryId}

Currencies

The currencies resource is used to get a list of ISO standard currencies.

Get a currency: Method: get
Path: /fndCurrencies/{CurrencyCode}
Get all currencies: Method: get
Path: /fndCurrencies

Customer Account with Technician Preferences

The customer account with technician preferences shows the customer accounts that have technician preferences defined. It also displays information such as account number and address.

Get a customer account with technician preferences: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerAccountWithTechnicianPreferences/{AccountPartyId}
Get all customer accounts with technician preferences: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerAccountWithTechnicianPreferences

Customer Self-Service Users

The self-service users resource is used to view the users associated with the self-service functionality.

Get a self-service user: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerSelfServiceUsers/{UserId}
Get all self-service users: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerSelfServiceUsers

Customer Self-Service Users/Customer Self-Service Roles

The self-service roles resource is used to view, create, update, and delete roles for self-service users.

Create a self-service role: Method: post
Path: /crmRestApi/resources/11.13.18.05/customerSelfServiceUsers/{UserId}/child/SelfServiceRoles
Delete a self-service role: Method: delete
Path: /crmRestApi/resources/11.13.18.05/customerSelfServiceUsers/{UserId}/child/SelfServiceRoles/{RoleId}
Get a self-service role: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerSelfServiceUsers/{UserId}/child/SelfServiceRoles/{RoleId}
Get all self-service roles: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerSelfServiceUsers/{UserId}/child/SelfServiceRoles
Update a self-service role: Method: patch
Path: /crmRestApi/resources/11.13.18.05/customerSelfServiceUsers/{UserId}/child/SelfServiceRoles/{RoleId}

Customer Self-Service Users/Customer Self-Service Roles Histories

The self-service roles histories resource is used to view when a role was granted to or revoked from a self-service user.

Get a self-service role history: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerSelfServiceUsers/{UserId}/child/SelfServiceRolesHistory/{HistoryId}
Get all self-service role history: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerSelfServiceUsers/{UserId}/child/SelfServiceRolesHistory

DaaS Smart Data

The DaaS smart data resource is used to implement the smart defaulting feature for the account and address entities.

Create smart data: Method: post
Path: /crmRestApi/resources/11.13.18.05/daaSSmartData
Delete smart data: Method: delete
Path: /crmRestApi/resources/11.13.18.05/daaSSmartData/{daaSSmartDataUniqID}
Get accounts by account ID and address fields: Method: post
Path: /crmRestApi/resources/11.13.18.05/daaSSmartData/action/getAccount
Get address data: Method: post
Path: /crmRestApi/resources/11.13.18.05/daaSSmartData/action/getAddress
Get all smart data: Method: get
Path: /crmRestApi/resources/11.13.18.05/daaSSmartData
Get smart data: Method: get
Path: /crmRestApi/resources/11.13.18.05/daaSSmartData/{daaSSmartDataUniqID}
Update smart data: Method: patch
Path: /crmRestApi/resources/11.13.18.05/daaSSmartData/{daaSSmartDataUniqID}

Deal Registrations

The deal registration resource is used to view, create, update, and delete a deal registration. A 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.

Approve a deal: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/performApprovalAction
Calculate product amount total - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/calculateProductAmountTotal
Check if deal size or product amount changed - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/dealSizeOrProductAmountTotalChanged
Convert deal to opportunity: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/convertDealToOpportunity
Copy a deal: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/copyDeal
Create a deal registration: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals
Get a deal registration: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}
Get all deal registrations: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals
Refreshes contact field - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/refreshContactRow
Refreshes customer field - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/refreshCustomerRow
Sync deal size and product amount total: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/autoSyncDealSizeAndProductAmountTotal
Update a deal registration: Method: patch
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}

Deal Registrations/Deal Approval Histories

The deal registration approval history lets you access a comprehensive record of approval-related information associated with the deal, encompassing the names of approvers, action dates, and the specific actions taken.

Get all approval history records: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealApprovalHistory
Get an approval history record: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealApprovalHistory/{VersionKey}

Deal Registrations/Deal Attachments

The attachments resource is used to view, create, update, and delete attachments of a deal. An attachment includes additional information about a deal.

Create a deal attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealAttachments
Delete a deal attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealAttachments/{DealAttachmentsUniqID}
Get a deal attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealAttachments/{DealAttachmentsUniqID}
Get all deal attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealAttachments
Update a deal attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealAttachments/{DealAttachmentsUniqID}

Deal Registrations/Deal Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealAttachments/{DealAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealAttachments/{DealAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealAttachments/{DealAttachmentsUniqID}/enclosure/FileContents

Deal Registrations/Deal Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealAttachments/{DealAttachmentsUniqID}/enclosure/FileWebImage

Deal Registrations/Deal Products

The deal products resource is used to view, create, update, and delete a deal product. The deal product is a product or product family associated with the deal registration that the customer is interested in.

Create a deal product: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealProduct
Delete a deal product: Method: delete
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealProduct/{DealProdId}
Get a deal product: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealProduct/{DealProdId}
Get all deal products: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealProduct
Update a deal product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealProduct/{DealProdId}

Deal Registrations/Deal Team Members

The deal team member resource is used to view, create, update, and delete a deal team member. A deal team member is a resource who is assigned to the deal registration team and who has the appropriate visibility and access to the deal registration record.

Create a deal team member: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealResources
Delete a deal team member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealResources/{DealResourceId}
Get a deal team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealResources/{DealResourceId}
Get all deal team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealResources
Update a deal team member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealResources/{DealResourceId}

Deal Registrations/Notes

The note resource is used to view, create, update, and delete notes associated with a deal. A note captures comments, information, or instructions related to a deal.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/Note/{NoteId}

Deal Registrations/Notes/Large Object (LOB) Attributes - NoteTxt

Delete a NoteTxt: Method: delete
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/Note/{NoteId}/enclosure/NoteTxt
Get a NoteTxt: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt: Method: put
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/Note/{NoteId}/enclosure/NoteTxt

Deal Registrations/Opportunities

The opportunity resource is used to view the opportunities associated with a deal registration. An opportunity is used by a sales organization to track information about a potential sale, such as the sales account, key contacts, product interests, and potential revenues. A matched opportunity is an opportunity that matches the deal registration based on the duplicate check process.

Assign matched opportunity: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/MatchedOpportunity/action/assignOpportunity
Copy matched opportunity: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/MatchedOpportunity/action/copyOpportunity
Create quote in Oracle CPQ Cloud: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/MatchedOpportunity/action/createQuote
Get all opportunities: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/MatchedOpportunity
Get an opportunity: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/MatchedOpportunity/{OptyId}

Deal Registrations/Partner Owner Picker

The partner owner picker resource is used to create a list of partners that is used to select the partner owner.

Create a partner owner: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/PartnerOwnerPicker
Delete a partner owner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/PartnerOwnerPicker/{deals_PartnerOwnerPicker_Id}
Get a partner owner: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/PartnerOwnerPicker
Get a partner owner: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/PartnerOwnerPicker/{deals_PartnerOwnerPicker_Id}
Update a partner owner: Method: patch
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/PartnerOwnerPicker/{deals_PartnerOwnerPicker_Id}

Deal Registrations/Product Groups

The product group resource is used to view information about related products. A product group is a business object that groups related products so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.

Get a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/productGroups/{ProdGroupId}
Get all product groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/productGroups
Set product group usag code - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/productGroups/action/setUsagCode
Set product group usage code - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/productGroups/action/setUsageCode
Set product group usage mode - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/productGroups/action/setUsageMode
Set territory filter user choice - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/productGroups/action/setUserSelectionForTM

Deal Registrations/Products

The product resource is used to view product information. A product is an item that an organization or company intends to sell.

Get a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/products/{productsUniqID}
Get all products: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/products
Set product usage code - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/products/action/setUsageCode
Set product usage mode - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/products/action/setUsageMode
Set territory filter user choice - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/products/action/setUserSelectionForTM
Set the user selected product group - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/products/action/setSelectedProductGroupId

Deal Registrations/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{deals_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/action/generateSmartActions
Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{deals_smartActions_Id}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/action/processMassAction

Deal Registrations/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{deals_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{deals_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{deals_smartActions_Id}/enclosure/ActionIntent

Deal Registrations/Smart Actions/Smart Action REST Path Parameter Definitions

Get all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{deals_smartActions_Id}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{deals_smartActions_Id}/child/UserActionURLBinding/{deals_smartActions_UserActionURLBinding_Id}

Deal Registrations/Smart Actions/Smart Action REST Payload Definitions

Get all action request payloads - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{deals_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{deals_smartActions_Id}/child/UserActionRequestPayload/{deals_smartActions_UserActionRequestPayload_Id}

Deal Registrations/Smart Actions/Smart Action User Interface Definitions

Get all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{deals_smartActions_Id}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{deals_smartActions_Id}/child/UserActionNavigation/{deals_smartActions_UserActionNavigation_Id}

Deleted Records

The deleted records resource is used to view all the records that were deleted either by transactions or by import.

Get a deleted record: Method: get
Path: /crmRestApi/resources/11.13.18.05/deletedRecords/{DeletedRecordId}
Get all deleted records: Method: get
Path: /crmRestApi/resources/11.13.18.05/deletedRecords

Device Tokens

The device token resource is used to create and update the tokens associated to the push notifications.

Create a device token: Method: post
Path: /crmRestApi/resources/11.13.18.05/deviceTokens
Delete a device token: Method: delete
Path: /crmRestApi/resources/11.13.18.05/deviceTokens/{DeviceTokenId}
Get a device token: Method: get
Path: /crmRestApi/resources/11.13.18.05/deviceTokens/{DeviceTokenId}
Get all device tokens: Method: get
Path: /crmRestApi/resources/11.13.18.05/deviceTokens
Update a device token: Method: patch
Path: /crmRestApi/resources/11.13.18.05/deviceTokens/{DeviceTokenId}

Dynamic Link Patterns

The dynamic link patterns resource is used to view, create, update, and delete the regular expressions used for parsing service request messages in order to determine various service request formats and transform them into hyperlinks.

Create a dynamic link pattern: Method: post
Path: /crmRestApi/resources/11.13.18.05/dynamicLinkPatterns
Delete a dynamic link pattern: Method: delete
Path: /crmRestApi/resources/11.13.18.05/dynamicLinkPatterns/{ObjectId}
Get a dynamic link pattern: Method: get
Path: /crmRestApi/resources/11.13.18.05/dynamicLinkPatterns/{ObjectId}
Get all dynamic link patterns: Method: get
Path: /crmRestApi/resources/11.13.18.05/dynamicLinkPatterns
Update a dynamic link pattern: Method: patch
Path: /crmRestApi/resources/11.13.18.05/dynamicLinkPatterns/{ObjectId}

Dynamic Link Values

The dynamic link values resource is used to view the dynamic link values of objects supporting dynamic links, such as article or service request.

Create a reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/dynamicLinkValues
Delete a reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/dynamicLinkValues/{dynamicLinkValuesUniqID}
Get a business unit: Method: get
Path: /crmRestApi/resources/11.13.18.05/dynamicLinkValues/{dynamicLinkValuesUniqID}
Get all business units: Method: get
Path: /crmRestApi/resources/11.13.18.05/dynamicLinkValues
Update a reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/dynamicLinkValues/{dynamicLinkValuesUniqID}

Email Footer Templates

An email footer enables the user to define a footer section for emails with information such as company name, place, and contact details. Footer templates help the user create different footers for specific use-cases and use them with email templates.

Create an email footer template: Method: post
Path: /crmRestApi/resources/11.13.18.05/emailFooterTemplates
Delete an email footer template: Method: delete
Path: /crmRestApi/resources/11.13.18.05/emailFooterTemplates/{TemplateNumber}
Get all email footer templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailFooterTemplates
Get an email footer template: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailFooterTemplates/{TemplateNumber}
Update an email footer template: Method: patch
Path: /crmRestApi/resources/11.13.18.05/emailFooterTemplates/{TemplateNumber}

Email Footer Templates/Large Object (LOB) Attributes - FooterContent

Delete a FooterContent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/emailFooterTemplates/{TemplateNumber}/enclosure/FooterContent
Get a FooterContent: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailFooterTemplates/{TemplateNumber}/enclosure/FooterContent
Replace a FooterContent: Method: put
Path: /crmRestApi/resources/11.13.18.05/emailFooterTemplates/{TemplateNumber}/enclosure/FooterContent

Email Templates

The email templates resource is used to view, create, update, delete, and toggle active status for message templates. Message templates can be used by salespeople and by automated processes in orchestrations.

Create an email template: Method: post
Path: /crmRestApi/resources/11.13.18.05/emailTemplates
Delete an email template: Method: delete
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}
Get all email templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates
Get an email template: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}
Get an email template with evaluated tokens: Method: post
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/action/getMergedEmailContent
Update an email template: Method: patch
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}

Email Templates/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/Attachments/{AttachmentsUniqID}

Email Templates/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Email Templates/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Email Templates/Email Template Translations

The email template translations resource is used to view, create, update, and delete the email template translations.

Create an email template translation: Method: post
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateTranslations
Delete an email template translation: Method: delete
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateTranslations/{EmailTemplateTranslationsUniqID}
Get all email template translations: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateTranslations
Get an email template translation: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateTranslations/{EmailTemplateTranslationsUniqID}
Update an email template translation: Method: patch
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateTranslations/{EmailTemplateTranslationsUniqID}

Email Templates/Email Template Translations/Large Object (LOB) Attributes - EmailBody

Delete an EmailBody: Method: delete
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateTranslations/{EmailTemplateTranslationsUniqID}/enclosure/EmailBody
Get an EmailBody: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateTranslations/{EmailTemplateTranslationsUniqID}/enclosure/EmailBody
Replace an EmailBody: Method: put
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateTranslations/{EmailTemplateTranslationsUniqID}/enclosure/EmailBody

Email Templates/Large Object (LOB) Attributes - EmailBody

Delete an EmailBody: Method: delete
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/enclosure/EmailBody
Get an EmailBody: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/enclosure/EmailBody
Replace an EmailBody: Method: put
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/enclosure/EmailBody

Email Verifications

The email verifications resource is used to view and create email verification. It is used to build integrations and automate workflows for verifying the email address.

Create an email verification: Method: post
Path: /crmRestApi/resources/11.13.18.05/emailVerification
Delete an email verification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/emailVerification/{Id}
Get all email verifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailVerification
Get an email verification: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailVerification/{Id}
Patch an email verification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/emailVerification/{Id}

Entitlements

The entitlements resource is used to view the subscription entitlement. The entitlements object has the details such as entitlement source, coverage name, covered product name.

Create a subscription entitlement: Method: post
Path: /crmRestApi/resources/11.13.18.05/entitlements
Get a subscription entitlement: Method: get
Path: /crmRestApi/resources/11.13.18.05/entitlements/{EntitlementsInputPuid}
Get all subscription entitlements: Method: get
Path: /crmRestApi/resources/11.13.18.05/entitlements

Entitlements/Entitlement Details

The entitlement details resource is used to view the subscription entitlement details. The entitlement details object has the details such as entitlement source, coverage name, entitlment matrix results.

Get a subscription entitlement detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/entitlements/{EntitlementsInputPuid}/child/entitlementDetails/{EntitlementsId}
Get all subscription entitlement details: Method: get
Path: /crmRestApi/resources/11.13.18.05/entitlements/{EntitlementsInputPuid}/child/entitlementDetails

Entitlements/Entitlement Details/Charge Adjustments

The charge adjustments resource is used to view the subscription entitlement charge adjustments. The charge adjustment object has the details such as service activity name, billing type, adjustment type, adjustment value.

Get a subscription coverage adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/entitlements/{EntitlementsInputPuid}/child/entitlementDetails/{EntitlementsId}/child/chargeAdjustments/{ChargeDiscountId}
Get all subscription coverage adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/entitlements/{EntitlementsInputPuid}/child/entitlementDetails/{EntitlementsId}/child/chargeAdjustments

Entitlements/Entitlement Details/Entitlement Results

The entitlement results resource is used to view the subscription entitlement results. The entitlement results object has the details such as schedule,matrix result.

Get a subscription entitlement result: Method: get
Path: /crmRestApi/resources/11.13.18.05/entitlements/{EntitlementsInputPuid}/child/entitlementDetails/{EntitlementsId}/child/entitlementResults/{EntitlementsResultId}
Get all subscription entitlement results: Method: get
Path: /crmRestApi/resources/11.13.18.05/entitlements/{EntitlementsInputPuid}/child/entitlementDetails/{EntitlementsId}/child/entitlementResults

Entitlements/Entitlement Details/Standard Coverages

The standard coverages resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.

Get a standard coverage: Method: get
Path: /crmRestApi/resources/11.13.18.05/entitlements/{EntitlementsInputPuid}/child/entitlementDetails/{EntitlementsId}/child/subscriptionCoverageHeader/{CoverageHeaderId}
Get all standard coverages: Method: get
Path: /crmRestApi/resources/11.13.18.05/entitlements/{EntitlementsInputPuid}/child/entitlementDetails/{EntitlementsId}/child/subscriptionCoverageHeader

Event Team Members

The automotive event team member resources lets you view, create, update, and delete team members associated with an automotive event.

Create an event team member: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoEventTeamMembers
Delete an event team member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoEventTeamMembers/{MemberNumber}
Get all event team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEventTeamMembers
Get an event team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEventTeamMembers/{MemberNumber}
Update an event team member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoEventTeamMembers/{MemberNumber}

Events

The automotive events resource lets you view, create, update, and delete automotive events.

Create an automotive event: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoEvents
Delete an automotive event: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}
Get all automotive event: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents
Get an automotive event: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}
Update an automotive event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}

Events/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/Attachments/{AttachmentsUniqID}

Events/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Events/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Events/Event Attendees

The automotive event team member resources lets you view, create, update, and delete attendees of an automotive event.

Create an automotive event attendee: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventAttendees
Delete an automotive event attendee: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventAttendees/{AttendeeNumber}
Get all automotive event attendees: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventAttendees
Get an automotive event attendee: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventAttendees/{AttendeeNumber}
Update an automotive event attendee: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventAttendees/{AttendeeNumber}

Events/Event Attendees/Event Feedback

The automotive event team member resources lets you view, create, update, and delete feedback from an automotive event.

Create an event attendee feedback: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventAttendees/{AttendeeNumber}/child/EventFeedbacks
Delete an event attendee feedback: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventAttendees/{AttendeeNumber}/child/EventFeedbacks/{FeedbackNumber}
Get all attendee feedback: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventAttendees/{AttendeeNumber}/child/EventFeedbacks
Get an event attendee feedback: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventAttendees/{AttendeeNumber}/child/EventFeedbacks/{FeedbackNumber}
Update an event attendee feedback: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventAttendees/{AttendeeNumber}/child/EventFeedbacks/{FeedbackNumber}

Events/Event Invitations

The automotive event team member resources lets you view, create, update, and delete invitations associated with an automotive event.

Create an event invitation: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventInvitations
Delete an event invitation: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventInvitations/{InvitationNumber}
Get all event invitations: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventInvitations
Get an event invitation: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventInvitations/{InvitationNumber}
Update an event invitation: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventInvitations/{InvitationNumber}

Events/Event Tasks

The automotive event team member resources lets you view, create, update, and delete tasks associated with an automotive event.

Create an event task: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventTasks
Delete an event task: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventTasks/{TaskNumber}
Get all event tasks: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventTasks
Get an event task: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventTasks/{TaskNumber}
Update an event task: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventTasks/{TaskNumber}

Export Activities

The export activities resource is used to view, create, and update large volumes of data. Bulk export can be used to export flat or hierarchical object data from target tables. The resource can also be used to export hierarchy trees with multiple levels.

Create a bulk export activity: Method: post
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities
Get a bulk export activity: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}
Get all bulk export activities: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities
Update a bulk export activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}

Export Activities/Export Attachments

The attachment resource is used to export attachments for an object.

Get all attachment details: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/Attachments
Get an attachment detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/Attachments/{AttachmentsUniqID}

Export Activities/Export Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Export Activities/Export Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Export Activities/Export Child Object Activities

The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.

Create a child bulk export activity: Method: post
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity
Get a bulk export activity child object detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity/{ExportObject}
Get all bulk export activity child object details: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity
Update a bulk export activity child object detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity/{ExportObject}

Export Activities/Export Child Object Activities/Export Child Object Activities

Create a child bulk export activity: Method: post
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity/{ExportObject}/child/childBulkExportActivity
Get a bulk export activity child object detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity/{ExportObject}/child/childBulkExportActivity/{ExportObject2}
Get all bulk export activity child object details: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity/{ExportObject}/child/childBulkExportActivity
Update a bulk export activity child object detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity/{ExportObject}/child/childBulkExportActivity/{ExportObject2}

Export Activities/Large Object (LOB) Attributes - Error Export File Contents

The contents of the attached export error file.

Get an Error Export File Contents: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/enclosure/ErrorReportFileContents

Export Activities/Large Object (LOB) Attributes - Export File Contents

The contents of the attached export file.

Get an Export File Contents: Method: get
Path: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/enclosure/ExportFileContents

Feed Configurations

The feed configurations resource is used to create, update, and delete feed configuration.

Clone Feed Configuration: Method: post
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/action/clone
Create a feed configuration: Method: post
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations
Delete a feed configuration: Method: delete
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}
Get a feed configuration: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}
Get all feed configurations: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations
Update a feed configuration: Method: patch
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}
Upgrade Feed Confguration: Method: post
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/action/upgrade

Feed Configurations/Feed Objects

The feed objects resource is used to create, update, and delete the objects of a feed configuration.

Create a feed object: Method: post
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject
Delete a feed object: Method: delete
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}
Get a feed object: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}
Get all feed objects: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject
Update a feed object: Method: patch
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}

Feed Configurations/Feed Objects/Feed Events

The feed events resource is used to create, update, and delete the events of the feed objects.

Create a feed event: Method: post
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent
Delete a feed event: Method: delete
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}
Get a feed event: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}
Get all feed events: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent
Update a feed event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}

Feed Configurations/Feed Objects/Feed Events/Feed Attributes

The feed attributes resource is used to create, update, and delete the attributes of the feed objects.

Create a feed attribute: Method: post
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/child/FeedAttr
Delete a feed attribute: Method: delete
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/child/FeedAttr/{FeedAttributeId}
Get a feed attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/child/FeedAttr/{FeedAttributeId}
Get all feed attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/child/FeedAttr
Update a feed attribute: Method: patch
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/child/FeedAttr/{FeedAttributeId}

Feed Configurations/Feed Objects/Feed Events/Feed Attributes/Large Object (LOB) Attributes - Feed Attribute Details

The CLOB that contains additional information of JSON.

Delete a Feed Attribute Details: Method: delete
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/child/FeedAttr/{FeedAttributeId}/enclosure/FeedAttrDetails
Get a Feed Attribute Details: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/child/FeedAttr/{FeedAttributeId}/enclosure/FeedAttrDetails
Replace a Feed Attribute Details: Method: put
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/child/FeedAttr/{FeedAttributeId}/enclosure/FeedAttrDetails

Feed Configurations/Feed Objects/Feed Events/Large Object (LOB) Attributes - Feed Event Details

This CLOB field contains additional information of JSON.

Delete a Feed Event Details: Method: delete
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/enclosure/FeedEventDetails
Get a Feed Event Details: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/enclosure/FeedEventDetails
Replace a Feed Event Details: Method: put
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/enclosure/FeedEventDetails

Feed Configurations/Feed Objects/Feed Attributes

The feed attributes resource is used to create, update, and delete the attributes of the feed objects.

Create a feed attribute: Method: post
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedAttr
Delete a feed attribute: Method: delete
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedAttr/{FeedAttributeId}
Get a feed attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedAttr/{FeedAttributeId}
Get all feed attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedAttr
Update a feed attribute: Method: patch
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedAttr/{FeedAttributeId}

Feed Configurations/Feed Objects/Feed Attributes/Large Object (LOB) Attributes - Feed Attribute Details

The CLOB that contains additional information of JSON.

Delete a Feed Attribute Details: Method: delete
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedAttr/{FeedAttributeId}/enclosure/FeedAttrDetails
Get a Feed Attribute Details: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedAttr/{FeedAttributeId}/enclosure/FeedAttrDetails
Replace a Feed Attribute Details: Method: put
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedAttr/{FeedAttributeId}/enclosure/FeedAttrDetails

Feed Configurations/Feed Objects/Feed Supported Attributes

The feed attributes LOV resource is used to view the LOVs for feed attributes.

Get a feed attributes LOV: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedSupportedAttributes/{AttributeName}
Get all feed attribute LOVs: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedSupportedAttributes

Feed Configurations/Feed Objects/Large Object (LOB) Attributes - Feed Object Details

This CLOB field contains the additional information of JSON.

Delete a Feed Object Details: Method: delete
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/enclosure/FeedObjectDetails
Get a Feed Object Details: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/enclosure/FeedObjectDetails
Replace a Feed Object Details: Method: put
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/enclosure/FeedObjectDetails

Feed Configurations/Feed Supported Attributes

The feed attributes LOV resource is used to view the LOVs for feed attributes.

Get a feed attributes LOV: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedSupportedAttributes/{AttributeName}
Get all feed attribute LOVs: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedSupportedAttributes

Feed Configurations/Feed Supported Objects

The feed objects LOV resource is used to view the LOVs for feed objects.

Get a feed object LOV: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedSupportedObjects/{Id}
Get all feed object LOVs: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedSupportedObjects

Field Groups

The field groups resource is used to view, create, update, and delete field groups. It's used to group fields of an object such as service requests.

Create a field group: Method: post
Path: /crmRestApi/resources/11.13.18.05/fieldGroups
Delete a field group: Method: delete
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}
Get a field group: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}
Get all field groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldGroups
Publish field security meta data: Method: post
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/action/publishFieldSecurityMetadata
Update a field group: Method: patch
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}

Field Groups/Field Group Fields

The field group fields resource is used to view, create, update, and delete fields from a field group. The field groups contain the fields that are part of the field group.

Create a field group field: Method: post
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}/child/fields
Delete a field group field: Method: delete
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}/child/fields/{FieldNumber}
Get a field group field: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}/child/fields/{FieldNumber}
Get all field group fields: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}/child/fields
Update a field group field: Method: patch
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}/child/fields/{FieldNumber}

Field Groups/Field Group Permissions

The field group permissions resource is used to view, create, update, and delete field group permissions. Field group permissions contain the association between field groups and access groups. It indicates members of which access group have access to a set of object fields.

Create a field group permission: Method: post
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}/child/permissions
Delete a field group permission: Method: delete
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}/child/permissions/{PermissionNumber}
Get a field group permission: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}/child/permissions/{PermissionNumber}
Get all field group permissions: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}/child/permissions
Update a field group permission: Method: patch
Path: /crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}/child/permissions/{PermissionNumber}

Field Service Connections

A field service connection is a configuration record used to hold information about the connections that are available.

Create a connection: Method: post
Path: /crmRestApi/resources/11.13.18.05/fieldServiceConnections
Delete a connection: Method: delete
Path: /crmRestApi/resources/11.13.18.05/fieldServiceConnections/{ConnectionCd}
Get a connection: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldServiceConnections/{ConnectionCd}
Get all connections: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldServiceConnections
Update a connection: Method: patch
Path: /crmRestApi/resources/11.13.18.05/fieldServiceConnections/{ConnectionCd}

Field Service Schedulers

A work order scheduler is defined in Service but populated from an API call to Oracle Field Service. It allows the scheduling of a technician in Oracle Field Service to a Service work order. The field service scheduler resource provides the configuration details about a scheduler including the name, description, scheduler type, quota values, and active status.

Create a scheduler: Method: post
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers
Delete a scheduler: Method: delete
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}
Get a scheduler: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}
Get all schedulers: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers
Update a scheduler: Method: patch
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}

Field Service Schedulers/Scheduler Filters

Scheduler filters identify the filter criteria that are being applied to the API call to Oracle Field Service to retrieve scheduling data. For example, the fitness formula values for work skill, work zone, and work time.

Create a scheduler filter: Method: post
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerFilters
Delete a scheduler filter: Method: delete
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerFilters/{SchedulerFilterId}
Get a scheduler filter: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerFilters/{SchedulerFilterId}
Get all scheduler filters: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerFilters
Update a scheduler filter: Method: patch
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerFilters/{SchedulerFilterId}

Field Service Schedulers/Scheduler Roles

Scheduler roles identify all the CRM and SCM job roles defined in IT Security Manager that have been assigned to a specific scheduler. The roles are used to determine which scheduler a user will see when scheduling a work order.

Create a scheduler role: Method: post
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerRoles
Delete a scheduler role: Method: delete
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerRoles/{SchedulerRoleId}
Get a scheduler role: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerRoles/{SchedulerRoleId}
Get all scheduler roles: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerRoles
Update a scheduler role: Method: patch
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/schedulerRoles/{SchedulerRoleId}

Field Service Schedulers/Scheduler Translations

Scheduler translations contain the translated scheduler configuration attributes such as the scheduler name and description. These are displayed to the user when viewing a scheduler.

Create a scheduler translation: Method: post
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/translations
Delete a scheduler translation: Method: delete
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/translations/{translationsUniqID}
Get a scheduler translation: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/translations/{translationsUniqID}
Get all scheduler translations: Method: get
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/translations
Update a scheduler translation: Method: patch
Path: /crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/translations/{translationsUniqID}

Forecasts

The forecasts resource is used to view and update a territory forecast. A territory forecast is the sum of the all the opportunity item sales that occurred in a territory in a specific time period.

Get a territory forecast: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}
Get all territory forecasts: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts
Update a territory forecast: Method: patch
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}

Forecasts/Adjustment Periods

The forecast adjustment periods resource is used to view and update the time period adjustment applied to a territory forecast.

Get a period adjustment for a forecast: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastAdjustmentPeriods/{FcstAdjustPeriodId}
Get all period adjustments for a forecast: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastAdjustmentPeriods
Update a period adjustment for a forecast: Method: patch
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastAdjustmentPeriods/{FcstAdjustPeriodId}

Forecasts/Forecast Items

The forecast items resource is used view and update the items associated with a forecast.

Get a forecast item: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/ForecastItemDetail/{ForecastItemDetailUniqID}
Get all forecast items: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/ForecastItemDetail
Update a forecast item: Method: patch
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/ForecastItemDetail/{ForecastItemDetailUniqID}

Forecasts/Forecast Products

The forecast products resource is used to view and update the products associated with a forecast. The forecast products resource displays forecasts categorized by product.

Get a forecast product: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastProducts/{FcstProductId}
Get all forecast products: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastProducts
Update a forecast product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastProducts/{FcstProductId}

Forecasts/Forecast Products/Product Adjustment Periods

The forecast product adjustment periods resource is used to view and update the time period adjustment applied to a forecast product.

Get a period adjustment for a forecast product: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastProducts/{FcstProductId}/child/forecastProductAdjustmentPeriods/{FcstAdjustPeriodId}
Get all period adjustments for a forecast product: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastProducts/{FcstProductId}/child/forecastProductAdjustmentPeriods
Update a period adjustment for a forecast product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastProducts/{FcstProductId}/child/forecastProductAdjustmentPeriods/{FcstAdjustPeriodId}

Forecasts/Revenue Items

The revenue items resource is used to view the revenue items that are not included in the forecast associated with a territory.

Get all unforecasted revenue items: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/unforecastedPipeline
Get an unforecasted revenue item: Method: get
Path: /crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/unforecastedPipeline/{unforecastedPipelineUniqID}

Geography Zones

The geography zones resource is used to view the zones related to a geography.

Get a geography zone: Method: get
Path: /crmRestApi/resources/11.13.18.05/geoZones/{ZoneId}
Get all geography zones: Method: get
Path: /crmRestApi/resources/11.13.18.05/geoZones

Goal Metric

Goal Metrics

Get a Goal Metric: Method: get
Path: /crmRestApi/resources/11.13.18.05/goalMetrics/{goalMetricsUniqID}
Get all Goal Metrics: Method: get
Path: /crmRestApi/resources/11.13.18.05/goalMetrics

Goal Metric/Goal Metric Breakdowns

The goal metric breakdown resource is used to view breakdowns for a goal metric.

Get a goal metric breakdown: Method: get
Path: /crmRestApi/resources/11.13.18.05/goalMetrics/{goalMetricsUniqID}/child/GoalMetricBreakdown/{GoalMetricBreakdownUniqID}
Get all goal metric breakdowns: Method: get
Path: /crmRestApi/resources/11.13.18.05/goalMetrics/{goalMetricsUniqID}/child/GoalMetricBreakdown

Goal Metric/Goal Metric Detail

Goal Metric Details

Get a Goal Metric Detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/goalMetrics/{goalMetricsUniqID}/child/GoalMetricDetails/{GoalMetricDetailsUniqID}
Get all Goal Metric Details: Method: get
Path: /crmRestApi/resources/11.13.18.05/goalMetrics/{goalMetricsUniqID}/child/GoalMetricDetails

Goals

Create a goal: Method: post
Path: /crmRestApi/resources/11.13.18.05/goals
Delete a goal: Method: delete
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}
Get a goal: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}
Get all goals: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals
Update a goal: Method: patch
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}

Goals/Goal History

Goal History

Create a goal history record: Method: post
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalHistory
Delete a goal history record: Method: delete
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalHistory/{GoalHistoryUniqID}
Get a goal history record: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalHistory/{GoalHistoryUniqID}
Get all goal history records: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalHistory
Update a goal history record: Method: patch
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalHistory/{GoalHistoryUniqID}

Goals/Goal Metric

Goal Metrics

Create a goal: Method: post
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics
Get a Goal Metric: Method: delete
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}
Get a Goal Metric: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}
Get a Goal Metric: Method: patch
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}
Get all Goal Metrics: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics

Goals/Goal Metric/Goal Metric Breakdowns

The goal metric breakdown resource is used to view breakdowns for a goal metric.

Create goal metric breakdowns: Method: post
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricBreakdown
Delete a goal metric breakdown record: Method: delete
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricBreakdown/{GoalMetricBreakdownUniqID}
Get a goal metric breakdown: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricBreakdown/{GoalMetricBreakdownUniqID}
Get a goal metric detail record: Method: patch
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricBreakdown/{GoalMetricBreakdownUniqID}
Get all goal metric breakdowns: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricBreakdown

Goals/Goal Metric/Goal Metric Detail

Goal Metric Details

Create a goal metric detail record: Method: post
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricDetails
Delete a goal metric detail record: Method: delete
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricDetails/{GoalMetricDetailsUniqID}
Get a Goal Metric Detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricDetails/{GoalMetricDetailsUniqID}
Get all Goal Metric Details: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricDetails
Update a goal metric detail record: Method: patch
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalMetrics/{GoalMetricsUniqID}/child/GoalMetricDetails/{GoalMetricDetailsUniqID}

Goals/Goal Participants

Goal Participants

Create a goal participant: Method: post
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalParticipants
Delete a goal participant: Method: delete
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalParticipants/{GoalParticipantId}
Get a goal participant: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalParticipants/{GoalParticipantId}
Get all goal participants: Method: get
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalParticipants
Update a goal participant: Method: patch
Path: /crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalParticipants/{GoalParticipantId}

HR Helpdesk Service Requests

The HR help desk service requests resource is used to view, create, update, and delete a request. It is a document to track a request for service from the time the person makes the request until the request is resolved. For example, an employee logs a service request that their last paycheck has not deposited.

copyAttachmentsToMessage: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/action/copyAttachmentsToMessage
Create a service request: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests
Create an attachment for an HR help desk request: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/action/copySRAttachments
Delete a service request: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}
Get a service request: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}
Get all service requests: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests
Get service request milestone diagnostics: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/action/processSrMilestones
Refresh service request milestones: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/action/getSrMilestoneDiagnostics
Send an email to SR message recipients: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/action/sendEmailForSrMessage
Update a service request: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}

HR Helpdesk Service Requests/Activities

The activities resource is used to view, create, update, and delete an activity.

Create activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/action/createActivitiesFromTemplate
Create an activity: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities
Create multiple activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/action/createMultipleActivitiesFromTemplate
Delete an activity: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}
Get all activities: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities
Get an activity: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}
Send notifications to resources: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/action/sendNotificationToResources
Update an activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}
Update an activity wrap up: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/action/updateActivityWrapup

HR Helpdesk Service Requests/Activities/Large Object (LOB) Attributes - ActivityDescription

Delete an ActivityDescription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityDescription
Get an ActivityDescription: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityDescription
Replace an ActivityDescription: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityDescription

HR Helpdesk Service Requests/Activities/Large Object (LOB) Attributes - ActivityMtgMinutes

Delete an ActivityMtgMinutes: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes
Get an ActivityMtgMinutes: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes
Replace an ActivityMtgMinutes: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes

HR Helpdesk Service Requests/Activities/Large Object (LOB) Attributes - WebConferenceDetails

Delete a WebConferenceDetails: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}/enclosure/WebConferenceDetails
Get a WebConferenceDetails: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}/enclosure/WebConferenceDetails
Replace a WebConferenceDetails: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}/enclosure/WebConferenceDetails

HR Helpdesk Service Requests/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}

HR Helpdesk Service Requests/Attachments/Attached Documents Descriptive Flexfield

The operations from the HR Helpdesk Service Requests/Attachments/Attached Documents Descriptive Flexfield category.

Create descriptive flexfield values for attached documents: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Get a descriptive flexfield value: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}
Get all descriptive flexfield values: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Update descriptive flexfield values for attached documents: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}

HR Helpdesk Service Requests/Attachments/Attachments Preview

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

HR Helpdesk Service Requests/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

HR Helpdesk Service Requests/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

HR Helpdesk Service Requests/Contact Members

The list of contacts associated to the serivce request.

Create a contact member: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/contacts
Delete a contact member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/contacts/{MemberId}
Get a contact member: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/contacts/{MemberId}
Get all contact members: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/contacts
Update a contact member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/contacts/{MemberId}

HR Helpdesk Service Requests/Interaction References

Indicates the list of interaction references for a service request.

Get a service request interaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srInteractionReferences/{ReferenceId}
Get all service request interactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srInteractionReferences

HR Helpdesk Service Requests/Interaction References/Large Object (LOB) Attributes - Payload

Delete a Payload: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload
Get a Payload: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload
Replace a Payload: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload

HR Helpdesk Service Requests/Messages

The list of service request messages.

Create a message: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages
Delete a message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}
Get a message: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}
Get all messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages
Update a message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}

HR Helpdesk Service Requests/Messages/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}

HR Helpdesk Service Requests/Messages/Attachments/Attached Documents Descriptive Flexfield

The operations from the HR Helpdesk Service Requests/Messages/Attachments/Attached Documents Descriptive Flexfield category.

Create descriptive flexfield values for attached documents: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Get a descriptive flexfield value: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}
Get all descriptive flexfield values: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Update descriptive flexfield values for attached documents: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}

HR Helpdesk Service Requests/Messages/Attachments/Attachments Preview

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

HR Helpdesk Service Requests/Messages/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

HR Helpdesk Service Requests/Messages/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

HR Helpdesk Service Requests/Messages/Large Object (LOB) Attributes - MessageContent

Delete a MessageContent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent
Get a MessageContent: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent
Replace a MessageContent: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent

HR Helpdesk Service Requests/Messages/Service Request Message Communications

The channel communications resource is used to view, create, update, and delete a channel communication. It's information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.

Create a channel communication record for an SR message: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication
Delete a channel communication record for an SR message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}
Get a channel communication record for an SR message: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}
Get all channel communication records for an SR message: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication
Update a channel communication record for an SR message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}

HR Helpdesk Service Requests/Milestones

Indicates the milestone associated with the service request.

Get a service request milestone: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srMilestone/{SrMilestoneId}
Get all service request milestones: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srMilestone
Update a service request milestone: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srMilestone/{SrMilestoneId}

HR Helpdesk Service Requests/Milestones/Milestones History

The list of changes in the service request milestone status.

Get a service request milestone history: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory/{HistoryId}
Get all service request milestone history: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory

HR Helpdesk Service Requests/References

The list of other objects associated to the service request. E.g. Knowledge articles.

Create a service request reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srReferences
Delete a service request reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srReferences/{ReferenceId}
Get a service request reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srReferences/{ReferenceId}
Get all service request references: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srReferences
Update a service request reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srReferences/{ReferenceId}

HR Helpdesk Service Requests/Resources

The list of resources associated to the service request.

Create a resource member: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/resourceMembers
Delete a resource member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/resourceMembers/{MemberId}
Get a resource member: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/resourceMembers/{MemberId}
Get all resource members: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/resourceMembers
Update a resource member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/resourceMembers/{MemberId}

HR Helpdesk Service Requests/Service Request Message Communications

The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.

Create a channel communication record for an SR: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/channelCommunication
Delete an SR channel communication record: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}
Get a channel communication record for an SR: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}
Get all channel communications records for an SR: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/channelCommunication
Update an SR channel communication record: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}

HR Helpdesk Service Requests/Smart Actions

This VO stores the endpoint and security details for every user action.

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/action/generateSmartActions
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/action/processMassAction

HR Helpdesk Service Requests/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/enclosure/ActionIntent

HR Helpdesk Service Requests/Smart Actions/Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionRequestPayload/{hrHelpDeskRequests_smartActions_UserActionRequestPayload_Id}

HR Helpdesk Service Requests/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionNavigation/{hrHelpDeskRequests_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionURLBinding/{hrHelpDeskRequests_smartActions_UserActionURLBinding_Id}

HR Helpdesk Service Requests/Tags

The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.

Create a tag: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srTags
Delete a tag: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srTags/{srTagsUniqID}
Get a tag: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srTags/{srTagsUniqID}
Get all tags: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srTags

Households

The household resource is used to view, create, update, and delete a household. A household is a party consisting of a collection of persons and organizations. A household, similar to a person or organization, can enter into a business relationship with other parties and can be assigned to opportunities and leads. A household can also have members of party type person or organization.

Create a household: Method: post
Path: /crmRestApi/resources/11.13.18.05/households
Delete a household: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}
Get a household: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}
Get all households: Method: get
Path: /crmRestApi/resources/11.13.18.05/households
Update a household: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}

Households/Additional Identifiers

The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.

Create an additional identifier: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalIdentifier
Delete an additional identifier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Get all additional identifiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalIdentifier
Get an additional identifier: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Update an additional identifier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}

Households/Additional Names

The additional name resource is used to view, create, update, and delete additional names associated with an account. You can use the resource to capture other names associated with an account, such as a maiden name, or a brand name.

Create an additional name: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalName
Delete an additional name: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalName/{NameId}
Get all additional names: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalName
Get an additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalName/{NameId}
Update an additional name: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalName/{NameId}

Households/Addresses

The addresses resource is used to view, create, update, and delete addresses of a household. An address contains the detailed location information of a household.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}

Households/Addresses/Address Locales

The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.

Create an address locale: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Delete an address locale: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Get all address locales: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Get an address locale: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Update an address locale: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}

Households/Addresses/Address Purposes

The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.

Create an address purpose: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose
Delete an address purpose: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}
Get all address purposes: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose
Get an address purpose: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}
Update an address purpose: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}

Households/Attachments

The attachments resource is used to view, create, update, and delete attachments of a household. An attachment includes additional information about a household.

Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Remove an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Replace an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Upload an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment

Households/Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Households/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Households/Aux Classifications

The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.

Create a customer classification: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/CustomerClassification
Delete a customer classification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get a customer classification: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get all customer classifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/CustomerClassification
Update a customer classification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}

Households/Contact Points

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/ContactPoint
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/ContactPoint
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/ContactPoint/{ContactPointId}

Households/Notes

The note resource is used to view, create, update, and delete notes associated with a household. A note captures comments, information, or instructions related to a household.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}

Households/Notes/Large Object (LOB) Attributes - Note Text

The column which will store the actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Households/Primary Addresses

The primary addresses resource is used to view, create, update, and delete the primary addresses of the households. A primary address is the default communication address of a household.

Create a primary address: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress
Delete a primary address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get a primary address: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get all primary addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress
Update a primary address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress/{AddressNumber}

Households/Relationships

The relationships resource is used to view, create, and update household relationships. A household relationship is the interconnection between parties, such as employee or board member.

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship/{RelationshipRecId}

Households/Sales Account Resources

Create a sales team member: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember
Delete a sales team member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get a sales team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get all sales team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember
Update a sales team member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}

Households/Source System References

The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.

Create a source system reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference
Delete a source system reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference
Update a source system reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}

Hub Organizations

The organizations resource is used to view, create, update, and delete an organization. An organization is an entity with whom you have a business relationship.

Create an organization: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations
Delete an organization: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}
Find duplicates: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/action/findDuplicates
Get all organizations: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations
Get an organization: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}
Promote the selected account in the duplicate set: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/action/promoteDuplicateParty
Update an organization: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}

Hub Organizations/Additional Identifiers

The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.

Create an additional identifier: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifier
Delete an additional identifier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Get all additional identifiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifier
Get an additional identifier: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Update an additional identifier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}

Hub Organizations/Additional Names

The additional names resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.

Create an additional name: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalName
Delete an additional name: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalName/{NameId}
Get all additional names: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalName
Get an additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalName/{NameId}
Update an additional name: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalName/{NameId}

Hub Organizations/Addresses

The addresses resource is used to view, create, update, and delete an address. It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Address
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Address/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Address
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Address/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Address/{AddressNumber}

Hub Organizations/Contact Points

The contact points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The Contactpoint describes the types of contact points. For example, phone, email, web etc.

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/ContactPoint
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/ContactPoint
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/ContactPoint/{ContactPointId}

Hub Organizations/Customer Classifications

The customer classifications resource is used to view, create, update, and delete a customer classification. It is an object that includes attributes used to store values while creating or updating a code assignment. A code assignment represents the classification category and classification code information of an account, contact, or household.

Create a customer classification: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification
Delete a customer classification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get a customer classification: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get all customer classifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification
Update a customer classification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}

Hub Organizations/Duplicate Parties

The duplicate parties resource is used to view, create, and delete all the duplicate parties for the given organization.

Create a duplicate party: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/DuplicateParty
Delete a duplicate party: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/DuplicateParty/{PartyNumber2}
Get a duplicate party: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/DuplicateParty/{PartyNumber2}
Get all duplicate parties: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/DuplicateParty
Update a linked party: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/DuplicateParty/{PartyNumber2}

Hub Organizations/Large Object (LOB) Attributes - D&B Business Report

The Dun & Bradstreet business information report.

Delete a D&B Business Report: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/enclosure/BusinessReport
Get a D&B Business Report: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/enclosure/BusinessReport
Replace a D&B Business Report: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/enclosure/BusinessReport

Hub Organizations/Linked Parties

The linked parties resource is used to view, create, and delete all the linked parties for the given organization.

Create a link party: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty
Delete a link party: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty/{LinkedPartyUniqID}
Get a link party: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty/{LinkedPartyUniqID}
Get all link parties: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty
Update a linked party: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty/{LinkedPartyUniqID}

Hub Organizations/Notes

The notes resource is used to view, create, update, and delete a note. It is a note data object that captures comments, information or instructions for an Oracle Fusion Applications business object.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}

Hub Organizations/Notes/Large Object (LOB) Attributes - NoteTxt

Delete a NoteTxt: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a NoteTxt: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Hub Organizations/Organization Attachments

The organization attachments resource is used to view, create, update, and delete attachments of an organization.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}

Hub Organizations/Organization Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Hub Organizations/Organization Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Hub Organizations/Party Usage Assignments

The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member.

Create a usage assignment: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/UsageAssignment
Delete a usage assignment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}
Get a usage assignment: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}
Get all usage assignments: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/UsageAssignment
Update a usage assignment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}

Hub Organizations/Relationships

The relationships resource is used to view, create, update, and delete a relationship. It is an object that includes attributes used to store values while creating or updating a relationship. This object stores attributes that define and categorizes a relationship between 2 entities such as account, contact and household.

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Relationship
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Relationship
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Relationship/{RelationshipRecId}

Hub Organizations/Smart Actions

This VO stores the endpoint and security details for every user action.

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/generateSmartActions
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/processMassAction

Hub Organizations/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/enclosure/ActionIntent

Hub Organizations/Smart Actions/Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionRequestPayload/{hubOrganizations_smartActions_UserActionRequestPayload_Id}

Hub Organizations/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionNavigation/{hubOrganizations_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionURLBinding/{hubOrganizations_smartActions_UserActionURLBinding_Id}

Hub Organizations/Source System References

The source system references resource is used to view, create, update, and delete a source system reference. It is an external system from which data can be imported into the trading community registry.

Create a source system reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReference
Delete a source system reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReference
Update a source system reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}

Hub Persons

The hub person resource is used to view, create, update, and delete person. An person is an entity with whom you have a business relationship.

Create a person: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons
Delete a person: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}
Find duplicates: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/action/findDuplicates
Get a person: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}
Get all persons: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons
Update a person: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}

Hub Persons/Additional Identifiers

The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.

Create an additional identifier: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalIdentifier
Delete an additional identifier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Get all additional identifiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalIdentifier
Get an additional identifier: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Update an additional identifier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}

Hub Persons/Additional Names

The additional name resource is used to view, create, update, and delete additional names associated with a person. The resource allows you to capture other names associated with a person such as a maiden name, or a brand name.

Create an additional name: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalName
Delete an additional name: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalName/{NameId}
Get all additional names: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalName
Get an additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalName/{NameId}
Update an additional name: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalName/{NameId}

Hub Persons/Addresses

The addresses resource is used to view, create, update, and delete an address, It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Address
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Address/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Address
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Address/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Address/{AddressNumber}

Hub Persons/Attachments

The person attachments resource is used to view, create, update, and delete attachments of a person.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}

Hub Persons/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Hub Persons/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Hub Persons/Contact Points

The contact points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The contact point describes the types of contact points. For example, phone, email, or web.

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/ContactPoint
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/ContactPoint
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/ContactPoint/{ContactPointId}

Hub Persons/Customer Classifications

Create a customer classification: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/CustomerClassification
Delete a customer classification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get a customer classification: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get all customer classifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/CustomerClassification
Update a customer classification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}

Hub Persons/Notes

The notes resource is used to view, create, update, and delete a note. A note data object captures comments, information, or instructions for an Oracle Fusion Applications business object.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}

Hub Persons/Notes/Large Object (LOB) Attributes - NoteTxt

Delete a NoteTxt: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a NoteTxt: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Hub Persons/Relationships

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Relationship
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Relationship
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Relationship/{RelationshipRecId}

Hub Persons/Source System References

Create a source system reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/SourceSystemReference
Delete a source system reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/SourceSystemReference
Update a source system reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}

Hub Persons/Usage Assignments

The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member.

Create a usage assignment: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/UsageAssignment
Delete a usage assignment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}
Get a usage assignment: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}
Get all usage assignments: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/UsageAssignment
Update a usage assignment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}

Import Activities

The import activities resource is used to view, create, and update data from a flat file into object related tables in the target database.

Create a file import activity: Method: post
Path: /crmRestApi/resources/11.13.18.05/importActivities
Get a file import activity: Method: get
Path: /crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}
Get all file import activities: Method: get
Path: /crmRestApi/resources/11.13.18.05/importActivities
Update a file import activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}

Import Activities/Import Activity Data Files

The import activity data files resource is used to view and create the data files that contain the information that is to be imported.

Create a file import activity data file: Method: post
Path: /crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}/child/DataFiles
Get a file import activity data file: Method: get
Path: /crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}/child/DataFiles/{InputFileContentId}
Get all file import activity data files: Method: get
Path: /crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}/child/DataFiles

Import Activity Maps

The import activity maps resource is used to view, create, update, and delete a file import map which can be used for a file-based import activity.

Create a file import map: Method: post
Path: /crmRestApi/resources/11.13.18.05/importMappings
Delete a file import map: Method: delete
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}
Get a file import map: Method: get
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}
Get all file import maps: Method: get
Path: /crmRestApi/resources/11.13.18.05/importMappings
Update a file import map: Method: patch
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}

Import Activity Maps/Import Activity Map Columns

The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.

Create a file import map column: Method: post
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns
Delete a file import map column: Method: delete
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns/{MappingColumnNumber}
Get a file import map column: Method: get
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns/{MappingColumnNumber}
Get all file import map columns: Method: get
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns
Update a file import map column: Method: patch
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns/{MappingColumnNumber}

Import Export Objects Metadata

The import export object metadata resource is used to view the objects which support for file-based import and export.

Get a file import and export object: Method: get
Path: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata/{ObjectCode}
Get all file import and export objects: Method: get
Path: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata

Import Export Objects Metadata/Import Export Object Attributes

The import export object attributes resource is used to view the attributes of a specific object which support for file-based import and export.

Get a file import and export object attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata/{ObjectCode}/child/ObjectAttributes/{AttributeCode}
Get all file import and export object attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata/{ObjectCode}/child/ObjectAttributes

Import Export Objects Metadata/Large Object (LOB) Attributes - DownloadTemplate

Get a DownloadTemplate: Method: get
Path: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata/{ObjectCode}/enclosure/DownloadTemplate

Inbound Message Filters

The inbound message filter resource is used to view, create, and update the filters setup by the administrator to accept or reject inbound messages. For example, you can create a filter to reject messages from a specific domain.

Create an inbound message filter: Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMsgFilters
Delete an inbound message filter: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMsgFilters/{FilterId}
Get all inbound message filters: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMsgFilters
Get an inbound message filter: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMsgFilters/{FilterId}
Update an inbound message filter: Method: patch
Path: /crmRestApi/resources/11.13.18.05/inboundMsgFilters/{FilterId}

Inbound Messages

The inbound messages resource is used to create, process, view, update, and replace a list of inbound messages received from customers, that need a response. For example, a message indicating that a customer's mobile camera is not functional.

Delete an inbound message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}
Get all inbound messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages
Get an inbound message: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}
Process an unprocessed inbound message: Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMessages
Process inbound messages: Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/action/processInboundMessageList
Update an inbound message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}

Inbound Messages/Attachments

The attachments resource is used to create, view, update, and delete the list of files sent as attachments with the inbound messages. For example, a document with a screenshot of an error message.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}

Inbound Messages/Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Inbound Messages/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Inbound Messages/Inbound Message Parts

The inbound message parts resource is used to create, view, update, and delete the list of components of an inbound message, such as From, To, CC, and Importance.

Create an inbound message part: Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts
Delete an inbound message part: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts/{InboundMsgPartId}
Get all inbound message parts: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts
Get an inbound message part: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts/{InboundMsgPartId}
Update an inbound message part: Method: patch
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts/{InboundMsgPartId}

Inbound Messages/Large Object (LOB) Attributes - Body

The content of the inbound message.

Delete a Body: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/Body
Delete a Body: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/PlainTextBody
Get a Body: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/Body
Get a Body: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/PlainTextBody
Replace a Body: Method: put
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/Body
Replace a Body: Method: put
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/PlainTextBody

Incentive Compensation Credit Details

The incentive compensation credit details resource is used to view the details of the participant's credits.

Get a credit detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCreditDetails/{CreditId}
Get all credit details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCreditDetails

Incentive Compensation Earnings

The incentive compensation earnings resource is used to view the details of the participant earnings for a transaction, or a pay period. Incentive compensation earnings store the earnings amount, the compensation plan, and the plan component for which it was earned.

Get all earnings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEarnings
Get an earning: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEarnings/{EarningId}

Incentive Compensation Expressions

The incentive compensation expressions resource is used to view, create, update, and delete an expression. It can also be used to display all the details of an expression. An expression is used to calculate the attainment using the measure formula, the earning using the incentive formula, the 'from' and 'to' tiers of an expression type rate dimension, or the input to a rate table. A new expression can be created either with multiple expression details or individually with only one expression, and associate the expression details later.

Create an expression: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions
Delete an expression: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}
Get all expressions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions
Get an expression: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}
Update an expression: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}

Incentive Compensation Expressions/Expression Details

The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component. If a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.

Create an expression detail: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails
Delete an expression detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails/{ExpressionDetailId}
Get all expression details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails
Get an expression detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails/{ExpressionDetailId}
Update an expression detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails/{ExpressionDetailId}

Incentive Compensation Expressions/Expression Usages

The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.

Get all expression usages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionUsages
Get an expression usage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionUsages/{ExpressionUsageId}

Incentive Compensation Expressions/Large Object (LOB) Attributes - Expression

Get an Expression: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/enclosure/Expression

Incentive Compensation Rule Hierarchies

The rule hierarchies resource is used for direct crediting, classification, rollup crediting, team crediting, participant role assignment, and analyst approvals. Rule hierarchies are set of rules arranged in hierarchical fashion, where a child rule inherits the criterion of the parent rule. Rule hierarchies are created and managed for each rule type such as crediting, classification, or rollup.

Create a rule hierarchy: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies
Delete a rule hierarchy: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}
Get a rule hierarchy: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}
Get all rule hierarchies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies
Update a rule hierarchy: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}

Incentive Compensation Rule Hierarchies/Qualifying Criteria

The qualifying criteria resource is used create and view how the transactions are matched for classification and credit processing. Use the Configure Tables and Columns task in the Setup and Maintenance work area to enable application table columns for use as qualifying criteria attributes in classification, direct credit, and participant assignment rules. You can also define your own qualifiers based on a descriptive flex field.

Create a qualifying criterion: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria
Delete a qualifying criterion: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}
Get a qualifying criterion: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}
Get all qualifying criteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria
Update a qualifying criterion: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}

Incentive Compensation Rule Hierarchies/Qualifying Criteria/Qualifying Attribute Values

The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.

Create a qualifying attribute value: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues
Delete a qualifying attribute value: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues/{RuleAttributeValueId}
Get a qualifying attribute value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues/{RuleAttributeValueId}
Get all qualifying attribute values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues
Update a qualifying attribute value: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues/{RuleAttributeValueId}

Incentive Compensation Rule Hierarchies/Rule Assignments

The rule assignments resource is used create, view, update, or delete the receiver of the credits, for a matching transaction, when a rule wins. Classification adds credit categories to matching transactions, and Participant role assignment rules assign eligible roles to matching participants. The rule assignments for Rollup and Team rules are used to create indirect credits.

Create a rule assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments
Delete a rule assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments/{RuleAssignmentId}
Get a rule assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments/{RuleAssignmentId}
Get all rule assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments
Update a rule assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments/{RuleAssignmentId}

Incentive Compensation Rule Hierarchies/Rules

The rules resource is used to create, view, update, or delete the child nodes for the rule hierarchy. The rules form the building blocks of a rule hierarchy and are date effective.

Create a rule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules
Delete a rule and all its child rules: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules/{RuleId2}
Get a rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules/{RuleId2}
Get all rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules
Update a rule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules/{RuleId2}

Incentive Compensation Summarized Credits

The incentive compensation summarized credits resource is used to view summarized credit amount for a participant within the interval selected under calendar period type.

Get a credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedCredits/{incentiveCompensationSummarizedCreditsUniqID}
Get all credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedCredits

Incentive Compensation Summarized Earnings

The incentive compensation summarized earnings resource is used to view the summarized earnings for a compensation plan, plan component, and pay period by the participant and participant managers. Participant managers may also review the summarized earnings information for direct reports in their management hierarchy. In addition to total earnings amounts, this resource returns the total input achieved, total output achieved, and total transaction amount.

Get a summarized earning: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedEarnings/{incentiveCompensationSummarizedEarningsUniqID}
Get all summarized earnings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedEarnings

Incentive Compensation Summarized Earnings Per Intervals

The incentive compensation summarized earnings per intervals resource is used to view summarized earnings amount for a participant within the interval selected under calendar period type.

Get all earnings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedEarningsPerInterval
Get an earning: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedEarningsPerInterval/{incentiveCompensationSummarizedEarningsPerIntervalUniqID}

Incentive Compensation Summarized Team Credits

The incentive compensation summarized team credits resource used to view the summarized team credits. It stores summarized credit amount for the first level directs under a participant manager within the interval selected under calendar period type.

Get a credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedTeamCredits/{incentiveCompensationSummarizedTeamCreditsUniqID}
Get all credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedTeamCredits

Incentive Compensation Transactions

The incentive compensation transactions resource is used to view, create, and update transactions, such as order, invoice, and so on.

Create a transaction: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions
Get a transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}
Get all transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions
Update a transaction: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}

Incentive Compensation Transactions/Credits

The credits resource is used to view, create, and update the credits for a transaction.

Create a credit: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits
Get a credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits/{CreditId}
Get all credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits
Update a credit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits/{CreditId}

Incentive Compensation Transactions/Transaction Descriptive Flex Fields

The transaction descriptive flex fields resource is used to view, create, and update additional attributes of the transaction that are used for classification, crediting, calculating, and reporting.

Create a transaction descriptive flex field: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF
Get a transaction descriptive flex field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF/{TransactionId2}
Get all transactions descriptive flex field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF
Update a transaction descriptive flex field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF/{TransactionId2}

Integration Instances v1

Integration instances represent the details of specific records integrated between Sales and other Oracle applications, such as routine identifier, status, integration payload, and integration map identifier.

Advanced query all integration instances: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/$query
Advanced query an integration instance: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}/$query
Create an integration instance: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances
Get all integration instances: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances
Get an integration instance: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}

Integration Instances v1/Integration Details v1

Integration details include information about an integration instance such as the integration level, inbound payload, outbound payload, and step name.

Advanced query all integration instance details: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}/integrationDetails/$query
Advanced query an integration instance detail: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}/integrationDetails/{integrationInstances-integrationDetails_id}/$query
Get all integration details: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}/integrationDetails
Get an integration detail: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}/integrationDetails/{integrationInstances-integrationDetails_id}

Integration Maps v1

Integration maps describe the attribute mappings between objects in Sales and objects in other Oracle applications. The integration process uses these mappings to determine the attributes that need to be synchronized from Sales to the other applications.

Advanced query all integration maps: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/$query
Advanced query an integration map: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/{integrationMaps_id}/$query
Create an integration map: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps
Get all integration maps: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps
Get an integration map: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/{integrationMaps_id}
Update an integration map: Method: patch
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/{integrationMaps_id}

Intelligence Onboarding Data Sufficiency Jobs

The intelligence onboarding jobs resources lets you view and add data sufficiency check jobs.

Create a job: Method: post
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs
Delete a job: Method: delete
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}
Get a job: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}
Get all jobs: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs
Update a job: Method: patch
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}

Intelligence Onboarding Data Sufficiency Jobs/Feature Data Sufficiency Reports

The intelligence onboarding reports resources lets you view and add data sufficiency check reports.

Create a report: Method: post
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}/child/JobSelectedFeatures
Delete a report: Method: delete
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}/child/JobSelectedFeatures/{DataSufficiencyReportId}
Get a report: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}/child/JobSelectedFeatures/{DataSufficiencyReportId}
Get all reports: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}/child/JobSelectedFeatures
Update a report: Method: patch
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}/child/JobSelectedFeatures/{DataSufficiencyReportId}

Intelligence in Sales Features

The intelligence feature resource lets you view and add the features.

Get a feature: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}
Get all features: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures
Update a feature: Method: patch
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}

Intelligence in Sales Features/Feature Data Sufficiency Reports

The intelligence onboarding reports resources lets you view and add data sufficiency check reports.

Create a report: Method: post
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/DatasufficiencyReports
Delete a report: Method: delete
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/DatasufficiencyReports/{DataSufficiencyReportId}
Get a report: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/DatasufficiencyReports/{DataSufficiencyReportId}
Get all reports: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/DatasufficiencyReports
Update a report: Method: patch
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/DatasufficiencyReports/{DataSufficiencyReportId}

Intelligence in Sales Features/Intelligence in Sales Feature Rules

The intelligence feature rules resource lets you view and add the feature rules.

Create a feature rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/FeatureRules
Delete a feature rule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/FeatureRules/{FeatureRuleId}
Get a feature rule: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/FeatureRules/{FeatureRuleId}
Get all feature rules: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/FeatureRules
Update a feature rule: Method: patch
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/FeatureRules/{FeatureRuleId}

Interactions

The interaction resource is used to view, create, and update the interactions between a customer and an agent.

Create an interaction and interaction reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions
Delete an interaction: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}
Get all interactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions
Get an interaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}
Update an interaction: Method: patch
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}

Interactions/Child Interactions

The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.

Create a child interaction and interaction reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions
Delete an interaction: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}
Get a child interaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}
Get all child interactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions
Update a child interaction: Method: patch
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}

Interactions/Child Interactions/Large Object (LOB) Attributes - Payload

The payload associated with the interaction.

Delete a Payload: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}/enclosure/Payload
Get a Payload: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}/enclosure/Payload
Replace a Payload: Method: put
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}/enclosure/Payload

Interactions/Interaction Participants

The interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference.

Create an interaction participant: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants
Delete an interaction participant: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}
Get all interaction participants: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants
Get an interaction participant: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}
Update an interaction participant: Method: patch
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}

Interactions/Interaction Participants/Large Object (LOB) Attributes - Json

Delete a Json: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}/enclosure/Json
Get a Json: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}/enclosure/Json
Replace a Json: Method: put
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}/enclosure/Json

Interactions/Interaction References

The interaction references resource is used to view, create, and update the association between an interaction and another business object, for example Service Requests. The supported business objects and their codes are Activities (ZMM_ACTIVITIES), Opportunities (MOO_OPTY), Work Orders (SVC_WORK_ORDERS), Service Requests (SVC_SERVICE_REQUESTS), and Leads (MKL_LM_LEADS).

Create an interaction reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences
Delete an interaction reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences/{interactions_interactionReferences_Id}
Get all interaction references: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences
Get an interaction reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences/{interactions_interactionReferences_Id}
Update an interaction reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences/{interactions_interactionReferences_Id}

Interactions/Large Object (LOB) Attributes - Payload

The payload associated with the interaction.

Delete a Payload: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/enclosure/Payload
Get a Payload: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/enclosure/Payload
Replace a Payload: Method: put
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/enclosure/Payload

Interactions/Smart Actions

This VO stores the endpoint and security details for every user action.

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/generateSmartActions
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/processMassAction

Interactions/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/enclosure/ActionIntent

Interactions/Smart Actions/Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionRequestPayload/{interactions_smartActions_UserActionRequestPayload_Id}

Interactions/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionNavigation/{interactions_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionURLBinding/{interactions_smartActions_UserActionURLBinding_Id}

Internal Service Requests

copyAttachmentsToMessage: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/action/copyAttachmentsToMessage
Create a service request: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests
Create an attachment for an internal service request: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/action/copySRAttachments
Delete a service request: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}
Get a service request: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}
Get all service requests: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests
Get service request milestone diagnostics: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/action/processSrMilestones
Refresh service request milestones: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/action/getSrMilestoneDiagnostics
Send an email to SR message recipients: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/action/sendEmailForSrMessage
Update a service request: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}

Internal Service Requests/Activities

The activities resource is used to view, create, update, and delete an activity.

Create activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/action/createActivitiesFromTemplate
Create an activity: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities
Create multiple activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/action/createMultipleActivitiesFromTemplate
Delete an activity: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}
Get all activities: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities
Get an activity: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}
Send notifications to resources: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/action/sendNotificationToResources
Update an activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}
Update an activity wrap up: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/action/updateActivityWrapup

Internal Service Requests/Activities/Large Object (LOB) Attributes - ActivityDescription

Delete an ActivityDescription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityDescription
Get an ActivityDescription: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityDescription
Replace an ActivityDescription: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityDescription

Internal Service Requests/Activities/Large Object (LOB) Attributes - ActivityMtgMinutes

Delete an ActivityMtgMinutes: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes
Get an ActivityMtgMinutes: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes
Replace an ActivityMtgMinutes: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes

Internal Service Requests/Activities/Large Object (LOB) Attributes - WebConferenceDetails

Delete a WebConferenceDetails: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/WebConferenceDetails
Get a WebConferenceDetails: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/WebConferenceDetails
Replace a WebConferenceDetails: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/WebConferenceDetails

Internal Service Requests/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}

Internal Service Requests/Attachments/Attached Documents Descriptive Flexfield

The operations from the Internal Service Requests/Attachments/Attached Documents Descriptive Flexfield category.

Create descriptive flexfield values for attached documents: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Get a descriptive flexfield value: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}
Get all descriptive flexfield values: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Update descriptive flexfield values for attached documents: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}

Internal Service Requests/Attachments/Attachments Preview

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

Internal Service Requests/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Internal Service Requests/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Internal Service Requests/Contact Members

The list of contacts associated to the serivce request.

Create a contact member: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts
Delete a contact member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts/{MemberId}
Get a contact member: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts/{MemberId}
Get all contact members: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts
Update a contact member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts/{MemberId}

Internal Service Requests/Interaction References

Indicates the list of interaction references for a service request.

Get a service request interaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences/{ReferenceId}
Get all service request interactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences

Internal Service Requests/Interaction References/Large Object (LOB) Attributes - Payload

Delete a Payload: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload
Get a Payload: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload
Replace a Payload: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload

Internal Service Requests/Messages

The list of service request messages.

Create a message: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages
Delete a message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}
Get a message: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}
Get all messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages
Update a message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}

Internal Service Requests/Messages/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}

Internal Service Requests/Messages/Attachments/Attached Documents Descriptive Flexfield

The operations from the Internal Service Requests/Messages/Attachments/Attached Documents Descriptive Flexfield category.

Create descriptive flexfield values for attached documents: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Get a descriptive flexfield value: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}
Get all descriptive flexfield values: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Update descriptive flexfield values for attached documents: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}

Internal Service Requests/Messages/Attachments/Attachments Preview

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

Internal Service Requests/Messages/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Internal Service Requests/Messages/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Internal Service Requests/Messages/Large Object (LOB) Attributes - MessageContent

Delete a MessageContent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent
Get a MessageContent: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent
Replace a MessageContent: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent

Internal Service Requests/Messages/Service Request Communications

Create a channel communication record for an SR message: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication
Delete a channel communication record for an SR message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}
Get a channel communication record for an SR message: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}
Get all channel communication records for an SR message: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication
Update a channel communication record for an SR message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}

Internal Service Requests/Milestones

Indicates the milestone associated with the service request.

Get a service request milestone: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}
Get all service request milestones: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone
Update a service request milestone: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}

Internal Service Requests/Milestones/Milestones History

The list of changes in the service request milestone status.

Get a service request milestone history: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory/{HistoryId}
Get all service request milestone history: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory

Internal Service Requests/References

The list of other objects associated to the service request. E.g. Knowledge articles.

Create a service request reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences
Delete a service request reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences/{ReferenceId}
Get a service request reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences/{ReferenceId}
Get all service request references: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences
Update a service request reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences/{ReferenceId}

Internal Service Requests/Resources

The list of resources associated to the service request.

Create a resource member: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/resourceMembers
Delete a resource member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/resourceMembers/{MemberId}
Get a resource member: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/resourceMembers/{MemberId}
Get all resource members: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/resourceMembers
Update a resource member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/resourceMembers/{MemberId}

Internal Service Requests/Service Request Communications

Create a channel communication record for an SR: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication
Delete an SR channel communication record: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}
Get a channel communication record for an SR: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}
Get all channel communications records for an SR: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication
Update an SR channel communication record: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}

Internal Service Requests/Smart Actions

This VO stores the endpoint and security details for every user action.

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/generateSmartActions
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/processMassAction

Internal Service Requests/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/enclosure/ActionIntent

Internal Service Requests/Smart Actions/Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionRequestPayload/{internalServiceRequests_smartActions_UserActionRequestPayload_Id}

Internal Service Requests/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionNavigation/{internalServiceRequests_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionURLBinding/{internalServiceRequests_smartActions_UserActionURLBinding_Id}

Internal Service Requests/Tags

The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.

Create a tag: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srTags
Delete a tag: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srTags/{srTagsUniqID}
Get a tag: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srTags/{srTagsUniqID}
Get all tags: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srTags

KPI

Create a KPI: Method: post
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators
Delete a KPI: Method: delete
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}
Get a KPI: Method: get
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}
Get all KPIs: Method: get
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators
Update a KPI: Method: patch
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}

KPI/KPI History Metadata

The KPI history metadata resource is used to view, create, update, and delete a KPI history metadata.

Create a KPI history metadata: Method: post
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/KPIHistoryMetadata
Delete a KPI history metadata: Method: delete
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/KPIHistoryMetadata/{KPIEventId}
Get a KPI history metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/KPIHistoryMetadata/{KPIEventId}
Get all KPI history metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/KPIHistoryMetadata
Update a KPI history metadata: Method: patch
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/KPIHistoryMetadata/{KPIEventId}

Lightbox Documents

The Lightbox document resource is used to view, create, update, and delete documents in the Lightbox content library, such as slide decks, web-based content, and so on.

Create a Lightbox document: Method: post
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments
Delete a Lightbox document: Method: delete
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}
Get a Lightbox document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}
Get all Lightbox documents: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments
Update a Lightbox document: Method: patch
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}

Lightbox Documents/Document-Viewed-Within-Lightbox Signals

The resource is used to view the signals that the document is viewed within Lightbox.

Get a document-viewed-within-Lightbox signal for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedInLightboxSignals/{documentViewedInLightboxSignalsUniqID}
Get all document-viewed-within-Lightbox signals for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedInLightboxSignals

Lightbox Documents/Document-shared-with-user Signals

The resource is used to view the signals captured when a document is shared with a user.

Get a document-shared-with-user signal for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentSharedToUserSignals/{documentSharedToUserSignalsUniqID}
Get all document-shared-with-user signals for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentSharedToUserSignals

Lightbox Documents/Document-unshared-with-user Signals

The resource is used to view the signals captured when a document share with a user is deleted.

Get a document-unshared-with-user signal for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentUnsharedFromUserSignals/{documentUnsharedFromUserSignalsUniqID}
Get all document-unshared-with-user signals for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentUnsharedFromUserSignals

Lightbox Documents/Document-viewed-outside-Lightbox Signals

The resource is used to view and create the signals captured when document is viewed by a process outside Lightbox.

Create a document-viewed-outside-Lightbox signal for a document: Method: post
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedOutsideLightboxSignals
Get a document-viewed-outside-Lightbox signal for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedOutsideLightboxSignals/{documentViewedOutsideLightboxSignalsUniqID}
Get all document-viewed-outside-Lightbox signals for document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedOutsideLightboxSignals

Lightbox Documents/Large Object (LOB) Attributes - DocumentContents

The field used to upload and download the document through services.

Delete a DocumentContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/enclosure/DocumentContents
Get a DocumentContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/enclosure/DocumentContents
Replace a DocumentContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/enclosure/DocumentContents

Lightbox Documents/Large Object (LOB) Attributes - Thumbnail

The field used to get the document thumbnail through services.

Get a Thumbnail: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/enclosure/Thumbnail

Lightbox Documents/Lightbox Document Pages

The Lightbox document page resource is used to view and update the pages within a Lightbox document.

Get a Lightbox document page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}
Get all Lightbox document pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages
Update a Lightbox document page: Method: patch
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}

Lightbox Documents/Lightbox Document Pages/Downloaded-from-cart Signals

The resource is used to view the signals captured when pages within a cart are downloaded by the user.

Get a downloaded-from-cart signal for a page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageDownloadedInCartSignals/{pageDownloadedInCartSignalsUniqID}
Get all downloaded-from-cart signals for a page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageDownloadedInCartSignals

Lightbox Documents/Lightbox Document Pages/Large Object (LOB) Attributes - Page Thumbnail

The field used to get the page thumbnail through services.

Get a Page Thumbnail: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/enclosure/PageThumbnail

Lightbox Documents/Lightbox Document Pages/Page-added-to-cart Signals

The resource is used to view the signals captured when pages of a document are added to cart.

Get a page-added-to-cart signal for a page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageAddedToCartSignals/{pageAddedToCartSignalsUniqID}
Get all page-added-to-cart signals for pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageAddedToCartSignals

Lightbox Documents/Lightbox Document Pages/Page-viewed-outside-Lightbox Signals

The resource is used to view and create signals that a Lightbox document's pages are viewed outside Lightbox.

Create a page-viewed-outside-Lightbox signal for a page: Method: post
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageViewedOutsideLightboxSignals
Get a page-viewed-outside-Lightbox signal for a page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageViewedOutsideLightboxSignals/{pageViewedOutsideLightboxSignalsUniqID}
Get all page-viewed-outside-Lightbox signals for a page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageViewedOutsideLightboxSignals

Lightbox Documents/Lightbox Scoring Signals

The resource is used to view the signals captured when a document is downloaded.

Get a signal for a downloaded document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentDownloadSignals/{documentDownloadSignalsUniqID}
Get all signals for downloaded documents: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentDownloadSignals

Lightbox Documents/Shared-person Instances

The shared person resource is used to view, create, and delete document shares. A document share lets you share the Lightbox document with another user.

Create a shared-person instance for a document: Method: post
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/sharedPersons
Delete a shared-person instance for a document: Method: delete
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/sharedPersons/{sharedPersonsUniqID}
Get a shared-person instance for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/sharedPersons/{sharedPersonsUniqID}
Get all shared-person instances for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/sharedPersons

Lightbox Presentation Session Feedback

The lightbox presentation session feedback resource is used to view, create, update, and delete the ratings and comments from the attendees at a Lightbox presentation session. The feedback may apply to an individual Lightbox document page or to an overall Lightbox document presented during a presentation session.

Create a lightbox presentation session feedback item: Method: post
Path: /crmRestApi/resources/11.13.18.05/presentationSessionFeedback
Delete a lightbox presentation session feedback item: Method: delete
Path: /crmRestApi/resources/11.13.18.05/presentationSessionFeedback/{presentationSessionFeedbackUniqID}
Get a lightbox presentation session feedback item: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessionFeedback/{presentationSessionFeedbackUniqID}
Get all lightbox presentation session feedback items: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessionFeedback
Update a lightbox presentation session feedback item: Method: patch
Path: /crmRestApi/resources/11.13.18.05/presentationSessionFeedback/{presentationSessionFeedbackUniqID}

Lightbox Presentation Sessions

The lightbox presentation sessions resource is used to view, create, update, and delete the occasions when Lightbox documents were presented to an audience. A session may be directly correlated to an activity, such as an appointment, call report, or task, or may be an ad-hoc session presented at a particular date and time without any association with an activity.

Create a Lightbox presentation session: Method: post
Path: /crmRestApi/resources/11.13.18.05/presentationSessions
Delete a Lightbox presentation session: Method: delete
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}
Get a Lightbox presentation session: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}
Get all Lightbox presentation sessions: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions
Update a Lightbox presentation session: Method: patch
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}

Lightbox Presentation Sessions/Presentation Session Attendance Events

The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.

Create a Lightbox presentation session attendance event: Method: post
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionAttendanceEvents
Get a Lightbox presentation session attendance event: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionAttendanceEvents/{sessionAttendanceEventsUniqID}
Get all Lightbox presentation session attendance events: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionAttendanceEvents

Lightbox Presentation Sessions/Presentation Session Display Events

The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.

Create a Lightbox presentation session display event: Method: post
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionDisplayEvents
Get a Lightbox presentation session display event: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionDisplayEvents/{sessionDisplayEventsUniqID}
Get all Lightbox presentation session display events: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionDisplayEvents

Link Templates

The work order link templates resource is used to view, create, update and delete work order link templates. A link template is a configuration record used to hold information about the type of link relationships that are available between field service customer work orders.

Create a link template: Method: post
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates
Delete a link template: Method: delete
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}
Get a link template: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}
Get all link templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates
Update a link template: Method: patch
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}

Link Templates/Link Template Translations

The work order link template translations resource shows all the translatable values for the work order link templates resource.

Create a link template translation: Method: post
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}/child/WoLinkTemplateTranslation
Delete a link template translation: Method: delete
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}/child/WoLinkTemplateTranslation/{WoLinkTemplateTranslationUniqID}
Get a link template translation: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}/child/WoLinkTemplateTranslation/{WoLinkTemplateTranslationUniqID}
Get all link template translations: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}/child/WoLinkTemplateTranslation
Update a link template translation: Method: patch
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}/child/WoLinkTemplateTranslation/{WoLinkTemplateTranslationUniqID}

Links

The work order link resource is used to view, create, and delete a customer work order link. A work order link is a transactional record, which is created when a customer needs to define a relationship between field service work orders.

Create a work order link: Method: post
Path: /crmRestApi/resources/11.13.18.05/svcWorkOrderLinks
Delete a work order link: Method: delete
Path: /crmRestApi/resources/11.13.18.05/svcWorkOrderLinks/{WoLinkId}
Get a work order link: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWorkOrderLinks/{WoLinkId}
Get all work order links: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWorkOrderLinks

List of Values/Access Group Relationships

The access group relationships resource is used to view the relationships between the source and target objects.

Get all access group relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupRelationships
Get an access group relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupRelationships/{RelationshipId}

List of Values/Activity Functions

The activity function lookup resource is used to view the list of activity functions. Activity function types group activities as appointments, tasks and call reports.

Get all activity functions: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups
Get an activity function: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}

List of Values/Activity Functions/Activity Type Lookups

The activity type lookup resource is used to view the activity types for an activity function. Activity types are used to further define an activity function.

Get all activity types: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}/child/activityTypeLookup
Get an activity type: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}/child/activityTypeLookup/{activityTypeLookupUniqID}

List of Values/Activity Functions/Activity Type Lookups/Activity Subtypes

The activity subtype lookup resource is used to view the activity subtypes for an Activity type and Activity Function. The activity subtypes provide additional detail to track activities.

Get all activity subtypes: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}/child/activityTypeLookup/{activityTypeLookupUniqID}/child/activitySubtypeLookup
Get an activity subtype: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}/child/activityTypeLookup/{activityTypeLookupUniqID}/child/activitySubtypeLookup/{ActivitySubtypeId}

List of Values/Activity Subtypes

The activity subtype lookup resource is used to view the activity subtypes for an Activity type and Activity Function. The activity subtypes provide additional detail to track activities.

Get all activity subtypes: Method: get
Path: /crmRestApi/resources/11.13.18.05/activitySubtypesLOV
Get an activity subtype: Method: get
Path: /crmRestApi/resources/11.13.18.05/activitySubtypesLOV/{ActivitySubtypeId}

List of Values/Activity Type Lookups

The activity type lookup resource is used to view the activity types for an activity function. Activity types are used to further define an activity function.

Get all activity types: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTypeLookupsLOV
Get an activity type: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTypeLookupsLOV/{activityTypeLookupsLOVUniqID}

List of Values/Application Roles

The application roles resource is to view security roles. An application role is a security role in the system, and include both Duty roles and Job roles.

Get a single application role: Method: get
Path: /crmRestApi/resources/11.13.18.05/applicationRoles/{apiName}
Get all application roles: Method: get
Path: /crmRestApi/resources/11.13.18.05/applicationRoles

List of Values/Assessment Templates

The assessment templates resource is used to view the assessment templates. It stores the templates associated with assessments.

Create a deep copy template: Method: post
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV/action/deepCopyTemplate
Deploy template: Method: post
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV/action/deployTemplate
Get all assessment templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV
Get an assessment template: Method: get
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV/{AssessTemplateId}
Get total question weightage: Method: post
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV/action/getTotalQtnWeight
Setup score ranges: Method: post
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV/action/setupScoreRanges

List of Values/Attributes Values

The rule attribute values list of values resource is used to view the list of the values associated to a rule attribute or qualifier.

Get a rule attribute value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleAttributeValuesLOV/{incentiveCompensationRuleAttributeValuesLOVUniqID}
Get all rule attribute values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleAttributeValuesLOV

List of Values/Availability Resource

The Work Order Available Resources resource lets you view resources from Oracle Field Service for direct assignment based on criteria in the request.

Get a matched resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources/{ResourceId}
Get all matched resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources

List of Values/Availability Resource/Availability

The Availability resource lets you view availability for resources from Oracle Field Service.

Get all availability for a matched resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources/{ResourceId}/child/Availability
Get an availability for a matched resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources/{ResourceId}/child/Availability/{AvailabilityUniqID}

List of Values/Availability Resource/Time Slots

The time slot resource lets you view all times slots used in Oracle Field Service.

Get a time slot: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources/{ResourceId}/child/TimeSlotInfo/{Label}
Get all time slots: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources/{ResourceId}/child/TimeSlotInfo

List of Values/Benefits

The benefit list type values list of values resource is used to get the benefit list type values.

Get a benefit list type value: Method: get
Path: /crmRestApi/resources/11.13.18.05/benefitListTypeValuesLOV/{BenefitListTypeValId}
Get all benefit list type values: Method: get
Path: /crmRestApi/resources/11.13.18.05/benefitListTypeValuesLOV

List of Values/Business Units

The business units list of values resource is used to view the list of defined business units.

Get a business unit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV/{incentiveCompensationBusinessUnitsLOVUniqID}
Get all business units: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

List of Values/CRM Business Units

The CRM business units resource is used to view the business unit details.

Get a business unit: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}
Get all business units: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits

List of Values/CRM Business Units/Assessment Templates

The assesment templates resource is used to view the assesment templates. It stores the templates associated with assessments.

Create a deep copy template: Method: post
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates/action/deepCopyTemplate
Deploy template: Method: post
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates/action/deployTemplate
Get all assessment templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates
Get an assessment template: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates/{AssessTemplateId}
Get total question weightage: Method: post
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates/action/getTotalQtnWeight
Setup score ranges: Method: post
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates/action/setupScoreRanges

List of Values/CRM Business Units/Common Set Id Lookups

The common set id lookups resource is used to view lookup values for set id enabled lookup types.

Get a set id enabled lookup value: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/fndCommonSetIdLookups/{fndCommonSetIdLookupsUniqID}
Get all common set id enabled lookup values: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/fndCommonSetIdLookups

List of Values/CRM Business Units/Opportunity Status Values

The opportunity status values resource is used to view the opportunity status value. The configurable setup data is defined specifically for sales usage.

Get all opportunity status values: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/optyStatus
Get an opportunity status value: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/optyStatus/{LookupValuesId}

List of Values/CRM Business Units/Sales Methods

The sales methods resource is used to view an approach which is used in the sales process. A method can encompass every stage associated with the sales process such as prospecting, forecasting, or closing opportunities.

Get a sales method: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}
Get all sales methods: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods

List of Values/CRM Business Units/Sales Methods/Sales Stages

The sales stages resource is used to view the sales stage. The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.

Get a sales stage: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}
Get all sales stages: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage

List of Values/CRM Business Units/Sales Methods/Sales Stages/Attachments

The attachments resource is used to view, create, and update attachments.

Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments/{AttachmentsUniqID}

List of Values/CRM Business Units/Sales Methods/Sales Stages/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

List of Values/CRM Business Units/Sales Methods/Sales Stages/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

List of Values/CRM Business Units/Sales Methods/Sales Stages/Sales Stage Process Steps

The sales stage process steps resource is used view the sales stage process steps. It is a sequence of recommended steps tied to a particular sales stage which is used to guide the sales representative through the opportunity lifecycle.

Get a sales stage process step: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/SalesStageProcessSteps/{StgProcessStepId}
Get all sales stage process steps: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/SalesStageProcessSteps

List of Values/Capacity Categories

The capacity categories resource is used to view capacity categories used in Oracle Field Service Cloud.

Get a capacity category: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}
Get all capacity catagories: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities

List of Values/Capacity Categories/Capacities

The capacities resource is used to view capacities used in Oracle Field Service Cloud.

Get a capacity: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/Capacity/{CapacityUniqID}
Get all capacities: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/Capacity

List of Values/Capacity Categories/Time Slots

The time slots resource is used to view all times slots used in Oracle Field Service Cloud.

Get a time slot: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/TimeSlotInfo/{Label}
Get all time slots: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/TimeSlotInfo

List of Values/Channel Types

The channel types resource is used to view the list of communication channels, such as Phone, Email, SMS, Social, and so on.

Get a channel type: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/{LookupCode}
Get all channel types: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV

List of Values/Channel Types/Channels

A list of channels associated with a channel type.

Get a channel associated with a channel type: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/{LookupCode}/child/svcChannelLookups/{ChannelId}
Get all channels associated with a channel type: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/{LookupCode}/child/svcChannelLookups

List of Values/Class Codes

The class codes resource is used to view classification codes for a given classification category. All responses for the class codes resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds).

Get a classification code: Method: get
Path: /crmRestApi/resources/11.13.18.05/classCodes/{classCodesUniqID}
Get all classification codes: Method: get
Path: /crmRestApi/resources/11.13.18.05/classCodes

List of Values/Contest Scores

Contest Scores

Get a contest score: Method: get
Path: /crmRestApi/resources/11.13.18.05/contestScores/{contestScoresUniqID}
Get all contest scores: Method: get
Path: /crmRestApi/resources/11.13.18.05/contestScores

List of Values/Contest Scores/Contest Score Details

Contest Score Details

Get a contest score detail record: Method: get
Path: /crmRestApi/resources/11.13.18.05/contestScores/{contestScoresUniqID}/child/ContestScoreDetails/{ContestScoreDetailsUniqID}
Get all contest score details: Method: get
Path: /crmRestApi/resources/11.13.18.05/contestScores/{contestScoresUniqID}/child/ContestScoreDetails

List of Values/Currencies

The currencies lists of values resource is used to query the ISO standard currencies.

Get all currencies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/currenciesLOV

List of Values/Custom Cascading Lookups

The custom cascading lookups resource is used to view, create, update, and delete custom cascading lookups.

Create a custom cascading lookup: Method: post
Path: /crmRestApi/resources/11.13.18.05/customCascadingLookups
Delete a custom cascading lookup: Method: delete
Path: /crmRestApi/resources/11.13.18.05/customCascadingLookups/{customCascadingLookups_Id}
Get a custom cascading lookup: Method: get
Path: /crmRestApi/resources/11.13.18.05/customCascadingLookups/{customCascadingLookups_Id}
Get all custom cascading lookups: Method: get
Path: /crmRestApi/resources/11.13.18.05/customCascadingLookups
Update a custom cascading lookup: Method: patch
Path: /crmRestApi/resources/11.13.18.05/customCascadingLookups/{customCascadingLookups_Id}

List of Values/Custom Lookups

The custom lookups resource is used to view, create, update, and delete custom lookups.

Create a custom lookup: Method: post
Path: /crmRestApi/resources/11.13.18.05/customLookups
Delete a custom lookup: Method: delete
Path: /crmRestApi/resources/11.13.18.05/customLookups/{customLookups_Id}
Get a custom lookup: Method: get
Path: /crmRestApi/resources/11.13.18.05/customLookups/{customLookups_Id}
Get all custom lookups: Method: get
Path: /crmRestApi/resources/11.13.18.05/customLookups
Update a custom lookup: Method: patch
Path: /crmRestApi/resources/11.13.18.05/customLookups/{customLookups_Id}

List of Values/Descriptive Flexfield Contexts

Get: Method: get
Path: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts/{FlexFndDffDescriptiveFlexfieldContexts_Id}
Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

List of Values/Eligible Pay Groups

The eligible pay groups list of values resource is used to view the list of eligible pay groups that can be used for creating payment batches.

Get all eligible pay groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEligiblePayGroupsLOV
Get an eligible pay group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEligiblePayGroupsLOV/{PayGroupId}

List of Values/End Periods

The End Period resource lets you view all end periods.

Get all end periods for the period type: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesGLEndPeriodTimesLOV
Get an end period for the period type: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesGLEndPeriodTimesLOV/{salesGLEndPeriodTimesLOVUniqID}

List of Values/Expression Detail Items

The expression detail items list of values resource is used to view the list of values pertaining to all the entities within an expression.

Get all expression detail items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV
Get an expression detail item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}

List of Values/Expression Detail Items/Expression Detail Basic Attribute Groups

The basic attribute groups resource is used to view the primary attribute groups used in an expression.

Get a basic attribute group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailBasicAttributeGroups/{expressionDetailBasicAttributeGroupsUniqID}
Get all basic attribute groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailBasicAttributeGroups

List of Values/Expression Detail Items/Expression Detail Basic Attribute Groups/Expression Detail Basic Attribute Names

The basic attribute names resource is used to view the list of basic attribute names within a basic attribute group used in an expression.

Get a basic attribute name: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailBasicAttributeGroups/{expressionDetailBasicAttributeGroupsUniqID}/child/expressionDetailBasicAttributeNames/{expressionDetailBasicAttributeNamesUniqID}
Get all basic attribute names: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailBasicAttributeGroups/{expressionDetailBasicAttributeGroupsUniqID}/child/expressionDetailBasicAttributeNames

List of Values/Expression Detail Items/Expression Detail Function Groups

The function groups resource is used to view the list of SQL functions groups based on the category of the functions they contain, that can be used in an expression.

Get a function group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailFunctionGroups/{expressionDetailFunctionGroupsUniqID}
Get all function groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailFunctionGroups

List of Values/Expression Detail Items/Expression Detail Function Groups/Expression Detail Function Names

The function names resource is used to view the list of SQL functions within a specific function group that can be used in an expression.

Get a function name: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailFunctionGroups/{expressionDetailFunctionGroupsUniqID}/child/expressionDetailFunctionNames/{FunctionCode}
Get all function names: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailFunctionGroups/{expressionDetailFunctionGroupsUniqID}/child/expressionDetailFunctionNames

List of Values/Expression Detail Items/Expression Detail Operators

The operators resource is used to view the list of mathematical operators that can be used in an expression.

Get all operators: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailOperators
Get an operator: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailOperators/{expressionDetailOperatorsUniqID}

List of Values/Expression Detail Items/Expression Detail Performance Measures

The performance measures list of values resource is used to view the list of performance measures for which its attributes can be used in an expression.

Get a performance measure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPerformanceMeasures/{MeasureId}
Get all performance measures: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPerformanceMeasures

List of Values/Expression Detail Items/Expression Detail Performance Measures/Expression Detail Performance Measure Attributes

The performance measure attributes list of values resource is used to view the list of attributes of a performance measure, that can be used in an expression.

Get a performance measure attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPerformanceMeasures/{MeasureId}/child/expressionDetailPerformanceMeasureAttributes/{expressionDetailPerformanceMeasureAttributesUniqID}
Get all performance measure attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPerformanceMeasures/{MeasureId}/child/expressionDetailPerformanceMeasureAttributes

List of Values/Expression Detail Items/Expression Detail Plan Components

The plan components list of values resource is used to view the list of plan components for which its attributes can be used in an expression.

Get a plan component: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}
Get all plan components: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents

List of Values/Expression Detail Items/Expression Detail Plan Components/Expression Detail Plan Component Attributes

The plan component attributes list of values resource is used to view the list of attributes of a plan component that can be used in an expression.

Get a plan component attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}
Get all plan component attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes

List of Values/Expression Detail Items/Expression Detail Plan Components/Expression Detail Plan Component Attributes/Expression Detail Plan Component Measures

The plan component measures list of values resource is used to view the list of measures within a plan component for which it's attributes can be used in an expression.

Get a plan component performance measure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}/child/expressionDetailPlanComponentsMeasures/{expressionDetailPlanComponentsMeasuresUniqID}
Get all plan component performance measures: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}/child/expressionDetailPlanComponentsMeasures

List of Values/Expression Detail Items/Expression Detail Plan Components/Expression Detail Plan Component Attributes/Expression Detail Plan Component Measures/Expression Detail Plan Component Measure Result Attributes

The plan component measure result attributes list of values resource is used to view the list of attributes of a performance measure within a plan component that can be used in an expression.

Get a plan component measure result attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}/child/expressionDetailPlanComponentsMeasures/{expressionDetailPlanComponentsMeasuresUniqID}/child/expressionDetailPlanComponentsMeasureResultAttributes/{expressionDetailPlanComponentsMeasureResultAttributesUniqID}
Get all plan component measure result attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}/child/expressionDetailPlanComponentsMeasures/{expressionDetailPlanComponentsMeasuresUniqID}/child/expressionDetailPlanComponentsMeasureResultAttributes

List of Values/Expression Detail Items/Expression Detail User Defined Functions

The user defined functions list of values resource is used to view the list of predefined PL/SQL functions that can be used in an expression.

Get a user defined function: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailUserDefinedFunctions/{expressionDetailUserDefinedFunctionsUniqID}
Get all user defined functions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailUserDefinedFunctions

List of Values/Expression Detail Items/Expression Detail User Defined Query Value Sets

The user defined query value sets list of values resource is used to view the list of user defined queries which were created using table value sets. These user defined queries can be used in an expression.

Get a user defined query: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/ExpressionDetailUserDefinedQueryValueSets/{ExpressionDetailUserDefinedQueryValueSetsUniqID}
Get all user defined queries: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/ExpressionDetailUserDefinedQueryValueSets

List of Values/Expression Usages

The expression usages list of values resource is used to view the list of expression usages which indicate where an expression can be used.

Get all expression usages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionUsagesLOV
Get an expression usage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionUsagesLOV/{ExpressionUsageId}

List of Values/FND Common SetId Lookups

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

Create a FND common set Id lookup: Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups
Delete a FND common set Id lookup: Method: delete
Path: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups/{fndCommonSetIdLookups_Id}
Get a FND common set Id lookup: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups/{fndCommonSetIdLookups_Id}
Get all FND common set Id lookups: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups
Update a FND common set Id lookup: Method: patch
Path: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups/{fndCommonSetIdLookups_Id}

List of Values/Feed Types

The feed types resource is used to list the types of feed.

Get a feed type: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedTypesLOV/{FeedType}
Get all feed types: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedTypesLOV

List of Values/Feed Types/Large Object (LOB) Attributes - TranslationBundle

Get a TranslationBundle: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedTypesLOV/{FeedType}/enclosure/TranslationBundle

List of Values/Feedback Ratings

The feedback ratings resource lets you view the list of ratings for a Lightbox document or page.

Get a feedback rating: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedbackRatingsLOV/{RatingValue}
Get all feedback ratings: Method: get
Path: /crmRestApi/resources/11.13.18.05/feedbackRatingsLOV

List of Values/Generic Value Set Values

Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/FlexFndPvsCharacterIdCharacterValues
Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/FlexFndPvsNumberIdCharacterValues

List of Values/Geographies

The geographies resource is used to view a list of geographies.

Get a geography: Method: get
Path: /crmRestApi/resources/11.13.18.05/geographies/{GeographyId}
Get a geography: Method: get
Path: /crmRestApi/resources/11.13.18.05/geographiesLOV/{geographiesLOVUniqID}
Get all geographies: Method: get
Path: /crmRestApi/resources/11.13.18.05/geographies
Get all geographies: Method: get
Path: /crmRestApi/resources/11.13.18.05/geographiesLOV

List of Values/Get Configurations

The get configurations resource is used to view the configuration information of the chat service. The resource can be invoked anonymously using a GET HTTP request with no Authorization header. The resource is protected by the SVC_GET_CHAT_CONFIGURATIONS_PRIV entitlement that is assigned to the ORA_FND_ANONYMOUS_USER_ABSTRACT role. By the means of a profile option SVC_CHAT_INLAYS_ACCESS_ENABLED, the customers will decide if they allow access to this method. - If the profile option has the Y value, the getConfigs method can be called. - If the profile option has the N value, the method will return a 403 FORBIDDEN http error.

Get a configuration - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/getConfigs/{billingId}
Get all configurations: Method: get
Path: /crmRestApi/resources/11.13.18.05/getConfigs

List of Values/HR Service Request Resolve Outcomes

The HR service request resolve outcomes resource is used to view the resolve outcomes. It contains the top level categories for describing the type of resolution achieved for the HR service request.

Get all outcomes: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrSRResolveOutcomeLookups
Get an outcome: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrSRResolveOutcomeLookups/{LookupCode}

List of Values/HR Service Request Resolve Outcomes/HR Service Request Resolve Outcome Resolutions

The HR service request resolve outcome resolutions resource is used to view the resolve request resolutions. It contains a detailed categorization describing how the chosen outcome was achieved for the HR service request.

Get all outcome resolutions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrSRResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups
Get an outcome resolution: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrSRResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups/{srResolutionLookupsUniqID}

List of Values/Industries

The industries list of values resource is used to view a list of industries which can be associated with a partner.

Get all industries: Method: get
Path: /crmRestApi/resources/11.13.18.05/industriesLOV
Get an industry: Method: get
Path: /crmRestApi/resources/11.13.18.05/industriesLOV/{industriesLOVUniqID}

List of Values/Integration Configurations

The integration configurations resource lets you view integration configurations used for Oracle Field Service.

Get all integration configurations: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoIntegrationConfigs
Get an integration configuration: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoIntegrationConfigs/{svcWoIntegrationConfigsUniqID}

List of Values/Integration Configurations/Scheduler Configurations

The scheduler configurations resource lets you view scheduler configurations used for Oracle Field Service.

Get a scheduler configuration: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoIntegrationConfigs/{svcWoIntegrationConfigsUniqID}/child/WoSchedulerConfigs/{SchedulerCd}
Get all scheduler configurations: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoIntegrationConfigs/{svcWoIntegrationConfigsUniqID}/child/WoSchedulerConfigs

List of Values/Internal Service Request Outcomes

The Internal Service Request outcomes resource lets you view, create, update and delete the top-level categories for describing the outcomes of Internal Service Requests.

Get all outcomes: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalSRResolveOutcomeLookups
Get an outcome: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalSRResolveOutcomeLookups/{LookupCode}

List of Values/Internal Service Request Outcomes/Internal Service Request Outcome Resolutions

The Internal Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for an Internal Service Request.

Get all outcome resolutions: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalSRResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups
Get an outcome resolution: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalSRResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups/{srResolutionLookupsUniqID}

List of Values/Languages

The languages list of values resource is used to query the list of languages.

Get all languages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/languagesLOV

List of Values/Lightbox Document Types

The lightbox document type LOV resource is used to view all Lightbox document types. You can use this to view information specific to a document type.

Get a lightbox document type: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocumentTypesLOV/{lightboxDocumentTypesLOVUniqID}
Get all lightbox document types: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocumentTypesLOV

List of Values/Lookups

The lookups resource is used to view standard lookup codes. It is recommended that you use the Standard Lookups List of Values to create a new lookup and add values to the fndStaticLookups. For more information, see the REST API for Common Features in Oracle Applications Cloud guide.

Get a lookup: Method: get
Path: /hzLookups/{hzLookupsUniqID}
Get a lookup.: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups/{fndStaticLookupsUniqID}
Get all lookups: Method: get
Path: /hzLookups
Get all lookups.: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

List of Values/Loy Events

The events resource is used to retrieve the details of the event defined for the program.

Get all events: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyEventsLOV
Get an event: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyEventsLOV/{LoyEventId}

List of Values/Loy PointTypes

The point types resource is used to retrieve the details of the loyalty point types defined for the program.

Get a point type: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPointTypesLOV/{LoyAttrdefnBId}
Get all point types: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPointTypesLOV

List of Values/Mapped Product Templates

The mapped product template resource is used to view the templates available to create a product.

Get a mapped product template: Method: get
Path: /crmRestApi/resources/11.13.18.05/mappedProductTemplates/{mappedProductTemplatesUniqID}
Get all mapped product templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/mappedProductTemplates

List of Values/Name and ID Types

The name and types resource is used to view the additional name and ID types.

Get a Name and Type: Method: get
Path: /crmRestApi/resources/11.13.18.05/nameAndIdTypes/{TypeCode}
Get All Name And Types: Method: get
Path: /crmRestApi/resources/11.13.18.05/nameAndIdTypes

List of Values/Note Types

The note types resource is used to view the note type.

Get a note type: Method: get
Path: /crmRestApi/resources/11.13.18.05/noteTypes/{MappedLookupCode}
Get all note types: Method: get
Path: /crmRestApi/resources/11.13.18.05/noteTypes

List of Values/Opportunity Status Values

The opportunity status values resource is used to view the opportunity status values. The configurable setup data is defined specifically for sales usage.

Get all opportunity status values: Method: get
Path: /crmRestApi/resources/11.13.18.05/optyStatusesLOV
Get an opportunity status value: Method: get
Path: /crmRestApi/resources/11.13.18.05/optyStatusesLOV/{LookupValuesId}

List of Values/Participants

The participants list of values resource is used to view the list of existing participants.

Get a participant: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipantsLOV/{ParticipantId}
Get all participants: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipantsLOV

List of Values/Partner Contact Managers

The partner contact managers list of values resource is used to view a list of partner contacts in a managerial role.

Get a partner contact manager: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContactManagersLOV/{partnerContactManagersLOVUniqID}
Get all partner contact managers: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContactManagersLOV

List of Values/Partner Enrolled Programs

The partner enrolled programs list of values resource is used to view a list of the partner programs a partner is enrolled in.

Get a partner enrolled program: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerEnrolledProgramsLOV/{ProgramEnrollmentId}
Get all partner enrolled programs: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerEnrolledProgramsLOV

List of Values/Partner Programs

The partner programs list of values resource is used to view the services to find partner programs.

Get a partner program: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramsLOV/{PartnerProgramId}
Get all partner programs: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramsLOV

List of Values/Partner Resource Roles

The partner resource roles resource is used to view a configuration of roles that can be used to indicate the function of a resource. For example sales representative or marketing administrator.

Get a partner resource role: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerResourceRolesLOV/{RoleId}
Get all partner resource roles: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerResourceRolesLOV

List of Values/Partner Statuses

The partner statuses list of values resource is used to get the list of valid statuses for a partner.

Get a partner status: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerStatusesLOV/{partnerStatusesLOVUniqID}
Get all partner statuses: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerStatusesLOV

List of Values/Partner Types

The partner types list of values resource is used to view a list of the business relationships that are shared with a partner.

Get a partner type: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerTypesLOV/{PartnerDimMembersId}
Get all partner types: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerTypesLOV

List of Values/Partners

The partner list of values resource is used to view a list of partners.

Get a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}
Get all partners: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnersLOV

List of Values/Partners/Partner Contact Managers

The partner contact managers list of values resource is used to view a list of partner contacts in a managerial role.

Get a partner contact manager: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}/child/partnerContactManagersLOV/{partnerContactManagersLOVUniqID}
Get all partner contact managers: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}/child/partnerContactManagersLOV

List of Values/Partners/Partner Enrolled Programs

The partner enrolled programs list of values resource is used to view a list of the partner programs a partner is enrolled in.

Get a program enrollment: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}/child/partnerEnrolledProgramsLOV/{ProgramEnrollmentId}
Get all program enrollments: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}/child/partnerEnrolledProgramsLOV

List of Values/Partners/Partner Types

The partner types resource is used to view, create, and delete the type of the partner. The partner type record enables you to categorize the partner account based on the type of business the partner performs. For example, a partner can be a reseller, or distributor.

Get a partner type: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}/child/partnerDimensionsLOV/{PartnerDimMembersId}
Get all partner types: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}/child/partnerDimensionsLOV

List of Values/Party Usages

The party usages resource is used to view the list of valid party usages that can be assigned to a party.

Get a party usage: Method: get
Path: /crmRestApi/resources/11.13.18.05/partyUsages/{PartyUsageCode}
Get all party usages: Method: get
Path: /crmRestApi/resources/11.13.18.05/partyUsages

List of Values/Payment Batch Participant Plan Components

The payment batch participant plan components list of values resource is used to view the plan components assigned to a participant when a paysheet is being created or updated for the participant within a payment batch.

Get a payment batch participant plan component: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paybatchParticipantPlanComponentsLOV/{PlanComponentId}
Get all payment batch participant plan components: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paybatchParticipantPlanComponentsLOV

List of Values/Performance Intervals

The performance intervals list of values resource is used to view the interval types list of values that are associated with a performance measure interval. The interval type affects the accumulation results for a performance measure calculation.

Get all interval types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceIntervalsLOV
Get an interval type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceIntervalsLOV/{incentiveCompensationPerformanceIntervalsLOVUniqID}

List of Values/Period Types

The Period Type resource lets you view all available period types.

Get a period type: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesGLPeriodTypes/{salesGLPeriodTypesUniqID}
Get all period types: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesGLPeriodTypes

List of Values/Period Types/End Periods

The End Period resource lets you view all end periods.

Get all end periods for the period type: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesGLPeriodTypes/{salesGLPeriodTypesUniqID}/child/salesGLEndPeriodTimes
Get an end period for the period type: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesGLPeriodTypes/{salesGLPeriodTypesUniqID}/child/salesGLEndPeriodTimes/{salesGLEndPeriodTimesUniqID}

List of Values/Period Types/Start Period Lookups

The start period resource lets you view the start periods.

Get a start period: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesGLPeriodTypes/{salesGLPeriodTypesUniqID}/child/salesGLStartPeriodTimes/{salesGLStartPeriodTimesUniqID}
Get all start periods: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesGLPeriodTypes/{salesGLPeriodTypesUniqID}/child/salesGLStartPeriodTimes

List of Values/Periods

The periods list of values resource is used to view the list of incentive compensation periods defined for a calendar associated with a business unit.

Get a period: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPeriodsLOV/{incentiveCompensationPeriodsLOVUniqID}
Get all periods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPeriodsLOV

List of Values/Phone Country Codes

The country codes resource is used to get the country codes for phone numbers. All responses for the country codes resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds). You need to have PER_MANAGE_PERSON_PHONE_PRIV.

Get a Country Code: Method: get
Path: /crmRestApi/resources/11.13.18.05/countryCodes/{PhoneCountryCodeId}
Get all Country Codes: Method: get
Path: /crmRestApi/resources/11.13.18.05/countryCodes

List of Values/Plan Document Templates

The plan document template list of values resource is used to view the list of template names associated with a plan document. The plan document which gets distributed to the participant is a BIP report which can have multiple templates associated with it.

Get a plan document template: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPlanDocumentTemplatesLOV/{TemplateName}
Get all plan document templates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPlanDocumentTemplatesLOV

List of Values/Product Groups

The product groups resource is used to view the product group.

Get a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroups/{ProdGrpDetailsId}
Get all product groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroups

List of Values/Product Specialties

The product specialities list of values resource is used to view a list of product specialities which can be associated with a partner.

Get a list of product specialties: Method: get
Path: /crmRestApi/resources/11.13.18.05/productSpecialitiesLOV
Get a product specialty: Method: get
Path: /crmRestApi/resources/11.13.18.05/productSpecialitiesLOV/{productSpecialitiesLOVUniqID}

List of Values/Product Templates

The product template resource is used to view all item templates of the sales product item organization under the root item class.

Get a product template: Method: get
Path: /crmRestApi/resources/11.13.18.05/productTemplates/{productTemplatesUniqID}
Get all product templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/productTemplates

List of Values/Program Tiers

The program tiers list of values resource is used to view the partner program tiers defined by the channel organization. For example, the partner program tiers may be defined as Gold, Silver, and Bronze.

Get a program tier: Method: get
Path: /crmRestApi/resources/11.13.18.05/programTiersLOV/{ProgramTierId}
Get all program tiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/programTiersLOV

List of Values/Rated Currencies

The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.

Get a rated currency: Method: get
Path: /crmRestApi/resources/11.13.18.05/ratedCurrencies/{CurrencyCode}
Get all rated currencies: Method: get
Path: /crmRestApi/resources/11.13.18.05/ratedCurrencies

List of Values/Relationship Types

The relationship types resource is used to view the relationship types.

Get a relationship type: Method: get
Path: /crmRestApi/resources/11.13.18.05/relationshipTypes/{relationshipTypesUniqID}
Get all relationship types: Method: get
Path: /crmRestApi/resources/11.13.18.05/relationshipTypes

List of Values/Revenue Sales Channels

The resource is used to view the values for sales channels of opportunity revenue.

Get a revenue sales channel: Method: get
Path: /crmRestApi/resources/11.13.18.05/revenueSalesChannels/{revenueSalesChannelsUniqID}
Get all revenue sales channels: Method: get
Path: /crmRestApi/resources/11.13.18.05/revenueSalesChannels

List of Values/Role-Based Lookups

The role-based lookups resource is used to view, create, update, and delete role-based lookups.

Create a role-based lookup: Method: post
Path: /crmRestApi/resources/11.13.18.05/roleBasedLookups
Delete a role-based lookup: Method: delete
Path: /crmRestApi/resources/11.13.18.05/roleBasedLookups/{roleBasedLookups_Id}
Get a role-based lookup: Method: get
Path: /crmRestApi/resources/11.13.18.05/roleBasedLookups/{roleBasedLookups_Id}
Get all role-based lookups: Method: get
Path: /crmRestApi/resources/11.13.18.05/roleBasedLookups
Update a role-based lookup: Method: patch
Path: /crmRestApi/resources/11.13.18.05/roleBasedLookups/{roleBasedLookups_Id}

List of Values/Roles List of Values

The rolesLOV resource includes the list of values for roles.

Get all roles: Method: get
Path: /hcmRestApi/resources/11.13.18.05/rolesLOV

List of Values/Rule Attributes

The rule attributes list of values resource is used to view the list of the qualifiers, their operators, and the rule types the qualifiers are used in.

Get a rule attribute: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleAttributesLOV/{incentiveCompensationRuleAttributesLOVUniqID}
Get all rule attributes: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleAttributesLOV

List of Values/Rule Types

The rule types list of values resource is used to view the list of rule types. It indicates the specific usage of the rule such as classification, crediting and other usages.

Get a rule type: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleTypesLOV/{incentiveCompensationRuleTypesLOVUniqID}
Get all rule types: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleTypesLOV

List of Values/Sales Methods

The sales methods list of values resource is used to view the sales method. A sales method is an approach used in the sales process. A method can encompass every stage associated with the sales process such as prospecting, forecasting, and closing opportunities.

Get a sales method: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMethodsLOV/{SalesMethodId}
Get all sales methods: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMethodsLOV

List of Values/Sales Objective Types

Sales Objective Types

Get a sales objective type: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectiveTypes/{salesObjectiveTypesUniqID}
Get all sales objective types: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectiveTypes

List of Values/Sales Order CPQ Integration Configurations

The sales order CPQ integration configurations resource is used to view the sales order CPQ integration configurations.

Get a quote integration configuration: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations/{OrderSetupRefId}
Get all quote integration configurations: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations

List of Values/Sales Order CPQ Integration Configurations/Sales Order Setup Disabled Revenue Fields

The sales order setup disabled revenue fields resource is used to view the disabled revenue fields after a opportunity is quoted. The foreign key is used for identifying the relation between disabled revenue field and order setup reference identifier.

Get a disabled revenue field: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations/{OrderSetupRefId}/child/SalesOrdersSetupDsbldRevnFields/{OrdersDsbldRevnFieldId}
Get all disabled revenue fields: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations/{OrderSetupRefId}/child/SalesOrdersSetupDsbldRevnFields

List of Values/Sales Order CPQ Integration Configurations/Sales Order Setup Reference Details

The sales order setup reference details is used to view the sales order setup detail rows.

Get a quote setup reference detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations/{OrderSetupRefId}/child/SalesOrdersSetupRefDetails/{OrderSetupRefDetailId}
Get all quote setup reference details: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations/{OrderSetupRefId}/child/SalesOrdersSetupRefDetails

List of Values/Sales Stages

The sales stages list of values resource is used to view the sales stage. The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.

Get a sales stage: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesStagesLOV/{StgId}
Get all sales stages: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesStagesLOV

List of Values/Screen Pop Pages

The screen pop pages resource is used to view the pages that are displayed as an initial starting point in a media based interaction. After identifying the contact, screen pop rules are run to determine which page is shown to the agent.

Get a screen pop page: Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages/{Name}
Get all screen pop pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages

List of Values/Screen Pop Pages/Screen Pop Page Parameters

The screen pop page parameters resource is used to view the parameters accepted by a screen pop page. The parameters indicate data needed to display the correct content on a page.

Get a page parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages/{Name}/child/McaParameters/{McaParametersUniqID}
Get all page parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages/{Name}/child/McaParameters

List of Values/Screen Pop Pages/Screen Pop Page Parameters/Screen Pop Page Map Parameters

The screen pop page map parameters resource is used to view a screen pop page parameter of the type map. Map type parameters can contain a variable number of other parameters, and are used to pass initial pre-populated fields to a create type page.

Get a page map parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages/{Name}/child/McaParameters/{McaParametersUniqID}/child/MapParameters/{MapParametersUniqID}
Get all page map parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages/{Name}/child/McaParameters/{McaParametersUniqID}/child/MapParameters

List of Values/Screen Pop Tokens

The screen pop tokens resource is used to view the data passed to the screen pop pages. A token can represent a business object attribute value or can contain literal values. Tokens are interpreted by the screen pop page at run time.

Get a screen pop token: Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopTokens/{TokenCode}
Get all screen pop tokens: Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopTokens

List of Values/Service Business Units

The service business units resource is used to view the units of an enterprise that have been configured to function as customer support or as a human resource help desk.

Get a service business unit: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}
Get all service business units: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits

List of Values/Service Business Units/Business Unit Lookups

The reference set enabled lookups resource is used to view the lookups associated with a business unit.

Get a reference set enabled lookup: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/fndSetEnabledLookups/{fndSetEnabledLookupsUniqID}
Get all reference set enabled lookups: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/fndSetEnabledLookups

List of Values/Service Business Units/Categories

The categories resource is used to view the categories associated with a business unit. Categories are used to group service requests.

Get a category: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/categories/{CategoryId}
Get all categories: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/categories

List of Values/Service Business Units/Channels

The channels resource is used to view the channels associated with a business unit. Channels used to listen and respond to customers.

Get a channel: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/channels/{ChannelId}
Get all channels: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/channels

List of Values/Service Business Units/Profile Options

The profile options resource is used to view the profile options associated with a business unit, such as product catalog usage or email template for service request responses.

Get a profile option: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/profileOptions/{OptionId}
Get all profile options: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/profileOptions

List of Values/Service Dependent Lookups

The service dependent lookups resource is used to view a list of child lookup values associated with a given parent lookup, such as all the resolution codes associated with a resolution outcome.

Get a lookup code: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceDependentLookupsLOV/{serviceDependentLookupsLOVUniqID}
Get all lookup codes: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceDependentLookupsLOV

List of Values/Service Lookup Properties

The service lookup properties resource is used to view the list of properties applicable to a lookup code. These properties are used by the application to define the behavior of the lookup code.

Get a service lookup property: Method: get
Path: /crmRestApi/resources/11.13.18.05/lookupProperties/{PropertyId}
Get all service lookup properties: Method: get
Path: /crmRestApi/resources/11.13.18.05/lookupProperties

List of Values/Service Request Outcomes

The service request outcomes resource lets you view, create, update and delete the top-level categories for describing the outcomes of Service Requests.

Get all outcomes: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcResolveOutcomeLookups
Get an outcome: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcResolveOutcomeLookups/{LookupCode}

List of Values/Service Request Outcomes/Service Request Outcome Resolutions

The Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for a Service Request.

Get all outcome resolutions: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups
Get an outcome resolution: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups/{srResolutionLookupsUniqID}

List of Values/Service Request Statuses

The service request statuses resource is used to view a list of possible statuses that can be associated with a service request, such as New, In Progress, Resolved, and so on.

Get a lookup code: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequestStatusesLOV/{serviceRequestStatusesLOVUniqID}
Get all lookup codes: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequestStatusesLOV

List of Values/Service Work Order Areas

The service work order areas resource is used to view the Oracle Field Service Cloud list of values indicating the bucket resources.

Get a work area: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoAreas/{Id}
Get all work areas: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoAreas

List of Values/Service Work Order Areas/Work Order Areas

The work order areas resource is used to view information about a bucket resource.

Get a work order area: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoAreas/{Id}/child/WorkOrderArea/{WorkOrderArea}
Get all work order areas: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoAreas/{Id}/child/WorkOrderArea

List of Values/Similar Service Requests

The similar service requests resource is used to view the list of similar service requests for a given service request.

Add feedback for a similar service request: Method: post
Path: /crmRestApi/resources/11.13.18.05/similarSRs/action/addFeedback
Call an AI action: Method: post
Path: /crmRestApi/resources/11.13.18.05/similarSRs/action/invokeAIAction
Configure similar service request: Method: post
Path: /crmRestApi/resources/11.13.18.05/similarSRs/action/getSimilarSRConfig
Get a similar service request: Method: get
Path: /crmRestApi/resources/11.13.18.05/similarSRs/{similarSRsUniqID}
Get all similar service requests: Method: get
Path: /crmRestApi/resources/11.13.18.05/similarSRs
Get all similar service requests: Method: post
Path: /crmRestApi/resources/11.13.18.05/similarSRs/action/findSimilarSRs

List of Values/Smart Text Folders and Texts

The smart text folders and texts resource is used to view smart text folders or smart texts.

Get a folder or smart text: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolderAndTexts/{UniqueIdentifier}
Get folders and smart texts: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolderAndTexts

List of Values/Smart Text Folders and Texts/Parents

The parents resource is used to view the parent smart text folders or texts.

Get parent folder or smart text: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolderAndTexts/{UniqueIdentifier}/child/ParentFolderIdStandardTextFolderAndText/{UniqueIdentifier2}
Get parent folders and smart texts: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolderAndTexts/{UniqueIdentifier}/child/ParentFolderIdStandardTextFolderAndText

List of Values/Smart Text Objects

The smart text objects resource is used to view business objects enabled for smart texts.

Get a smart text object: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextObjects
Get all smart text objects: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextObjects/{ObjectId}

List of Values/Smart Text Variables

The smart text resource is used to view all available smart text variables. You can use smart text variables to automatically populate information in a smart text.

Get a smart text variable: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextVariables/{VariableId}
Get all smart text variables: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextVariables

List of Values/Source Codes

The source codes resource is used to view the 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.

Get a source code: Method: get
Path: /crmRestApi/resources/11.13.18.05/sourcecodes/{SourceCodeId}
Get all source codes: Method: get
Path: /crmRestApi/resources/11.13.18.05/sourcecodes

List of Values/Standard Lookups List of Values

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

Get all standard lookups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

List of Values/Start Period Lookups

The start period resource lets you view the start periods.

Get a start period: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesGLStartPeriodTimesLOV/{salesGLStartPeriodTimesLOVUniqID}
Get all start periods: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesGLStartPeriodTimesLOV

List of Values/Subscription Balance Objects

The subscription balance objects resource is used to view, create, update, and delete balance objects.

Get a balance object: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceObjects/{BalanceObjectFullName}
Get all balance objects: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceObjects

List of Values/Subscription Balance Objects/Subscription Balance Attributes

The subscription balance attributes resource is used to view, create, update, and delete balance attributes.

Get a balance attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceObjects/{BalanceObjectFullName}/child/subscriptionBalanceAttributes/{BalanceAttributeFullName}
Get all balance attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceObjects/{BalanceObjectFullName}/child/subscriptionBalanceAttributes

List of Values/Subscription Coverage Exceptions

The subscription coverage exceptions resource is used to view the availability exception details. The availability exception object has details such as exception name, PUID.

Get a subscription availability exception: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}
Get all subscription availability exceptions: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions

List of Values/Subscription Coverage Exceptions/Subscription Coverage Availabilities

The subscription coverage availability resource is used to view the availability schedule details. The availability schedule object has details such as schedule name, timezone code,exception name, PUID.

Get a subscription availability schedule: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}
Get all subscription availability schedules: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}/child/SubscriptionCoverageAvailability

List of Values/Subscription Coverage Exceptions/Subscription Coverage Availabilities/Subscription Coverage Breaks

The subscription coverage break resource is used to view the availability schedule breaks. The availability schedule break object has details such as start hour, start minute,end hour, end minute.

Get a subscription availability break: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}/child/SubscriptionCoverageBreak/{BreakPuid}
Get all subscription availability breaks: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}/child/SubscriptionCoverageBreak

List of Values/Subscription Coverage Schedules

The subscription coverage schedule resource is used to view the availability schedule details. The availability schedule object has details such as schedule name, time zone code, schedule PUID , exception PUID

Get a subscription coverage availability schedule: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}
Get all subscription coverage availability schedules: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules

List of Values/Subscription Coverage Schedules/Subscription Coverage Intervals

The subscription coverage schedule interval resource is used to view the availability schedule interval details. The availability schedule interval object has details such as availability, start date , end date

Get a subscription coverage availability schedule interval: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}
Get all subscription coverage availability schedule intervals: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval

List of Values/Subscription Coverage Schedules/Subscription Coverage Intervals/Subscription Coverage Availabilities

The subscription coverage schedule availability resource is used to view the schedule availability details. The availability object has details such as start hour, start minute, end hour, end minute

Get a subscription coverage availability detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}
Get all subscription coverage availability details: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}/child/SubscriptionCoverageAvailability

List of Values/Subscription Coverage Schedules/Subscription Coverage Intervals/Subscription Coverage Availabilities/Subscription Coverage Breaks

The subscription coverage break resource is used to view the schedule break details. The break object has details such as start hour, start minute, end hour, end minute

Get a subscription coverage availability break: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}/child/SubscriptionCoverageBreak/{BreakPuid}
Get all subscription coverage availability breaks: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}/child/SubscriptionCoverageBreak

List of Values/Subscription Customer Assets

The customer asset LOV resource is used to view the assets. The customer asset LOV object has details such as asset number, serial number

Get a customer asset: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCustomerAssetsLOV/{AssetNumber}
Get all customer assets: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCustomerAssetsLOV

List of Values/Subscription Profiles

The subscriptions profiles resource to view the subscription profile details. The subscriptions profile has details such as accounting rule, invoicing rule, billing frequency, invoice text, and so on.

Get a subscription profile: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProfiles/{SubscriptionProfileId}
Get all subscription profiles: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProfiles

List of Values/Territories

The territories list of values resource is used to query the ISO standard territories.

Get all territories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/territoriesLOV

List of Values/Time Code Units

The time code units resource is used to view the time code conversion details. The time code units object has details such as user uom code, base uom code, conversion rate and so on.

Get a time code unit conversion: Method: get
Path: /crmRestApi/resources/11.13.18.05/timeCodeUnits/{ConversionId}
Get all time code unit conversions: Method: get
Path: /crmRestApi/resources/11.13.18.05/timeCodeUnits

List of Values/Time Zones

The time zones list of values resource is used to query the time zones.

Get all time zones: Method: get
Path: /fscmRestApi/resources/11.13.18.05/timezonesLOV

List of Values/Title

The navigator metadata resource is used to view saved searches, quick actions and menu items the authenticated user has access to.

Get a navigator resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/navigatorMetadata/{navigatorMetadataUniqID}
Get all navigator resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/navigatorMetadata

List of Values/Units of Measure

The Units of Measure resource gets the units of measure that an application, system, or service can use with the transaction.

Get: Method: get
Path: /crmRestApi/resources/11.13.18.05/productUnitOfMeasures/{UOMCode}
Get all: Method: get
Path: /crmRestApi/resources/11.13.18.05/productUnitOfMeasures

List of Values/Work Order Link Templates List of Values

The work order link templates list of values resource is used to view list of work order link templates provided in a list of values format.

Get a link template from list of values: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplatesLOV/{svcWoLinkTemplatesLOVUniqID}
Get all link templates from list of values: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplatesLOV

List of Values/Work Order Status Codes

The work order status codes resource is used to view the work order status. The list of values indicates the status of the work order such as Scheduled, Started, Canceled, Completed, and so on.

Get a work order status code: Method: get
Path: /crmRestApi/resources/11.13.18.05/woStatusCodeLookups/{woStatusCodeLookupsUniqID}
Get all work order status codes: Method: get
Path: /crmRestApi/resources/11.13.18.05/woStatusCodeLookups

List of Values/Work Order Type Mappings

The work order type mappings resource is used to view the work order type mappings. It provides a mapping of work order types to the corresponding integrated system type.

Get a work order type mapping: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoTypeMapLookups/{svcWoTypeMapLookupsUniqID}
Get all work order type mappings: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoTypeMapLookups

MDF Requests

The market development fund requests resource is used to view, create, update, and delete an MDF Request. An MDF request is a request for resources to develop and maintain sales and marketing activities.

Create an MDF request: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfRequests
Delete an MDF request: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}
Get all MDF requests: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests
Get an MDF request: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}
Update an MDF request: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}

MDF Requests/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Attachments/{AttachmentsUniqID}

MDF Requests/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

MDF Requests/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

MDF Requests/Claims

The claims resource is used to create, view, create, update, and delete claims. A claim is a request for reimbursement of marketing expenses submitted by a partner.

Create a claim: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim
Delete a claim: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim/{ClaimId}
Get a claim: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim/{ClaimId}
Get all claims: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim
Update a claim: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim/{ClaimId}

MDF Requests/MDF Request Teams

The Fund Request Teams resource is used to view, create, update, and delete a team member. An MDF request team member is a resource who is assigned to the MDF request team, and has the appropriate visibility and access to the MDF Request record.

Create a fund request resource: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource
Delete a fund request resource: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource/{FundRequestResourceId}
Get a fund request resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource/{FundRequestResourceId}
Get all fund request resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource
Update a fund request resource: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource/{FundRequestResourceId}

MDF Requests/Notes

The note resource is used to view, create, update, and delete notes associated with an MDF request. A note captures comments, information, or instructions related to an MDF request.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note/{NoteId}

MDF Requests/Notes/Large Object (LOB) Attributes - Note Text

The column which will store the actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note/{NoteId}/enclosure/NoteTxt

Machine Learning Use Cases

Create a use case: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases
Delete a use case: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}
Get a use case: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}
Get all use cases: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases
Update a use case: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}

Machine Learning Use Cases/Large Object (LOB) Attributes - AdditionalMetadata

Delete an AdditionalMetadata: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/enclosure/AdditionalMetadata
Get an AdditionalMetadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/enclosure/AdditionalMetadata
Replace an AdditionalMetadata: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/enclosure/AdditionalMetadata

Machine Learning Use Cases/Model Validation and Transformation Rules

Model Validation and Transformation Rules

Create a use case rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlFixedFieldRules
Delete a use case rule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}
Get a use case rule: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}
Get all use case rules: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlFixedFieldRules
Update a use case rule: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}

Machine Learning Use Cases/Model Validation and Transformation Rules/Large Object (LOB) Attributes - AdditionalMetadata

Delete an AdditionalMetadata: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/AdditionalMetadata
Get an AdditionalMetadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/AdditionalMetadata
Replace an AdditionalMetadata: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/AdditionalMetadata

Machine Learning Use Cases/Model Validation and Transformation Rules/Large Object (LOB) Attributes - RuleValue

Delete a RuleValue: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/RuleValue
Get a RuleValue: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/RuleValue
Replace a RuleValue: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/RuleValue

Machine Learning Use Cases/Sales Machine Learning Models

Sales Machine Learning Models

Create a machine learning model: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlJobs
Delete a machine learning model: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlJobs/{JobId}
Get a machine learning model: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlJobs/{JobId}
Get all machine learning models: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlJobs
Update a machine learning model: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlJobs/{JobId}

Machine Learning Use Cases/Use Case Available Fields

Sales Machine Learning Available Features

Create an available field: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseAvailableFields
Delete an available field: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseAvailableFields/{ZcaOmlUsecaseAvailableFieldsUniqID}
Get all available fields: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseAvailableFields
Get an available field: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseAvailableFields/{ZcaOmlUsecaseAvailableFieldsUniqID}
Update an available field: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseAvailableFields/{ZcaOmlUsecaseAvailableFieldsUniqID}

Machine Learning Use Cases/Use Case Selected Fields

Sales Machine Learning Selected Features

Create a use case selected field: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseFixedFields
Delete a use case selected field: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}
Get a use case selected field: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}
Get all use case selected fields: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseFixedFields
Update a use case selected field: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}

Machine Learning Use Cases/Use Case Selected Fields/Large Object (LOB) Attributes - AdditionalMetadata

Delete an AdditionalMetadata: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}/enclosure/AdditionalMetadata
Get an AdditionalMetadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}/enclosure/AdditionalMetadata
Replace an AdditionalMetadata: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}/enclosure/AdditionalMetadata

Maintenance/Debriefs

The Debriefs resource manages additional information for a source document, technician, business unit, customer party, customer account, bill-to site, item number, serial number, asset number, and debrief status.

Create debriefs: Method: post
Path: /fscmRestApi/resources/11.13.18.05/debriefs
Delete one debrief: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}
Get all debriefs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs
Get one debrief: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}
Update one debrief: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}

Maintenance/Debriefs/Debrief Lines

The Debrief Lines resource manages additional information for service activity, labor item, start time, end time, material item, quantity, unit of measure, expense item, amount, and currency code.

Create lines: Method: post
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/lines
Delete one line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/lines/{DebriefLineId}
Get all lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/lines
Get one line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/lines/{DebriefLineId}
Update one line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/lines/{DebriefLineId}

Maintenance/Debriefs/Debrief Lines/Charges

The Charges resource is used to view all the service charges for a debrief line.

Get all service charges: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/lines/{DebriefLineId}/child/charges
Get one service charge: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/lines/{DebriefLineId}/child/charges/{chargesUniqID}

Maintenance/Debriefs/Debrief Lines/Flexfields for Debrief Lines

The Flexfields for Debrief Lines resource manages the flexfields for a debrief line.

Create one debrief line flexfield: Method: post
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/lines/{DebriefLineId}/child/linesDFF
Get all debrief line flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/lines/{DebriefLineId}/child/linesDFF
Get one debrief line flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/lines/{DebriefLineId}/child/linesDFF/{DebriefLineId2}
Update one debrief line flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/lines/{DebriefLineId}/child/linesDFF/{DebriefLineId2}

Maintenance/Debriefs/Flexfields for Debriefs

The Flexfields for Debriefs resource manages the flexfields for a debrief.

Create one debrief flexfield: Method: post
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/debriefsDFF
Get all debrief flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/debriefsDFF
Get one debrief flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/debriefsDFF/{DebriefHeaderId2}
Update one debrief flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/debriefsDFF/{DebriefHeaderId2}

Maintenance/Debriefs/Flexfields for Project Details

The Flexfields for Project Details resource manages the flexfields that contain details about the project.

Create one project flexfield: Method: post
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/projectDetailsDFF
Get all project flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/projectDetailsDFF
Get one project flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/projectDetailsDFF/{DebriefHeaderId3}
Update one project flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/debriefs/{DebriefHeaderId}/child/projectDetailsDFF/{DebriefHeaderId3}

Maintenance/List of Values/Part Items List of Values

The Part Items List of Values resource gets the part item numbers.

Get all part items: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partItemsLOV
Get one part item: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partItemsLOV/{ItemId}

Maintenance/List of Values/Service Activities List of Values

The Service Activity List of Values resource manages the codes used to order parts for the customer support, the parts exchange, and the depot repair logistics business processes. These service activity codes drive the pricing and sales order creation.

Get all activities: Method: get
Path: /fscmRestApi/resources/11.13.18.05/serviceActivitiesLOV
Get one activity: Method: get
Path: /fscmRestApi/resources/11.13.18.05/serviceActivitiesLOV/{ServiceActivityId}

Maintenance/List of Values/Shipping Methods List Of Values

The shipping method list of values resource returns the shipping methods for an inventory organization.

Get all shipping methods: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partsShippingMethodsLOV
Get one shipping method: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partsShippingMethodsLOV/{partsShippingMethodsLOVUniqID}

Maintenance/Part Requirement Lines

Records that detail the requirements for a particular part or component. The records help you view, create, or update the part requirement for an Oracle Fusion Cloud Engagement service request, Oracle Engagement work order, or third-party document.

Create lines: Method: post
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines
Creates orders for part requirements: Method: post
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/action/orderPartRequirements
Delete one line: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}
Find the preferred source: Method: post
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/action/getPreferredSource
Find the preferred source and price the parts: Method: post
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/action/calculateSourceAndPrice
Finds all the sources from where the part can be sourced.: Method: post
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/action/getAvailableParts
Get all lines: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines
Get one line: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}
Refresh a part requirement line: Method: post
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/action/refreshLines
Update one line: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}

Maintenance/Part Requirement Lines/Flexfields for Part Requirement Lines

Data used to manage the flexfields for a part requirement line.

Create flexfields: Method: post
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/partRequirementLinesDFF
Get all flexfields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/partRequirementLinesDFF
Get one flexfield: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/partRequirementLinesDFF/{RequirementLineId2}
Update one flexfield: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/partRequirementLinesDFF/{RequirementLineId2}

Maintenance/Part Requirement Lines/Part Requirement Line Details

Records that contain additional details of a particular part or component. They help you view, create, or update sourcing information for a part requirement line.

Create line details: Method: post
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/lineDetails
Delete one line detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/lineDetails/{RequirementLineDetailId}
Get all line details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/lineDetails
Get one line detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/lineDetails/{RequirementLineDetailId}
Update one line detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/lineDetails/{RequirementLineDetailId}

Maintenance/Part Requirement Lines/Service Charges

Charges levied for the components of a part requirement line, for example, for a party site or a customer.

Get all service charges: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/serviceCharges
Get one service charge: Method: get
Path: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/serviceCharges/{ServiceChargeId}

Maintenance/Return Routing Rules

Rules for reverse logistics return routing that automatically determine the parts to be returned to a warehouse when the parts are returned from a source warehouse or from a customer location.

Create rules: Method: post
Path: /fscmRestApi/resources/11.13.18.05/returnRoutingRules
Delete one rule: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/returnRoutingRules/{RuleId}
Find a destination warehouse: Method: post
Path: /fscmRestApi/resources/11.13.18.05/returnRoutingRules/action/getDestination
Get all rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/returnRoutingRules
Get one rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/returnRoutingRules/{RuleId}
Update one rule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/returnRoutingRules/{RuleId}

Maintenance/Service Part Returns

The Service Part Returns resource gets the parts to be returned.

Get all parts: Method: get
Path: /fscmRestApi/resources/11.13.18.05/servicePartReturns
Get one part: Method: get
Path: /fscmRestApi/resources/11.13.18.05/servicePartReturns/{ReturnId}

Maintenance/Stocking Locations

Service that's used to create stocking-location records in the RCL_STOCK_LOCATION table to store additional attributes for inventory organizations and subinventories.

Create one stocking location: Method: post
Path: /fscmRestApi/resources/11.13.18.05/stockingLocations
Delete one stocking location: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/stockingLocations/{StockLocationId}
Get all stocking locations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/stockingLocations
Get one stocking location: Method: get
Path: /fscmRestApi/resources/11.13.18.05/stockingLocations/{StockLocationId}
Update one stocking location: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/stockingLocations/{StockLocationId}

Maintenance/Stocking Locations/Site-Dedicated Locations

Service that's used to create site-dedicated, stocking-location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.

Create one site-dedicated location: Method: post
Path: /fscmRestApi/resources/11.13.18.05/stockingLocations/{StockLocationId}/child/siteDedicatedLocations
Delete one site-dedicated location: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/stockingLocations/{StockLocationId}/child/siteDedicatedLocations/{SiteDedicatedLocId}
Get all site-dedicated locations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/stockingLocations/{StockLocationId}/child/siteDedicatedLocations
Get one site-dedicated location: Method: get
Path: /fscmRestApi/resources/11.13.18.05/stockingLocations/{StockLocationId}/child/siteDedicatedLocations/{SiteDedicatedLocId}
Update one site-dedicated location: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/stockingLocations/{StockLocationId}/child/siteDedicatedLocations/{SiteDedicatedLocId}

Maintenance/Technician Subinventories

The Technician Subinventories resource manages a technician subinventory that assigns an existing subinventory to a field service technician.

Create field service technician subinventories: Method: post
Path: /fscmRestApi/resources/11.13.18.05/technicianSubinventories
Get all field service technician subinventories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/technicianSubinventories
Get one field service technician subinventory: Method: get
Path: /fscmRestApi/resources/11.13.18.05/technicianSubinventories/{TechSubinventoryId}

Maintenance/Trunk Stocks

The Trunk Stocks resource gets trunk stock sub-inventory quantities and serial numbers.

Get all trunk stocks: Method: get
Path: /fscmRestApi/resources/11.13.18.05/trunkStocks
Get one trunk stock: Method: get
Path: /fscmRestApi/resources/11.13.18.05/trunkStocks/{trunkStocksUniqID}

Milestones

The milestone resource lets you view, create, update, and delete milestones.

Create a milestone: Method: post
Path: /crmRestApi/resources/11.13.18.05/milestones
Delete a milestone: Method: delete
Path: /crmRestApi/resources/11.13.18.05/milestones/{MilestoneConfigId}
Get a milestone: Method: get
Path: /crmRestApi/resources/11.13.18.05/milestones/{MilestoneConfigId}
Get all milestones: Method: get
Path: /crmRestApi/resources/11.13.18.05/milestones
Update a milestone: Method: patch
Path: /crmRestApi/resources/11.13.18.05/milestones/{MilestoneConfigId}

Multi Channel Adapter Events

The multi-channel adapter event is used to view, create, update, and delete the details of an event initiated through the multi-channel adapter. An event can be created and updated through the process event action of the resource for a number of different event names, like newCommEvent, startCommEvent, closeCommEvent, and more.

Create an event: Method: post
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents
Delete an event: Method: delete
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents/{McaEventId}
Fetch toolbar configuration: Method: post
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents/action/fetchUserEventConfiguration
Get all events: Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents
Get an event: Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents/{McaEventId}
Process a multi-channel adapter event: Method: post
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents/action/processEvent
Update an event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents/{McaEventId}

Multi-Channel Adapter Toolbars

The multi-channel adapter toolbars resource is used to view, create, update, and delete toolbars used by the multi-channel adapter framework. It provides configuration of multi-channel adapter toolbars. It support telephony, chat, and other real time integrations.

Create all toolbars: Method: post
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars
Delete a toolbar: Method: delete
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}
Get a toolbar: Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}
Get all toolbars: Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars
Update a toolbar: Method: patch
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}

Multi-Channel Adapter Toolbars/Multi-Channel Adapter Toolbar Additions

The adapter toolbar additions resource is used to view, create, update, and delete additional secondary user areas about a multi-channel adapter toolbar. It provides alternative configuration data for the multi-channel adapter toolbar parent.

Create all toolbar additions: Method: post
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition
Delete a toolbar addition: Method: delete
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition/{ToolbarAddlId}
Get a toolbar addition: Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition/{ToolbarAddlId}
Get all toolbar additions: Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition
Update a toolbar addition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition/{ToolbarAddlId}

My Self-Service Roles

The my self-service roles resource is used to view, create, and delete the roles for the self-service user who is currently logged in.

Get a self-service role: Method: get
Path: /crmRestApi/resources/11.13.18.05/mySelfServiceRoles/{RoleId}
Get all the self-service roles: Method: get
Path: /crmRestApi/resources/11.13.18.05/mySelfServiceRoles

Non-Duplicate Records

The resolution non-duplicate resource is used to view, create, and update non-duplicate records. Non-duplicate records prevent specified parties from appearing in future duplicate identification results.

Create a non-duplicate record: Method: post
Path: /crmRestApi/resources/11.13.18.05/nonDuplicates
Get a non-duplicate record: Method: get
Path: /crmRestApi/resources/11.13.18.05/nonDuplicates/{NonDuplicateId}
Get all non-duplicate records: Method: get
Path: /crmRestApi/resources/11.13.18.05/nonDuplicates
Update a non-duplicate record: Method: patch
Path: /crmRestApi/resources/11.13.18.05/nonDuplicates/{NonDuplicateId}

Notification Followers

The notification followers resource is used to view, create, update, and delete notifications for an object record.

Create a notification follow entry: Method: post
Path: /crmRestApi/resources/11.13.18.05/notificationFollowers
Delete a notification follow entry: Method: delete
Path: /crmRestApi/resources/11.13.18.05/notificationFollowers/{FollowerId}
Get a notification follower: Method: get
Path: /crmRestApi/resources/11.13.18.05/notificationFollowers/{FollowerId}
Get all notification followers: Method: get
Path: /crmRestApi/resources/11.13.18.05/notificationFollowers
Update a notification follow entry: Method: patch
Path: /crmRestApi/resources/11.13.18.05/notificationFollowers/{FollowerId}

Object Capacities

The object capacities resource is used to view, create, update, and delete an object capacity.

Create an object capacity: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectCapacities
Delete an object capacity: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectCapacities/{ObjectCapacityId}
Get all object capacities: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectCapacities
Get an object capacity: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectCapacities/{ObjectCapacityId}
Update an object capacity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectCapacities/{ObjectCapacityId}

Object Link Types

The object link types resource is used to view, create, update, and delete the object link types.

Create an object link type: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectLinkTypes
Delete an object link type: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectLinkTypes/{LinkTypeNumber}
Get all object link types: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectLinkTypes
Get an object link type: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectLinkTypes/{LinkTypeNumber}
Update an object link type: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectLinkTypes/{LinkTypeNumber}

Object Links

The object links resource is used to view, create, update, and delete an object link.

Create an object link: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectLinks
Delete an object link: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectLinks/{LinkNumber}
Get all object links: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectLinks
Get an object link: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectLinks/{LinkNumber}
Update an object link: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectLinks/{LinkNumber}

Object Metadata

The object metadata resource is used to view object metadata. It's also used to view business objects, object relations, object attributes and its corresponding properties.

Generate related object query: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/action/generateRelatedObjectQuery
Get all object metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata
Get an object metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}
View object query: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/action/generateFindByKeyQuery
View object query: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/action/generateObjectQuery

Object Metadata/Attribute Properties

The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.

Create an attribute property: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/objectProperties
Delete an attribute property: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/objectProperties/{objectPropertiesUniqID}
Get all attribute properties: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/objectProperties
Get an attribute property: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/objectProperties/{objectPropertiesUniqID}
Update an attribute property: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/objectProperties/{objectPropertiesUniqID}

Object Metadata/Attributes

The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition.

Create an attribute: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/attributes
Delete an attribute: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/attributes/{AttributeCode}
Get all attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/attributes
Get an attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/attributes/{AttributeCode}
Update an attribute: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/attributes/{AttributeCode}

Object Metadata/Attributes/Attribute Properties

The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.

Create an attribute property: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/attributes/{AttributeCode}/child/attributeProperties
Delete an attribute property: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/attributes/{AttributeCode}/child/attributeProperties/{attributePropertiesUniqID}
Get all attribute properties: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/attributes/{AttributeCode}/child/attributeProperties
Get an attribute property: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/attributes/{AttributeCode}/child/attributeProperties/{attributePropertiesUniqID}
Update an attribute property: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/attributes/{AttributeCode}/child/attributeProperties/{attributePropertiesUniqID}

Object Metadata/Child Object Metadata

The child object metadata resource is used to view, create, update, and delete child object metadata. It represents object hierarchy and can be used to navigate to child object specific relations and attributes.

Create a child object metadata: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata
Delete a child object metadata: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}
Get a child object metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}
Get all child object metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata
Update a child object metadata: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}

Object Metadata/Child Object Metadata/Attribute Properties

The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.

Create an attribute property: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/objectProperties
Delete an attribute property: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/objectProperties/{objectPropertiesUniqID}
Get all attribute properties: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/objectProperties
Get an attribute property: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/objectProperties/{objectPropertiesUniqID}
Update an attribute property: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/objectProperties/{objectPropertiesUniqID}

Object Metadata/Child Object Metadata/Attributes

The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition.

Create an attribute: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes
Delete an attribute: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes/{AttributeCode}
Get all attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes
Get an attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes/{AttributeCode}
Update an attribute: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes/{AttributeCode}

Object Metadata/Child Object Metadata/Attributes/Attribute Properties

The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.

Create an attribute property: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes/{AttributeCode}/child/attributeProperties
Delete an attribute property: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes/{AttributeCode2}/child/attributeProperties/{attributePropertiesUniqID}
Get all attribute properties: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes/{AttributeCode}/child/attributeProperties
Get an attribute property: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes/{AttributeCode2}/child/attributeProperties/{attributePropertiesUniqID}
Update an attribute property: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes/{AttributeCode2}/child/attributeProperties/{attributePropertiesUniqID}

Object Metadata/Child Object Metadata/Child Object Metadata

Create a child object metadata: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/childObjectMetadata
Delete a child object metadata: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/childObjectMetadata/{ObjectCode3}
Get a child object metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/childObjectMetadata/{ObjectCode3}
Get all child object metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/childObjectMetadata
Update a child object metadata: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/childObjectMetadata/{ObjectCode3}

Object Metadata/Child Object Metadata/Relationships

The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects.

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships/{RelationCode}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships/{RelationCode}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships/{RelationCode}

Object Metadata/Child Object Metadata/Relationships/Attribute Properties

The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.

Create an attribute property: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships/{RelationCode}/child/relationshipProperties
Delete an attribute property: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships/{RelationCode2}/child/relationshipProperties/{relationshipPropertiesUniqID}
Get all attribute properties: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships/{RelationCode}/child/relationshipProperties
Get an attribute property: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships/{RelationCode2}/child/relationshipProperties/{relationshipPropertiesUniqID}
Update an attribute property: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships/{RelationCode2}/child/relationshipProperties/{relationshipPropertiesUniqID}

Object Metadata/Relationships

The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects.

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/relationships
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/relationships/{RelationCode}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/relationships/{RelationCode}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/relationships
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/relationships/{RelationCode}

Object Metadata/Relationships/Attribute Properties

The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.

Create an attribute property: Method: post
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/relationships/{RelationCode}/child/relationshipProperties
Delete an attribute property: Method: delete
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/relationships/{RelationCode3}/child/relationshipProperties/{relationshipPropertiesUniqID}
Get all attribute properties: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/relationships/{RelationCode}/child/relationshipProperties
Get an attribute property: Method: get
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/relationships/{RelationCode3}/child/relationshipProperties/{relationshipPropertiesUniqID}
Update an attribute property: Method: patch
Path: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/relationships/{RelationCode3}/child/relationshipProperties/{relationshipPropertiesUniqID}

Objectives

The objectives resource is used to view, create, update, and delete sales objectives. Objectives are measurable tactical goals that partners need to meet to achieve a higher level strategic goal defined in the partner business plan. For example, objectives establish tactical goals, such as target revenue for a quarter, completing number of sales calls within a specific tenure of the business plan, and organizing a certain number of sales presentations.

Create an objective: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesObjectives
Delete an objective: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}
Get all objectives: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives
Get an objective: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}
Update an objective: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}

Objectives/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/AttachmentsVO
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/AttachmentsVO/{salesObjectives_AttachmentsVO_Id}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/AttachmentsVO
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/AttachmentsVO/{salesObjectives_AttachmentsVO_Id}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/AttachmentsVO/{salesObjectives_AttachmentsVO_Id}

Objectives/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/AttachmentsVO/{salesObjectives_AttachmentsVO_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/AttachmentsVO/{salesObjectives_AttachmentsVO_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/AttachmentsVO/{salesObjectives_AttachmentsVO_Id}/enclosure/FileContents

Objectives/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/AttachmentsVO/{salesObjectives_AttachmentsVO_Id}/enclosure/FileWebImage

Objectives/Objective Splits

The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters.

Create an objective split: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits
Delete an objective split: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits/{ObjectiveSplitId}
Get all objective splits: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits
Get an objective split: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits/{ObjectiveSplitId}
Update an objective split: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits/{ObjectiveSplitId}

Omnichannel Events

The omnichannel events resource is used to view and update omnichannel events. It tracks the events that happens while a business object is routed to an agent for assignment.

Get all omnichannel events: Method: get
Path: /crmRestApi/resources/11.13.18.05/omniChannelEvents
Get an omnichannel event: Method: get
Path: /crmRestApi/resources/11.13.18.05/omniChannelEvents/{EventId}

Omnichannel Presence and Availability

The omnichannel presence and availability resource is used to view and update an omnichannel presence and availability for new work assignments.

Get all omnichannel presence: Method: get
Path: /crmRestApi/resources/11.13.18.05/resourcePresences
Get an omnichannel presence: Method: get
Path: /crmRestApi/resources/11.13.18.05/resourcePresences/{ResourcePartyId}
Mark the resource as active: Method: post
Path: /crmRestApi/resources/11.13.18.05/resourcePresences/{ResourcePartyId}/action/keepAlive
Update an omnichannel presence: Method: patch
Path: /crmRestApi/resources/11.13.18.05/resourcePresences/{ResourcePartyId}

Omnichannel Properties

The omnichannel properties resource is used to create, get, and delete properties pertinent to channel types. Each channel type is described as real-time or non-real-time and designated to a media type.

Create an omnichannel property: Method: post
Path: /crmRestApi/resources/11.13.18.05/omniChannelProps
Delete an omnichannel property: Method: delete
Path: /crmRestApi/resources/11.13.18.05/omniChannelProps/{ChannelPropId}
Get all omnichannel properties: Method: get
Path: /crmRestApi/resources/11.13.18.05/omniChannelProps
Get an omnichannel property: Method: get
Path: /crmRestApi/resources/11.13.18.05/omniChannelProps/{ChannelPropId}
Update an omnichannel property: Method: patch
Path: /crmRestApi/resources/11.13.18.05/omniChannelProps/{ChannelPropId}

Opportunities

The opportunities resource is used to view, create, update, and delete an opportunity. An opportunity is a business object that is used to track and store data about potential sales.

Assign matched opportunity: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/action/assignOpportunity
Copy matched opportunity: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/action/copyOpportunity
Create an opportunity: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities
Create quote in Oracle CPQ Cloud: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/action/createQuote
Delete an opportunity: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}
Get all opportunities: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities
Get an opportunity: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}
Update an opportunity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}

Opportunities/Assessments

The assessments resource is used to view, create, update, and delete the assessment of an opportunity.

Create an assessment: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments
Delete an assessment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}
Get all assessments: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments
Get an assessment: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}
Update an assessment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}

Opportunities/Assessments/Assessment Answer Groups

The assessment answer groups resource is used to view and update the question groups in an assessment.

Get all assessment answer groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups
Get an assessment answer group: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}
Update an assessment answer group: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}

Opportunities/Assessments/Assessment Answer Groups/Assessment Answers

The assessment answers resource is used to view and update a response to a question in the question group.

Get all assessment answers: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer
Get an assessment answer: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}
Update an assessment answer: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}

Opportunities/Interviews

The interviews resource is used to view the list of interviews related to the opportunities.

Delete an interview: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews/{opportunities_Interviews_Id}
Get all interviews: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews
Get an interview: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews/{opportunities_Interviews_Id}
Get interview deployment names: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews/action/getInterviewDeployments

Opportunities/Interviews/Large Object (LOB) Attributes - InterviewData

Delete an InterviewData: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews/{opportunities_Interviews_Id}/enclosure/InterviewData
Get an InterviewData: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews/{opportunities_Interviews_Id}/enclosure/InterviewData
Replace an InterviewData: Method: put
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews/{opportunities_Interviews_Id}/enclosure/InterviewData

Opportunities/Interviews/Large Object (LOB) Attributes - InterviewDraft

Delete an InterviewDraft: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews/{opportunities_Interviews_Id}/enclosure/InterviewDraft
Get an InterviewDraft: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews/{opportunities_Interviews_Id}/enclosure/InterviewDraft
Replace an InterviewDraft: Method: put
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews/{opportunities_Interviews_Id}/enclosure/InterviewDraft

Opportunities/Notes

The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note/{NoteId}

Opportunities/Notes/Large Object (LOB) Attributes - Note Text

The column which stores the actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Opportunities/Object Hints

The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.

End date all object hints: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/AiObjectHints/action/endDateObjectHints
Get all object hints: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/AiObjectHints
Get an object hint: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/AiObjectHints/{ObjectHintId}
Update an object hint: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/AiObjectHints/{ObjectHintId}

Opportunities/Object Hints/Large Object (LOB) Attributes - Explanations

Delete an Explanations: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/AiObjectHints/{ObjectHintId}/enclosure/Explanations
Get an Explanations: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/AiObjectHints/{ObjectHintId}/enclosure/Explanations
Replace an Explanations: Method: put
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/AiObjectHints/{ObjectHintId}/enclosure/Explanations

Opportunities/Opportunity Attachments

The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment/{AttachmentUniqID}

Opportunities/Opportunity Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Opportunities/Opportunity Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Opportunities/Opportunity Campaigns

The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.

Create an opportunity campaign: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCampaigns
Delete an opportunity campaign: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCampaigns/{OptyCampaignId}
Get all opportunity campaigns: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCampaigns
Get an opportunity campaign: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCampaigns/{OptyCampaignId}
Update an opportunity campaign: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCampaigns/{OptyCampaignId}

Opportunities/Opportunity Competitors

The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.

Create an opportunity competitor: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2
Delete an opportunity competitor: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2/{OptyCompetitorId}
Get all opportunity competitors: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2
Get an opportunity competitor: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2/{OptyCompetitorId}
Update an opportunity competitor: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2/{OptyCompetitorId}

Opportunities/Opportunity Contacts

The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.

Create an opportunity contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact
Delete an opportunity contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact/{OptyConId}
Get all opportunity contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact
Get an opportunity contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact/{OptyConId}
Update an opportunity contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact/{OptyConId}

Opportunities/Opportunity Deals

The opportunity deals resource is used to view the deals associated with an opportunity.

Get all opportunity deals: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityDeal
Get an opportunity deal: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityDeal/{OptyDealId}

Opportunities/Opportunity Leads

The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.

Create an opportunity lead: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead
Delete an opportunity lead: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead/{OptyLeadId}
Get all opportunity leads: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead
Get an opportunity lead: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead/{OptyLeadId}
Update an opportunity lead: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead/{OptyLeadId}

Opportunities/Opportunity Partners

The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.

Create an opportunity revenue partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary
Delete an opportunity revenue partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary/{RevnPartOrgPartyId}
Get all opportunity revenue partners: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary
Get an opportunity revenue partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary/{RevnPartOrgPartyId}
Update an opportunity revenue partner: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary/{RevnPartOrgPartyId}

Opportunities/Opportunity Rollups

The opportunity rollups resource is used to view an opportunity rollup.

Get all opportunity rollups: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityRollup
Get an opportunity rollup: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityRollup/{OptyId}

Opportunities/Opportunity Sources

The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.

Create an opportunity source: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySource1
Delete an opportunity source: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySource1/{OptySrcId}
Get all opportunity sources: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySource1
Get an opportunity source: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySource1/{OptySrcId}
Update an opportunity source: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySource1/{OptySrcId}

Opportunities/Opportunity Stage Snapshots

The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.

Get all opportunity stage snapshots: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/opportunityStageSnapshots
Get an opportunity stage snapshot: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/opportunityStageSnapshots/{OptyStgSnapshotId}

Opportunities/Opportunity Subscriptions

The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.

Get all opportunity subscriptions: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySubscription
Get an opportunity subscription: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySubscription/{OptySubscriptionId}

Opportunities/Opportunity Team Members

The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.

Create an opportunity team member: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource
Delete an opportunity team member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource/{OpportunityResourceUniqID}
Get all opportunity team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource
Get an opportunity team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource/{OpportunityResourceUniqID}
Update an opportunity team member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource/{OpportunityResourceUniqID}

Opportunities/Opportunity Teams

The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.

Get all opportunity teams: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityTeam
Get an opportunity team (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityTeam/{OpportunityTeamUniqID}

Opportunities/Orchestration Associations

The orchestrations associations resource is used to view, create, update, and delete an orchestration association.

Create an orchestration association: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations
Disassociate the orchestration with the transactional object: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/action/detachAssociatedOrchestration
Get all orchestration associations: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations
Get an orchestration association: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}
Get unhelpful objective details: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/action/getNotHelpfulObjectiveDetails
Update an orchestration association: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}

Opportunities/Orchestration Associations/Error Logs

The error logs resource is used to view error logs associated to the orchestration associations.

Get all error logs: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs
Get an error log: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs/{ErrorLogsNumber}

Opportunities/Orchestration Associations/Error Logs/Large Object (LOB) Attributes - ErrorDescription

Delete an ErrorDescription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs/{ErrorLogsNumber}/enclosure/ErrorDescription
Get an ErrorDescription: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs/{ErrorLogsNumber}/enclosure/ErrorDescription
Replace an ErrorDescription: Method: put
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs/{ErrorLogsNumber}/enclosure/ErrorDescription

Opportunities/Orchestration Associations/Stage Objectives

The stage objectives resource is used to view the stage objectives of the orchestration association.

Get a sales objective: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StageObjectives/{RunTimeStageObjectiveNumber}
Get all sales objectives: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StageObjectives

Opportunities/Orchestration Associations/Stages

The stages resource is used to view the stage of the orchestration association.

Get a stage: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Stages/{RuntimeStageNumber}
Get all stages: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Stages

Opportunities/Orchestration Associations/Step Transitions

The step transitions resource is used to view the step transitions of the orchestration association.

Get a step transition: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions/{StepTransitionNumber}
Get all step transitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions

Opportunities/Orchestration Associations/Step Transitions/Large Object (LOB) Attributes - ActivityDescription

Delete an ActivityDescription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions/{StepTransitionNumber}/enclosure/ActivityDescription
Get an ActivityDescription: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions/{StepTransitionNumber}/enclosure/ActivityDescription
Replace an ActivityDescription: Method: put
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions/{StepTransitionNumber}/enclosure/ActivityDescription

Opportunities/Orchestration Associations/Steps

The steps resource is used to view the steps of the orchestration association.

Get a step: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Steps/{RunTimeStepNumber}
Get all steps: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Steps

Opportunities/Orchestration Associations/Steps In Execution Path

The steps in execution path resource is used to view all the steps including future steps of the orchestration association.

Get all orchestration steps: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepsInExecutionPath
Get an orchestration step: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepsInExecutionPath/{OrchestrationStepId}

Opportunities/Revenue Items

The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.

Create an opportunity revenue: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue
Delete an opportunity revenue: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}
Get all opportunity revenues: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue
Get an opportunity revenue: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}
Update an opportunity revenue: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}

Opportunities/Revenue Items/Child Split Revenues

The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.

Create a child split revenue: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/ChildSplitRevenue
Delete a child split revenue: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/ChildSplitRevenue/{ChildSplitRevenueUniqID}
Get a child split revenue: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/ChildSplitRevenue/{ChildSplitRevenueUniqID}
Get all child split revenues: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/ChildSplitRevenue
Update a child split revenue: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/ChildSplitRevenue/{ChildSplitRevenueUniqID}

Opportunities/Revenue Items/Opportunity Revenue Territories

The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.

Create a territory for an opportunity revenue: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RevenueTerritory
Delete an opportunity revenue territory: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RevenueTerritory/{RevenueTerritoryUniqID}
Get all opportunity revenue territories: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RevenueTerritory
Get an opportunity revenue territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RevenueTerritory/{RevenueTerritoryUniqID}
Update an opportunity revenue territory: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RevenueTerritory/{RevenueTerritoryUniqID}

Opportunities/Revenue Items/Product Groups

The product group resource is used to view the product groups associated with an opportunity. A product group is a business object that groups related products, so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.

Get a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/productGroups/{ProdGroupId}
Get all product groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/productGroups
Set usag code (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/productGroups/action/setUsagCode
Set usage code (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/productGroups/action/setUsageCode
Set usage mode (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/productGroups/action/setUsageMode
Set user selection (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/productGroups/action/setUserSelectionForTM

Opportunities/Revenue Items/Products

The products resource is used to view the products associated with an opportunity.

Get a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/products/{productsUniqID}
Get all products: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/products
Set selected product group Id (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/products/action/setSelectedProductGroupId
Set usage code (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/products/action/setUsageCode
Set usage mode (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/products/action/setUsageMode
Set user selection (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/products/action/setUserSelectionForTM

Opportunities/Revenue Items/Recurring Revenues

The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.

Create a recurring revenue: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RecurringRevenue
Delete a recurring revenue: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RecurringRevenue/{RevnId}
Get a recurring revenue: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RecurringRevenue/{RevnId}
Get all recurring revenues: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RecurringRevenue
Update a recurring revenue: Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RecurringRevenue/{RevnId}

Opportunities/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{opportunities_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/action/generateSmartActions
Get a smart action (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{opportunities_smartActions_Id}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/action/processMassAction

Opportunities/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{opportunities_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{opportunities_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{opportunities_smartActions_Id}/enclosure/ActionIntent

Opportunities/Smart Actions/Smart Action REST Path Parameter Definitions

Get all action URL bindings (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{opportunities_smartActions_Id}/child/UserActionURLBinding
Get an action URL binding (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{opportunities_smartActions_Id}/child/UserActionURLBinding/{opportunities_smartActions_UserActionURLBinding_Id}

Opportunities/Smart Actions/Smart Action REST Payload Definitions

Get all action request payload (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{opportunities_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{opportunities_smartActions_Id}/child/UserActionRequestPayload/{opportunities_smartActions_UserActionRequestPayload_Id}

Opportunities/Smart Actions/Smart Action User Interface Definitions

Get all action navigations (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{opportunities_smartActions_Id}/child/UserActionNavigation
Get an action navigation (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{opportunities_smartActions_Id}/child/UserActionNavigation/{opportunities_smartActions_UserActionNavigation_Id}

Opportunities/Win Probability Details

The win probability details resource is used to view the details of the winning probability of an opportunity.

Get a win probability detail not supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/winProbabilityDetails/{winProbabilityDetailsUniqID}
Get all win probability details: Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/winProbabilityDetails

Orchestration Supported Objects

The orchestration supported objects resource is used to view the objects that support orchestration.

Generate related object query: Method: post
Path: /crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects/action/generateRelatedObjectQuery
Get all orchestration supported objects: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects
Get an orchestration supported object: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects/{orchestrationSupportedObjectsUniqID}
View object query: Method: post
Path: /crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects/action/generateFindByKeyQuery
View object query: Method: post
Path: /crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects/action/generateObjectQuery

Orchestrations

The orchestrations resource is used to view, create, update, and delete an orchestration. It's a guided series of sequential stages and steps to help you plan and advance your business workflows at maximum efficiency.

Copy orchestration: Method: post
Path: /crmRestApi/resources/11.13.18.05/orchestrations/action/cloneOrchestration
Create an orchestration: Method: post
Path: /crmRestApi/resources/11.13.18.05/orchestrations
Delete an orchestration: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}
Get all orchestrations: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations
Get an orchestration: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}
Update an orchestration: Method: patch
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}

Orchestrations/Error Logs

The error logs resource is used to view the error details.

Get all orchestration error logs: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/ErrorLogs
Get an orchestration error log: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/ErrorLogs/{ErrorLogsNumber}

Orchestrations/Error Logs/Large Object (LOB) Attributes - ErrorDescription

Delete an ErrorDescription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/ErrorLogs/{ErrorLogsNumber}/enclosure/ErrorDescription
Get an ErrorDescription: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/ErrorLogs/{ErrorLogsNumber}/enclosure/ErrorDescription
Replace an ErrorDescription: Method: put
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/ErrorLogs/{ErrorLogsNumber}/enclosure/ErrorDescription

Orchestrations/Large Object (LOB) Attributes - AssociationCriteriaExpression

Delete an AssociationCriteriaExpression: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/enclosure/AssociationCriteriaExpression
Get an AssociationCriteriaExpression: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/enclosure/AssociationCriteriaExpression
Replace an AssociationCriteriaExpression: Method: put
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/enclosure/AssociationCriteriaExpression

Orchestrations/Large Object (LOB) Attributes - SimulationCriteriaExpression

Delete a SimulationCriteriaExpression: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/enclosure/SimulationCriteriaExpression
Get a SimulationCriteriaExpression: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/enclosure/SimulationCriteriaExpression
Replace a SimulationCriteriaExpression: Method: put
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/enclosure/SimulationCriteriaExpression

Orchestrations/Stages

The stages resource is used to view, create, update, and delete an orchestration stage. The stages are a collection of steps, objectives, and associations.

Create an orchestration stage: Method: post
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages
Delete an orchestration stage: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}
Get all orchestration stages: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages
Get an orchestration stage: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}
Update an orchestration stage: Method: patch
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}

Orchestrations/Stages/Stage Objectives

The stage objectives resource is used to view, create, update, and delete a stage objective. It's a free form of goals to achieve in a particular stage.

Create an orchestration stage objective: Method: post
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StageObjectives
Delete an orchestration stage objective: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StageObjectives/{StageObjectiveNumber}
Get all orchestration stage objectives: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StageObjectives
Get an orchestration stage objective: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StageObjectives/{StageObjectiveNumber}
Update an orchestration stage objective: Method: patch
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StageObjectives/{StageObjectiveNumber}

Orchestrations/Stages/Step Objective Associations

The step objective associations resource is used to view, create, update, and delete a step objective association. It's the objective of performing a step. One step can be mapped to multiple objectives.

Create an orchestration step objective association: Method: post
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepObjectivesAssociations
Delete an orchestration step objective association: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepObjectivesAssociations/{StepObjectiveAssocNumber}
Get all orchestration step objective associations: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepObjectivesAssociations
Get an orchestration step objective association: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepObjectivesAssociations/{StepObjectiveAssocNumber}
Update an orchestration step objective association-Not Supported: Method: patch
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepObjectivesAssociations/{StepObjectiveAssocNumber}

Orchestrations/Stages/Step Tasks

Step tasks contains the list of tasks and their related information for a given step.

Create a step task: Method: post
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks
Delete a step task: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}
Get a step task: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}
Get all step tasks: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks
Update a step task: Method: patch
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}

Orchestrations/Stages/Step Tasks/Large Object (LOB) Attributes - AssignedToRule

Delete an AssignedToRule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}/enclosure/AssignedToRule
Get an AssignedToRule: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}/enclosure/AssignedToRule
Replace an AssignedToRule: Method: put
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}/enclosure/AssignedToRule

Orchestrations/Stages/Step Tasks/Large Object (LOB) Attributes - FieldUpdateJson

Delete a FieldUpdateJson: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}/enclosure/FieldUpdateJson
Get a FieldUpdateJson: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}/enclosure/FieldUpdateJson
Replace a FieldUpdateJson: Method: put
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}/enclosure/FieldUpdateJson

Orchestrations/Stages/Step Tasks/Large Object (LOB) Attributes - OrchestrationStepTaskDescription

Delete an OrchestrationStepTaskDescription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}/enclosure/OrchestrationStepTaskDescription
Get an OrchestrationStepTaskDescription: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}/enclosure/OrchestrationStepTaskDescription
Replace an OrchestrationStepTaskDescription: Method: put
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}/enclosure/OrchestrationStepTaskDescription

Orchestrations/Stages/Steps

The steps resource is used to view, create, update, and delete a step. Steps are individual action items such as execute a smart action, send an email, make a phone call, and so on.

Create an orchestration step: Method: post
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps
Delete an orchestration step: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}
Get all orchestration steps: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps
Get an orchestration step: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}
Update an orchestration step: Method: patch
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}

Orchestrations/Stages/Steps/Large Object (LOB) Attributes - EmailContactsFilterCriteria

Delete an EmailContactsFilterCriteria: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}/enclosure/EmailContactsFilterCriteria
Get an EmailContactsFilterCriteria: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}/enclosure/EmailContactsFilterCriteria
Replace an EmailContactsFilterCriteria: Method: put
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}/enclosure/EmailContactsFilterCriteria

Orchestrations/Stages/Steps/Large Object (LOB) Attributes - FieldUpdateJson

Delete a FieldUpdateJson: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}/enclosure/FieldUpdateJson
Get a FieldUpdateJson: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}/enclosure/FieldUpdateJson
Replace a FieldUpdateJson: Method: put
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}/enclosure/FieldUpdateJson

Orchestrations/Stages/Steps/Large Object (LOB) Attributes - SuccessCriteria

Delete a SuccessCriteria: Method: delete
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}/enclosure/SuccessCriteria
Get a SuccessCriteria: Method: get
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}/enclosure/SuccessCriteria
Replace a SuccessCriteria: Method: put
Path: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}/enclosure/SuccessCriteria

Outbound Messages

The outbound messages resource is used to view, create, update, and delete an outbound message. It's used to get the description of the root outbound message resource.

Create an outbound message: Method: post
Path: /crmRestApi/resources/11.13.18.05/outboundMessages
Create an outbound message for a business object: Method: post
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/action/getMessageDetails
Delete an outbound message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}
Get all outbound messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/outboundMessages
Get an outbound message: Method: get
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}
Update an outbound message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}

Outbound Messages/Large Object (LOB) Attributes - Body

Delete a Body: Method: delete
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/enclosure/Body
Get a Body: Method: get
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/enclosure/Body
Replace a Body: Method: put
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/enclosure/Body

Outbound Messages/Large Object (LOB) Attributes - MessageContent

Delete a MessageContent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/enclosure/MessageContent
Get a MessageContent: Method: get
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/enclosure/MessageContent
Replace a MessageContent: Method: put
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/enclosure/MessageContent

Outbound Messages/Outbound Message Parts

The outbound message parts resource is used to view, create, update, and delete an outbound message part. It's used to get the description of the root outbound message resource part.

Create an outbound message parts: Method: post
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/child/OutboundMsgParts
Delete an outbound message part: Method: delete
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/child/OutboundMsgParts/{OutboundMsgPartId}
Get all outbound message parts: Method: get
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/child/OutboundMsgParts
Get an outbound message part: Method: get
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/child/OutboundMsgParts/{OutboundMsgPartId}
Update an outbound message part: Method: patch
Path: /crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/child/OutboundMsgParts/{OutboundMsgPartId}

Participant Compensation Plans

The participant compensation plans resource is used to view and update the participant plan. A participant compensation plan defines how to calculate earnings for a participant.

Get a participant compensation plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}
Get all participant compensation plans: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans
Update a participant compensation plan: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}

Participant Compensation Plans/Descriptive Flex Fields

The participant compensation plan descriptive flex fields resource is used to view and update custom attributes for a participant compensation plan. You can configure and deploy participant plan flex fields using the Setup and Maintenance, Manage Incentive Compensation Descriptive Flexfields task.

Get all descriptive flex fields for a participant plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantCompensationPlansDFFs
Get descriptive flex fields for a participant plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantCompensationPlansDFFs/{SrpCompPlanId}
Update descriptive flex fields for a participant plan: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantCompensationPlansDFFs/{SrpCompPlanId}

Participant Compensation Plans/Plan Components

The participant compensation plan components resource is used to view and update the plan components for a participant compensation plan. It can also be used to update the plan component target percentage and enable or disable further individualization of goals and rates.

Get a plan component: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}
Get all plan components: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents
Update a plan component: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}

Participant Compensation Plans/Plan Components/Performance Measures

The plan component performance measures resource is used to view the participant performance measures for a plan component. A performance measure is used to measure the performance attainment.

Get a performance measure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}
Get all performance measures: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures

Participant Compensation Plans/Plan Components/Performance Measures/Goals

The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.

Get a performance measure goal: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}
Get all performance measure goals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals
Update a performance measure goal: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}

Participant Compensation Plans/Plan Components/Performance Measures/Goals/Interval Goals

The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.

Get all interval goals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalIntervalGoals
Get an interval goal: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalIntervalGoals/{ParticipantIntervalGoalId}

Participant Compensation Plans/Plan Components/Performance Measures/Goals/Period Goals

The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.

Get a period goal: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalPeriodGoals/{ParticipantPeriodGoalId}
Get all period goals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalPeriodGoals
Update a period goal: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalPeriodGoals/{ParticipantPeriodGoalId}

Participant Compensation Plans/Plan Components/Performance Measures/Large Object (LOB) Attributes - RenderedMeasureFormulaExpression

Delete a RenderedMeasureFormulaExpression: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/enclosure/RenderedMeasureFormulaExpression
Get a RenderedMeasureFormulaExpression: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/enclosure/RenderedMeasureFormulaExpression
Replace a RenderedMeasureFormulaExpression: Method: put
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/enclosure/RenderedMeasureFormulaExpression

Participant Compensation Plans/Plan Components/Performance Measures/Scorecards

The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.

Get a performance measure scorecard: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards/{ParticipantPerformanceMeasureScorecardId}
Get all performance measure scorecards: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards

Participant Compensation Plans/Plan Components/Performance Measures/Scorecards/Scorecard Rates

The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component.

Create a scorecard rate: Method: post
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards/{ParticipantPerformanceMeasureScorecardId}/child/ParticipantScorecardRates
Get a scorecard rate: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards/{ParticipantPerformanceMeasureScorecardId}/child/ParticipantScorecardRates/{ParticipantScorecardRateId}
Get all scorecard rates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards/{ParticipantPerformanceMeasureScorecardId}/child/ParticipantScorecardRates
Update a scorecard rate: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards/{ParticipantPerformanceMeasureScorecardId}/child/ParticipantScorecardRates/{ParticipantScorecardRateId}

Participant Compensation Plans/Plan Components/Rate Tables

The plan component rate tables resource is used to view the rate tables for a participant plan component. The plan component rate table determines the compensation rate for earning calculations.

Get a plan component rate table: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}
Get all plan component rate tables: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables

Participant Compensation Plans/Plan Components/Rate Tables/Rate Table Rates

The rate table rates resource is used to view, create, and update the rates for a participant rate table that can be individualized. You enable individualization for a rate table by setting the Individualize option to Yes for the related participant plan component.

Create a rate table rate: Method: post
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}/child/ParticipantRateTableRates
Get a rate table rate: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}/child/ParticipantRateTableRates/{ParticipantRateTableRateId}
Get all rate table rates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}/child/ParticipantRateTableRates
Update a rate table rate: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{participantCompensationPlansUniqID}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}/child/ParticipantRateTableRates/{ParticipantRateTableRateId}

Participants

The participants resource is used to view and update a participant. A participant is anyone in the system who could receive a credit or is an associate in the sales hierarchy, e.g.: a Sales Manager or a Sales Representative.

Create a participant header: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants
Get a participant: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}
Get all participants: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants
Update a participant: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}

Participants/Participant Details

The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.

Create a participant detail: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails
Get a participant detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails/{ParticipantDetailId}
Get all participant details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails
Update a participant detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails/{ParticipantDetailId}

Participants/Participant Details/Participant Details Descriptive Flex Fields

The participant details descriptive flex fields resource is used to view, create, or update custom attributes for a participant details resource and define validations for them. It is also used to delete an existing participant details flex field.

Create a descriptive flex field: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails/{ParticipantDetailId}/child/participantDetailsDFF
Get a descriptive flex field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails/{ParticipantDetailId}/child/participantDetailsDFF/{ParticipantDetailId2}
Get all descriptive flex fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails/{ParticipantDetailId}/child/participantDetailsDFF
Update a descriptive flex field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantDetails/{ParticipantDetailId}/child/participantDetailsDFF/{ParticipantDetailId2}

Participants/Participant Roles

The participant roles resource is used to view, create, update, and delete a role associated with a participant, such as a sales representative or a sales manager.

Create a participant role: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantRoles
Delete a participant role: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantRoles/{ParticipantRoleId}
Get a participant role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantRoles/{ParticipantRoleId}
Get all participant roles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantRoles
Update a participant role: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantRoles/{ParticipantRoleId}

Participants/Participants Descriptive Flex Fields

The participant descriptive flex fields resource is used to view, create, or update custom attributes for a participant resource and define validations for them. It is also used to delete an existing participant flex field.

Create a descriptive flex field: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/participantsDFF
Get a descriptive flex field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/participantsDFF/{ParticipantId}
Get all descriptive flex fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/participantsDFF
Update a descriptive flex field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/participantsDFF/{ParticipantId}

Partner Contacts

The partner contacts resource is used to view, create, update, and delete a partner contact.

Create a partner contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts
Delete a partner contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}
Get a partner contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}
Get all partner contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts
Update a partner contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}

Partner Contacts/Addresses

The addresses resource is used to view, create, update, and delete addresses of a partner contact.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/addresses
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/addresses/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/addresses
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/addresses/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/addresses/{AddressNumber}

Partner Contacts/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/attachments/{attachmentsUniqID}

Partner Contacts/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Partner Contacts/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Partner Contacts/Contact Points

The contact points resource is used to view, create, update, and delete the partner contact's contact points such as e-mail address, phone number, fax number, and so on. These contact points can be assiged as a public contact point for the partner-contact. Such as a contact point created for an e-mail address can be assigned as a public e-mail address for the partner contact.

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/contactPoints
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/contactPoints/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/contactPoints/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/contactPoints
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/contactPoints/{ContactPointId}

Partner Contacts/Partner Contact User Details

The user details resource is used to view, create, update, and delete an user detail.

Create an user detail: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/userdetails
Delete an user detail: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/userdetails/{Username}
Get all user details: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/userdetails
Get an user detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/userdetails/{Username}
Update an user detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/userdetails/{Username}

Partner Contacts/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/{partnerContacts_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/action/generateSmartActions
Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/{partnerContacts_smartActions_Id}
Get action evaluation attributes: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions
Get attributes: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/action/getAttributesForResource
Get entities: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/action/getEntities
Get object functions: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/action/getObjectFunctions
Process mass action: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/action/processMassAction

Partner Contacts/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/{partnerContacts_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/{partnerContacts_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/{partnerContacts_smartActions_Id}/enclosure/ActionIntent

Partner Contacts/Smart Actions/Smart Action REST Path Parameter Definitions

Get all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/{partnerContacts_smartActions_Id}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/{partnerContacts_smartActions_Id}/child/UserActionURLBinding/{partnerContacts_smartActions_UserActionURLBinding_Id}

Partner Contacts/Smart Actions/Smart Action REST Payload Definitions

Get all action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/{partnerContacts_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/{partnerContacts_smartActions_Id}/child/UserActionRequestPayload/{partnerContacts_smartActions_UserActionRequestPayload_Id}

Partner Contacts/Smart Actions/Smart Action User Interface Definitions

Get all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/{partnerContacts_smartActions_Id}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/smartActions/{partnerContacts_smartActions_Id}/child/UserActionNavigation/{partnerContacts_smartActions_UserActionNavigation_Id}

Partner Programs

The partner programs resource is used to view, create, update, and delete partner programs. Partner programs are used to set up a program structure to distinguish and reward your partners, based on their performance and contributions to the business.

Create a partner program: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms
Delete a partner program: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}
Delete a partner program: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/action/delete
Get a partner program: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}
Get all partner programs: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms
Update a partner program: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}

Partner Programs/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/Attachments/{AttachmentsUniqID}

Partner Programs/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Partner Programs/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Partner Programs/Countries

The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.

Create a country for a partner program: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries
Delete a country from a partner program: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries/{ProgramCountryId}
Get a country for a partner program: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries/{ProgramCountryId}
Get all countries for a partner program: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries
Update a country for a partner program: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries/{ProgramCountryId}

Partner Programs/Program Benefit Details

The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.

Create a program benefit for a partner program: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails
Delete a program benefit from a partner program: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}
Get a program benefit for a partner program: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}
Get all program benefits for a partner program: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails
Update a program benefit for a partner program: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}

Partner Programs/Tiers

The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.

Create a tier for a partner program: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers
Delete a tier from a partner program: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers/{ProgramTierId}
Get a tier for a partner program: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers/{ProgramTierId}
Get all tiers for a partner program: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers
Update a tier for a partner program: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers/{ProgramTierId}

Partner Tiers

The partner tiers resource is used to view, create, update, and delete the tiers a partner can be added to. Partner tiers help with the assignment of partners and partner programs.

Create a partner tier: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerTiers
Delete a partner tier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}
Delete partner tier: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}/action/delete
Get a partner tier: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}
Get all partner tiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerTiers
Move down partner tier: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}/action/moveDown
Move up partner tier: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}/action/moveUp
Update a partner tier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}

Partners

The partners resource is used to view, create, and update partners. A partner is an independent business that works with one or many channel organizations. A partner could engage with an organization in sales or service, as an influencer, as support, and so on. Note: The FiscalYearendMonth attribute is not supported in the Partner REST resource though it is listed for the Partner object in the App Composer.

Create a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners
Get a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}
Get all partners: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners
Update a partner: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}

Partners/Addresses

The addresses resource is used to view, create, update, and delete addresses of a partner.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses/{AddressNumber}

Partners/Assessments

The assessments resource is used to view, create, update, and delete the assessment of a partner.

Create an assessment: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment
Delete an assessment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}
Get all assessments: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment
Get an assessment: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}
Update an assessment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}

Partners/Assessments/Assessment Answer Groups

The assessment answer groups resource is used to view and update the question groups in an assessment.

Get all assessment answer groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}/child/AssessAnswerGroups
Get an assessment answer group: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}

Partners/Assessments/Assessment Answer Groups/Assessment Answers

The assessment answers resource is used to view and update a response to a question in the question group.

Get all assessment answers: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer
Get an assessment answer: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}
Update an assessment answer: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}

Partners/Attachments

An attachments resource is used to view, create, modify or delete the partner's attachments.

Create a partner attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments
Delete a partner attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}
Get a partner attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}
Get all partner attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments
Update a partner attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}

Partners/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Partners/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Partners/Contact Points

The contact points resource is used to view, create, update, and delete the partner's contact points such as e-mail address, phone number, fax number etc. These contact points can be assiged as a public contact point for the partner. For example, a contact point created for an e-mail address can be assigned as a public e-mail address for the partner.

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints/{ContactPointId}

Partners/Expertises

The expertise resource is used to view, create, and delete the partner's expertise. Partner expertise indicates areas where the partner has special knowledge or skill.

Create an expertise for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises
Delete an expertise for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises/{PartnerMultivalLovId}
Get all expertises for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises
Get an expertise for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises/{PartnerMultivalLovId}

Partners/Focus Areas

The focus areas resource is used to view, create, or delete the partner's focus areas. For example, a partner's focus area can be green servers.

Create a product specialty for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities
Delete a product specialty for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities/{PartnerDimMembersId}
Get a product specialty for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities/{PartnerDimMembersId}
Get all product specialties for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities

Partners/Geographies

The partner geographies resource is used to view, create, delete the geographies that the partner operates in, such as US, CA, and so on.

Create a geography for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies
Delete a geography for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies/{PartnerDimMembersId}
Get a geography for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies/{PartnerDimMembersId}
Get all geographies for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies

Partners/Industries

The industries resource is used to view, create, and delete the industries that a channel partner works with. For example, a partner's industry can be manufacturing or automotive.

Create an industry for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries
Delete an industry for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries/{PartnerDimMembersId}
Get all industries for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries
Get an industry for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries/{PartnerDimMembersId}

Partners/Notes

The note resource is used to view, create, update, and delete notes associated with a partner. A note captures comments, information, or instructions related to a partner.

Create a note for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes
Delete a note for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}
Get a note for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}
Get all notes for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes
Update a note for a partner: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}

Partners/Notes/Large Object (LOB) Attributes - Note Text

The actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}/enclosure/NoteTxt

Partners/Partner Account Team Members

The partner account team members resource is used to view, create, update, and delete the team members who will work with the partner. The team members are responsible for a partner account, and have access to edit the partner account information.

Create a partner account team member for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers
Delete a partner account team member for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers/{PartnerAccountResourceId}
Get a partner account team member for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers/{PartnerAccountResourceId}
Get all partner account team members for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers
Update a partner account team member for a partner: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers/{PartnerAccountResourceId}

Partners/Partner Announcements

The partner annoucements resource is used to view the partner annoucements which are relavant to the partner user based on the partner company. The partner annoucements are created by channel users and the audience is defined based on partner company or attributes of the partner company.

Get a partner announcement: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/partnerAnnouncements/{AnnouncementId}
Get all partner announcements: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/partnerAnnouncements

Partners/Partner Announcements/Large Object (LOB) Attributes - Description

Get a Description: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/partnerAnnouncements/{AnnouncementId}/enclosure/Description

Partners/Partner Certifications

The partner certifications resource is used to view, create, and delete the certifications of a partner. Through certifications, partners can qualify for competencies offered by the channel organization and become eligible for higher partner levels (Gold, Silver, Bronze), increased discounts, and so on.

Create a certification for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications
Delete a certification for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications/{PartnerMultivalLovId}
Get a certification for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications/{PartnerMultivalLovId}
Get all certifications for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications

Partners/Partner Contacts

The partner contacts resource is used to view, create, update, and delete the contacts of a partner company. For example, a partner sales rep, a partner sales manager, a partner administrator, and so on. Note: The following attributes are not supported in the Partner Contacts resource, though they are listed for the Partner object in the App Composer: ContactRole, ContactStatus, RegistrationStatus, SalesProfileStatus, RecordSet, DataCloudStatus, and TimezoneCode.

Create a partner contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts
Delete a partner contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}
Get a partner contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}
Get all partner contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts
Update a partner contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}

Partners/Partner Contacts/Attachments

An attachments resource is used to view, create, modify or delete the partner's attachments.

Create a partner attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments
Delete a partner attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}
Get a partner attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}
Get all partner attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments
Update a partner attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}

Partners/Partner Contacts/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Partners/Partner Contacts/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Partners/Partner Contacts/User Account Details

The user account details resource is used to view, create, update, and delete the user account details of a partner contact.

Create a partner contact user detail: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails
Delete a partner contact user detail: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails/{Username}
Get a partner contact user details: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails/{Username}
Get all partner contact user details: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails
Update a partner contact user detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails/{Username}

Partners/Partner Types

Create a partner type: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types
Delete a partner type: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types/{PartnerDimMembersId}
Get a partner type: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types/{PartnerDimMembersId}
Get all partner types: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types

Partners/Record Set Lookup

The recordset lookup resource lets you create, update and delete a recortset lookup.

Create a record set lookup: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/RecordSetLookup
Delete a record set lookup: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/RecordSetLookup/{partners_RecordSetLookup_Id}
Get a record set lookup: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/RecordSetLookup/{partners_RecordSetLookup_Id}
Get all record set lookups: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/RecordSetLookup
Update a record set lookup: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/RecordSetLookup/{partners_RecordSetLookup_Id}

Partners/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{partners_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/action/generateSmartActions
Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{partners_smartActions_Id}
Get action evaluation attributes: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions
Get attributes: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/action/getAttributesForResource
Get entities: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/action/getEntities
Get object functions: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/action/getObjectFunctions
Process mass action: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/action/processMassAction

Partners/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{partners_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{partners_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{partners_smartActions_Id}/enclosure/ActionIntent

Partners/Smart Actions/Smart Action REST Path Parameter Definitions

Get all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{partners_smartActions_Id}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{partners_smartActions_Id}/child/UserActionURLBinding/{partners_smartActions_UserActionURLBinding_Id}

Partners/Smart Actions/Smart Action REST Payload Definitions

Get all action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{partners_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{partners_smartActions_Id}/child/UserActionRequestPayload/{partners_smartActions_UserActionRequestPayload_Id}

Partners/Smart Actions/Smart Action User Interface Definitions

Get all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{partners_smartActions_Id}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{partners_smartActions_Id}/child/UserActionNavigation/{partners_smartActions_UserActionNavigation_Id}

Passive Beacon Service Statuses

The passive beacon service statuses resource is internally used to view the available information of the chat service. In order to call this API, a Provider and a Service have to be registered. This API is related to the Chat "ProviderName": "RTENG" and its only service "ServiceName": "RTENG_SERVICE". This method returns the Chat Server availability information. This method can be called using a GET HTTP request containing an Authorization header. The passiveBeaconProviderStatus method is protected by the entitlement SVC_DETERMINE_SERVICE_STATUS_PRIV assigned to ORA_SVC_SERVICE_STATUS_COMPUTATION role.

Get a passive beacon provider status - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/passiveBeaconProviderStatus/{ProviderId}
Get all passive beacon provider statuses: Method: get
Path: /crmRestApi/resources/11.13.18.05/passiveBeaconProviderStatus

Passive Beacon Service Statuses/Passive Beacon Provider Statuses

The passive beacon provider statuses resource is internally used to view the available information of the chat service.

Get a passive beacon service status - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/passiveBeaconProviderStatus/{ProviderId}/child/PassiveBeaconServiceStatus/{ServiceId}
Get all passive beacon service statuses: Method: get
Path: /crmRestApi/resources/11.13.18.05/passiveBeaconProviderStatus/{ProviderId}/child/PassiveBeaconServiceStatus

Pay Groups

The pay groups resource is used to view, create, update, and delete an incentive compensation pay group. A pay group is used to gather participants that are on the same payment cycle and are paid by the same payment application.

Create a pay group: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups
Delete a pay group: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}
Get a pay group: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}
Get all pay groups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups
Update a pay group: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}

Pay Groups/Pay Group Assignments

The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group.

Create a pay group assignments: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupAssignments
Delete a pay group assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupAssignments/{ParticipantPayGroupId}
Get a pay group assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupAssignments/{ParticipantPayGroupId}
Get all pay group assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupAssignments
Update a pay group assignments: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupAssignments/{ParticipantPayGroupId}

Pay Groups/Pay Group Roles

The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group.

Create a pay group role: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles
Delete a pay group role: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles/{RolePayGroupId}
Get a pay group role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles/{RolePayGroupId}
Get all pay group roles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles
Update a pay group role: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles/{RolePayGroupId}

Payment Batches

The payment batches resource is used to view and create payment batches. Payment batches are used to generate the paysheets for each participant who meets the payment batch selection criteria.

Create a payment batch: Method: post
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches
Get a payment batch: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}
Get all payment batches: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches

Payment Batches/Payment Transactions

The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.

Create a manual adjustment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paymentTransactions
Delete a manual adjustment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paymentTransactions/{ParticipantPayId}
Get a payment transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paymentTransactions/{ParticipantPayId}
Get all payment transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paymentTransactions
Update a payment transaction: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paymentTransactions/{ParticipantPayId}

Payment Batches/Paysheets

The paysheets resource is used to view and update participant paysheets. A payment batch generates paysheets for each incentive compensation participant who meets the payment batch criteria. Individual paysheets are generated for each plan component and a summarized paysheet is generated for all plan components.

Get a paysheet: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}
Get all paysheets: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets
Update a paysheet: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}

Payment Batches/Paysheets/Payment Transactions

Create a manual adjustment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}/child/paymentTransactions
Delete a manual adjustment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}
Get a payment transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}
Get all payment transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}/child/paymentTransactions
Update a payment transaction: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}

Payment Plans

The payment plans resource is used to view, create, update, and delete an incentive compensation payment plan. The payment plan contains rules for payment draw, draw recovery, and cap amounts to pay to assigned participants.

Create a payment plan: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans
Delete a payment plan: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}
Get a payment plan: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}
Get all payment plans: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans
Update a payment plan: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}

Payment Plans/Payment Plans Assignments

The assignments resource is used to view, create, update, or delete an incentive compensation assignment for a payment plan.

Create a payment plan assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments
Delete a payment plan assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments/{ParticipantPaymentPlanId}
Get a payment plan assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments/{ParticipantPaymentPlanId}
Get all payment plan assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments
Update a payment plan assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments/{ParticipantPaymentPlanId}

Payment Plans/Payment Plans Roles

The roles resource is used to view, create, update, or delete an incentive compensation role assignment for a payment plan.

Create a payment plan role: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanRoles
Delete a payment plan role: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanRoles/{RolePaymentPlanId}
Get a payment plan role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanRoles/{RolePaymentPlanId}
Get all payment plan roles: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanRoles
Update a payment plan role: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanRoles/{RolePaymentPlanId}

Payment Transactions

Create a manual adjustment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/paymentTransactions
Delete a manual adjustment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/paymentTransactions/{ParticipantPayId}
Get a payment transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentTransactions/{ParticipantPayId}
Get all payment transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentTransactions
Update a payment transaction: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paymentTransactions/{ParticipantPayId}

Paysheets

The paysheet resource is used to view and update participant paysheets. A payment batch generates paysheets for each incentive compensation participant who meets the payment batch criteria. Individual paysheets are generated for each plan component and a summarized paysheet is generated for all plan components.

Get a paysheet: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}
Get all paysheets: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paysheets
Update a paysheet: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}

Paysheets/Payment Transactions

Create a manual adjustment for a paysheet: Method: post
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}/child/paymentTransactions
Delete a manual adjustment for a paysheet: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}
Get a payment transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}
Get all payment transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}/child/paymentTransactions
Update a payment transaction: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}

Performance Measures

The performance measures resource is used to view, create, update, and delete a performance measure. It can also be used to display all the details of a performance measure. A performance measure is a determination of the accomplishment of a participant. It could include a goal/target, an eligibility criteria, a measure formula, and a score card. A new performance measure can be created in five different ways, with an incentive formula (output expression), with a credit category (with or without credit factors and transaction factors), with a scorecard (without an rate dimensional input expression - this input expression should be assigned only after the scorecard has been assigned), with any combination of the above, or individually where only the performance measure is created (association with other components needs to be done separately.) When a performance measure is created, Goals, Interval Goals, and Period Goals are created with a default value of 0. The user can then update the total goal or the period goals.

Create a performance measure: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures
Delete a performance measure: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}
Get a performance measure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}
Get all performance measures: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures
Update a performance measure: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}

Performance Measures/Credit Categories

The credit categories resource is used to view, create, and delete the association of a credit category with a performance measure. It can also be used to display all the details of the credit categories under a performance measure. A credit category is used to define which transaction is eligible for crediting by the Incentive Compensation system. A performance measure credit category record links the credit category to a performance measure and provides additional details at this level. A credit category needs to exist before creating this record.

Create a credit category: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories
Delete a credit category: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}
Get a credit category: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}
Get all credit categories: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories

Performance Measures/Credit Categories/Credit Factors

The credit factors resource is used to view, create, update, and delete the credit factor or earning factor within a credit category associated to a performance measure. The credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time. The earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time.

Create a credit factor: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors
Delete a credit factor: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors/{PerformanceMeasureCreditFactorId}
Get a credit factor: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors/{PerformanceMeasureCreditFactorId}
Get all credit factors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors
Update a credit factor: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors/{PerformanceMeasureCreditFactorId}

Performance Measures/Credit Categories/Transaction Factors

The transaction factors resource is used to view, create, update, and delete the transaction factor associated with a performance measure credit category. A transaction factor is used to decide the influence of the sales stage (Invoicing, PO stage, etc.) on the sales credit.

Create a transaction factor: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureTransactionFactors
Delete a transaction factor: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureTransactionFactors/{PerformanceMeasureTransactionFactorId}
Get a transaction factor: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureTransactionFactors/{PerformanceMeasureTransactionFactorId}
Get all transaction factors: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureTransactionFactors
Update a transaction factor: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureTransactionFactors/{PerformanceMeasureTransactionFactorId}

Performance Measures/Descriptive Flex fields

The Descriptive Flex Field resource is used to create, view, and update user defined values for the performance measure. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.

Create a descriptive flex field: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureDFF
Get a descriptive flex field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureDFF/{FormulaId}
Get all descriptive flex fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureDFF
Update a descriptive flex field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureDFF/{FormulaId}

Performance Measures/Goals

The goals resource is used to view and update a goal. It can also be used to display all the details of a goal. A goal under a performance measure defines the target applicable to a participant and could be assigned across a timeline. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.

Get a goal: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}
Get all goals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals
Update a goal: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}

Performance Measures/Goals/Interval Goals

The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. This is created when creating a Performance Measure with a default value of 0.

Get all interval goals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals
Get an interval goal: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}
Update an interval goal: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}

Performance Measures/Goals/Interval Goals/Period Goals

The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.

Get a period goal: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}/child/performanceMeasurePeriodGoals/{PeriodGoalId}
Get all period goals: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}/child/performanceMeasurePeriodGoals
Update a period goal: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}/child/performanceMeasurePeriodGoals/{PeriodGoalId}

Performance Measures/Large Object (LOB) Attributes - Rendered Expression

The entire measure formula expression with all the expression components like operators, attributes, functions, etc. This attribute is used to display the entire expression on the user interface.

Get a Rendered Expression: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/enclosure/RenderedMeasureFormulaExpression

Performance Measures/Rate Dimensional Input Expressions

The Rate Dimensional Input Expressions resource is used to view and update the association of an input expression with a performance measure. It can also be used to display all the details of the input expressions under a performance measure. This record specifies the inputs of a rate dimension of a scorecard and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. This should be assigned only after the scorecard has been assigned.

Get a rate dimensional input: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureRateDimensionalInputs/{PerformanceMeasureInputExpressionId}
Get all rate dimensional inputs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureRateDimensionalInputs
Update a rate dimensional input: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureRateDimensionalInputs/{PerformanceMeasureInputExpressionId}

Performance Measures/Scorecards

The scorecards resource is used to view, create, update, and delete the association of a scorecard with a performance measure. It can also be used to display all the details of a scorecard associated with a performance measure. This resource links the scorecard to a performance measure and provides additional details at this level. A scorecard needs to exist before creating this record.

Create a scorecard: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards
Delete a scorecard: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards/{PerformanceMeasureScorecardId}
Get a scorecard: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards/{PerformanceMeasureScorecardId}
Get all scorecards: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards
Update a scorecard: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards/{PerformanceMeasureScorecardId}

Phone Verifications

The phone verifications resource is used to view and create phone verification record, or verify the phone number. It is used to build integrations and automate workflows for verifying the phone.

Create a phone verification: Method: post
Path: /crmRestApi/resources/11.13.18.05/phoneVerification
Delete a phone verification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/phoneVerification/{Id}
Get a phone verification: Method: get
Path: /crmRestApi/resources/11.13.18.05/phoneVerification/{Id}
Get all phone verifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/phoneVerification
Update a phone verification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/phoneVerification/{Id}

Plan Components

The plan components resource is used to create, update or delete a plan component. It can also be used to display all the details of plan components. A plan component defines the earnings of a participant based on their performance. A new plan component can be created with a performance measure assignment, a with plan component DFFs, with any combination of the above , or Individually where only the plan component is created initially & the association with child resources is done later.

Create a plan component: Method: post
Path: /fscmRestApi/resources/11.13.18.05/planComponents
Delete a plan component: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}
Get a plan component: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}
Get all plan components: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents
Update a plan component: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}

Plan Components/Plan Component - Incentive Formulas

The plan component - incentive formulas resource is used to update the association of an incentive formula to the plan component. It can also be used to display all the details of a incentive formula associated to a plan component. This record specifies the formula used to calculate the earnings and provides additional details at this level. This is created automatically, without any values, when a plan component is created and has to be updated later.

Get all incentive formulas: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas
Get an incentive formula: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}
Update an incentive formula: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}

Plan Components/Plan Component - Incentive Formulas/Large Object (LOB) Attributes - Rendered Expression

The entire incentive formula expression with all the expression components like operators, attributes, functions, etc. This is primarily used to display the entire expression.

Get a Rendered Expression: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/enclosure/RenderedIncentiveFormulaExpression

Plan Components/Plan Component - Incentive Formulas/Plan Component - Rate Dimensional Input Expressions

The plan component - rate dimensional input expressions resource is used to update the association of a input expression with a plan component. It can also be used to display all the details of input expressions associated with a plan component. This record specifies the inputs of a rate dimension of a rate table and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. You should assign the input expression only after the rate table is assigned.

Get a rate dimensional input: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateDimensionalInputs/{PlanComponentInputExpressionId}
Get all rate dimensional inputs: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateDimensionalInputs
Update a rate dimensional input: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateDimensionalInputs/{PlanComponentInputExpressionId}

Plan Components/Plan Component - Incentive Formulas/Plan Component - Rate Tables

The plan component - rate tables resource is used to create, update or delete the association of a rate table with a plan component. It can also be used to display all the details of rate table associated with a performance measure. This record links the rate table to a performance measure and provides additional details at this level. A rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created.

Create a rate table: Method: post
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables
Delete a rate table: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables/{PlanComponentRateTableId}
Get a rate table: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables/{PlanComponentRateTableId}
Get all rate tables: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables
Update a rate table: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables/{PlanComponentRateTableId}

Plan Components/Plan Component - Performance Measures

The plan component - performance measures resource is used to create, update or delete the association of a performance measure with a plan component. It can also be used to display all the details of performance measures under a plan component. A plan component - performance measure record links the performance measure to a plan component and provides additional details at this level. A performance measure needs to exist before creating this record.

Create a performance measure: Method: post
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures
Delete a performance measure: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures/{PlanComponentPerformanceMeasureId}
Get a performance measure: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures/{PlanComponentPerformanceMeasureId}
Get all performance measures: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures
Update a performance measure: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures/{PlanComponentPerformanceMeasureId}

Plan Components/Plan Component Descriptive Flex Fields

The plan component - descriptive flex fields resource is used to store user defined values for the plan component. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.

Create a descriptive flex field: Method: post
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF
Get a descriptive flex field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF/{planComponentsDFFUniqID}
Get all descriptive flex fields: Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF
Update a descriptive flex field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF/{planComponentsDFFUniqID}

Price Book Headers

The Price Book Header resource is used to view, create, update, and delete the name, description, and status of a price book. It also includes the unique identifier, unique code, and the currency on which the price book amount is based.

Create a pricebook: Method: post
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders
Delete a pricebook: Method: delete
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}
Get a pricebook: Method: get
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}
Get all pricebooks: Method: get
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders
Update a pricebook: Method: patch
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}

Price Book Headers/Price Book Items

The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.

Create a pricebook item: Method: post
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/PriceBookItem
Delete a pricebook item: Method: delete
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/PriceBookItem/{priceBookHeaders_PriceBookItem_Id}
Get a pricebook item: Method: get
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/PriceBookItem/{priceBookHeaders_PriceBookItem_Id}
Get all pricebook items: Method: get
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/PriceBookItem
Update a pricebook item: Method: patch
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/PriceBookItem/{priceBookHeaders_PriceBookItem_Id}

Price Book Headers/Status Search

The Status Search resource lets you search for the status of a pricebook.

Create a status search: Method: post
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/StatusSearchLovVA
Delete a status search: Method: delete
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/StatusSearchLovVA/{priceBookHeaders_StatusSearchLovVA_Id}
Get a status search: Method: get
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/StatusSearchLovVA/{priceBookHeaders_StatusSearchLovVA_Id}
Get all status search items: Method: get
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/StatusSearchLovVA
Update a status search: Method: patch
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookHeaders_Id}/child/StatusSearchLovVA/{priceBookHeaders_StatusSearchLovVA_Id}

Process Metadata

The process metadata resource is used to view, create, update, and delete a process metadata, It contains the process cloud metadata of processes that are associated to the action plans.

Create a process metadata: Method: post
Path: /crmRestApi/resources/11.13.18.05/processMetadata
Delete a process metadata: Method: delete
Path: /crmRestApi/resources/11.13.18.05/processMetadata/{ProcessMetadataNumber}
Get a process metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/processMetadata/{ProcessMetadataNumber}
Get all process metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/processMetadata
Update a process metadata: Method: patch
Path: /crmRestApi/resources/11.13.18.05/processMetadata/{ProcessMetadataNumber}

Product Group Products

The product group products resource is used to view the products that are associated to the products groups in sales catalog.

Create a product relationship on a product group and lock it: Method: post
Path: /crmRestApi/resources/11.13.18.05/productGroupProducts
Get a product relationship on a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupProducts/{ProdGroupItemsId}
Get all product relationships on product groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupProducts
Update a product relationship on a product group: Method: patch
Path: /crmRestApi/resources/11.13.18.05/productGroupProducts/{ProdGroupItemsId}

Product Group Usages

The product group usages resource is used to view the product group usage.

Get a product group usage: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}
Get all product group usages: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages

Product Group Usages/Product Group Usage Functions

The product group usage engines resource is used to view the usage engines of the product group.

Get a product group usage engine: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageEngine/{ProductGroupUsageEngineUniqID}
Get all product group usage engines: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageEngine

Product Group Usages/Product Group Usage Modes

The product group usage modes resource is used to view the usage mode of the product group.

Get a product group usage mode: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageModeSetup/{ProductGroupUsageModeSetupUniqID}
Get all product group usage modes: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageModeSetup

Product Group Usages/Product Group Usage Preferences

The product group usage preferences resource is used to view the usage preferences of the product group.

Get a product group usage preference: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsagePreferenceSetup/{ProductGroupUsagePreferenceSetupUniqID}
Get all product group usage preferences: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsagePreferenceSetup

Product Group Usages/Product Group Usage Roots

The product group usage roots resource is used to view the usage roots of the product group.

Get a root product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageRootProdGrpSetup/{ProdGrpRootsId}
Get all root product groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageRootProdGrpSetup

Product Groups

The product groups resource is used to view, create, update, delete, lock, publish, and release product groups. A product group is a business object that groups related products. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog. Locking a product group makes it inaccessible or non editable for other users while you are making some changes. Unlocking releases the lock and rolls the changes back. Publishing the product group makes the changes available to the users at runtime.

Create a product group: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs
Delete a product group: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}
Get a product group by product group ID: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}
Get all product groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs
Get publish product group status: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/action/getPublishProductGroupsStatus
Lock a product group for editing: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/action/lockProductGroup
Publish all product groups: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/action/publishProductGroups
Release lock on a product group: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/action/unlockProductGroup
Update a product group: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}

Product Groups/Attachments

The attachments resource is used to view, create, update, and delete the attachments associated with a product group. The attachments are typically used to associate images to the product groups so that you can identify the product groups visually in browse sales catalog.

Delete an attachment on the product group: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}
Get all attachment for a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}
Upload an attachment to the product group: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments

Product Groups/Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}/enclosure/FileContents

Product Groups/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}/enclosure/FileWebImage

Product Groups/Filter Attributes

The filter attributes resource is used to view, create, update, and delete the filter attributes associated with a product group. Filter attributes allows a customer to sort through the products based on their preference, such as Color, Texture, and other such material properties.

Create an attribute for the product group: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup
Delete an attribute from a product group: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}
Get all attributes on a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup
Get an attribute by product group attribute ID: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}
Update an attribute by product group attribute ID: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}

Product Groups/Filter Attributes/Filter Attribute Values

The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.

Create an attribute value: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup
Delete an attribute value: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}
Get all attribute values for a given attribute setup: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup
Get an attribute value by attribute ID: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}
Update an attribute value: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}

Product Groups/Products

The products resource is used to view, create, update, and delete the product association to a product group. Typically, products are associated to the leaf most nodes of the product group hierarchy. These products are sourced from items defined in Product Information Management.

Create a product for the product group: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup
Delete a product on a product group: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}
Get a product relationship details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}
Get all product relationships on a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup
Update a product relationship on a product group: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}

Product Groups/Products/EligibilityRules

The eligibility rules resource is used to view, create, update, and delete the various eligibility rules so that only a few products are available for selection at run time. For each item, you can add one or more eligibility rules specifying whether a rule is valid for a particular country or for all countries.

Create an eligibility rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules
Delete an eligibility rule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules/{EligibilityRuleId}
Get all eligibility rules: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules
Get an eligibility rule: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules/{EligibilityRuleId}
Update an eligibility rule: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules/{EligibilityRuleId}

Product Groups/Related Groups

The related groups resource is used to view, create, update, and delete the association between sub product groups and parent product groups. While the Subgroups resource can be used to create or update the product group to sub group association, the deletion of such association can only be done using the Related Groups resource.

Create a subgroup relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup
Delete a subgroup relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup/{ProdGroupRelationshipId}
Get a subgroup relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup/{ProdGroupRelationshipId}
Get all subgroup relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup
Update a subgroup relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup/{ProdGroupRelationshipId}

Product Groups/Subgroups

The subgroups resources is used to view, create, and update the association of a sub product group to a parent product group so that a hierarchy of product groups can be built.

Create a subgroup: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration
Get a subgroup details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration/{ProdGroupId2}
Get all subgroups within a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration
Update a subgroup: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration/{ProdGroupId2}

Product Statuses

The product statuses resource is used to view all statuses that can be assigned to a product.

Get a product status: Method: get
Path: /crmRestApi/resources/11.13.18.05/productStatuses/{InventoryItemStatusCode}
Get all product statuses: Method: get
Path: /crmRestApi/resources/11.13.18.05/productStatuses

Product Structure Hierarchies

The product structure hierarchies resource is used to view the structure hierarchies of the product.

Get a structure hierarchy - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/structureHierarchies/{Id}
Get all structure hierarchies: Method: get
Path: /crmRestApi/resources/11.13.18.05/structureHierarchies

Product Structures

The product structures resource is used to view, create, and update the details of a product structure. It is used to include a primary structure that is used to build the item or an alternate structure.

Create a product structure: Method: post
Path: /crmRestApi/resources/11.13.18.05/productStructures
Get a product structure: Method: get
Path: /crmRestApi/resources/11.13.18.05/productStructures/{BillSequenceId}
Get all product structures: Method: get
Path: /crmRestApi/resources/11.13.18.05/productStructures
Get product structure hierarchy: Method: post
Path: /crmRestApi/resources/11.13.18.05/productStructures/action/getStructureHierarchy
Update a product structure: Method: patch
Path: /crmRestApi/resources/11.13.18.05/productStructures/{BillSequenceId}

Product Structures/Components

The components resource is used to view, create, and update the details of a component within a structure.

Create a component: Method: post
Path: /crmRestApi/resources/11.13.18.05/productStructures/{BillSequenceId}/child/Component
Get a component: Method: get
Path: /crmRestApi/resources/11.13.18.05/productStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}
Get all components: Method: get
Path: /crmRestApi/resources/11.13.18.05/productStructures/{BillSequenceId}/child/Component
Update a component: Method: patch
Path: /crmRestApi/resources/11.13.18.05/productStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}

Product Template Mappings

The product template mapping resource is used to view, create, or delete a product template mapping. A product template mapping maps an item template under the root item class to the product template, and is used while creating products in sales.

Create a product template map: Method: post
Path: /crmRestApi/resources/11.13.18.05/productTemplateMappings
Delete a product template mapping: Method: delete
Path: /crmRestApi/resources/11.13.18.05/productTemplateMappings/{ProdTmplMappingCode}
Get a product template mapping: Method: get
Path: /crmRestApi/resources/11.13.18.05/productTemplateMappings/{ProdTmplMappingCode}
Get all product template mappings: Method: get
Path: /crmRestApi/resources/11.13.18.05/productTemplateMappings

Products

The product resource is used to view, create, or modify a product. A product is an item that an organization or company intends to sell.

Create a product: Method: post
Path: /crmRestApi/resources/11.13.18.05/products
Get a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}
Get all products: Method: get
Path: /crmRestApi/resources/11.13.18.05/products
Update a product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}

Products/Default Prices

The default prices resource is used to view, create, update, and delete default prices for products.

Create a default price: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices
Delete a default price: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices/{DefaultPriceId}
Get a default price: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices/{DefaultPriceId}
Get all default prices: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices
Update a default price: Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices/{DefaultPriceId}

Products/Large Object (LOB) Attributes - ExtendedDescriptionOne

Delete an ExtendedDescriptionOne: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionOne
Get an ExtendedDescriptionOne: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionOne
Replace an ExtendedDescriptionOne: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionOne

Products/Large Object (LOB) Attributes - ExtendedDescriptionTwo

Delete an ExtendedDescriptionTwo: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionTwo
Get an ExtendedDescriptionTwo: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionTwo
Replace an ExtendedDescriptionTwo: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionTwo

Products/Product Attachments

The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.

Create an attachment for a product: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments
Delete an attachment for a product: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}
Get all attachments for a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments
Get an attachment for a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}
Update an attachment for a product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}

Products/Product Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}/enclosure/FileContents

Products/Product Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}/enclosure/FileWebImage

Products/Product Image Attachments

The attachment resource is used to view, create, and update image attachments of a product.

Create an image attachment for a product: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments
Delete an image attachment for a product: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}
Get all image attachments for a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments
Get an image attachment for a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}
Update an image attachment for a product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}

Products/Product Image Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}/enclosure/FileContents

Products/Product Image Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}/enclosure/FileWebImage

Products/Product Translations

The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.

Get a product translation: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{Language}
Get all product translations: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations

Products/Product Translations/Large Object (LOB) Attributes - ExtendedDescriptionOne

Delete an ExtendedDescriptionOne: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{Language}/enclosure/ExtendedDescriptionOne
Get an ExtendedDescriptionOne: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{Language}/enclosure/ExtendedDescriptionOne
Replace an ExtendedDescriptionOne: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{Language}/enclosure/ExtendedDescriptionOne

Products/Product Translations/Large Object (LOB) Attributes - ExtendedDescriptionTwo

Delete an ExtendedDescriptionTwo: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{Language}/enclosure/ExtendedDescriptionTwo
Get an ExtendedDescriptionTwo: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{Language}/enclosure/ExtendedDescriptionTwo
Replace an ExtendedDescriptionTwo: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{Language}/enclosure/ExtendedDescriptionTwo

Products/Smart Actions

This VO stores the endpoint and security details for every user action.

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/action/generateSmartActions
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/action/processMassAction

Products/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/enclosure/ActionIntent

Products/Smart Actions/Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Create an action request payload definition: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionRequestPayload
Delete an action request payload definition: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionRequestPayload/{products_smartActions_UserActionRequestPayload_Id}
Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionRequestPayload/{products_smartActions_UserActionRequestPayload_Id}
Update an action request payload definition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionRequestPayload/{products_smartActions_UserActionRequestPayload_Id}

Products/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Create an action navigation definition: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionNavigation
Create an action REST path parameter: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionURLBinding
Delete an action navigation definition: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionNavigation/{products_smartActions_UserActionNavigation_Id}
Delete an action path parameter: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionURLBinding/{products_smartActions_UserActionURLBinding_Id}
Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionNavigation/{products_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionURLBinding/{products_smartActions_UserActionURLBinding_Id}
Update an action navigation definition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionNavigation/{products_smartActions_UserActionNavigation_Id}
Update an action path parameter: Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/smartActions/{products_smartActions_Id}/child/UserActionURLBinding/{products_smartActions_UserActionURLBinding_Id}

Program Benefits

The program benefits resource is used to view, create, update, and delete the benefits that can be added to partner programs from the benefits library.

Create a program benefit: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits
Delete a program benefit: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}
Get a program benefit: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}
Get all program benefits: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits
Update a program benefit: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}

Program Benefits/Benefit List Values

The benefit list values resource is used to view, create, update, and delete the benefit list values that are required to associate a program benefit with a partner program.

Create a benefit list type value: Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues
Delete a benefit list type value: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues/{BenefitListTypeValId}
Get a benefit list type value: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues/{BenefitListTypeValId}
Get all benefit list type values: Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues
Update a benefit list type value: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues/{BenefitListTypeValId}

Program Enrollments

The program enrollments resource is used to view, create, and update partner enrollments into a partner program. Partner program enrollments also includes additional information, such as details about the enrollment contracts, who is enrolled in these programs, and attachments containing enrollment information.

Create an enrollment: Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments
Get all enrollments: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments
Get an enrollment: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}
Update an enrollment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}

Program Enrollments/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Attachments/{AttachmentsUniqID}

Program Enrollments/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Program Enrollments/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Program Enrollments/Notes

The notes resource is used to view, create, update, and delete notes associated with a partner program. A note captures comments, information, or instructions related to a partner program.

Create a note for an enrollment: Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes
Delete a note for an enrollment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes/{NoteId}
Get a note for an enrollment: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes/{NoteId}
Get all notes for an enrollment: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes
Update a note for an enrollment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes/{NoteId}

Program Enrollments/Notes/Large Object (LOB) Attributes - Note Text

The actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes/{NoteId}/enclosure/NoteTxt

Program Enrollments/Partner Programs

The partner programs resource is used to view information about the partner programs, such as the name of the program, program description, validity period, and so on.

Delete a partner program: Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/PartnerProgram/{PartnerProgramId}/action/delete
Get a partner program for the enrollment: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/PartnerProgram/{PartnerProgramId}
Get all the partner programs for the enrollment: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/PartnerProgram

Program Enrollments/Program Benefit Details

The program benefit details resource is used to view the details of a program benefit.

Get a program benefit for an enrollment: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}
Get all program benefit details for an enrollment: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/ProgramBenefitDetails

Program Enrollments/Smart Actions

This VO stores the endpoint and security details for every user action.

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/{programEnrollments_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/action/generateSmartActions
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/{programEnrollments_smartActions_Id}
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/action/processMassAction

Program Enrollments/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/{programEnrollments_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/{programEnrollments_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/{programEnrollments_smartActions_Id}/enclosure/ActionIntent

Program Enrollments/Smart Actions/Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/{programEnrollments_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/{programEnrollments_smartActions_Id}/child/UserActionRequestPayload/{programEnrollments_smartActions_UserActionRequestPayload_Id}

Program Enrollments/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/{programEnrollments_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/{programEnrollments_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/{programEnrollments_smartActions_Id}/child/UserActionNavigation/{programEnrollments_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActions/{programEnrollments_smartActions_Id}/child/UserActionURLBinding/{programEnrollments_smartActions_UserActionURLBinding_Id}

Queues

The queues resource is used to view, create, update, and delete the list of unassigned requests awaiting assignment to members of a service team. Team members can select the requests to work on, or assign the requests to an appropriate team member depending on the queue. For example, queues can be based on location, such as a North America Queue or an EMEA Queue.

Create a queue: Method: post
Path: /crmRestApi/resources/11.13.18.05/queues
Delete a queue: Method: delete
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}
Get a queue: Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}
Get all queues: Method: get
Path: /crmRestApi/resources/11.13.18.05/queues
Update a queue: Method: patch
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}

Queues/Overflow Queues

The overflow queues resource is used to view, create, update, and delete an overflow queue. Overflow queues are backup queues containing alternative resources that can be made available when the currently assigned resources are unavailable, or are unable to keep up with the incoming work.

Create an overflow queue: Method: post
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues
Delete an overflow queue: Method: delete
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues/{QueueResourceId}
Get all overflow queues: Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues
Get an overflow queue: Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues/{QueueResourceId}
Update an overflow queue: Method: patch
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues/{QueueResourceId}

Queues/Queue Resource Members

The queue resource members resource is used to view, create, update, and delete a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.

Create a resource member: Method: post
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers
Delete a resource member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers/{QueueResourceId}
Get a resource member: Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers/{QueueResourceId}
Get all resource members: Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers
Update a resource member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers/{QueueResourceId}

Queues/Queue Resource Teams

The queue resource team resource is used to view, create, update, and delete a resource team assigned to a queue. Resource teams are groups of employees or partners who can take ownership of items in a queue.

Create a resource team: Method: post
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams
Delete a resource team: Method: delete
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams/{QueueResourceId}
Get a resource team: Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams/{QueueResourceId}
Get all resource teams: Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams
Update a resource team: Method: patch
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams/{QueueResourceId}

Queues/Queue Resource Teams/Queue Resource Team Members

The queue resource team members resource is used to view the resource team members associated with a queue resource team. Resource team members are employees or partners who can take ownership of items in a queue.

Get a resource team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams/{QueueResourceId}/child/resourceTeamMembers/{TeamMemberId}
Get all resource team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams/{QueueResourceId}/child/resourceTeamMembers

Quote and Order Lines

Sales order line view object contains details of order lines like line number, header name, and other revenue related data.

Create a sales order line: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrderLines
Delete a sales order line: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesOrderLines/{OrderLineNumber}
Get a sales order line: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderLines/{OrderLineNumber}
Get all sales order lines: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderLines
Get Sales Order Line IDs: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrderLines/action/getIdValues
Update a sales order line: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesOrderLines/{OrderLineNumber}

Rate Dimensions

The rate dimensions resource is used to create, update or delete a rate dimension. It can also be used to display all the details of rate dimensions. Rate tables contain one or more dimensions. Rate dimensions define the nature of the tiers that is used in a rate table.

Create a rate dimension: Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions
Delete a rate dimension: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}
Get a rate dimension: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}
Get all rate dimensions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions
Update a rate dimension: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}

Rate Dimensions/Rate Dimension - Tiers

The rate dimensions tiers resource is used to create, update, or delete the association of tiers to a rate dimension. It can also be used to display all the details of the tiers in a dimension.

Create a rate dimension tier: Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers
Delete a rate dimension tier: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers/{RateDimTierId}
Get a rate dimension tier: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers/{RateDimTierId}
Get all rate dimension tiers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers
Update a rate dimension tier: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers/{RateDimTierId}

Rate Tables

The rate table resource is used to create, update or delete a rate table. It can also be used to display all details of rate tables. The plan component rate table determines the compensation rate for the earnings calculations. The performance measure scorecard is used to establish attainment rates or fixed amounts for different performance levels.

Create a rate table: Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateTables
Delete a rate table: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}
Get a rate table detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}
Get all rate table details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables
Update a rate table: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}

Rate Tables/Rate Table Dimensions

The rate table - dimensions resource is used to create, update, or delete the association of dimensions to a rate table. It can also be used to display all details of the dimensions in a rate table. You can only add up to ten rate dimensions to a rate table using REST Services.

Create a rate dimension association with a rate table: Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions
Delete a rate dimension association with a rate table: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions/{RateTableDimId}
Get a rate dimension details within a rate table: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions/{RateTableDimId}
Get all rate dimension details within a rate table: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions

Rate Tables/Rate Table Dimensions/Rate Dimensions Tiers

The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.

Get a rate dimension tier: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions/{RateTableDimId}/child/RateTableDimensionTiers/{RateTableDimensionTiersUniqID}
Get all rate dimension tiers: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions/{RateTableDimId}/child/RateTableDimensionTiers

Rate Tables/Rate Table Rates

The rate table rates resource is used to create, view, or update the rates for a rate table or a scorecard. It can also be used to display all the rates of a rate table or a scorecard. You can only create rates with non-zero values.

Create a rate table rate: Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableRates
Get a rate table rate: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableRates/{RateTableRateId}
Get all rate table rates: Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableRates
Update a rate table rate: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableRates/{RateTableRateId}

Recent Items

The recent items resource is used to view and create, and update a recent item. It is used to share recent items between VBCS and User Context.

Add to recent items: Method: post
Path: /crmRestApi/resources/11.13.18.05/recentItems/action/addToRecentItems
Create a recent item: Method: post
Path: /crmRestApi/resources/11.13.18.05/recentItems
Get a recent item: Method: get
Path: /crmRestApi/resources/11.13.18.05/recentItems/{RecentItemId}
Get all recent items: Method: get
Path: /crmRestApi/resources/11.13.18.05/recentItems
Update a recent item: Method: patch
Path: /crmRestApi/resources/11.13.18.05/recentItems/{RecentItemId}

Resolution Links

The resolution link resource is used to view, create, and update resolution links. A resolution link indicates that party records have duplicate information, and includes information about the linked parties. A link has a master record and link member record which can be removed from, or restored to, the link.

Create a link: Method: post
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks
Get a link: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}
Get all links: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks
Update a link: Method: patch
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}

Resolution Links/Link Members

The link member resource is used to view, create, and update the members of a link.

Create a link member for the link: Method: post
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}/child/LinkMember
Get a link member: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}/child/LinkMember/{PartyNumber}
Get all link members for the link: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}/child/LinkMember
Update a link member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}/child/LinkMember/{PartyNumber}

Resolution Requests

The resolution requests resource is used to view and create resolution requests. A resolution request includes information about duplicate party (account, contact, and so on) records, and attempts to duplicate parties in the system or resolve duplicate detail information for a party. The request is then immediately processed or sent to the data steward for review and approval.

Create a resolution request: Method: post
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests
Get a resolution request: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}
Get all resolution requests: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests

Resolution Requests/Duplicate Parties

The duplicate parties resource is used to view and create duplicate parties in a resolution request. The duplicate parties resource include details of the duplicate party, such as its name, identifier, and so on.

Create a duplicate party: Method: post
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty
Get a duplicate party: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty/{DuplicatePartyUniqID}
Get all duplicate parties: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty

Resolution Requests/Duplicate Parties/Source System References

The source system references resource is used to view the unique identifier of the duplicate record in the source system. Source system is the system from the duplicate record originated.

Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty/{DuplicatePartyUniqID}/child/SourceSystemReference/{SourceSystemReferenceUniqID}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty/{DuplicatePartyUniqID}/child/SourceSystemReference

Resolution Requests/Resolution Details

The resolution details resource is used to view and create a master record of the surviving entities after the resolution of duplicate records.

Create a detailed record for a duplicate party resolution: Method: post
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/ResolutionDetail
Get a detailed record for a duplicate party resolution: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/ResolutionDetail/{ResolutionDetailUniqID}
Get all detailed records for all duplicate party resolutions: Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/ResolutionDetail

Resource Capacities

The resource capacity resource is used to view, create, update, and delete resource capacities. A resource capacity indicates the maximum number of objects a resource can be assigned per channel type.

Create a resource capacity: Method: post
Path: /crmRestApi/resources/11.13.18.05/resourceCapacities
Delete a resource capacity: Method: delete
Path: /crmRestApi/resources/11.13.18.05/resourceCapacities/{resourceCapacitiesUniqID}
Get a resource capacity: Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceCapacities/{resourceCapacitiesUniqID}
Get all resource capacities: Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceCapacities
Update a resource capacity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/resourceCapacities/{resourceCapacitiesUniqID}

Resource Loads

The omnichannel load resource is used to view omnichannel agents load by the channel type.

Get a resource load: Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceLoads/{ResourceLoadId}
Get all resource loads: Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceLoads

Resource Users

The resource users REST resource is used to view, create, update, and delete a resource user. You can use this REST resource to manage the various stages of a resource's lifecycle, such as hiring, promotion, demotion, and so on. Note that this REST resource should be used only to work with Oracle CX Sales and B2B Service, and not for any other product family.

Create a resource user: Method: post
Path: /crmRestApi/resources/11.13.18.05/resourceUsers
Delete a resource user - Not Supported: Method: delete
Path: /crmRestApi/resources/11.13.18.05/resourceUsers/{resourceUsersUniqID}
Get a resource user: Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceUsers/{resourceUsersUniqID}
Get all resource users: Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceUsers
Update a resource user: Method: patch
Path: /crmRestApi/resources/11.13.18.05/resourceUsers/{resourceUsersUniqID}

Resource Users/Resource Role Assignments

The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.

Get a resource role assignment: Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceUsers/{resourceUsersUniqID}/child/ResourceRoleAssign/{RoleRelateId}
Get all role assignments for a resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceUsers/{resourceUsersUniqID}/child/ResourceRoleAssign

Resources

Resources is used to view the details of 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.

Get a resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}
Get all resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources

Resources/Picture Attachments

The picture attachments resource is used to view the picture of a resource.

Get a resource's picture: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}
Get all resources' pictures: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment

Resources/Picture Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents

Resources/Picture Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileWebImage

Roles

The incentive compensation roles resource is used to view, create, update, and delete an incentive compensation role. Incentive compensation roles match plans, pay groups, and payment plans to participants by grouping them under a specific role.

Create an incentive compensation role: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles
Delete an incentive compensation role: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}
Get a specific incentive compensation role detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}
Get all incentive compensation role details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles
Update an incentive compensation role: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}

Roles/Role - Participants

The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.

Create a participant for a role: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants
Delete a participant from a role: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants/{ParticipantRoleId}
Get a participant for a role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants/{ParticipantRoleId}
Get all participants for a role: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants
Update a participant for a role: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants/{ParticipantRoleId}

Rollups

The rollups resource is used to view attributes on a rollup configuration.

Get a rollup: Method: get
Path: /crmRestApi/resources/11.13.18.05/rollups/{RollupId}
Get all rollups: Method: get
Path: /crmRestApi/resources/11.13.18.05/rollups

Sales Contents

The sales contents resource is used to view, create, update, and delete content for a sales object. It's used to store the association of content to an object. For example, customer reference stories can be associated to a lead.

Create a sales content: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesContents
Delete a sales content: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesContents/{SalesContentId}
Delete content: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesContents/action/deleteContentAssociation
Get a sales content: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesContents/{SalesContentId}
Get all sales contents: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesContents
Mark content for deletion: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesContents/action/markContentAssociationForDeletion
Modify a sales content: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesContents/{SalesContentId}
Rename content: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesContents/action/renameContent

Sales Forecast Adjustments

The sales forecast adjustments resource is used to view, create, update, and delete sales forecast adjustments in next generation forecasting.

Create all sales forecast adjustments: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesForecastAdjustments
Delete a sales forecast adjustment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesForecastAdjustments/{AdjustmentId}
Get a sales forecast adjustment: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastAdjustments/{AdjustmentId}
Get all sales forecast adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastAdjustments
Update a sales forecast adjustment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesForecastAdjustments/{AdjustmentId}

Sales Forecast Dimension Metadata

The sales forecast dimension metadata resource captures information related to custom dimensions such as the lookup type or object name as well as the related opportunity or revenue attribute.

Create a dimension metadata record: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesForecastDimensionMetadata
Delete a dimension metadata record: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesForecastDimensionMetadata/{MetricDimMetaId}
Get a dimension metadata record: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastDimensionMetadata/{MetricDimMetaId}
Get all dimension metadata records: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastDimensionMetadata
Update a dimension metadata record: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesForecastDimensionMetadata/{MetricDimMetaId}

Sales Forecast Dimensions

The sales forecast dimensions resource is used to view sales forecast dimensions such as product in next generation forecasting.

Get a sales forecast dimension: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastDimensions/{MetricDimDnId}
Get all sales forecast dimensions: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastDimensions

Sales Forecast Metric Definitions

The sales forecast metric definition is used to view and manage the definitions of sales forecast metrics such as Best Case and Commit metric sources.

Get a sales forecast metric definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricDefinitions/{MetricDefnId}
Get all sales forecast metric definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricDefinitions
Update a sales forecast metric definition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricDefinitions/{MetricDefnId}

Sales Forecast Metric Source Dimension Mappings

The sales forecast metric source dimension mappings resource captures a dimension mapping for a given metric source. It indicates the list of dimensions that are supported for a metric source.

Create a metric source dimension mapping: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricSourceDimensionMappings
Delete a metric source dimension mapping: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricSourceDimensionMappings/{MetricSrcDimMapId}
Get a metric source dimension mapping: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricSourceDimensionMappings/{MetricSrcDimMapId}
Get all metric source dimension mappings: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricSourceDimensionMappings
Update a metric source dimension mapping: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricSourceDimensionMappings/{MetricSrcDimMapId}

Sales Forecast Metric Source Items

The sales forecast metric source items resource is used to view the information for the metric sources that are directly or indirectly owned by a particular forecast participant.

Get a sales forecast metric source item: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricSourceItems/{salesForecastMetricSourceItemsUniqID}
Get all sales forecast metric source items: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricSourceItems

Sales Forecast Metric Sources

The sales forecast metric source resource is used to view and manage the dimensions such as territory, team member, product and revenue category type for the opportunity or revenue metric source.

Get a sales forecast metric source: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricSources/{MetricSrcCode}
Get all sales forecast metric sources: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricSources
Update a sales forecast metric source: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetricSources/{MetricSrcCode}

Sales Forecast Parameters

The sales forecast parameters resource is used to view or modify the sales forecast parameters.

Get a sales forecast parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastParams/{ParamName}
Get all sales forecast parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastParams
Update a sales forecast parameter: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesForecastParams/{ParamName}

Sales Forecast Participants

The sales forecast participants resource is used to view the participant and their subordinate information.

Get a sales forecast participant details: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastParticipants/{PartyId}
Get sales forecast participant and their subordinate details: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastParticipants

Sales Forecast Periods

The sales forecast periods resource is used to view the sales forecast periods.

Get a sales forecast period: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastPeriods/{PeriodName}
Get all sales forecast periods: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastPeriods

Sales Forecast Quotas

The sales forecast quotas resource is used to view, create, update, and delete a sales forecast quota.

Create a sales forecast quota: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesForecastQuotas
Delete a sales forecast quota: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesForecastQuotas/{QuotaNumber}
Get a sales forecast quota: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastQuotas/{QuotaNumber}
Get all sales forecast quotas: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastQuotas
Update a sales forecast quota: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesForecastQuotas/{QuotaNumber}

Sales Forecasts Metrics

The sales forecast metrics resource is used to view the forecast metrics.

Get a sales forecast metric: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetrics/{salesForecastMetricsUniqID}
Get all sales forecast metrics: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesForecastMetrics

Sales Insights

The Sales Insights resource lets you view different insights for the supported objects

Get activity effectiveness metrics of an object: Method: get
Path: /crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics/activityEffectiveness
Get classifications and fact explanations: Method: get
Path: /crmRestApi/crmSalesIntelligenceApi/11.13.18.05/insights
Get engagement level metrics of an object: Method: get
Path: /crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics/engagementLevel
Get facts about recommended contacts for a lead or opportunity: Method: get
Path: /crmRestApi/crmSalesIntelligenceApi/11.13.18.05/facts/contactRecommendation
Get facts about the activity effectiveness: Method: get
Path: /crmRestApi/crmSalesIntelligenceApi/11.13.18.05/facts/activityEffectiveness
Get facts about the engagement level: Method: get
Path: /crmRestApi/crmSalesIntelligenceApi/11.13.18.05/facts/engagementLevel
Get facts generated by the contact validation insight template: Method: get
Path: /crmRestApi/crmSalesIntelligenceApi/11.13.18.05/facts/contactValidation
Get links to access the enabled insight type metrices: Method: get
Path: /crmRestApi/crmSalesIntelligenceApi/11.13.18.05/metrics
Get links to access the enabled insight-type facts: Method: get
Path: /crmRestApi/crmSalesIntelligenceApi/11.13.18.05/facts

Sales Leads

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.

Accept lead: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/action/acceptLead
Assign leads: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/action/runAssignment
Convert a lead to an opportunity: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/action/convertLeadToOpty
Create a sales lead: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads
Delete a sales lead: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}
Get a sales lead: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}
Get all sales leads: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads
Rank leads: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/action/rankLead
Reject leads: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/action/rejectLead
Score leads: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/action/scoreLead
Update a sales lead: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}

Sales Leads/Interviews

The interviews resource is used to view and delete an interview record.

Delete an interview: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews/{leads_Interviews_Id}
Get all interviews: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews
Get an interview: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews/{leads_Interviews_Id}
Get interview deployment names: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews/action/getInterviewDeployments

Sales Leads/Interviews/Large Object (LOB) Attributes - InterviewData

Delete an InterviewData: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews/{leads_Interviews_Id}/enclosure/InterviewData
Get an InterviewData: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews/{leads_Interviews_Id}/enclosure/InterviewData
Replace an InterviewData: Method: put
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews/{leads_Interviews_Id}/enclosure/InterviewData

Sales Leads/Interviews/Large Object (LOB) Attributes - InterviewDraft

Delete an InterviewDraft: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews/{leads_Interviews_Id}/enclosure/InterviewDraft
Get an InterviewDraft: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews/{leads_Interviews_Id}/enclosure/InterviewDraft
Replace an InterviewDraft: Method: put
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews/{leads_Interviews_Id}/enclosure/InterviewDraft

Sales Leads/Lead Campaigns

The lead campaign resource is used to view, create, update, and delete the association of a campaign with a lead.

Create a lead campaign: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCampaigns
Delete a lead campaign: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}
Get a lead campaign: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}
Get all lead campaigns: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCampaigns
Update a lead campaign: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCampaigns/{LeadCampaignId}

Sales Leads/Lead Qualifications

The assessments resource is used to view, create and update qualifications of a lead.

Create a lead qualification: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments
Delete a lead qualification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}
Get a lead qualification: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}
Get all lead qualifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments
Update a lead qualification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}

Sales Leads/Lead Qualifications/Assessment Answer Groups

The assessment answer groups resource is used to view question groups in an assessment.

Get a lead qualification answer group: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}
Get all lead qualification answer groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups

Sales Leads/Lead Qualifications/Assessment Answer Groups/Assessment Answers

The assessment answer resource is used to view and update a response for a question in a question group.

Get a lead qualification answer: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}
Get all lead qualification answers: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer
Update a lead qualification answer: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}

Sales Leads/Lead Rollups

The lead rollups resource is used to view a sales lead rollup.

Get a lead rollup: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadRollup/{LeadId}
Get all lead rollups: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadRollup

Sales Leads/Lead Score Details

The lead score details resource is used to view the details of lead conversion probability.

Get a lead score detail not supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/leadScoreDetails/{leads_leadScoreDetails_Id}
Get all lead score details: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/leadScoreDetails

Sales Leads/Lead Team

The lead teams resource is used to view the team members and territory team members associated with a lead.

Get a lead team memeber not supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTeam/{LeadTeamId}
Get all lead teams members: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTeam

Sales Leads/Marketing Source Codes

The marketing source code resource is used to track responses and leads generated by each sales and marketing campaigns, and helps gauge the effectiveness of each initiative. A marketing source code is a unique identifier representing a marketing campaign and the underlying treatment and segment or list used within each execution.

Create a marketing source code: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/sourceCodes
Delete a marketing source code: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/sourceCodes/{leads_sourceCodes_Id}
Get a marketing source code: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/sourceCodes/{leads_sourceCodes_Id}
Get all marketing source codes: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/sourceCodes
Update a marketing source code: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/sourceCodes/{leads_sourceCodes_Id}

Sales Leads/Notes

The note resource is used to capture comments, information, or instructions for a sales lead.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Note/{NoteId}

Sales Leads/Notes/Large Object (LOB) Attributes - Note Text

The column which stores the actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Note/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Note/{NoteId}/enclosure/NoteTxt

Sales Leads/Opportunities

The opportunity resource is used to view, create, or modify an opportunity generated from a lead. An opportunity list associated with the lead represents leads that have already been converted to the list of opportunities.

Get all opportunities: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadOpportunity
Get an opportunity: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadOpportunity/{LeadNumber}

Sales Leads/Orchestration Associations

The orchestrations associations resource is used to view, create, update, and delete an orchestration association.

Create an orchestration association: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations
Disassociate the orchestration with the transactional object: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/action/detachAssociatedOrchestration
Get all orchestration associations: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations
Get an orchestration association: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}
Get unhelpful objective details: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/action/getNotHelpfulObjectiveDetails
Update an orchestration association: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}

Sales Leads/Orchestration Associations/Error Logs

The error logs resource is used to view error logs associated to the orchestration associations.

Get all error logs: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs
Get an error log: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs/{ErrorLogsNumber}

Sales Leads/Orchestration Associations/Error Logs/Large Object (LOB) Attributes - ErrorDescription

Delete an ErrorDescription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs/{ErrorLogsNumber}/enclosure/ErrorDescription
Get an ErrorDescription: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs/{ErrorLogsNumber}/enclosure/ErrorDescription
Replace an ErrorDescription: Method: put
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs/{ErrorLogsNumber}/enclosure/ErrorDescription

Sales Leads/Orchestration Associations/Stage Objectives

The stage objectives resource is used to view the stage objectives of the orchestration association.

Get a sales objective: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StageObjectives/{RunTimeStageObjectiveNumber}
Get all sales objectives: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StageObjectives

Sales Leads/Orchestration Associations/Stages

The stages resource is used to view the stage of the orchestration association.

Get a stage: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Stages/{RuntimeStageNumber}
Get all stages: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Stages

Sales Leads/Orchestration Associations/Step Transitions

The step transitions resource is used to view the step transitions of the orchestration association.

Get a step transition: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions/{StepTransitionNumber}
Get all step transitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions

Sales Leads/Orchestration Associations/Step Transitions/Large Object (LOB) Attributes - ActivityDescription

Delete an ActivityDescription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions/{StepTransitionNumber}/enclosure/ActivityDescription
Get an ActivityDescription: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions/{StepTransitionNumber}/enclosure/ActivityDescription
Replace an ActivityDescription: Method: put
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions/{StepTransitionNumber}/enclosure/ActivityDescription

Sales Leads/Orchestration Associations/Steps

The steps resource is used to view the steps of the orchestration association.

Get a step: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Steps/{RunTimeStepNumber}
Get all steps: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Steps

Sales Leads/Orchestration Associations/Steps In Execution Path

The steps in execution path resource is used to view all the steps including future steps of the orchestration association.

Get all orchestration steps: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepsInExecutionPath
Get an orchestration step: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepsInExecutionPath/{OrchestrationStepId}

Sales Leads/Product Groups

The product groups resource is used to capture the name of the product group associated with the sales lead. A product group is a business object that groups related products, so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.

Get a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/productGroups/{ProdGroupId}
Get all product groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/productGroups
Set product group usag code (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/productGroups/action/setUsagCode
Set product group usage code (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/productGroups/action/setUsageCode
Set product group usage mode (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/productGroups/action/setUsageMode
Set territory filter user choice (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/productGroups/action/setUserSelectionForTM

Sales Leads/Products

The product resource is used to capture the name of the product associated with the sales lead.

Get a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/products/{productsUniqID}
Get all products: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/products
Set product usage code (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/products/action/setUsageCode
Set product usage mode (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/products/action/setUsageMode
Set territory filter user choice (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/products/action/setUserSelectionForTM
Set the user selected product group (Not Supported): Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/products/action/setSelectedProductGroupId

Sales Leads/Sales Contents

The sales contents resource is used to view, create, update, and delete the sales content associated with a lead.

Create a lead sales content: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/SalesContents
Delete a lead sales content: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/SalesContents/{SalesContentId}
Delete content: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/SalesContents/action/deleteContentAssociation
Get a lead sales content: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/SalesContents/{SalesContentId}
Get all lead sales contents: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/SalesContents
Mark content for deletion: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/SalesContents/action/markContentAssociationForDeletion
Rename content: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/SalesContents/action/renameContent
Update a lead sales content: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/SalesContents/{SalesContentId}

Sales Leads/Sales Lead Competitors

The lead competitors resource is used to view, create, update, and delete the association of a campaign with a lead.

Create a lead competitor: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCompetitors
Delete a lead competitor: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}
Get a lead competitor: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}
Get all lead competitors: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCompetitors
Update a lead competitor: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCompetitors/{LeadCompetitorId}

Sales Leads/Sales Lead Contacts

The sales lead contacts resource is used to capture a contact associated with the sales lead.

Create a sales lead contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1
Delete a sales lead contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}
Get a sales lead contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}
Get all sales lead contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1
Update a sales lead contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}

Sales Leads/Sales Lead Products

The sales lead products resource is used to capture a product associated with the sales lead.

Create a sales lead product: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklProdAssoc1
Delete a sales lead product: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}
Get a sales lead product: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}
Get all sales lead products: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklProdAssoc1
Update a sales lead product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}

Sales Leads/Sales Lead Resources

The sales lead resources data object (resource) is used to capture a resource associated with the sales lead team. A lead resource is a business object that is used to represent resources who are team members that form part of the lead sales team.

Create a sales lead resource: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadResources
Delete a sales lead resource: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}
Get a sales lead resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}
Get all sales lead resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadResources
Update a sales lead resource: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadResources/{LeadResourceId}

Sales Leads/Sales Lead Territories

The sales lead territories resource is used to view the associated sales lead territories.

Get a sales lead territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTerritoryAssoc/{LeadTerritoryId}
Get all sales lead territories: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTerritoryAssoc

Sales Leads/Sales Leads Attachments

The attachment resource is used to view, create, and update attachments of a sales lead. An attachment includes additional information about a sales lead.

Create a sales lead attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/AllLeadAttachments
Delete a sales lead attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/AllLeadAttachments/{AllLeadAttachmentsUniqID}
Get a sales lead attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/AllLeadAttachments/{AllLeadAttachmentsUniqID}
Get all sales lead attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/AllLeadAttachments
Update a sales lead attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/AllLeadAttachments/{AllLeadAttachmentsUniqID}

Sales Leads/Sales Leads Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/AllLeadAttachments/{AllLeadAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/AllLeadAttachments/{AllLeadAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/AllLeadAttachments/{AllLeadAttachmentsUniqID}/enclosure/FileContents

Sales Leads/Sales Leads Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/AllLeadAttachments/{AllLeadAttachmentsUniqID}/enclosure/FileWebImage

Sales Leads/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/{leads_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/action/generateSmartActions
Get a smart action (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/{leads_smartActions_Id}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/action/processMassAction

Sales Leads/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/{leads_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/{leads_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/{leads_smartActions_Id}/enclosure/ActionIntent

Sales Leads/Smart Actions/Smart Action REST Path Parameter Definitions

Get all action URL bindings (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/{leads_smartActions_Id}/child/UserActionURLBinding
Get an action URL binding (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/{leads_smartActions_Id}/child/UserActionURLBinding/{leads_smartActions_UserActionURLBinding_Id}

Sales Leads/Smart Actions/Smart Action REST Payload Definitions

Get all action request payload (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/{leads_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/{leads_smartActions_Id}/child/UserActionRequestPayload/{leads_smartActions_UserActionRequestPayload_Id}

Sales Leads/Smart Actions/Smart Action User Interface Definitions

Get all action navigations (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/{leads_smartActions_Id}/child/UserActionNavigation
Get an action navigation (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions/{leads_smartActions_Id}/child/UserActionNavigation/{leads_smartActions_UserActionNavigation_Id}

Sales Machine Learning Models

Create a machine learning model: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesMLModels
Delete a machine learning model: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}
Get a machine learning model: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}
Get all machine learning models: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels
Update a machine learning model: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}

Sales Machine Learning Models/Machine Learning Job Statistics Details

Model Statistics

Create a selected field: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobStatistics
Delete a selected field: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobStatistics/{JobRunId}
Get a selected field: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobStatistics/{JobRunId}
Get all selected fields: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobStatistics
Update a selected field: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobStatistics/{JobRunId}

Sales Machine Learning Models/Model Selected Fields

Model Selected Fields

Create a selected field: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields
Delete a selected field: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields/{ZcaOmlJobsSelFieldsUniqID}
Get a selected field: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields/{ZcaOmlJobsSelFieldsUniqID}
Get all selected fields: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields
Update a selected field: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields/{ZcaOmlJobsSelFieldsUniqID}

Sales Machine Learning Models/Model Selected Fields/Model Validation and Transformation Rules

Sales Machine Learning Model Rules

Create a use case rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields/{ZcaOmlJobsSelFieldsUniqID}/child/ZcaOmlJobRules
Delete a use case rule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields/{ZcaOmlJobsSelFieldsUniqID}/child/ZcaOmlJobRules/{JobRuleId}
Get a use case rule: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields/{ZcaOmlJobsSelFieldsUniqID}/child/ZcaOmlJobRules/{JobRuleId}
Get all use case rules: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields/{ZcaOmlJobsSelFieldsUniqID}/child/ZcaOmlJobRules
Update a use case rule: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlJobsSelFields/{ZcaOmlJobsSelFieldsUniqID}/child/ZcaOmlJobRules/{JobRuleId}

Sales Machine Learning Models/Model Validation and Transformation Rules

Model Validation and Transformation Rules

Create a use case rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlFixedFieldRules
Delete a use case rule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}
Get a use case rule: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}
Get all use case rules: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlFixedFieldRules
Update a use case rule: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}

Sales Machine Learning Models/Model Validation and Transformation Rules/Large Object (LOB) Attributes - AdditionalMetadata

Delete an AdditionalMetadata: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/AdditionalMetadata
Get an AdditionalMetadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/AdditionalMetadata
Replace an AdditionalMetadata: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/AdditionalMetadata

Sales Machine Learning Models/Model Validation and Transformation Rules/Large Object (LOB) Attributes - RuleValue

Delete a RuleValue: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/RuleValue
Get a RuleValue: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/RuleValue
Replace a RuleValue: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlFixedFieldRules/{FieldRuleCode}/enclosure/RuleValue

Sales Machine Learning Models/Use Case Selected Fields

Sales Machine Learning Selected Features

Create a use case selected field: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlUsecaseFixedFields
Delete a use case selected field: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}
Get a use case selected field: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}
Get all use case selected fields: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlUsecaseFixedFields
Update a use case selected field: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}

Sales Machine Learning Models/Use Case Selected Fields/Large Object (LOB) Attributes - AdditionalMetadata

Delete an AdditionalMetadata: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}/enclosure/AdditionalMetadata
Get an AdditionalMetadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}/enclosure/AdditionalMetadata
Replace an AdditionalMetadata: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesMLModels/{JobId}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}/enclosure/AdditionalMetadata

Sales Orders

The sales order resource is used to view, create, update, and delete sales orders. A sales order is an order issued for product or services by a party. The sales order resource captures the quote and the order header information such as name, version, status, and amount.

Create a quote: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders
Create proposal in Oracle CPQ Cloud: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/action/createProposal
Delete a quote: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}
Generate URL based on smart action: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/action/getQuotingSiteURL
Get a quote: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}
Get all quotes: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders
Update a quote: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}

Sales Orders/Quote Rollups

The quote rollups resource is used to view quote rollup information.

Get a quote rollup: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderRollup/{OrderHeaderId2}
Get all quote rollups: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderRollup

Sales Orders/Quote and Order Lines

The quote and order lines resource is used to view, create, update, and delete a sales order line. It contains details of order lines like product, quote name, and other revenue related data.

Create a sales order line: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderLine
Delete a sales order line: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderLine/{OrderLineId}
Get a sales order line: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderLine/{OrderLineId}
Get all sales order lines: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderLine
Get Sales Order Line IDs: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderLine/action/getIdValues
Update a sales order line: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderLine/{OrderLineId}

Sales Orders/Sales Orders Active Version

The sales orders active versions resource lists all active sales order versions.

Create a sales order version: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderActiveVersionVA
Delete a sales order version: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderActiveVersionVA/{salesOrders_SalesOrderActiveVersionVA_Id}
Get a sales order version: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderActiveVersionVA/{salesOrders_SalesOrderActiveVersionVA_Id}
Get all sales order versions: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderActiveVersionVA
Update a sales order version: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/SalesOrderActiveVersionVA/{salesOrders_SalesOrderActiveVersionVA_Id}

Sales Orders/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/{salesOrders_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/action/generateSmartActions
Get a smart action (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/{salesOrders_smartActions_Id}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/action/processMassAction

Sales Orders/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/{salesOrders_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/{salesOrders_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/{salesOrders_smartActions_Id}/enclosure/ActionIntent

Sales Orders/Smart Actions/Smart Action REST Path Parameter Definitions

Get all action URL bindings (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/{salesOrders_smartActions_Id}/child/UserActionURLBinding
Get an action URL binding (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/{salesOrders_smartActions_Id}/child/UserActionURLBinding/{salesOrders_smartActions_UserActionURLBinding_Id}

Sales Orders/Smart Actions/Smart Action REST Payload Definitions

Get all action request payload (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/{salesOrders_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/{salesOrders_smartActions_Id}/child/UserActionRequestPayload/{salesOrders_smartActions_UserActionRequestPayload_Id}

Sales Orders/Smart Actions/Smart Action User Interface Definitions

Get all action navigations (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/{salesOrders_smartActions_Id}/child/UserActionNavigation
Get an action navigation (Not Supported): Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}/child/smartActions/{salesOrders_smartActions_Id}/child/UserActionNavigation/{salesOrders_smartActions_UserActionNavigation_Id}

Sales Promotions

The sales promotion resource is used to view, create, update, or delete a sales promotion. A sales promotion is a business object that is used to offer special pricing to your customers to promote products.

Create a sales promotion: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesPromotions
Delete a sales promotion: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesPromotions/{SalesPromotionId}
Get a sales promotion: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesPromotions/{SalesPromotionId}
Get all sales promotions: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesPromotions
Update a sales promotion: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesPromotions/{SalesPromotionId}

Sales Suggestions

The sales suggestions resource is used to view and create sales suggestions.

Analyze text: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/action/analyzeText
Create a sales suggestion: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions
Get a sales suggestion: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}
Get all sales suggestions: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions
Process analyzed text: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/action/processAnalyzedText
Update a sales suggestion: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}

Sales Suggestions/Large Object (LOB) Attributes - Suggestion

Delete a Suggestion: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/enclosure/Suggestion
Get a Suggestion: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/enclosure/Suggestion
Replace a Suggestion: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/enclosure/Suggestion

Sales Suggestions/Large Object (LOB) Attributes - SuggestionContext

Delete a SuggestionContext: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/enclosure/SuggestionContext
Get a SuggestionContext: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/enclosure/SuggestionContext
Replace a SuggestionContext: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/enclosure/SuggestionContext

Sales Suggestions/Large Object (LOB) Attributes - SuggestionReason

Delete a SuggestionReason: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/enclosure/SuggestionReason
Get a SuggestionReason: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/enclosure/SuggestionReason
Replace a SuggestionReason: Method: put
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/enclosure/SuggestionReason

Sales Suggestions/Suggestion Related Objects

The suggestion related objects resource is used to view the related objects associated to sales suggestion.

Get a suggestion related object: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/child/SuggestionRelatedObjects/{SuggestionRelatedObjectId}
Get all suggestion related objects: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/child/SuggestionRelatedObjects

Sales Territories

The sales territories resource represents the list of sales territories that the logged-in user can view. A sales territory is an organizational domain with boundaries defined by attributes of customers, products, services, resources, and so on. Sales territories can be created based on multiple criteria including postal code, area code, country, vertical market, size of company, product expertise, and geographical location. Sales territories form the fundamental infrastructure of sales management as they define the jurisdiction that salespeople have over sales accounts, or the jurisdiction that channel sales managers have over partners and partner transactions.

Create a territory: Method: post
Path: /crmRestApi/resources/11.13.18.05/territories
Delete a territory: Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}
Get a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}
Get all territories: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories
Update a territory: Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}

Sales Territories/Line of Business

The line of business resource is used to view the lines of business associated with a sales territory. A line of business is a general term that describes the products or services offered by the company or organization. The line of business object contains all lines of business for historical, active, and draft territory versions. It is optional for a sales territory to have associated lines of business.

Create a line of business for a territory: Method: post
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness
Delete a line of business for a territory: Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness/{TerrLobId}
Get a line of business for a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness/{TerrLobId}
Get all lines of business for a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness
Update a line of business for a territory: Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness/{TerrLobId}

Sales Territories/Resources

The resources resource is used to view the resources, such as owner or sales people associated with a sales territory. The equivalent functional term for resource is team member. The resources object contains all team members for historical, active, and draft territory versions. Each sales territory must have an owner, so each of the sales territory versions has at least one resource record.

Create a resource for a territory: Method: post
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource
Delete a resource for a territory: Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource/{TerritoryResourceUniqID}
Get a resource for a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource/{TerritoryResourceUniqID}
Get all resources for a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource
Update a resource for a territory: Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource/{TerritoryResourceUniqID}

Sales Territories/Rules

The rules resource is used to view the territory rules associated with a sales territory. The equivalent functional term for rule is coverage. The coverage is what identifies the scope of responsibility of the sales territory team in the market space. The rules object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.

Create a rule for a territory: Method: post
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule
Delete a rule for a territory: Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}
Get a rule for a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}
Get all rules for a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule
Update a rule for a territory: Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}

Sales Territories/Rules/Rule Boundaries

The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.

Create a rule boundary for a territory: Method: post
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1
Delete a rule boundary for a territory: Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}
Get a rule boundary for a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}
Get all rule boundaries for a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1
Update a rule boundary for a territory: Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}

Sales Territories/Rules/Rule Boundaries/Rule Boundary Values

The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.

Create a rule boundary value for a territory: Method: post
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1
Delete a rule boundary value for a territory: Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1/{TerrRuleBndryValueId}
Get a rule boundary value for a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1/{TerrRuleBndryValueId}
Get all rule boundary values for a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1
Update a rule boundary value for a territory: Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1/{TerrRuleBndryValueId}

Sales Territory Proposals

The sales territory proposals resource is used to view, create, update, and delete territory proposals. A territory proposal is a container used to model territory changes without affecting the active territories. Sales executives, administrators, and managers use territory proposals to model different ways to partition their territories and view the results until they are satisfied with a model. They can then activate the preferred territory proposals.

Create a proposal: Method: post
Path: /crmRestApi/resources/11.13.18.05/proposals
Delete a proposal: Method: delete
Path: /crmRestApi/resources/11.13.18.05/proposals/{TerrProposalId}
Get a proposal: Method: get
Path: /crmRestApi/resources/11.13.18.05/proposals/{TerrProposalId}
Get all proposals: Method: get
Path: /crmRestApi/resources/11.13.18.05/proposals
Update a proposal: Method: patch
Path: /crmRestApi/resources/11.13.18.05/proposals/{TerrProposalId}

Scoring Models

The scoring models resource is used to view, create, and delete a scoring model. It's used to calculate a score based on the object's attributes and child object's attributes.

Create a scoring model: Method: post
Path: /crmRestApi/resources/11.13.18.05/scoringModels
Delete a scoring model: Method: delete
Path: /crmRestApi/resources/11.13.18.05/scoringModels/{ModelUuid}
Get a scoring model: Method: get
Path: /crmRestApi/resources/11.13.18.05/scoringModels/{ModelUuid}
Get all scoring models: Method: get
Path: /crmRestApi/resources/11.13.18.05/scoringModels

Scoring Models/Scoring Details

The scoring details resource is used to view and create a scoring detail. It defines the object and attribute that the scoring will be calculated on.

Create a scoring detail: Method: post
Path: /crmRestApi/resources/11.13.18.05/scoringModels/{ModelUuid}/child/ScoringDetail
Get a scoring detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/scoringModels/{ModelUuid}/child/ScoringDetail/{ScoringDetailUniqID}
Get all scoring details: Method: get
Path: /crmRestApi/resources/11.13.18.05/scoringModels/{ModelUuid}/child/ScoringDetail

Scoring Models/Scoring Details/Scoring Weights

The scoring weights resource is used to view and create a scoring weight. It defines the condition and the score weight.

Create a scoring weight: Method: post
Path: /crmRestApi/resources/11.13.18.05/scoringModels/{ModelUuid}/child/ScoringDetail/{ScoringDetailUniqID}/child/ScoringWeight
Get a scoring weight: Method: get
Path: /crmRestApi/resources/11.13.18.05/scoringModels/{ModelUuid}/child/ScoringDetail/{ScoringDetailUniqID}/child/ScoringWeight/{ScoringWeightUniqID}
Get all scoring weights: Method: get
Path: /crmRestApi/resources/11.13.18.05/scoringModels/{ModelUuid}/child/ScoringDetail/{ScoringDetailUniqID}/child/ScoringWeight

Self-Service Registrations

The self-service registrations resource is used to view, create, and update self-service registration requests. Self-registration, allows users to create their own login and password for the application.

Create a self-service registration request: Method: post
Path: /crmRestApi/resources/11.13.18.05/selfRegistrations
Get a self-service registration request: Method: get
Path: /crmRestApi/resources/11.13.18.05/selfRegistrations/{RegistrationId}
Get all self-service registration requests: Method: get
Path: /crmRestApi/resources/11.13.18.05/selfRegistrations
Update a self-service registration request: Method: patch
Path: /crmRestApi/resources/11.13.18.05/selfRegistrations/{RegistrationId}

Self-Service Role Mappings

The self service role mappings resource is used to view, create, update, and delete a mapping between custom self-service roles and job roles.

Create a mapping: Method: post
Path: /crmRestApi/resources/11.13.18.05/cssIdpRoleMappings
Delete a mapping: Method: delete
Path: /crmRestApi/resources/11.13.18.05/cssIdpRoleMappings/{RoleMappingId}
Get a mapping: Method: get
Path: /crmRestApi/resources/11.13.18.05/cssIdpRoleMappings/{RoleMappingId}
Get all mappings: Method: get
Path: /crmRestApi/resources/11.13.18.05/cssIdpRoleMappings

Self-Service Roles

The self-service roles resource is used to view, create, and delete roles for self-service users.

Create a role for a self-service user: Method: post
Path: /crmRestApi/resources/11.13.18.05/selfServiceRoles
Delete a role from a self-service user: Method: delete
Path: /crmRestApi/resources/11.13.18.05/selfServiceRoles/{RoleId}
Get a role for a self-service user: Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceRoles/{RoleId}
Get all roles for a self-service user: Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceRoles
Update a role for a self-service user: Method: patch
Path: /crmRestApi/resources/11.13.18.05/selfServiceRoles/{RoleId}

Self-Service Users

The self-service users resource is used to view the users associated with the self-service functionality.

Get a self-service user: Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}
Get all the self-service users: Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers

Self-Service Users/Self-Service Roles

The self-service roles resource is used to view, create, update, and delete roles for self-service users.

Create a self-service role: Method: post
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRoles
Delete a self-service role: Method: delete
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRoles/{RoleId}
Get a self-service role: Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRoles/{RoleId}
Get all self-service roles: Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRoles
Update a self-service role: Method: patch
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRoles/{RoleId}

Self-Service Users/Self-Service Roles Histories

The self-service roles histories resource is used to view when a role was granted to or revoked from a self-service user.

Get a self-service role history: Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRolesHistory/{HistoryId}
Get all self-service role histories: Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRolesHistory

Service Details

The service details resource is used view the details of a service provided by an organization.

Get a service detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceDetails/{ServiceId}
Get all service details: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceDetails

Service Profiles

The service profiles resource is used to view, create, update, and delete a service profile. It tracks how your organization provides service to your customers by grouping contacts and assets into profiles with common preferences. For example, a site profile can track the contacts and assets located at the site. It also includes notes about preferences and restrictions for providing service to the site. Customers can have many service profiles but there can be only one site profile for a given address.

Create a service profile: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles
Delete a service profile: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}
Get a service profile: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}
Get all service profiles: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles
Update a service profile: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}

Service Profiles/Notes

The note objects resource is used to view the note objects.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/notes
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/notes/{NoteId}
Get a note object: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/notes/{NoteId}
Get all note objects: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/notes
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/notes/{NoteId}

Service Profiles/Notes/Large Object (LOB) Attributes - NoteTxt

Delete a NoteTxt: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/notes/{NoteId}/enclosure/NoteTxt
Get a NoteTxt: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/notes/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt: Method: put
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/notes/{NoteId}/enclosure/NoteTxt

Service Profiles/Service Profile Contacts

The service profile contacts resource is used to view, create, update, and delete a service profile contact. It's the list of the people that work with the assets grouped in the profile, including their preferences and restrictions for how they receive service. A given customer contact can be associated to one or more service profiles.

Create a service profile contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/contacts
Delete a service profile contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/contacts/{SpContactId}
Get a service profile contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/contacts/{SpContactId}
Get all service profile contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/contacts
Update a service profile contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceProfiles/{ServiceProfileNumber}/child/contacts/{SpContactId}

Service Providers

The service providers resource is used to view, create, update, and delete the details of all service providers.

Create a service provider: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceProviders
Delete a service provider: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}
Get a service provider: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}
Get all service providers: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders
Update a service provider: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}

Service Providers/Services

The services resource is used view, create, update, and delete the details of services that are under the purview of a service provider.

Create a service: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services
Delete a service: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}
Get a service: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}
Get all services: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services
Update a service: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}

Service Providers/Services/Service Histories

The service histories resource is used to view the historical information about the availability of a service.

Get a service history: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}/child/serviceHistories/{HistoryId}
Get all service histories: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}/child/serviceHistories

Service Request Tags v1

Service request tags are keywords or terms assigned to a service request that help in describing and classifying the service request.

Advanced query a service request tag: Method: post
Path: /api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequestTags/{serviceRequestTags_id}/$query
Advanced query all service request tags: Method: post
Path: /api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequestTags/$query
Create a service request tag: Method: post
Path: /api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequestTags
Delete a service request tag: Method: delete
Path: /api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequestTags/{serviceRequestTags_id}
Get a service request tag: Method: get
Path: /api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequestTags/{serviceRequestTags_id}
Get all service request tags: Method: get
Path: /api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequestTags

Service Requests

The service requests resource is used to view, create, update, and delete service requests. A service request is a document to track a request from a customer for a service from the time the customer makes the request until the request is resolved.

Copy service request attachments: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/action/copySRAttachments
Create a service request: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests
Delete a service request: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}
Get a service request: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}
Get all service requests: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests
Get service request milestone diagnostics: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/action/getSrMilestoneDiagnostics
Refresh service request milestones: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/action/processSrMilestones
Send an email to SR message recipients: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/action/sendEmailForSrMessage
Update a service request: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}

Service Requests/Activities

The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.

Create activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/action/createActivitiesFromTemplate
Create an activity: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities
Create multiple activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/action/createMultipleActivitiesFromTemplate
Delete an activity: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}
Get all activities: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities
Get an activity: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}
Send notifications to resources: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/action/sendNotificationToResources
Update an activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}
Update an activity wrap up: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/action/updateActivityWrapup

Service Requests/Activities/Large Object (LOB) Attributes - Description

A text area for capturing information about the activity.

Delete a Description: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}/enclosure/ActivityDescription
Get a Description: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}/enclosure/ActivityDescription
Replace a Description: Method: put
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}/enclosure/ActivityDescription

Service Requests/Activities/Large Object (LOB) Attributes - Meeting Minutes

The minutes of an activity meeting.

Delete a Meeting Minutes: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes
Get a Meeting Minutes: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes
Replace a Meeting Minutes: Method: put
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes

Service Requests/Activities/Large Object (LOB) Attributes - WebConferenceDetails

Delete a WebConferenceDetails: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}/enclosure/WebConferenceDetails
Get a WebConferenceDetails: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}/enclosure/WebConferenceDetails
Replace a WebConferenceDetails: Method: put
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}/enclosure/WebConferenceDetails

Service Requests/Attachments

The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}

Service Requests/Attachments/Attached Documents Descriptive Flexfield

The operations from the Service Requests/Attachments/Attached Documents Descriptive Flexfield category.

Create descriptive flexfield values for attached documents: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Get a descriptive flexfield value: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}
Get all descriptive flexfield values: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Update descriptive flexfield values for attached documents: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}

Service Requests/Attachments/Attachments Preview

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

Service Requests/Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Service Requests/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Service Requests/Channel Communications

The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.

Create a channel communication: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/channelCommunication
Delete a channel communication: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/channelCommunication/{channelCommunicationUniqID}
Get a channel communication: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/channelCommunication/{channelCommunicationUniqID}
Get all channel communications: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/channelCommunication
Update a channel communication: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/channelCommunication/{channelCommunicationUniqID}

Service Requests/Contact Members

The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.

Create a contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts
Delete a contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts/{MemberId}
Get a contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts/{MemberId}
Get all contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts
Update a contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts/{MemberId}

Service Requests/Interaction References

The interaction references resource is used to view the relationship between an interaction and a service request.

Get a service request interaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferences/{ReferenceId}
Get all service request interactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferences

Service Requests/Interaction References/Large Object (LOB) Attributes - Payload

The payload associated with the interaction.

Delete a Payload: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload
Get a Payload: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload
Replace a Payload: Method: put
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload

Service Requests/Messages

The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.".

Create a message: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages
Delete a message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}
Get a message: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}
Get all messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages
Update a message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}

Service Requests/Messages/Attachments

The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}

Service Requests/Messages/Attachments/Attached Documents Descriptive Flexfield

The operations from the Service Requests/Messages/Attachments/Attached Documents Descriptive Flexfield category.

Create descriptive flexfield values for attached documents: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Get a descriptive flexfield value: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}
Get all descriptive flexfield values: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Update descriptive flexfield values for attached documents: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}

Service Requests/Messages/Attachments/Attachments Preview

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

Service Requests/Messages/Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Service Requests/Messages/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Service Requests/Messages/Channel Communications

Create a channel communication: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication
Delete a channel communication: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication/{ViaId}
Get a channel communication: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication/{ViaId}
Get all channel communications: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication
Update a channel communication: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication/{ViaId}

Service Requests/Messages/Large Object (LOB) Attributes - Message Content

The content of the message encoded in base 64 format. Any attachment associated with the message is not the content of the message.

Delete a Message Content: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/enclosure/MessageContent
Get a Message Content: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/enclosure/MessageContent
Replace a Message Content: Method: put
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/enclosure/MessageContent

Service Requests/Milestones

The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.

Get a service request milestone: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone/{SrMilestoneId}
Get all service request milestones: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone
Update a service request milestone: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone/{SrMilestoneId}

Service Requests/Milestones/Milestone Codes

The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.

Get a service request milestone history: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory/{HistoryId}
Get all service request milestone history: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory

Service Requests/Resources

Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.

Create a resource member: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers
Delete a resource member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers/{MemberId}
Get a resource member: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers/{MemberId}
Get all resource members: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers
Update a resource member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers/{MemberId}

Service Requests/Service Addresses

A service address represents the location information that will guide technicians in providing service to the right location. The service address can be an existing address in the system, or it can be entered as a single-use address.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/addresses
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/addresses/{ServiceAddressId}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/addresses
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/addresses/{ServiceAddressId}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/addresses/{ServiceAddressId}

Service Requests/Service Request References

The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.

Create a service request reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences
Delete a service request reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences/{ReferenceId}
Get a service request reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences/{ReferenceId}
Get all service request references: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences
Update a service request reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences/{ReferenceId}

Service Requests/Smart Actions

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{serviceRequests_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/action/generateSmartActions
Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{serviceRequests_smartActions_Id}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/action/processMassAction

Service Requests/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{serviceRequests_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{serviceRequests_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{serviceRequests_smartActions_Id}/enclosure/ActionIntent

Service Requests/Smart Actions/Smart Action REST Path Parameter Definitions

Get all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{serviceRequests_smartActions_Id}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{serviceRequests_smartActions_Id}/child/UserActionURLBinding/{serviceRequests_smartActions_UserActionURLBinding_Id}

Service Requests/Smart Actions/Smart Action REST Payload Definitions

Get all action request payloads - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{serviceRequests_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{serviceRequests_smartActions_Id}/child/UserActionRequestPayload/{serviceRequests_smartActions_UserActionRequestPayload_Id}

Service Requests/Smart Actions/Smart Action User Interface Definitions

Get all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{serviceRequests_smartActions_Id}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{serviceRequests_smartActions_Id}/child/UserActionNavigation/{serviceRequests_smartActions_UserActionNavigation_Id}

Service Requests/Tags

The tags resource is used to view, create, and delete keywords or terms assigned to a service request. Tags help describe and classify a service request.

Create a tag: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srTags
Delete a tag: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srTags/{srTagsUniqID}
Get a tag: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srTags/{srTagsUniqID}
Get all tags: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srTags

Setup Assistants

The Setup Assistant resource is used to view the progress status of setup tasks.

Get a setup task: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}
Get all setup tasks: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants
Initialize Setup Assistant: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/action/initializeSA
Update a setup tasks: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}

Setup Assistants/Accounting Calendars

The Accounting Calendar resource is used to create accounting calendar.

Create an accounting calendar: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AccountingCalendars
Get all accounting calendars: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AccountingCalendars
Get an accounting calendar: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AccountingCalendars/{Id}
Update an accounting calendar: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AccountingCalendars/{Id}

Setup Assistants/Adaptive Searches

The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.

Create adaptive search setup details: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AdaptiveSearch
Get all adaptive search setup details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AdaptiveSearch
Get an adaptive search setup details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AdaptiveSearch/{Id}
Update adaptive search setup details: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AdaptiveSearch/{Id}

Setup Assistants/Company Profiles

The Company Profile resource is used to create the enterprise information.

Create a company profile: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/CompanyProfiles
Get a company profile: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/CompanyProfiles/{Id}
Get all company profiles: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/CompanyProfiles
Update a company profile: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/CompanyProfiles/{Id}

Setup Assistants/Competitors

The Competitors resource is used to create competitors.

Create a competitor: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Competitors
Delete a competitor: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Competitors/{Id}
Get a competitor: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Competitors/{Id}
Get all competitors: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Competitors
Update a competitor: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Competitors/{Id}

Setup Assistants/Geographies

The Geographies resource is used to import geographies and enable geocoding.

Create geographies setup data: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Geographies
Get a geography setup data: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Geographies/{Id}
Get all geographies setup data: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Geographies
Update a geography setup data: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Geographies/{Id}

Setup Assistants/Large Object (LOB) Attributes - Data

Delete a Data: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/enclosure/Data
Get a Data: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/enclosure/Data
Replace a Data: Method: put
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/enclosure/Data

Setup Assistants/Opportunities

The Opportunities resource is used to create, view and update opportunity setup.

Create opportunities setup data: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities
Get all opportunities setup data: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities
Get an opportunity setup data: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities/{Id}
Update opportunity setup data: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities/{Id}

Setup Assistants/Opportunities/Sales Stages

The Sales Stages resource is used to create, view and update sales stages for the selected sales method.

Create sales stages for the selected sales method: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities/{Id}/child/SalesStages
Delete a user defined sales stage for the selected sales method: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities/{Id}/child/SalesStages/{StgId}
Get all sales stages of the selected sales method: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities/{Id}/child/SalesStages
Get sales stages of the selected sales method: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities/{Id}/child/SalesStages/{StgId}
Update a sales stage of the selected sales method: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities/{Id}/child/SalesStages/{StgId}

Setup Assistants/Product Groups

The Product Group resource is used to create the root product group.

Create product group setup details: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/ProductGroups
Get all product group setup details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/ProductGroups
Get product group setup details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/ProductGroups/{Id}
Update product group setup details: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/ProductGroups/{Id}

Setup Assistants/Role Mappings

The Resource Role Mapping resource is used to create resource roles and role mappings.

Create resource roles and role mappings: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/RoleMappings
Delete a resource role and role mapping: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/RoleMappings/{Id}
Get all resource roles and role mappings: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/RoleMappings
Get resource role and role mapping: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/RoleMappings/{Id}
Update a resource role and role mapping: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/RoleMappings/{Id}

Setup Assistants/Sales Forecasts

The Sales Forecasting resource is used to setup owner based sales forecasting.

Create sales forecasting details: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesForecastings
Get all sales forecasting setup details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesForecastings
Get sales forecasting setup details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesForecastings/{Id}
Update sales forecasting setup details: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesForecastings/{Id}

Setup Assistants/Sales Stages

The Sales Stages resource is used to create, view and update sales stages for the selected sales method.

Create sales stages for the selected sales method: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesStages
Delete a user defined sales stage for the selected sales method: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesStages/{StgId}
Get all sales stages of the selected sales method: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesStages
Get sales stages of the selected sales method: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesStages/{StgId}
Update a sales stage of the selected sales method: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesStages/{StgId}

Setup Assistants/Setup Histories

The setup history resource is used to view setup data captured by the Setup Assistant.

Get a setup history detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupHistory/{TaskCode}
Get all setup history details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupHistory

Setup Assistants/Setup Progress

The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.

Get a setup task details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupProgress/{TaskCode}
Get all setup task details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupProgress

Setup Assistants/Setup Users

The Setup Users resource is used to create setup users.

Create setup users details: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupUsers
Delete a setup user details: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupUsers/{Id10}
Get all setup user details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupUsers
Get setup user details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupUsers/{Id10}
Update a setup user details: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupUsers/{Id10}

Setup Assistants/Top Sales Users

The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.

Create top sales users details: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/TopSalesUsers
Get all top sales user details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/TopSalesUsers
Get top sales user details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/TopSalesUsers/{Id11}
Update a top sales user details: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/TopSalesUsers/{Id11}

Signatures

The signatures resource is used to view, create, update, and delete a signature for an agent. It's used to get the description of the root signatures resource.

Create a signature: Method: post
Path: /crmRestApi/resources/11.13.18.05/signatures
Delete a signature: Method: delete
Path: /crmRestApi/resources/11.13.18.05/signatures/{SignatureNumber}
Get a signature: Method: get
Path: /crmRestApi/resources/11.13.18.05/signatures/{SignatureNumber}
Get all signatures: Method: get
Path: /crmRestApi/resources/11.13.18.05/signatures
Update a signature: Method: patch
Path: /crmRestApi/resources/11.13.18.05/signatures/{SignatureNumber}

Signatures/Large Object (LOB) Attributes - SignatureContent

Delete a SignatureContent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/signatures/{SignatureNumber}/enclosure/SignatureContent
Get a SignatureContent: Method: get
Path: /crmRestApi/resources/11.13.18.05/signatures/{SignatureNumber}/enclosure/SignatureContent
Replace a SignatureContent: Method: put
Path: /crmRestApi/resources/11.13.18.05/signatures/{SignatureNumber}/enclosure/SignatureContent

Smart Text Folders

The smart text folder resource is used to view, create, delete, and update the smart text folders.

Create a smart text folder: Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders
Delete a smart text folder: Method: delete
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}
Get a smart text folder: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}
Get all smart text folders: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders
Update a smart text folder: Method: patch
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}

Smart Text Folders/Smart Text Child Folders

The smart text child folder resource is used to view, create, delete, and update the smart text child folders.

Create smart text child folders: Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFolders
Delete a smart text child folder: Method: delete
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFolders/{FolderId2}
Get a smart text child folder: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFolders/{FolderId2}
Get all smart text child folders: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFolders
Update a smart text child folder: Method: patch
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFolders/{FolderId2}

Smart Text User Variables

The smart text user variables resource is used to view, create, update, and delete user defined smart text variables. Smart text user variables can be defined to derive values from business objects such as service requests, defined as a literal value, or be presented as a prompt variable.

Create a smart text user variable: Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTextUserVariables
Delete a smart text user variable: Method: delete
Path: /crmRestApi/resources/11.13.18.05/smartTextUserVariables/{VariableId}
Get a smart text user variable: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextUserVariables/{VariableId}
Get all smart text user variables: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextUserVariables
Update a smart text user variable: Method: patch
Path: /crmRestApi/resources/11.13.18.05/smartTextUserVariables/{VariableId}

Smart Texts

The Smart Text resource is used to view, create, update, and delete smart texts. A SmartText entry is a reusable fragment of text that you can use in SR messages.

Create a smart text: Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTexts
Delete a smart text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}
Get a smart text: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}
Get all smart texts: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTexts
Get Smart Text Variable Values: Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTexts/action/fetchSmartTextVarValues
Process smart text variable substitution: Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}/action/processSmartText
Process smart text variable substitution by the unique identifier: Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTexts/action/processSmartTextById
Update a smart text: Method: patch
Path: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}

Smart Texts/Large Object (LOB) Attributes - Text

Delete a Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}/enclosure/Text
Get a Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}/enclosure/Text
Replace a Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}/enclosure/Text

SmartText History

The SmartText history resource is used to view, create, update, and delete SmartText history entries. A SmartText history entry is an object which allows reporting against the usages of SmartTexts.

Create a SmartText history: Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTextHistory
Delete a SmartText history: Method: patch
Path: /crmRestApi/resources/11.13.18.05/smartTextHistory/{StdTxtHistId}
Get a SmartText history: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextHistory/{StdTxtHistId}
Get all SmartText histories: Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextHistory
Update a SmartText history: Method: delete
Path: /crmRestApi/resources/11.13.18.05/smartTextHistory/{StdTxtHistId}

Social Posts

The social posts resource is used view, create, and delete the details of a social post received from the Oracle Social Cloud application that the customer service personnel review and respond to. For example, posts such as "Is the oracle_support email server down? Our customers are unable to receive any email responses from our agent.".

Create a social post: Method: post
Path: /crmRestApi/resources/11.13.18.05/socialPosts
Delete a social post: Method: delete
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}
Get a social post: Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}
Get all social posts: Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts

Social Posts/Large Object (LOB) Attributes - PostContent

The content of the social post made by the customer.

Get a PostContent: Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/enclosure/PostContent

Social Posts/Social Post Tags

The social post tags resource is used to view, create, and delete the tags associated with a social post, such as Customer_Churn, Billing Customer Service, etc.

Create a social post tag: Method: post
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/SocialPostTags
Delete a social post tag: Method: delete
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/SocialPostTags/{SocialPostTagsUniqID}
Get a social post tag: Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/SocialPostTags/{SocialPostTagsUniqID}
Get all social post tags: Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/SocialPostTags

Social Posts/Social Post URLs

The social post URLs resource is used to view, create, and delete the URLs associated with service objects such as social posts or service requests. An example of an URL is the link to a photo sent by a customer along with a social post.

Add a social post URL: Method: post
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/socialPostUrls
Delete a social post URL: Method: delete
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/socialPostUrls/{socialPostUrlsUniqID}
Get a social post URL: Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/socialPostUrls/{socialPostUrlsUniqID}
Get all social post URLs: Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/socialPostUrls

Social Users

The social users resource is used to view, create, and update the details of the social network user who created a social post that was captured by the Oracle Social Cloud application and sent to Engagement Cloud. For example, the details of a Twitter user who created a social post.

Create a social user: Method: post
Path: /crmRestApi/resources/11.13.18.05/socialUsers
Get a social user: Method: get
Path: /crmRestApi/resources/11.13.18.05/socialUsers/{UserId}
Get all social users: Method: get
Path: /crmRestApi/resources/11.13.18.05/socialUsers
Update a social user: Method: patch
Path: /crmRestApi/resources/11.13.18.05/socialUsers/{UserId}

Source System References

The source system references resource is used to view, create, update or delete a source system reference assignment for Trading Community objects.

Create a source system reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubSourceSystemReferences
Delete a source system reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/{SourceSystemReferenceId}
Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/{SourceSystemReferenceId}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubSourceSystemReferences
Update a source system reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/{SourceSystemReferenceId}

Standard Coverages

The standard coverage resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.

Create a standard coverage: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders
Delete a standard coverage: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders/{CoverageHeaderPuid}
Get a standard coverage: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders/{CoverageHeaderPuid}
Get all standard coverages: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders
Update a standard coverage: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders/{CoverageHeaderPuid}

Standard Coverages/Adjustments

The adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information.

Create an adjustment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders/{CoverageHeaderPuid}/child/CoverageChargeDiscounts
Get all adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders/{CoverageHeaderPuid}/child/CoverageChargeDiscounts
Get an adjustment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders/{CoverageHeaderPuid}/child/CoverageChargeDiscounts/{CoverageDiscountPuid}
Update an adjustment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders/{CoverageHeaderPuid}/child/CoverageChargeDiscounts/{CoverageDiscountPuid}

Subscription AI Features

The subscription AI features resource lets you view the churn feature details. It has details such as start and end dates, item, unit price, amount, bill-to details, billing frequency, invoice rule, payment method, and account details such as account length, renewals, average renewal durations, product terminations, open/closed service requests, and average bill amounts.

Create a product churn feature: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAiFeatures
Delete a product churn feature: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAiFeatures/{SubscriptionProductPuid}
Get all product churn features: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAiFeatures
Get product churn feature: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAiFeatures/{SubscriptionProductPuid}
Update a product churn feature: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAiFeatures/{SubscriptionProductPuid}

Subscription Accounts

The subscription accounts resource is used to view, create, update, and delete a subscription account. It lists all the subscription accounts with details.

Create a subscription account: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts
Delete a subscription account: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}
Get a subscription account: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}
Get all subscription accounts: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts
Update a subscription account: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}

Subscription Accounts Roles

The subscription account roles resource is used to view, created, update, and delete roles associated with your subscription accounts.

Create a subscription account role: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccountRoles
Delete a subscription account role: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccountRoles/{SubscrAccRoleNumber}
Get a subscription account role: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccountRoles/{SubscrAccRoleNumber}
Get all subscription account roles: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccountRoles
Update a subscription account role: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccountRoles/{SubscrAccRoleNumber}

Subscription Accounts/Attachments

The attachments resource is used to view, create, update, and delete an attachment. The attachments are associated with the subscription account.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments/{AttachmentsUniqID}

Subscription Accounts/Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Subscription Accounts/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Subscription Accounts/Billing Profiles

The billing profiles resource is used view, create, update, and delete a billing profile. It lists all the billing profiles for the given subscription account.

Create a billing profile: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles
Delete a billing profile: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles/{BillingProfileNumber}
Get a billing profile: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles/{BillingProfileNumber}
Get all billing profiles: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles
Update a billing profile: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles/{BillingProfileNumber}

Subscription Accounts/Notes

The notes resource is used to view, create, update, and delete notes associated with the subscription account. A note captures comments, information, or instructions related to an account.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note/{NoteId}

Subscription Accounts/Notes/Large Object (LOB) Attributes - NoteTxt

Delete a NoteTxt: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a NoteTxt: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt: Method: put
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Subscription Accounts/Subscription Account Addresses

The subscription account addresses resource is used to view, create, update, and delete an account resource. It lists all the subscription account addresses with details.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress/{AddressNumber}

Subscription Accounts/Subscription Account Asset Relationships

The subscription account asset relationships resource is used to view, create, update, and delete a subscription account asset relationship. It lists all the subscription account asset relationships with details.

Create a subscription account asset relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAssetRelationships
Delete a subscription account asset relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAssetRelationships/{SubscriptionAccountAssetRelationshipNumber}
Get a subscription account asset relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAssetRelationships/{SubscriptionAccountAssetRelationshipNumber}
Get all subscription account asset relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAssetRelationships
Update a subscription account asset relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAssetRelationships/{SubscriptionAccountAssetRelationshipNumber}

Subscription Accounts/Subscription Account Relationships

The subscription account relationships resource is used to view, create, update, and delete an account relationship.

Create a subscription account relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship
Delete a subscription account relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship/{SubscriptionAccountRelationshipNumber}
Get a subscription account relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship/{SubscriptionAccountRelationshipNumber}
Get all subscription account relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship
Update a subscription account relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship/{SubscriptionAccountRelationshipNumber}

Subscription Accounts/Subscription Account Roles

The subscription account roles resource is used to view, create, update, and delete an account role. It lists all the subscription account roles with details.

Create a subscription account role: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRoles
Delete a subscription account role: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRoles/{SubscrAccRoleNumber}
Get a subscription account role: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRoles/{SubscrAccRoleNumber}
Get all subscription account roles: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRoles
Update a subscription account role: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRoles/{SubscrAccRoleNumber}

Subscription Asset Transactions

The subscription asset transactions resource is used to view and create the asset transactions. The subscription asset transaction object has details such as customer asset, transaction type, transaction date etc.

Create a subscription asset transaction: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions
Get a subscription asset transaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}
Get all subscription asset transactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions
Notify fulfillment completed: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/action/notifyFulfillmentCompleted
Notify pending fulfillment canceled: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/action/notifyPendingFulfillmentCancelled
Notify return completed: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/action/notifyReturnCompleted
Notify shipment completed: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/action/notifyShipmentCompleted

Subscription Asset Transactions/Asset Fulfillment Lines

The asset fulfillment lines resource to view and create the asset fulfillment details in a replacement or upgrade transaction. The Asset Fulfillment Lines object has details such as replaced or upgraded customer asset, fulfillment date, fulfillment type etc.

Create a fulfillment line: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetFulfillmentLines
Get a fulfillment line: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetFulfillmentLines/{FulfillmentLineNumber}
Get all fulfillment lines: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetFulfillmentLines

Subscription Asset Transactions/Asset Split Lines

The asset split lines resource to is used view and create the asset split details in a split transaction. The Asset Split Lines object has details such as customer asset, quantity etc.

Create a split line: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetSplitLines
Get a split line: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetSplitLines/{SplitLineNumber}
Get all split lines: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetSplitLines

Subscription Balance Codes

The subscription balance codes resource is used to view, create, update, and delete a balance code.

Activate balance code: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/action/activate
Create a balance code: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes
Deactivate balance code: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/action/deActivate
Delete a balance code: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}
Get a balance code: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}
Get all balance codes: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes
Update a balance code: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}

Subscription Balance Codes/Subscription Balance Code Charges

The subscription balance codes charges resource is used to view, create, update, and delete a balance code charge

Create a balance code charge: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/balanceCodeCharges
Delete a balance code charge: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/balanceCodeCharges/{BalanceCodeChargeNumber}
Get a balance code charge: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/balanceCodeCharges/{BalanceCodeChargeNumber}
Get all balance code charges: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/balanceCodeCharges
Update a balance code charge: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/balanceCodeCharges/{BalanceCodeChargeNumber}

Subscription Balance Codes/Subscription Balance Condition Criteria

The subscription balance condition criteria resource is used to view, create, update, and delete balance conditions.

Create a balance condition criterion: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/conditionCriteria
Delete a balance condition criterion: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/conditionCriteria/{BalanceCriteriaNumber}
Get a balance condition criterion: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/conditionCriteria/{BalanceCriteriaNumber}
Get all balance condition criteria: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/conditionCriteria
Update a balance condition criterion: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/conditionCriteria/{BalanceCriteriaNumber}

Subscription Balance Codes/Subscription Balance Condition Criteria/Subscription Balance Condition Predicates

The subscription balance condition predicates resource is used to view, create, update, and delete balance predicate.

Create a balance consumption predicate: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/conditionCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates
Delete a balance consumption predicate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/conditionCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}
Get all balance consumption predicates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/conditionCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates
Update a balance consumption predicate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/conditionCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}

Subscription Balance Codes/Subscription Balance Condition Criteria/Subscription Balance Consumption Predicates

The operations from the Subscription Balance Codes/Subscription Balance Condition Criteria/Subscription Balance Consumption Predicates category.

Get a balance condition predicate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/conditionCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}

Subscription Balance Codes/Subscription Balance Consumption Criteria

The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

Create a balance consumption criterion: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria
Delete a balance consumption criterion: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria/{BalanceCriteriaNumber}
Get a balance consumption criterion: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria/{BalanceCriteriaNumber}
Get all balance consumption criteria: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria
Update a balance consumption criterion: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria/{BalanceCriteriaNumber}

Subscription Balance Codes/Subscription Balance Consumption Criteria/Subscription Balance Consumption Predicates

The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

Create a balance consumption predicate: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates
Delete a balance consumption predicate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}
Get a balance consumption predicate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}
Get all balance consumption predicates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates
Update a balance consumption predicate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}

Subscription Balance Consumption Criteria

Get a balance consumption criterion: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCriteria/{BalanceCriteriaNumber}
Get all balance consumption criteria: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCriteria

Subscription Balance Consumption Criteria/Subscription Balance Consumption Predicates

The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

Get a balance consumption predicate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}
Get all balance consumption predicates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates

Subscription Balance Profiles

The subscription balance profiles resource is used to view, create, update, and delete a balance profile.

Activate balance profile: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/action/activate
Create a balance profile: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles
Deactivate balance profile: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/action/deActivate
Delete a balance profile: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}
Get a balance profile: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}
Get all balance profiles: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles
Update a balance profile: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}

Subscription Balance Profiles/Subscription Balance Consumption Criteria

Create a balance consumption criterion: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria
Delete a balance consumption criterion: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria/{BalanceCriteriaNumber}
Get a balance consumption criterion: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria/{BalanceCriteriaNumber}
Get all balance consumption criteria: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria
Update a balance consumption criterion: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria/{BalanceCriteriaNumber}

Subscription Balance Profiles/Subscription Balance Consumption Criteria/Subscription Balance Consumption Predicates

The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

Create a balance consumption predicate: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates
Delete a balance consumption predicate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}
Get a balance consumption predicate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}
Get all balance consumption predicates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates
Update a balance consumption predicate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}

Subscription Balance Profiles/Subscription Balance Profile Charges

The subscription balance profile charges resource is used to view a balance profile charges.

Create a balance profile charge: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileCharges
Delete a balance profile charge: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileCharges/{BalanceProfileChargeNumber}
Get a subscription balance profile charge: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileCharges/{BalanceProfileChargeNumber}
Get all subscription balance profile charges: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileCharges
Update a balance profile charge: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileCharges/{BalanceProfileChargeNumber}

Subscription Balance Profiles/Subscription Profile Balance Codes

The subscription balance profile balance codes resource is used to view, create, update, and delete a balance profile balance code.

Create a balance profile balance code: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileBalanceCodes
Delete a balance profile balance code: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileBalanceCodes/{ProfileBalanceCodeNumber}
Get a balance profile balance code: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileBalanceCodes/{ProfileBalanceCodeNumber}
Get all balance profile balance codes: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileBalanceCodes
Update a balance profile balance code: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileBalanceCodes/{ProfileBalanceCodeNumber}

Subscription Balance Registers

The subscription balance registers resource is used to view a balance registers.

Activate balance register: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/action/activate
Create a subscription balance register: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters
Delete a subscription balance register: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}
Get a subscription balance register: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}
Get all subscription balance registers: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters
Update a subscription balance register: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}

Subscription Balance Registers/Subscription Balance Consumption Criteria

Create a balance consumption criterion: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCriteria
Delete a balance consumption criterion: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCriteria/{BalanceCriteriaNumber}
Get a balance consumption criterion: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCriteria/{BalanceCriteriaNumber}
Get all balance consumption criteria: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCriteria
Update a balance consumption criterion: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCriteria/{BalanceCriteriaNumber}

Subscription Balance Registers/Subscription Balance Consumption Criteria/Subscription Balance Consumption Predicates

The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

Create a balance consumption predicate: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates
Delete a balance consumption predicate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}
Get a balance consumption predicate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}
Get all balance consumption predicates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates
Update a balance consumption predicate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}

Subscription Balance Registers/Subscription Balance Periods

The subscription balance register periods resource is used to view a balance register period.

Get a subscription balance register period: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}
Get all subscription balance register periods: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods

Subscription Balance Registers/Subscription Balance Periods/Subscription Balance Register Allowance Grants

The subscription balance register allowance grants resource is used to view a balance register allowance grant.

Get a subscription balance register allowance grant: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/allowanceGrants/{AllowanceGrantNumber}
Get all subscription balance register allowance grants: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/allowanceGrants
Update a subscription balance register allowance grant: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/allowanceGrants/{AllowanceGrantNumber}

Subscription Balance Registers/Subscription Balance Periods/Subscription Balance Register Commitments

The commitments resource is used to view a register which displays the commitment records. These records are displayed only for those balance codes which have the commitment flag enabled.

Get a subscription balance register commitment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/commitments/{BalanceCommitmentNumber}
Get all subscription balance register commitments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/commitments
Update a subscription balance register commitment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/commitments/{BalanceCommitmentNumber}

Subscription Balance Registers/Subscription Balance Periods/Subscription Balance Register Estimates

The estimates resource is used to view a register which displays the estimates records. These records are displayed only for those balance codes which have the estimate flag enabled.

Get a subscription balance register estimate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/estimates/{BalanceEstimateNumber}
Get all subscription balance register estimates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/estimates
Update a subscription balance register estimate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/estimates/{BalanceEstimateNumber}

Subscription Balance Registers/Subscription Balance Periods/Subscription Balance Register Estimates/Subscription Balance Register Estimate True-Up

The true-up estimate resource is used to view, create, update, and delete ad-hoc true-up. You can create the ad-hoc true-up only for those balance codes where the allow manual true-up flag is checked in the balance profile.

Create a subscription balance true-up estimate: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/estimates/{BalanceEstimateNumber}/child/trueupEstimates
Delete a subscription balance true-up estimate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/estimates/{BalanceEstimateNumber2}/child/trueupEstimates/{TrueupEstimateNumber}
Get a subscription balance true-up estimate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/estimates/{BalanceEstimateNumber2}/child/trueupEstimates/{TrueupEstimateNumber}
Get all subscription balance true-up estimates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/estimates/{BalanceEstimateNumber}/child/trueupEstimates
Update a subscription balance true-up estimate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/estimates/{BalanceEstimateNumber2}/child/trueupEstimates/{TrueupEstimateNumber}

Subscription Balance Registers/Subscription Balance Profile Charges

The subscription balance profile charges resource is used to view a balance profile charges.

Get a subscription balance profile charge: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/profileCharges/{BalanceProfileChargeNumber}
Get all subscription balance profile charges: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/profileCharges

Subscription Balance Registers/Subscription Balance Register Allowance Grants

The subscription balance register allowance grants resource is used to view a balance register allowance grant.

Get a subscription balance register allowance grant: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerAllowances/{AllowanceGrantNumber}
Get all subscription balance register allowance grants: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerAllowances
Update a subscription balance register allowance grant: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerAllowances/{AllowanceGrantNumber}

Subscription Balance Registers/Subscription Balance Register Commitments

The commitments resource is used to view a register which displays the commitment records. These records are displayed only for those balance codes which have the commitment flag enabled.

Get a subscription balance register commitment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCommitments/{BalanceCommitmentNumber}
Get all subscription balance register commitments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCommitments
Update a subscription balance register commitment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCommitments/{BalanceCommitmentNumber}

Subscription Balance Registers/Subscription Balance Register Estimates

The estimates resource is used to view a register which displays the estimates records. These records are displayed only for those balance codes which have the estimate flag enabled.

Get a subscription balance register estimate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerEstimates/{BalanceEstimateNumber}
Get all subscription balance register estimates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerEstimates
Update a subscription balance register estimate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerEstimates/{BalanceEstimateNumber}

Subscription Balance Registers/Subscription Balance Register Estimates/Subscription Balance Register Estimate True-Up

Create a subscription balance true-up estimate: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerEstimates/{BalanceEstimateNumber}/child/trueupEstimates
Delete a subscription balance true-up estimate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerEstimates/{BalanceEstimateNumber}/child/trueupEstimates/{TrueupEstimateNumber}
Get a subscription balance true-up estimate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerEstimates/{BalanceEstimateNumber}/child/trueupEstimates/{TrueupEstimateNumber}
Get all subscription balance true-up estimates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerEstimates/{BalanceEstimateNumber}/child/trueupEstimates
Update a subscription balance true-up estimate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerEstimates/{BalanceEstimateNumber}/child/trueupEstimates/{TrueupEstimateNumber}

Subscription Entitlement Assignments

The subscription entitlement assignments resource is used to view, create, update, and delete an entitlement assignment.

Activate entitlement assignment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/action/activate
Create an entitlement assignment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments
Deactivate entitlement assignment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/action/deActivate
Delete an entitlement assignment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}
Get all entitlement assignments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments
Get an entitlement assignment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}
Update an entitlement assignment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}

Subscription Entitlement Assignments/Subscription Balance Consumption Criteria

Create a balance consumption criterion: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria
Delete a balance consumption criterion: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}
Get a balance consumption criterion: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}
Get all balance consumption criteria: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria
Update a balance consumption criterion: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}

Subscription Entitlement Assignments/Subscription Balance Consumption Criteria/Subscription Balance Consumption Predicates

The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

Create a balance consumption predicate: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates
Delete a balance consumption predicate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}
Get a balance consumption predicate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}
Get all balance consumption predicates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates
Update a balance consumption predicate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}/child/subscriptionBalancePredicates/{BalancePredicateNumber}

Subscription Entitlement Plans

The subscription entitlement plans resource is used to view, create, update, and delete an entitlement plan.

Activate entitlement plan: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/action/activate
Create an entitlement plan: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans
Deactivate entitlement plan: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/action/deActivate
Delete an entitlement plan: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}
Get all entitlement plans: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans
Get an entitlement plan: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}
Update an entitlement plan: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}

Subscription Entitlement Plans/Subscription Entitlement Plan Commitments

The commitments resource is used to create a entitlement plan based on commitments. These records can be created only for those balance codes which have the commitment flag enabled.

Create an entitlement plan commitment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/commitments
Delete an entitlement plan commitment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/commitments/{EntitlementPlanCommitmentNumber}
Get all entitlement plan commitments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/commitments
Get an entitlement plan commitment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/commitments/{EntitlementPlanCommitmentNumber}
Update an entitlement plan commitment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/commitments/{EntitlementPlanCommitmentNumber}

Subscription Entitlement Plans/Subscription Entitlement Plan Details

The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.

Create an entitlement plan detail: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/subscriptionEntitlementPlanDetails
Delete an entitlement plan detail: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/subscriptionEntitlementPlanDetails/{EntitlementPlanDetailNumber}
Get a subscription entitlement plan detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/subscriptionEntitlementPlanDetails/{EntitlementPlanDetailNumber}
Get all entitlement plan details: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/subscriptionEntitlementPlanDetails
Update an entitlement plan detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/subscriptionEntitlementPlanDetails/{EntitlementPlanDetailNumber}

Subscription Entitlement Plans/Subscription Entitlement Plan Estimates

The estimates resource is used to create a entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled.

Create an entitlement plan estimate: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/estimates
Delete an entitlement plan estimate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/estimates/{EntitlementPlanEstimateNumber}
Get all entitlement plan estimates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/estimates
Get an entitlement plan estimate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/estimates/{EntitlementPlanEstimateNumber}
Update an entitlement plan estimate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/estimates/{EntitlementPlanEstimateNumber}

Subscription Metrics

The subscription metrics resource is used to view the subscription metrics such as monthly recurring revenue or number of subscriptions for a customer.

Get a subscription metric: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionMetrics/{subscriptionMetricsUniqID}
Get all subscription metrics: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionMetrics

Subscription Order Transactions

The subscription order transactions resource is used to view the transactions in the order management interface table.

Get a subscription order transaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionOrderTransactions/{TransactionNumber}
Get all subscription order transactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionOrderTransactions

Subscription Products

The subscription products resource is used to view, create, update, and delete subscription product details, such as start and end dates, items, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.

Cancel a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/cancel
Close a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/close
Create a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts
Delete a subscription product: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Get a subscription product: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Get all subscription products: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts
Hold a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/putOnHold
Remove hold on a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/removeHold
Resume a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/resume
Suspend a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/suspend
Undo close of a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/action/undoClose
Update a subscription product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}

Subscription Products/Associated Assets

The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.

Create an associated asset of a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/associatedAsset
Delete an associated asset of a subscription product: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/associatedAsset/{AssociatedAssetPuid}
Get all associated assets of a subscription product: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/associatedAsset
Get an associated asset of a subscription product: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/associatedAsset/{AssociatedAssetPuid}
Update an associated asset of a subscription product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/associatedAsset/{AssociatedAssetPuid}

Subscription Products/Bill Lines

The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.

Create a bill line: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines
Delete a bill line: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}
Get a bill line: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}
Get all bill lines: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines
Update a bill line: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}

Subscription Products/Bill Lines/Bill Adjustments

The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.

Create a bill adjustment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Delete a bill adjustment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Get a bill adjustment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Get all bill adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Update a bill adjustment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}

Subscription Products/Charges

The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.

Create a charge: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges
Delete a charge: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}
Get a charge: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}
Get all charges: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges
Update a charge: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}

Subscription Products/Charges/Adjustments

The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.

Create an adjustment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments
Delete an adjustment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Get all adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments
Get an adjustment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Update an adjustment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}

Subscription Products/Charges/Charge Milestone Events

The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.

Create a charge milestone event: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents
Delete a charge milestone event: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents/{MilestonePuid}
Get a charge milestone event: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents/{MilestonePuid}
Get all charge milestone events: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents
Update a charge milestone event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents/{MilestonePuid}

Subscription Products/Charges/Charge Tiers

The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.

Create a charge tier: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers
Delete a charge tier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Get a charge tier: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Get all charge tiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers
Update a charge tier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}

Subscription Products/Covered Levels

The covered levels resource is used to create, view, update, or delete the subscription covered levels details, such as subscription ID, subscription product ID, covered asset and its associated details.

Create a covered level: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels
Delete a covered level: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}
Get a covered level: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}
Get all covered levels: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels
Update a covered level: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}

Subscription Products/Covered Levels/Bill Lines

Create a bill line: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines
Delete a bill line: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}
Get a bill line: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}
Get all bill lines: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines
Update a bill line: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}

Subscription Products/Covered Levels/Bill Lines/Bill Adjustments

Create a bill adjustment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Delete a bill adjustment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid2}/child/billAdjustments/{BillAdjustmentPuid}
Get a bill adjustment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid2}/child/billAdjustments/{BillAdjustmentPuid}
Get all bill adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Update a bill adjustment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid2}/child/billAdjustments/{BillAdjustmentPuid}

Subscription Products/Covered Levels/Charges

The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.

Create a charge: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges
Delete a charge: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}
Get a charge: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}
Get all charges: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges
Update a charge: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}

Subscription Products/Covered Levels/Charges/Adjustments

Create an adjustment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments
Delete an adjustment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/adjustments/{ChargeAdjustmentPuid}
Get all adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments
Get an adjustment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/adjustments/{ChargeAdjustmentPuid}
Update an adjustment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/adjustments/{ChargeAdjustmentPuid}

Subscription Products/Covered Levels/Charges/Charge Milestone Events

The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.

Create a charge milestone event: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents
Delete a charge milestone event: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeMilestoneEvents/{MilestonePuid}
Get a charge milestone event: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeMilestoneEvents/{MilestonePuid}
Get all charge milestone events: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents
Update a charge milestone event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeMilestoneEvents/{MilestonePuid}

Subscription Products/Covered Levels/Charges/Charge Tiers

The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.

Create a charge tier: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers
Delete a charge tier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeTiers/{ChargeTierPuid}
Get a charge tier: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeTiers/{ChargeTierPuid}
Get all charge tiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers
Update a charge tier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeTiers/{ChargeTierPuid}

Subscription Products/Covered Levels/Relationships

The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships/{OperationLinksPuid}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships/{OperationLinksPuid}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships/{OperationLinksPuid}

Subscription Products/Credit Cards

The credit cards resource is used to view, create, and update the credit cards associated with a subscription.

Create a credit card: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards
Get a credit card: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards/{CreditCardPuid}
Get all credit cards: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards
Update a credit card: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards/{CreditCardPuid}

Subscription Products/Descriptive Flexfields

The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.

Create a descriptive flexfield: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/flexFields
Get a descriptive flexfield: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/flexFields/{SubscriptionProductId}
Get all descriptive flexfields: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/flexFields
Update a descriptive flexfield: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/flexFields/{SubscriptionProductId}

Subscription Products/Large Object (LOB) Attributes - RatePlanDocument

Delete a RatePlanDocument: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/enclosure/RatePlanDocument
Get a RatePlanDocument: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/enclosure/RatePlanDocument
Replace a RatePlanDocument: Method: put
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/enclosure/RatePlanDocument

Subscription Products/Relationships

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationships
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationships/{OperationLinksPuid}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationships/{OperationLinksPuid}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationships
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationships/{OperationLinksPuid}

Subscription Products/Sales Credits

The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.

Create a sales credit: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits
Delete a sales credit: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}
Get a sales credit: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}
Get all sales credits: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits
Update a sales credit: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}

Subscription Products/Service Resources

The service resources resouce is used to view, create, update, and delete the service identifier for a subscription product.

Create a service resource: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/serviceResources
Delete a service resource: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/serviceResources/{ServiceResourcePuid}
Get a service resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/serviceResources/{ServiceResourcePuid}
Get all service resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/serviceResources
Update a service resource: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/serviceResources/{ServiceResourcePuid}

Subscription Products/Subscription Entitlement Plan Commitments

The subscription entitlement plan commitments resource is used to create a negotiated entitlement plan based on commitments. These records can be created only for those balance codes which have the commitments flag enabled.

Create an entitlement plan commitment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanCommitments
Delete an entitlement plan commitment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanCommitments/{EntitlementPlanCommitmentNumber}
Get all entitlement plan commitments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanCommitments
Get an entitlement plan commtiment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanCommitments/{EntitlementPlanCommitmentNumber}
Update an entitlement plan commitment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanCommitments/{EntitlementPlanCommitmentNumber}

Subscription Products/Subscription Entitlement Plan Details

The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.

Create an entitlement plan detail: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanDetails
Delete an entitlement plan detail: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanDetails/{EntitlementPlanDetailNumber}
Get all entitlement plan details: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanDetails
Get an entitlement plan detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanDetails/{EntitlementPlanDetailNumber}
Update an entitlement plan detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanDetails/{EntitlementPlanDetailNumber}

Subscription Products/Subscription Entitlement Plan Estimates

The subscription entitlement plan estimates resource is used to create a negotiated entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled.

Create an entitlement plan estimate: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanEstimates
Delete an entitlement plan estimate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanEstimates/{EntitlementPlanEstimateNumber}
Get all entitlement plan estimates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanEstimates
Get an entitlement plan estimate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanEstimates/{EntitlementPlanEstimateNumber}
Update an entitlement plan estimate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanEstimates/{EntitlementPlanEstimateNumber}

Subscription Usage Event Batches

The usage event batches resource is used to view, create, update, and delete an usage event batch.

Create an usage event batch: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches
Delete an usage event batch: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}
Get all usage event batches: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches
Get an usage event batch: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}
Update an usage event batch: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}

Subscription Usage Event Batches/Subscription Usage Events

The usage events resource is used to view, create, update, and delete an usage event. It provides details of subscription usage event information.

Create an usage event: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents
Delete an usage event: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}
Get all usage events: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents
Get an usage event: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}
Update an usage event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}

Subscription Usage Event Batches/Subscription Usage Events/Subscription Usage Event Charges

The usage event charges resource is used to view, create, update, and delete an usage event charge. It provides details of the usage event charges associated with a subscription product.

Create an usage event charge: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}/child/usageCharges
Delete an usage event charge: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}/child/usageCharges/{UsageChargePuid}
Get all usage event charges: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}/child/usageCharges
Get an usage event charge: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}/child/usageCharges/{UsageChargePuid}
Update an usage event charge: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}/child/usageCharges/{UsageChargePuid}

Subscription Usage Event Batches/Subscription Usage Events/Subscription Usage Event Messages

The usage event messages resource is used to view, create, update, and delete an usage event message.

Get all usage event messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}/child/usageMessages
Get an usage event message: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches/{BatchNumber}/child/usageEvents/{EventNumber}/child/usageMessages/{UsageMessageId}

Subscription Usage Event Types

The subscription usage event types resource is used to view, create, update, and delete an event type.

Activate an event type: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/action/activate
Create an event type: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes
Deactivate an event type: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/action/deActivate
Delete an event type: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}
Get all event types: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes
Get an event type: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}
Update an event type: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}

Subscription Usage Event Types/Subscription Usage Event Type Attributes

The event type attributes resource is used to view, create, update, and delete an event type attribute.

Create an event type attribute: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeAttributes
Delete an event type attribute: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeAttributes/{EventTypeAttributeId}
Get all event type attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeAttributes
Get an event type attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeAttributes/{EventTypeAttributeId}
Update an event type attribute: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeAttributes/{EventTypeAttributeId}

Subscription Usage Event Types/Subscription Usage Event Type Charges

The event type charges resource is used to view, create, update, and delete an event type charge.

Create an event type charge: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeCharges
Delete an event type charge: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeCharges/{EventTypeChargeId}
Get all event type charges: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeCharges
Get an event type charge: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeCharges/{EventTypeChargeId}
Update an event type charge: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeCharges/{EventTypeChargeId}

Subscription Usage Events

The subscription usage events resource is used to view, create, update, and delete the subscription usage event details. The usage events object has details such as start and end time, type of event, charge identifier, usage quantity, rating status and final rated amount.

Create a usage event: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents
Delete a usage event: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}
Get a usage event: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}
Get all usage events: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents
Update a usage event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}

Subscription Usage Events/Subscription Usage Event Charges

The usage event charges resource is used to view, create, update, and delete an usage event charge. It provides details of the usage event charges associated with a subscription product.

Create an usage event charge: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageCharges
Delete an usage event charge: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageCharges/{UsageChargePuid}
Get all usage event charges: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageCharges
Get an usage event charge: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageCharges/{UsageChargePuid}
Update an usage event charge: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageCharges/{UsageChargePuid}

Subscription Usage Events/Subscription Usage Event Messages

The usage event messages resource is used to view, create, update, and delete an usage event message.

Get all usage event messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageMessages
Get an usage event message: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/usageMessages/{UsageMessageId}

Subscriptions

The subscriptions resource is used to view, create, update, and delete subscriptions. A subscription includes information such as start and end dates, customer, subscription profile, and total contract value.

Activate a subscription: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/activate
Calculate credit amount: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/calculateCreditAmount
Calculate early termination fee: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/calculateEarlyTerminationFee
Cancel a subscription: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/cancel
Close a subscription: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/close
Create a subscription: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions
Delete a subscription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}
Get a subscription: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}
Get all subscriptions: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions
Hold a subscription: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/putOnHold
Preview a subscription: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/previewSubscriptions
Raise user transition: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/raiseUserTransition
Remove hold on a subscription: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/removeHold
Renew a subscription: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/renew
Update a subscription: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}

Subscriptions/Contract Attachments

The contract attachments resource is used to view, create, and update attachments.

Create a contract attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/contractAttachment
Delete a contract attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/contractAttachment/{contractAttachmentUniqID}
Get a contract attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/contractAttachment/{contractAttachmentUniqID}
Get all contract attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/contractAttachment
Update a contract attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/contractAttachment/{contractAttachmentUniqID}

Subscriptions/Contract Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/contractAttachment/{contractAttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/contractAttachment/{contractAttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/contractAttachment/{contractAttachmentUniqID}/enclosure/FileContents

Subscriptions/Contract Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/contractAttachment/{contractAttachmentUniqID}/enclosure/FileWebImage

Subscriptions/Credit Cards

The credit cards resource is used to view, create, and update the credit card information associated with a subscription.

Create a credit card: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/creditCards
Get a credit card: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/creditCards/{CreditCardPuid}
Get all credit cards: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/creditCards
Update a credit card: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/creditCards/{CreditCardPuid}

Subscriptions/Descriptive Flexfields

The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.

Create a descriptive flexfield: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/flexFields
Get a descriptive flexfield: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/flexFields/{SubscriptionId}
Get all descriptive flexfields: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/flexFields
Update a descriptive flexfield: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/flexFields/{SubscriptionId}

Subscriptions/Parties

The parties resource to view, create, update, and delete the subscription parties.

Create subscription parties: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties
Delete a subscription party: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}
Get a subscription party: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}
Get all subscription parties: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties
Update a subscription party: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}

Subscriptions/Parties/Contacts

The contacts resource to view, create, update, and delete the contacts in a subscription party.

Create subscription contacts: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/contacts
Delete a subscription contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/contacts/{ContactPuid}
Get a subscription contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/contacts/{ContactPuid}
Get all subscription contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/contacts
Update a subscription contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/contacts/{ContactPuid}

Subscriptions/Products

The products resource is used to view, create, update, and delete the product details for a subscription, such as start and end dates, item, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.

Cancel a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/cancel
Close a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/close
Create a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products
Delete a subscription product: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Get a subscription product: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Get all subscription products: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products
Hold a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/putOnHold
Remove hold on a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/removeHold
Resume a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/resume
Suspend a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/suspend
Undo close of a subscription product: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/undoClose
Update a subscription product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}

Subscriptions/Products/Associated Assets

The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.

Create an associated asset: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/associatedAsset
Delete an associated asset: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/associatedAsset/{AssociatedAssetPuid}
Get all associated assets: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/associatedAsset
Get an associated asset: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/associatedAsset/{AssociatedAssetPuid}
Update an associated asset: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/associatedAsset/{AssociatedAssetPuid}

Subscriptions/Products/Bill Lines

The bill lines resource is used to view, create, update, and delete the subscription bill line details.

Create subscription bill lines: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines
Delete a subscription bill line: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}
Get a subscription bill line: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}
Get all subscription bill lines: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines
Update a subscription bill line: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}

Subscriptions/Products/Bill Lines/Bill Adjustments

The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.

Create subscription bill adjustments: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Delete a subscription bill adjustment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Get a subscription bill adjustment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Get all subscription bill adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Update a subscription bill adjustment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}

Subscriptions/Products/Charges

The charges resource is used to view, create, update, and delete the charges for a subscription.

Create subscription charges: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges
Delete a subscription charge: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}
Get a subscription charge: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}
Get all subscription charges: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges
Update a subscription charge: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}

Subscriptions/Products/Charges/Adjustments

The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.

Create subscription adjustments: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments
Delete a subscription adjustment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Get a subscription adjustment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Get all subscription adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments
Update a subscription adjustment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}

Subscriptions/Products/Charges/Charge Milestone Events

The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.

Create a charge milestone event: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents
Delete a charge milestone event: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents/{MilestonePuid}
Get a charge milestone event: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents/{MilestonePuid}
Get all charge milestone events: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents
Update a charge milestone event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents/{MilestonePuid}

Subscriptions/Products/Charges/Charge Tiers

The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.

Create subscription charge tiers: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers
Delete a subscription charge tier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Get a subscription charge tier: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Get all subscription charge tiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers
Update a subscription charge tier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}

Subscriptions/Products/Covered Levels

The covered levels resource is used to view, create, update, and delete the subscription covered levels.

Create a covered level: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels
Delete a covered level: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}
Get a covered level: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}
Get all covered levels: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels
Update a covered level: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}

Subscriptions/Products/Covered Levels/Bill Lines

The bill lines resource is used to view, create, update, and delete the subscription bill line details.

Create subscription bill lines: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines
Delete a subscription bill line: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}
Get a subscription bill line: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}
Get all subscription bill lines: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines
Update a subscription bill line: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}

Subscriptions/Products/Covered Levels/Bill Lines/Bill Adjustments

The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.

Create subscription bill adjustments: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Delete a subscription bill adjustment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid2}/child/billAdjustments/{BillAdjustmentPuid}
Get a subscription bill adjustment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid2}/child/billAdjustments/{BillAdjustmentPuid}
Get all subscription bill adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Update a subscription bill adjustment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid2}/child/billAdjustments/{BillAdjustmentPuid}

Subscriptions/Products/Covered Levels/Charges

The charges resource is used to view, create, update, and delete the charges for a subscription.

Create subscription charges: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges
Delete a subscription charge: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}
Get a subscription charge: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}
Get all subscription charges: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges
Update a subscription charge: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}

Subscriptions/Products/Covered Levels/Charges/Adjustments

The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.

Create subscription adjustments: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments
Delete a subscription adjustment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/adjustments/{ChargeAdjustmentPuid}
Get a subscription adjustment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/adjustments/{ChargeAdjustmentPuid}
Get all subscription adjustments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments
Update a subscription adjustment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/adjustments/{ChargeAdjustmentPuid}

Subscriptions/Products/Covered Levels/Charges/Charge Milestone Events

The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.

Create a charge milestone event: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents
Delete a charge milestone event: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeMilestoneEvents/{MilestonePuid}
Get a charge milestone event: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeMilestoneEvents/{MilestonePuid}
Get all charge milestone events: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeMilestoneEvents
Update a charge milestone event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeMilestoneEvents/{MilestonePuid}

Subscriptions/Products/Covered Levels/Charges/Charge Tiers

The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.

Create subscription charge tiers: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers
Delete a subscription charge tier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeTiers/{ChargeTierPuid}
Get a subscription charge tier: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeTiers/{ChargeTierPuid}
Get all subscription charge tiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers
Update a subscription charge tier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid2}/child/chargeTiers/{ChargeTierPuid}

Subscriptions/Products/Covered Levels/Child Covered Levels

The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.

Create a child covered level: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels
Delete a child covered level: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}
Get a child covered level: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}
Get all child covered levels: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels
Update a child covered level: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}

Subscriptions/Products/Covered Levels/Relationships

The relationships resource is used to view, create, update, and delete the subscription product relationships.

Create a subscription relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships
Delete a subscription relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships/{OperationLinksPuid}
Get a subscription relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships/{OperationLinksPuid}
Get all subscription relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships
Update a subscription relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships/{OperationLinksPuid}

Subscriptions/Products/Credit Cards

The credit cards resource is used to view, create, and update the credit card information associated with a subscription.

Create a credit card: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/creditCards
Get a credit card: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/creditCards/{CreditCardPuid}
Get all credit cards: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/creditCards
Update a credit card: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/creditCards/{CreditCardPuid}

Subscriptions/Products/Descriptive Flexfields

The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.

Create a descriptive flexfield: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/flexFields
Get a descriptive flexfield: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/flexFields/{SubscriptionProductId}
Get all descriptive flexfields: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/flexFields
Update a descriptive flexfield: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/flexFields/{SubscriptionProductId}

Subscriptions/Products/Large Object (LOB) Attributes - RatePlanDocument

Delete a RatePlanDocument: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/enclosure/RatePlanDocument
Get a RatePlanDocument: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/enclosure/RatePlanDocument
Replace a RatePlanDocument: Method: put
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/enclosure/RatePlanDocument

Subscriptions/Products/Relationships

The relationships resource is used to view, create, update, and delete the subscription product relationships.

Create a subscription relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/relationships
Delete a subscription relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/relationships/{OperationLinksPuid}
Get a subscription relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/relationships/{OperationLinksPuid}
Get all subscription relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/relationships
Update a subscription relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/relationships/{OperationLinksPuid}

Subscriptions/Products/Sales Credits

The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.

Create a sales credit: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/salesCredits
Delete a sales credit: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}
Get a sales credit: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}
Get all sales credits: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/salesCredits
Update a sales credit: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}

Subscriptions/Products/Service Resources

The service resources resource is used to view, create, update, and delete the service identifier for a subscription product.

Create a service resource: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/serviceResources
Delete a service resource: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/serviceResources/{ServiceResourcePuid}
Get a service resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/serviceResources/{ServiceResourcePuid}
Get all service resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/serviceResources
Update a service resource: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/serviceResources/{ServiceResourcePuid}

Subscriptions/Products/Subscription Entitlement Plan Commitments

Create an entitlement plan commitment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanCommitments
Delete an entitlement plan commitment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanCommitments/{EntitlementPlanCommitmentNumber}
Get all entitlement plan commitments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanCommitments
Get an entitlement plan commitment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanCommitments/{EntitlementPlanCommitmentNumber}
Update an entitlement plan commitment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanCommitments/{EntitlementPlanCommitmentNumber}

Subscriptions/Products/Subscription Entitlement Plan Details

The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.

Create an entitlement plan detail: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanDetails
Delete an entitlement plan detail: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanDetails/{EntitlementPlanDetailNumber}
Get all entitlement plan details: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanDetails
Get an entitlement plan detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanDetails/{EntitlementPlanDetailNumber}
Update an entitlement plan detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanDetails/{EntitlementPlanDetailNumber}

Subscriptions/Products/Subscription Entitlement Plan Estimates

Create an entitlement plan estimate: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanEstimates
Delete an entitlement plan estimate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanEstimates/{EntitlementPlanEstimateNumber}
Get all entitlement plan estimates: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanEstimates
Get an entitlement plan estimate: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanEstimates/{EntitlementPlanEstimateNumber}
Update an entitlement plan estimate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/negotiatedEntitlementPlanEstimates/{EntitlementPlanEstimateNumber}

Subscriptions/Sales Credits

The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.

Create a sales credit: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/salesCredits
Delete a sales credit: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/salesCredits/{SalesCreditPuid}
Get a sales credit: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/salesCredits/{SalesCreditPuid}
Get all sales credits: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/salesCredits
Update a sales credit: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/salesCredits/{SalesCreditPuid}

Subscriptions/Supporting Document Attachments

The supporting document attachments resource is used to view, create, and update supporting document attachments.

Create a supporting document attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/supportingDocumentAttachments
Delete a supporting document attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/supportingDocumentAttachments/{supportingDocumentAttachmentsUniqID}
Get a supporting document attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/supportingDocumentAttachments/{supportingDocumentAttachmentsUniqID}
Get all supporting document attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/supportingDocumentAttachments
Update a supporting document attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/supportingDocumentAttachments/{supportingDocumentAttachmentsUniqID}

Subscriptions/Supporting Document Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/supportingDocumentAttachments/{supportingDocumentAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/supportingDocumentAttachments/{supportingDocumentAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/supportingDocumentAttachments/{supportingDocumentAttachmentsUniqID}/enclosure/FileContents

Subscriptions/Supporting Document Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/supportingDocumentAttachments/{supportingDocumentAttachmentsUniqID}/enclosure/FileWebImage

Subscriptions/Validate Subscriptions

The validate subscriptions resource to view, create, update, and delete the validation errors for a subscription.

Create a subscription validation: Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/validateSubscription
Delete a subscription validation: Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/validateSubscription/{validateSubscriptionUniqID}
Get a subscription validation: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/validateSubscription/{validateSubscriptionUniqID}
Get all subscription validations: Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/validateSubscription
Update a subscription validation: Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/validateSubscription/{validateSubscriptionUniqID}

Survey Configurations

The survey configuration resource is used to create, read, update and delete the configuration associated to the survey.

Create a survey configuration: Method: post
Path: /crmRestApi/resources/11.13.18.05/surveyConfigurations
Delete a survey configuration: Method: delete
Path: /crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}
Get a survey configuration: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}
Get all survey configurations: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveyConfigurations
Update a survey configuration: Method: patch
Path: /crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}

Survey Configurations/Survey Configuration Attributes

The survey configuration attribute resource is used to create, read, update and delete the attributes associated to the survey configuration.

Create a survey configuration attribute: Method: post
Path: /crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}/child/configurationAttributes
Delete a survey configuration attribute: Method: delete
Path: /crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}/child/configurationAttributes/{ConfigAttrId}
Get a survey configuration attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}/child/configurationAttributes/{ConfigAttrId}
Get all survey configuration attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}/child/configurationAttributes
Update a survey configuration attribute: Method: patch
Path: /crmRestApi/resources/11.13.18.05/surveyConfigurations/{ConfigId}/child/configurationAttributes/{ConfigAttrId}

Survey Requests

The request resource is used to view and update the survey requests.

Create a survey request: Method: post
Path: /crmRestApi/resources/11.13.18.05/surveyRequests
Get a survey request: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}
Get all survey requests: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveyRequests
Update a survey request: Method: patch
Path: /crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}

Survey Requests/Survey Responses

The response resource is used to view and update the survey responses.

Create a survey response: Method: post
Path: /crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}/child/responses
Get a survey response: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}/child/responses/{SurveyResponseId}
Get all survey responses: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}/child/responses
Update a survey response: Method: patch
Path: /crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}/child/responses/{SurveyResponseId}

Survey Requests/Survey Responses/Large Object (LOB) Attributes - Text

Delete a Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}/child/responses/{SurveyResponseId}/enclosure/Text
Get a Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}/child/responses/{SurveyResponseId}/enclosure/Text
Replace a Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/surveyRequests/{SurveyRequestId}/child/responses/{SurveyResponseId}/enclosure/Text

Surveys

The surveys resource is used to view and update the surveys.

Create a survey: Method: post
Path: /crmRestApi/resources/11.13.18.05/surveys
Delete a survey: Method: delete
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}
Get a survey: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}
Get all surveys: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveys
Update a survey: Method: patch
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}

Surveys/Survey Questions

The questions resource is used to view and update the questions in the survey.

Create a survey question: Method: post
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions
Delete a survey question: Method: delete
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions/{QuestionId}
Get a survey question: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions/{QuestionId}
Get all survey questions: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions
Update a survey question: Method: patch
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions/{QuestionId}

Surveys/Survey Questions/Survey Answer Choices

The answer choices resource is used to view and update the answer choices in the survey.

Create a survey answer choice: Method: post
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions/{QuestionId}/child/answerChoices
Delete a survey answer choice: Method: delete
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions/{QuestionId}/child/answerChoices/{AnswerId}
Get a survey answer choice: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions/{QuestionId}/child/answerChoices/{AnswerId}
Get all survey answer choices: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions/{QuestionId}/child/answerChoices
Update a survey answer choice: Method: patch
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/questions/{QuestionId}/child/answerChoices/{AnswerId}

Surveys/Survey Requests

The request resource is used to view and update the survey requests.

Create a survey request: Method: post
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests
Get a survey request: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests/{SurveyRequestId}
Get all survey requests: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests
Update a survey request: Method: patch
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests/{SurveyRequestId}

Surveys/Survey Requests/Survey Responses

The response resource is used to view and update the survey responses.

Create a survey response: Method: post
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests/{SurveyRequestId}/child/responses
Get a survey response: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests/{SurveyRequestId}/child/responses/{SurveyResponseId}
Get all survey responses: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests/{SurveyRequestId}/child/responses
Update a survey response: Method: patch
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests/{SurveyRequestId}/child/responses/{SurveyResponseId}

Surveys/Survey Requests/Survey Responses/Large Object (LOB) Attributes - Text

Delete a Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests/{SurveyRequestId}/child/responses/{SurveyResponseId}/enclosure/Text
Get a Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests/{SurveyRequestId}/child/responses/{SurveyResponseId}/enclosure/Text
Replace a Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/surveys/{SurveyId}/child/requests/{SurveyRequestId}/child/responses/{SurveyResponseId}/enclosure/Text

Tags/Tags 11.13.18.05

The tags resource is used to create, view, and delete keywords or terms assigned to a business object such as service request. Tags help in describing and classifying a busines object.

Create a tag: Method: post
Path: /crmRestApi/resources/11.13.18.05/tags
Delete a tag: Method: delete
Path: /crmRestApi/resources/11.13.18.05/tags/{TagId}
Get a tag: Method: get
Path: /crmRestApi/resources/11.13.18.05/tags/{TagId}
Get all tags: Method: get
Path: /crmRestApi/resources/11.13.18.05/tags
Update a tag: Method: patch
Path: /crmRestApi/resources/11.13.18.05/tags/{TagId}

Tags/Tags v1

The operations from the Tags/Tags v1 category.

Advanced query a tag instance: Method: post
Path: /api/boss/data/objects/ora/cxServiceCore/common/v1/tags/{tags_id}/$query
Advanced query all tag instances: Method: post
Path: /api/boss/data/objects/ora/cxServiceCore/common/v1/tags/$query
Create a tag instance: Method: post
Path: /api/boss/data/objects/ora/cxServiceCore/common/v1/tags
Delete a tag instance: Method: delete
Path: /api/boss/data/objects/ora/cxServiceCore/common/v1/tags/{tags_id}
Get a tag instance: Method: get
Path: /api/boss/data/objects/ora/cxServiceCore/common/v1/tags/{tags_id}
Get all tag instances: Method: get
Path: /api/boss/data/objects/ora/cxServiceCore/common/v1/tags

Technician Preferences

Technician preferences captures information of the required or preferred technician at a customer site. It also records whether a technician is forbidden. These preferences can by identified and sent with the work order to Oracle Field Service and will be taken into consideration when assigning activities to technicians. These preferences can be identified for an account or a service profile.

Create a technician preference: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences
Delete a technician preference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences/{TechnicianPreferenceId}
Get a technician preference: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences/{TechnicianPreferenceId}
Get all technician preferences: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences
Update a technician preference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianPreferences/{TechnicianPreferenceId}

Technician Preferences View

The technician view preferences provides a view of technicians that are required, preferred, or forbidden for a given site. You can also view customer account provided with the site preferences shown as precedence.

Get a technician preference: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianViewPreferences/{TechnicianPreferenceId}
Get all technician preferences: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianViewPreferences

Technician's Access Hours

The technician's access hours identifies the hours in which a technician can access a customer site.

Create a technician's access hour: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessHours
Delete a technician's access hour: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessHours/{SchedHoursId}
Get a technician's access hour: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessHours/{SchedHoursId}
Get all technicians' access hours: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessHours
Update a technician's access hour: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessHours/{SchedHoursId}

Technician's Access Hours Adjusted for Overrides

The technician's access hours adjusted for overrides identifies the hours in which a technician has access to a customer site which is adjusted for any overrides applied.

Get a technician's access hour adjusted for overrides: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianViewAccessHours/{SchedHoursId}
Get all hours of technician's access adjusted for overrides: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianViewAccessHours

Technician's Access Schedules

A technician's access schedule captures the days and time when a technician can access the customer site, and also days and time when access isn't available. You can set this at primary, country and region, account, and site levels. Access hours record the times when scheduling is available. You can also record the days when no work should be assigned. The access can be overridden when scheduling a work order in urgent situations. You can change working hours and nonworking days for a specific work order. For example, you can remove nonworking days or add different nonworking days. This ability to override is controlled by a privilege.

Create a technician's access schedule: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules
Delete a technician's access schedule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}
Get a technician's access schedule: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}
Get all technicians' access schedule: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules
Get the access schedule days payload: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/action/getAccessScheduleOffdaysPayload
Get the access schedule hours payload: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/action/getAccessScheduleHoursPayload
Get the access schedule payload: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/action/getAccessSchedulePayload
Update a technician's access schedule: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}

Technician's Access Schedules/Technician's Access Hours

The technician's access hours identifies the hours in which a technician can access a customer site.

Create a technician's access hour: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}/child/hours
Delete a technician's access hour: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}/child/hours/{SchedHoursId}
Get a technician's access hour: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}/child/hours/{SchedHoursId}
Get all technicians' access hours: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}/child/hours
Update a technician's access hour: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}/child/hours/{SchedHoursId}

Technician's Access Schedules/Technician's Access off Days

The technician's access off days identifies when a technician can't access a customer site.

Create a technician's access off day: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}/child/offdays
Delete a technician's access off day: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}/child/offdays/{SchedOffdaysId}
Get a technician's access off day: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}/child/offdays/{SchedOffdaysId}
Get all technicians' access off days: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}/child/offdays
Update a technician's access off day: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}/child/offdays/{SchedOffdaysId}

Technician's Access off Days

The technician's access off days identifies when a technician can't access a customer site.

Create a technician's access off day: Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessOffDays
Delete a technician's access off day: Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessOffDays/{SchedOffdaysId}
Get a technician's access off day: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessOffDays/{SchedOffdaysId}
Get all technicians' access off days: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessOffDays
Update a technician's access off day: Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianAccessOffDays/{SchedOffdaysId}

Technician's Access off Days Adjusted for Overrides

The technician's access off days identifies the time when a technician is unable to access a customer site which is adjusted for overrides.

Get a technician's access off day: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianViewAccessOffDays/{SchedOffdaysId}
Get all technicians' access off days: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceTechnicianViewAccessOffDays

Territories

The territories resource is used to get a list of ISO standard territories.

Get a territory: Method: get
Path: /fndTerritories/{TerritoryCode}
Get all territories: Method: get
Path: /fndTerritories

Territories for Sales

The sales territories resource is used to view, create, update, and delete the various versions of a sales territory. Each version record contains most of the key attributes of a territory. Most of the sales territory components are child object to a sales territory, for example, territory resource, territory coverage, and territory line of business.

Create a territory: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesTerritories
Delete a territory: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}
Get a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}
Get all territories: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesTerritories
Update a territory: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}

Territories for Sales/Territory Business

The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.

Create a territory line of business: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryLineOfBusiness
Delete a territory line of business: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryLineOfBusiness/{LobCode}
Get a territory line of business: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryLineOfBusiness/{LobCode}
Get all territory line of business: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryLineOfBusiness
Update a territory line of business: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryLineOfBusiness/{LobCode}

Territories for Sales/Territory Coverages

The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.

Create a territory coverage: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverage
Delete a territory coverage: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverage/{CoverageNumber}
Get a territory coverage: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverage/{CoverageNumber}
Get all territory coverages: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverage
Update a territory coverage: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverage/{CoverageNumber}

Territories for Sales/Territory Resources

The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.

Create a territory resource: Method: post
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryResource
Delete a territory resource: Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryResource/{TerritoryResourceUniqID}
Get a territory resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryResource/{TerritoryResourceUniqID}
Get all territory resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryResource
Update a territory resource: Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryResource/{TerritoryResourceUniqID}

Universal Work Objects

The universal work objects resource is used to view and update universal work objects. It tracks channel requests that need to be routed to an agent for assignment.

Cancel outstanding universal work object: Method: post
Path: /crmRestApi/resources/11.13.18.05/universalWorkObjects/action/cancelWork
Create an universal work object: Method: post
Path: /crmRestApi/resources/11.13.18.05/universalWorkObjects
Delete an universal work object: Method: delete
Path: /crmRestApi/resources/11.13.18.05/universalWorkObjects/{WorkId}
Get all universal work objects: Method: get
Path: /crmRestApi/resources/11.13.18.05/universalWorkObjects
Get an universal work object: Method: get
Path: /crmRestApi/resources/11.13.18.05/universalWorkObjects/{WorkId}
Initiate update of a universal work object: Method: post
Path: /crmRestApi/resources/11.13.18.05/universalWorkObjects/action/updateWork
Submit an enriched universal work object: Method: post
Path: /crmRestApi/resources/11.13.18.05/universalWorkObjects/action/submitWork
Update an universal work object: Method: patch
Path: /crmRestApi/resources/11.13.18.05/universalWorkObjects/{WorkId}

Universal Work Objects/Large Object (LOB) Attributes - PreferredResources

Delete a PreferredResources: Method: delete
Path: /crmRestApi/resources/11.13.18.05/universalWorkObjects/{WorkId}/enclosure/PreferredResources
Get a PreferredResources: Method: get
Path: /crmRestApi/resources/11.13.18.05/universalWorkObjects/{WorkId}/enclosure/PreferredResources
Replace a PreferredResources: Method: put
Path: /crmRestApi/resources/11.13.18.05/universalWorkObjects/{WorkId}/enclosure/PreferredResources

User Context Data Sources

The user context data sources resource is used to view and update the user context data sources.

Get a context data source: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextDataSources/{DataSourceCode}
Get all context data sources: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextDataSources
Update a context data source: Method: patch
Path: /crmRestApi/resources/11.13.18.05/userContextDataSources/{DataSourceCode}

User Context Object Types

The user context object types resource is used to view and update an user context object type.

Create an object type: Method: post
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes
Get all object types: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes
Get an object type: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}
Update an object type: Method: patch
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}

User Context Object Types/Object Configurations

The object configurations resource is used to view and update an object configuration.

Create an object configuration: Method: post
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs
Get all object configurations: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs
Get an object configuration: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}
Update an object configuration: Method: patch
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}

User Context Object Types/Object Configurations/Object Configuration Details

The object configuration details resource is used to view and update the object configuration.

Create an object configuration details: Method: post
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}/child/objectConfigDetails
Get all object configuration details: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}/child/objectConfigDetails
Get an object configuration detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}/child/objectConfigDetails/{ObjectConfigDetailsId}
Update an object configuration detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}/child/objectConfigDetails/{ObjectConfigDetailsId}

User Context Object Types/Object Configurations/Object Configuration Details/Large Object (LOB) Attributes - SavedSearchJson

Delete a SavedSearchJson: Method: delete
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}/child/objectConfigDetails/{ObjectConfigDetailsId}/enclosure/SavedSearchJson
Get a SavedSearchJson: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}/child/objectConfigDetails/{ObjectConfigDetailsId}/enclosure/SavedSearchJson
Replace a SavedSearchJson: Method: put
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}/child/objectConfigDetails/{ObjectConfigDetailsId}/enclosure/SavedSearchJson

User Context Object Types/Object Criteria

The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches.

Create an object criterion: Method: post
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria
Get all object criteria: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria
Get an object criterion: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria/{SavedSearchUuid}
Update an object criterion: Method: patch
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria/{SavedSearchUuid}

User Context Object Types/Object Criteria/Large Object (LOB) Attributes - SavedSearchJson

Delete a SavedSearchJson: Method: delete
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria/{SavedSearchUuid}/enclosure/SavedSearchJson
Get a SavedSearchJson: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria/{SavedSearchUuid}/enclosure/SavedSearchJson
Replace a SavedSearchJson: Method: put
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria/{SavedSearchUuid}/enclosure/SavedSearchJson

User Context Object Types/Related Objects

The related objects resource is used to view and update a related object.

Create a related object mapping: Method: post
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/relatedObjects
Get a related object mapping: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/relatedObjects/{TargetObjectTypeCode}
Get all related object mappings: Method: get
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/relatedObjects
Update a related object mapping: Method: patch
Path: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/relatedObjects/{TargetObjectTypeCode}

User Favorites

The user favorites resource is used to view, create, and delete a favorite of the user. It stores the list of favorites for the users. A favorite can belong to any object, for example an object record, or saved search record.

Create a user favorite: Method: post
Path: /crmRestApi/resources/11.13.18.05/userFavorites
Delete a user favorite: Method: delete
Path: /crmRestApi/resources/11.13.18.05/userFavorites/{UserFavoriteId}
Get a user favorite: Method: get
Path: /crmRestApi/resources/11.13.18.05/userFavorites/{UserFavoriteId}
Get all user favorites: Method: get
Path: /crmRestApi/resources/11.13.18.05/userFavorites
Set favorite: Method: post
Path: /crmRestApi/resources/11.13.18.05/userFavorites/action/setFavorite

User Relevant Items

The user relevant items resource is used to view relevant items for the users. It supports user-context that tracks what is relevant to a user, and drives the navigation according to it.

Add to user context: Method: post
Path: /crmRestApi/resources/11.13.18.05/userRelevantItems/action/addToUserContext
Get all user relevant items: Method: get
Path: /crmRestApi/resources/11.13.18.05/userRelevantItems
Get an user relevant item: Method: get
Path: /crmRestApi/resources/11.13.18.05/userRelevantItems/{RelevantItemId}
Refresh all relevant items: Method: post
Path: /crmRestApi/resources/11.13.18.05/userRelevantItems/action/refreshUserContext

User Relevant Items/User Relevant Item Details

The user relevant item details resource is used to view details about the relevant item for the users.

Get all user relevant item details: Method: get
Path: /crmRestApi/resources/11.13.18.05/userRelevantItems/{RelevantItemId}/child/UserRelevantItemDetail
Get an user relevant item detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/userRelevantItems/{RelevantItemId}/child/UserRelevantItemDetail/{RelevantItemDetailId}

Validation Report Rules

The validation report resource is used to view the status of validation rules.

Add status for all setup tasks: Method: post
Path: /crmRestApi/resources/11.13.18.05/validationReport
Get a setup task status: Method: get
Path: /crmRestApi/resources/11.13.18.05/validationReport/{validationReportUniqID}
Get all setup tasks statuses: Method: get
Path: /crmRestApi/resources/11.13.18.05/validationReport
Populate validation report: Method: post
Path: /crmRestApi/resources/11.13.18.05/validationReport/action/populateValidationReport
Update status for all setup tasks: Method: patch
Path: /crmRestApi/resources/11.13.18.05/validationReport/{validationReportUniqID}

Vehicles

The vehicles resource lets you view, update, create and delete a vehicle.

Create a vehicle: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles
Delete a vehicle: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}
Get a vehicle: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}
Get all vehicles: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles
Update a vehicle: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}

Vehicles/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Attachments
Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/PictureAttachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Attachments/{AttachmentsUniqID}
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/PictureAttachment/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Attachments
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/PictureAttachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Attachments/{AttachmentsUniqID}
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/PictureAttachment/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/PictureAttachment/{AttachmentsUniqID}

Vehicles/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/PictureAttachment/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/PictureAttachment/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/PictureAttachment/{AttachmentsUniqID}/enclosure/FileContents

Vehicles/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage
Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/PictureAttachment/{AttachmentsUniqID}/enclosure/FileWebImage

Vehicles/Notes

The note objects resource is used to view the note objects.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Note/{NoteId}
Get a note object: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Note/{NoteId}
Get all note objects: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Note/{NoteId}

Vehicles/Notes/Large Object (LOB) Attributes - NoteTxt

Delete a NoteTxt: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a NoteTxt: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt: Method: put
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Vehicles/Vehicle Finances

The vehicle finances resource is used to view, create, update, or delete a vehicle finance.

Create a vehicle finance: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleFinances
Delete a vehicle finance: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleFinances/{AccountNumber}
Get a vehicle finance: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleFinances/{AccountNumber}
Get all vehicle finances: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleFinances
Update a vehicle finance: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleFinances/{AccountNumber}

Vehicles/Vehicle KPIs

The vehicle KPIs resource is used to view, create, update, or delete a vehicle KPI.

Create a vehicle KPI: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleIoTKpis
Delete a vehicle KPI: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleIoTKpis/{IotKPINumber}
Get a vehicle KPI: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleIoTKpis/{IotKPINumber}
Get all vehicle KPIs: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleIoTKpis
Update a vehicle KPI: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleIoTKpis/{IotKPINumber}

Vehicles/Vehicle Marketing Cards

The vehicle marketing cards resource is used to view, create, update, or delete a vehicle marketing card.

Create a vehicle marketing card: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleMarketingCards
Delete a vehicle marketing card: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleMarketingCards/{MarketingCardNumber}
Get a vehicle marketing card: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleMarketingCards/{MarketingCardNumber}
Get all vehicle marketing cards: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleMarketingCards
Update a vehicle marketing card: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleMarketingCards/{MarketingCardNumber}

Vehicles/Vehicle Options

The vehicle option resource is used to view, create, update, or delete a vehicle optional.

Create a vehicle option: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOptionals
Delete a vehicle option: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOptionals/{OptionalNumber}
Get a vehicle option: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOptionals/{OptionalNumber}
Get all vehicle options: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOptionals
Update a vehicle option: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOptionals/{OptionalNumber}

Vehicles/Vehicle Owners

The vehicle owners resource is used to view, create, update, or delete a vehicle ownership.

Create a vehicle owner: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOwnerships
Delete a vehicle owner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOwnerships/{OwnershipNumber}
Get a vehicle owner: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOwnerships/{OwnershipNumber}
Get all vehicle owners: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOwnerships
Update a vehicle owner: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOwnerships/{OwnershipNumber}

Vehicles/Vehicle Plates

The vehicle plates resource is used to view, create, update, or delete a vehicle plate.

Create a vehicle plate: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehiclePlates
Delete a vehicle plate: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehiclePlates/{VehiclePlateNumber}
Get a vehicle plate: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehiclePlates/{VehiclePlateNumber}
Get all vehicle plates: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehiclePlates
Update a vehicle plate: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehiclePlates/{VehiclePlateNumber}

Vehicles/Vehicle Sales

The vehicle sales resource is used to view, create, update, or delete a vehicle sale.

Create a vehicle sale: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleSales
Delete a vehicle sale: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleSales/{SaleNumber}
Get a vehicle sale: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleSales/{SaleNumber}
Get all vehicle sales: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleSales
Update a vehicle sale: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleSales/{SaleNumber}

Vehicles/Vehicle Service Entries

The vehicle service entries resource is used to view, create, update, or delete a vehicle service entry.

Create a vehicle service entry: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleServiceEntries
Delete a vehicle service entry: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleServiceEntries/{ServiceNumber}
Get a vehicle service entry: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleServiceEntries/{ServiceNumber}
Get all vehicle service entries: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleServiceEntries
Update a vehicle service entry: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleServiceEntries/{ServiceNumber}

Vehicles/Vehicle Service Warranties

The vehicle warranties resource is used to view, create, update, or delete a vehicle warranty.

Create a vehicle service warranty: Method: post
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleWarranties
Delete a vehicle service warranty: Method: delete
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleWarranties/{WarrantyNumber}
Get a vehicle service warranty: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleWarranties/{WarrantyNumber}
Get all vehicle service warranties: Method: get
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleWarranties
Update a vehicle service warranty: Method: patch
Path: /crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleWarranties/{WarrantyNumber}

Web Activities

The web activities resource is used to view the web activities. It is used to view the marketing activities such as email opens, clicks, form submissions, website visits etc.

Get a web activity: Method: get
Path: /crmRestApi/resources/11.13.18.05/webActivities/{WebActivityNumber}
Get all web activities: Method: get
Path: /crmRestApi/resources/11.13.18.05/webActivities

Web Activity Rules

The web activity rules resource is used to view, create, update, and delete the web activity rules.

Create a web activity rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/webActivityRules
Delete a web activity rule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}
Get a web activity rule: Method: get
Path: /crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}
Get all web activity rules: Method: get
Path: /crmRestApi/resources/11.13.18.05/webActivityRules
Update a web activity rule: Method: patch
Path: /crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}

Web Activity Rules/Web Activity Rule Conditions

The web activity rule conditions resource is used to view, create, update, and delete the web activity rule conditions.

Create a web activity rule condition: Method: post
Path: /crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}/child/WebActivityRuleCondition
Delete a web activity rule condition: Method: delete
Path: /crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}/child/WebActivityRuleCondition/{WebActyRuleCondId}
Get a web activity rule condition: Method: get
Path: /crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}/child/WebActivityRuleCondition/{WebActyRuleCondId}
Get all web activity rule conditions: Method: get
Path: /crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}/child/WebActivityRuleCondition
Update a web activity rule condition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}/child/WebActivityRuleCondition/{WebActyRuleCondId}

Web Activity Rules/Web Activity Rule Conditions/Large Object (LOB) Attributes - RuleConditionExpression

Delete a RuleConditionExpression: Method: delete
Path: /crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}/child/WebActivityRuleCondition/{WebActyRuleCondId}/enclosure/RuleConditionExpression
Get a RuleConditionExpression: Method: get
Path: /crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}/child/WebActivityRuleCondition/{WebActyRuleCondId}/enclosure/RuleConditionExpression
Replace a RuleConditionExpression: Method: put
Path: /crmRestApi/resources/11.13.18.05/webActivityRules/{WebActivityRuleNumber}/child/WebActivityRuleCondition/{WebActyRuleCondId}/enclosure/RuleConditionExpression

Work Order Area Configurations

A work order area configuration is defined in Service and is used to call Oracle Field Service REST services. It controls how the work order area information will be retrieved. During creation of a work order the configuration detailed here will be used to retrieve from Oracle Field Service the list of work order areas which are known as buckets in Oracle Field Service.

Create a work order area configuration: Method: post
Path: /crmRestApi/resources/11.13.18.05/woAreaConfigurations
Delete a work order area configuration: Method: delete
Path: /crmRestApi/resources/11.13.18.05/woAreaConfigurations/{ConfigNumber}
Get a work order area configuration: Method: get
Path: /crmRestApi/resources/11.13.18.05/woAreaConfigurations/{ConfigNumber}
Get all work order area configurations: Method: get
Path: /crmRestApi/resources/11.13.18.05/woAreaConfigurations
Update a work order area configuration: Method: patch
Path: /crmRestApi/resources/11.13.18.05/woAreaConfigurations/{ConfigNumber}

Work Orders

The work order resource is used to view, create, and update a work order. A work order is a transaction record, which is created when a customer needs to schedule a field service resource to perform work at the customer's location.

Create a work order: Method: post
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders
Delete a work order: Method: delete
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}
Get a work order: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}
Get access schedule payload: Method: post
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/action/getAccessSchedulePayload
Get all work orders: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders
Update a work order: Method: patch
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}

Work Orders/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/Attachment/{AttachmentUniqID}

Work Orders/Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Work Orders/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Work Orders/Links

Create a work order link: Method: post
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/WoLink
Delete a work order link: Method: delete
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/WoLink/{WoLinkId}
Get a work order link: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/WoLink/{WoLinkId}
Get all work order links: Method: get
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/WoLink
Update a work order link: Method: patch
Path: /crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/child/WoLink/{WoLinkId}

Work Skill Conditions Configuration Keys

A work skill condition key is defined in Service and is used to call Oracle Field Service REST services. It's used to identify all the required work order attributes that you need to pass to Oracle Field Service for their work skill conditions when retrieving work order area or scheduler information. During creation of a work order the configuration keys detailed here will be used to retrieve the work order area and scheduler information from Oracle Field Service.

Create a work skill configuration key: Method: post
Path: /crmRestApi/resources/11.13.18.05/workSkillConfigKeys
Delete a work skill configuration key: Method: delete
Path: /crmRestApi/resources/11.13.18.05/workSkillConfigKeys/{WoKeyId}
Get a work skill configuration key: Method: get
Path: /crmRestApi/resources/11.13.18.05/workSkillConfigKeys/{WoKeyId}
Get all work skill configuration keys: Method: get
Path: /crmRestApi/resources/11.13.18.05/workSkillConfigKeys
Update a work skill configuration key: Method: patch
Path: /crmRestApi/resources/11.13.18.05/workSkillConfigKeys/{WoKeyId}

Work Zone Configuration Keys

A work zone configuration key is defined in Service and used to call Oracle Field Service REST services. It's used to identify all the required work order attributes that you need to pass to Oracle Field Service for their work zone key when retrieving work order area or scheduler information. During creation of a work order the configuration keys detailed here will be used to retrieve the work order area and scheduler information from Oracle Field Service.

Create a work zone configuration key: Method: post
Path: /crmRestApi/resources/11.13.18.05/workZoneConfigKeys
Delete a work zone configuration key: Method: delete
Path: /crmRestApi/resources/11.13.18.05/workZoneConfigKeys/{WoKeyId}
Get a work zone configuration key: Method: get
Path: /crmRestApi/resources/11.13.18.05/workZoneConfigKeys/{WoKeyId}
Get all work zone configuration keys: Method: get
Path: /crmRestApi/resources/11.13.18.05/workZoneConfigKeys
Update a work zone configuration key: Method: patch
Path: /crmRestApi/resources/11.13.18.05/workZoneConfigKeys/{WoKeyId}

Wrap Ups

The wrap ups resource is used to view, create, and update the details of a media interaction. A wrap up is created at the end of an interaction, which is a child resource of the interaction. The object tracks outcome, reasons, notes, and other details related to the media interaction.

Create a wrap up: Method: post
Path: /crmRestApi/resources/11.13.18.05/wrapUps
Delete a wrap up: Method: delete
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}
Get a wrap up: Method: get
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}
Get all wrap ups: Method: get
Path: /crmRestApi/resources/11.13.18.05/wrapUps
Update a wrap up: Method: patch
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}

Wrap Ups/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/child/Attachments/{wrapUps_Attachments_Id}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/child/Attachments/{wrapUps_Attachments_Id}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/child/Attachments/{wrapUps_Attachments_Id}

Wrap Ups/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/child/Attachments/{wrapUps_Attachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/child/Attachments/{wrapUps_Attachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/child/Attachments/{wrapUps_Attachments_Id}/enclosure/FileContents

Wrap Ups/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/child/Attachments/{wrapUps_Attachments_Id}/enclosure/FileWebImage

Wrap Ups/Large Object (LOB) Attributes - CallNotes

Delete a CallNotes: Method: delete
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/enclosure/CallNotes
Get a CallNotes: Method: get
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/enclosure/CallNotes
Replace a CallNotes: Method: put
Path: /crmRestApi/resources/11.13.18.05/wrapUps/{SummaryId}/enclosure/CallNotes