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}
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 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/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.

Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}
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/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/{UserActionId}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}

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/{UserActionId}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

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/{UserActionId}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}

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 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 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
Retrieve attribute mappings for the given action plan or action: Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans/action/getActionMappings
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

Contains the dependencies of actions on other actions in an action plan.

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

Indicates the relation between the actions of 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
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}
Update an activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}

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

Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{UserActionId}
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/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/{UserActionId}/child/UserActionURLBinding
GET an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}

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/{UserActionId}/child/UserActionRequestPayload
GET an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

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/{UserActionId}/child/UserActionNavigation
GET an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}

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 template: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity
Delete an activity template: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}
Get all activity templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity
Get an activity template: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}
Update an activity template: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}

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/{UserActionId}
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/{UserActionId}
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/{UserActionId}

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/{UserActionId}/child/UserActionRequestPayload
Delete an action request payload definition: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}
Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}
Update an action request payload definition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

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/{UserActionId}/child/UserActionNavigation
Create an action REST path parameter: Method: post
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Delete an action navigation definition: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Delete an action path parameter: Method: delete
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{UserActionNavId}
Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{UserActionNavId}
Update an action navigation definition: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Update an action path parameter: Method: patch
Path: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{UserActionNavId}

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 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 object create count: Method: get
Path: /appInsightsObjectSma
Get the 7-day and 30-day SMA for click count: Method: get
Path: /appInsightsClicksSma
Get the 7-day and 30-day SMA for login count: Method: get
Path: /appInsightsLoginSma
Get the 7-day and 30-day SMA 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 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
Update 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
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}

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.

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

Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{UserActionId}
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/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/{UserActionId}/child/UserActionURLBinding
GET an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}

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/{UserActionId}/child/UserActionRequestPayload
GET an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

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/{UserActionId}/child/UserActionNavigation
GET an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}

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/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

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

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

Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{UserActionId}
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/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/{UserActionId}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}

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/{UserActionId}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

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/{UserActionId}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}

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
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/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, and update attachments.

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/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

Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{UserActionId}
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/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/{UserActionId}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}

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/{UserActionId}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

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/{UserActionId}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}

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 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 calculation simulations resource is used to view summary simulation results.

Get a calculation simulation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/{SimulationId}
Get all calculation simulations: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights

Compensation Estimation Insights/Estimation Summary by Plan Components

The calculation simulations resource is used to view simulation results by plan component.

Get a calculation simulation: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimationInsights/{SimulationId}/child/SummaryByPlanComponent/{SummaryByPlanComponentId}
Get all calculation simulations: 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

Competencies

The competencies resource is used to view, create, update, and delete a competency. Competencies are specific knowledge areas that an agent might use to solve problems at work.

Create a competency: Method: post
Path: /crmRestApi/resources/11.13.18.05/competencies
Delete a competency: Method: delete
Path: /crmRestApi/resources/11.13.18.05/competencies/{CompetencyId}
Get a competency: Method: get
Path: /crmRestApi/resources/11.13.18.05/competencies/{CompetencyId}
Get all competencies: Method: get
Path: /crmRestApi/resources/11.13.18.05/competencies
Reorder competencies: Method: post
Path: /crmRestApi/resources/11.13.18.05/competencies/action/reorderCompetencies
Update a competency: Method: patch
Path: /crmRestApi/resources/11.13.18.05/competencies/{CompetencyId}

Competency Templates

The Competency Template resource is used to view, create, update, and delete competency templates. A template has a list of items, each representing one of the competencies defined in the system, and a priority and relaxation behavior for that competency. You can associate competency template with to one or more routing queues.

Create a competency template: Method: post
Path: /crmRestApi/resources/11.13.18.05/competencyTemplates
Delete a competency template: Method: delete
Path: /crmRestApi/resources/11.13.18.05/competencyTemplates/{TemplateId}
Get a competency template: Method: get
Path: /crmRestApi/resources/11.13.18.05/competencyTemplates/{TemplateId}
Get all competency templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/competencyTemplates
Reorder competency template items: Method: post
Path: /crmRestApi/resources/11.13.18.05/competencyTemplates/action/reorderTemplateCompetencies
Update a competency template: Method: patch
Path: /crmRestApi/resources/11.13.18.05/competencyTemplates/{TemplateId}

Competency Templates/Competency Template Items

The Template Competency resource is used to view, create, update and delete competency template items. A template competency item associates a new priority and relaxation behavior to one of the competencies defined in the system. This way a competency template specifies a different order of evaluation and relaxation behavior than the defaults.

Add a competency template item: Method: post
Path: /crmRestApi/resources/11.13.18.05/competencyTemplates/{TemplateId}/child/TemplateCompetency
Delete a competency template item: Method: delete
Path: /crmRestApi/resources/11.13.18.05/competencyTemplates/{TemplateId}/child/TemplateCompetency/{TemplateCompetencyId}
Get a competency template item: Method: get
Path: /crmRestApi/resources/11.13.18.05/competencyTemplates/{TemplateId}/child/TemplateCompetency/{TemplateCompetencyId}
Get all competency template items: Method: get
Path: /crmRestApi/resources/11.13.18.05/competencyTemplates/{TemplateId}/child/TemplateCompetency
Update a competency template item: Method: patch
Path: /crmRestApi/resources/11.13.18.05/competencyTemplates/{TemplateId}/child/TemplateCompetency/{TemplateCompetencyId}

Competitors

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: Method: post
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts
Get a competitor: Method: get
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}
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/competitorAccounts
Get all competitors: Method: get
Path: /crmRestApi/resources/11.13.18.05/competitors
Update a competitor: Method: patch
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}

Competitors/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/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/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

Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}
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/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/{UserActionId}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}

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/{UserActionId}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

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/{UserActionId}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}

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

Bill Plan DFF linkage

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

Bill plan translation linkage

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

Job assignment override linkage

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

Job rate override linkage

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

Job title override linkage

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

Labor multiplier override linkage

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

Non labor rate override linkage

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

Person rate override linkage

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

Associated Project Element

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

Billing Control Element

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

Contract Line Flexfield Element

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

Project Contract Line Internal 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

Contract Line Translation Element

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

Sales Credit

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

Contract Party Contact Element

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

Contract Party Contact Flexfield Element

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

Contract Party Flexfield Element

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

Job assignment override linkage

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

Job rate override linkage

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

Labor multiplier override linkage

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

Non labor rate override linkage

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

Person rate override linnkage

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

Revenue Plan DFF linkage

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

Revenue Plan Translation linkage

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

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/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.

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/{UserActionId}
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/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/{UserActionId}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

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/{UserActionId}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{UserActionNavId}

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}

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 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

Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{UserActionId}
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/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/{UserActionId}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}

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/{UserActionId}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

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/{UserActionId}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}

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 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 adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information.

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 coverage 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

process that enables exporting child objects data from target tables.

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

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}

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.

Create a service request: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests
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
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}
Update an activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/activities/{ActivityId}

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 attached document descriptive flexfields resource is used to view, create, and update descriptive flexfields for attached documents.

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.

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/{UserActionId}
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/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/{UserActionId}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

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/{UserActionId}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{UserActionNavId}

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

An object that includes attributes used to store details of additional identifiers associated to a Party. For example, if the customer would like to capture the Drivers License or the passport information for a party, this information would be stored as a Additional Identifier.

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

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/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

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/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}
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/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/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/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}

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
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
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
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
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

Internal Service Requests

Create a service request: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests
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
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}
Update an activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}

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 attached document descriptive flexfields resource is used to view, create, and update descriptive flexfields for attached documents.

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 Message 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 Message 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.

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/{UserActionId}
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/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/{UserActionId}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

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/{UserActionId}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{UserActionNavId}

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

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 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

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 a currency: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies/{CurrencyCode}
Get all currencies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/currenciesLOV
Get all currencies: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies

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 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 list of values resource is used to view a list of geographies which can be associated with a partner.

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/HZ Lookups

The HZ lookups resource is used to view the lookups.

Get all HZ lookups: Method: get
Path: /crmRestApi/resources/11.13.18.05/hzLookups
Get an HZ lookup: Method: get
Path: /crmRestApi/resources/11.13.18.05/hzLookups/{hzLookupsUniqID}

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.

Get a lookup: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups/{fndStaticLookupsUniqID}
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).

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
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 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 a territory: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndTerritories/{TerritoryCode}
Get all territories: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndTerritories
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/{navigatorMetadata_Id}
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 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

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.