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

All REST Endpoints

Access Group Extension Rules

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

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

Access Group Extension Rules/Access Group Extension Rule Details

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

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

Access Group Rules

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

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

Access Group Rules/Access Group Rule Candidates

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

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

Access Group Rules/Access Group Rule Conditions

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

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

Access Groups

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

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

Access Groups/Access Group Members

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

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

Accounts

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

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

Accounts/Account Attachments

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

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

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

The contents of the attachment.

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

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

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

Accounts/Account Extension Bases

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

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

Accounts/Account Hierarchy

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

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

Accounts/Account Resources

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

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

Accounts/Account Rollups

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

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

Accounts/Account Team

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

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

Accounts/Additional Identifier

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

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

Accounts/Additional Names

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

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

Accounts/Addresses

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

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

Accounts/Addresses/Address Locales

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

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

Accounts/Addresses/Address Purposes

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

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

Accounts/Aux Classifications

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

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

Accounts/Contact Points

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

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

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

The Dun & Bradstreet business information report.

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

Accounts/Notes

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

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

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

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

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

Accounts/Organization Contacts

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

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

Accounts/Primary Addresses

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

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

Accounts/Relationships

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

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

Accounts/Smart Actions

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

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

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

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

Accounts/Smart Actions/Smart Action REST Path Parameter Definitions

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

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

Accounts/Smart Actions/Smart Action REST Payload Definitions

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

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

Accounts/Smart Actions/Smart Action User Interface Definitions

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

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

Accounts/Source System References

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

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

Action Bar Configurations

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

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

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

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

Action Bar Synonyms

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

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

Action Events

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

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

Action Plans

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

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

Action Plans/Action Plan Actions

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

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

Action Plans/Action Plan Actions/Action Plan Action Relations

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

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

Action Status Conditions

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

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

Action Templates

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

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

Action Templates/Template Actions

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

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

Action Templates/Template Actions/Action Relations

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

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

Actions

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

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

Actions/Action Attributes

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

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

Actions/Action Conditions

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

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

Activities

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

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

Activities/Activity Assignees

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

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

Activities/Activity Attachments

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

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

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

The contents of the attachment.

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

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

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

Activities/Activity Contacts

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

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

Activities/Activity Objectives

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

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

Activities/Large Object (LOB) Attributes - Description

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

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

Activities/Large Object (LOB) Attributes - Meeting Minutes

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

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

Activities/Large Object (LOB) Attributes - WebConferenceDetails

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

Activities/Notes

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

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

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

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

Activities/Smart Actions

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

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

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

Activities/Smart Actions/Smart Action REST Path Parameter Definitions

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

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

Activities/Smart Actions/Smart Action REST Payload Definitions

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

Activities/Smart Actions/Smart Action User Interface Definitions

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

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

Activity Templates

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

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

Activity Templates/Activities

Activity

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

Activity Templates/Activities/Attachments

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

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

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

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

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

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

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

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

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

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

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

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

Activity Templates/Activities/Smart Actions

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

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

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

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

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

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

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

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

UI navigation metadata striped by app usage.

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

Address Style Formats

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

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

Address Style Formats/Address Style Format Layouts

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

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

Application Usage Insights

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

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

Assets

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

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

Assets/Asset Activities

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

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

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

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

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

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

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

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

Assets/Asset Contacts

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

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

Assets/Asset Leads

The asset leads resource is used to view an asset lead. A lead is a transaction record created when a party has expressed an interest in a product or service. It represents a selling opportunity.

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

Assets/Asset Opportunities

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

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

Assets/Asset Resources

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

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

Assets/Asset Service Requests

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

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

Assets/Attachments

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

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

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

The contents of the attachment.

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

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

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

Assets/Smart Actions

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

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

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

Assets/Smart Actions/Smart Action REST Path Parameter Definitions

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

Assets/Smart Actions/Smart Action REST Payload Definitions

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

Assets/Smart Actions/Smart Action User Interface Definitions

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

Attribute Predictions

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

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

Billing Adjustments

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

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

Billing Adjustments/Billing Adjustment Events

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

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

Budgets

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

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

Budgets/Attachments

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

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

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

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

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

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

Budgets/Budget Countries

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

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

Budgets/Claims

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

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

Budgets/Fund Requests

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

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

Budgets/MDF Budget Teams

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

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

Budgets/Notes

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

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

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

The actual note text.

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

Budgets/Smart Actions

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

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

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

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/smartActions/{mdfBudgets_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/smartActions/{mdfBudgets_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/smartActions/{mdfBudgets_smartActions_Id}/enclosure/ActionIntent

Budgets/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/mdfBudgets/{BudgetCode}/child/smartActions/{mdfBudgets_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/smartActions/{mdfBudgets_smartActions_Id}/child/UserActionRequestPayload/{mdfBudgets_smartActions_UserActionRequestPayload_Id}

Budgets/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/mdfBudgets/{BudgetCode}/child/smartActions/{mdfBudgets_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/smartActions/{mdfBudgets_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/smartActions/{mdfBudgets_smartActions_Id}/child/UserActionNavigation/{mdfBudgets_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/smartActions/{mdfBudgets_smartActions_Id}/child/UserActionURLBinding/{mdfBudgets_smartActions_UserActionURLBinding_Id}

Business Plans

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

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

Business Plans/Attachments

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

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

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

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

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

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

Business Plans/Business Plan Resources

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

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

Business Plans/Notes

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

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

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

The actual note text.

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

Business Plans/SWOTs

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

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

Calculation Simulations

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

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

Calculation Simulations/Simulation Earnings

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

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

Calculation Simulations/Simulation Meause Results

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

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

Calculation Simulations/Simulation Transactions

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

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

Calculation Simulations/Simulation Transactions/Simulation Credits

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

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

Calculation Simulations/Simulation Transactions/Simulation Transaction Descriptive Flex Fields

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

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

Campaign Members

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

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

Campaigns

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

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

Campaigns/Campaign Account Attribution Criteria

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

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

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

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

Campaigns/Campaign Accounts

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

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

Campaigns/Campaign Members

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

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

Campaigns/Campaign Products

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

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

Campaigns/Campaign Rollups

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

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

Campaigns/Campaign Teams

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

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

Campaigns/Sales Contents

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

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

Campaigns/Smart Actions

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

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

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

Campaigns/Smart Actions/Smart Action REST Path Parameter Definitions

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

Campaigns/Smart Actions/Smart Action REST Payload Definitions

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

Campaigns/Smart Actions/Smart Action User Interface Definitions

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

Cases

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

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

Cases/Attachments

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

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

Cases/Attachments/Attachment Previews

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

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

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

The content of the message that is not an attachment.

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

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

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

Cases/Case Contacts

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

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

Cases/Case Households

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

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

Cases/Case Messages

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

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

Cases/Case Messages/Attachments

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

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

Cases/Case Messages/Attachments/Attachment Previews

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

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

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

The content of the message that is not an attachment.

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

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

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

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

The content of the message that is not an attachment.

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

Cases/Case Opportunities

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

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

Cases/Case Resources

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

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

Cases/Smart Actions

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

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

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

Cases/Smart Actions/Path Parameter Definitions

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

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

Cases/Smart Actions/Payload Definitions

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

Cases/Smart Actions/User Interface Definitions

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

Catalog Product Groups

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

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

Catalog Product Groups/Attachments

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

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

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

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

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

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

Catalog Product Groups/Translations

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

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

Catalog Products Items

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

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

Catalog Products Items/Attachments

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

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

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

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

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

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

Catalog Products Items/Item Translation

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

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

Categories

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

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

Channels

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

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

Channels/Channel Resources

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

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

Channels/Sender Identification Priorities

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

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

Chat Authentications

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

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

Chat Conversations

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

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

Chat Conversations/Large Object (LOB) Attributes - MessageContent

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

Chat Details

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

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

Chat Details/Attachments

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

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

Chat Details/Attachments/Attached Documents Descriptive Flexfield

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

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

Chat Details/Attachments/Attachment Previews

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

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

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

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

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

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

Chat Interactions

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

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

Chat Interactions/Transcripts

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

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

Chat Transcripts

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

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

Chat Transcripts/Large Object (LOB) Attributes - MessageContent

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

Claims

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

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

Claims/Attachments

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

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

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

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

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

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

Claims/Claim Approval Histories

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

Get a claim approval history: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimApprovalHistory/{VersionKey}
Get all claim approval history: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimApprovalHistory

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

Claims/Smart Actions

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

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

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

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/smartActions/{mdfClaims_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/smartActions/{mdfClaims_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/smartActions/{mdfClaims_smartActions_Id}/enclosure/ActionIntent

Claims/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/mdfClaims/{ClaimCode}/child/smartActions/{mdfClaims_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/smartActions/{mdfClaims_smartActions_Id}/child/UserActionRequestPayload/{mdfClaims_smartActions_UserActionRequestPayload_Id}

Claims/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/mdfClaims/{ClaimCode}/child/smartActions/{mdfClaims_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/smartActions/{mdfClaims_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/smartActions/{mdfClaims_smartActions_Id}/child/UserActionNavigation/{mdfClaims_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/smartActions/{mdfClaims_smartActions_Id}/child/UserActionURLBinding/{mdfClaims_smartActions_UserActionURLBinding_Id}

Collaboration Actions

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

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

Collaboration Actions/Action Attributes

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

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

Collaboration Actions/Large Object (LOB) Attributes - RequestPayload

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

Collaboration Actions/Large Object (LOB) Attributes - ResponsePayload

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

Collaboration Recipients

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

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

Collaborations

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

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

Compensation Estimation Insights

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

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

Compensation Estimation Insights/Estimation Summary by Plan Components

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

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

Compensation Plans

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

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

Compensation Plans/Assigned Participants

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

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

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

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

Compensation Plans/Compensation Plan - Descriptive Flex Fields

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

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

Compensation Plans/Compensation Plan - Plan Components

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

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

Compensation Plans/Compensation Plan - Roles

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

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

Compensation Plans/Direct Assignment Requests

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

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

Competitors

The competitors resource is used to view the details of a competitor. A competitor is an organization that competes with the deploying organization for sales in the market. The resource stores competitor attributes such as SWOT analysis, the products competitors sell, how they map to the deploying organization's products, win/loss reasons, and competitive literature.

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

Competitors Accounts

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

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

Competitors Accounts/Attachments

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

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

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

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

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

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

Contact Content Associations

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

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

Contacts

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

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

Contacts/Additional Identifiers

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

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

Contacts/Additional Names

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

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

Contacts/Attachments

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

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

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

The contents of the attachment.

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

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

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

Contacts/Aux Classifications

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

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

Contacts/Contact Addresses

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

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

Contacts/Contact Addresses/Address Locales

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

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

Contacts/Contact Addresses/Contact Address Purposes

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

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

Contacts/Contact Attachments

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

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

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

The contents of the attachment.

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

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

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

Contacts/Contact Points

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

Contacts/Contact Primary Addresses

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

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

Contacts/Contact Rollups

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

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

Contacts/Notes

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

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

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

The actual note text.

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

Contacts/Relationships

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

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

Contacts/Sales Account Resources

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

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

Contacts/Smart Actions

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

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

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

Contacts/Smart Actions/Smart Action REST Path Parameter Definitions

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

Contacts/Smart Actions/Smart Action REST Payload Definitions

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

Contacts/Smart Actions/Smart Action User Interface Definitions

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

Contacts/Source System References

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

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

Contests

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

Contests/Contest History

Contest History

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

Contests/Contest Resources

Contest Resources

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

Contests/Contest Scores

Contest Scores

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

Contests/Contest Scores/Contest Score Details

Contest Score Details

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

Contract Asset Transactions

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

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

Contract Asset Transactions/Contract Asset Transaction Details

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

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

Contracts

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

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

Contracts/Bill Plans

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

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

Contracts/Bill Plans/Bill Plan Flexfields

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

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

Contracts/Bill Plans/Bill Plan Translations

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

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

Contracts/Bill Plans/Job Assignment Overrides

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

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

Contracts/Bill Plans/Job Rate Overrides

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

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

Contracts/Bill Plans/Job Title Overrides

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

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

Contracts/Bill Plans/Labor Multiplier Overrides

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

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

Contracts/Bill Plans/Non Labor Rate Overrides

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

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

Contracts/Bill Plans/Person Rate Overrides

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

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

Contracts/Billing Controls

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

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

Contracts/Contract Documents

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

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

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

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

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

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

Contracts/Contract Header Flexfields

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

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

Contracts/Contract Header Translations

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

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

Contracts/Contract Lines

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

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

Contracts/Contract Lines/Associated Projects

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

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

Contracts/Contract Lines/Billing Controls

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

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

Contracts/Contract Lines/Contract Line Flexfields

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

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

Contracts/Contract Lines/Contract Line Internal Attributes

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

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

Contracts/Contract Lines/Contract Line Translations

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

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

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

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

Contracts/Contract Lines/Milestones

Milestones are single point-in-time events that can be used for billing, revenue recognition, or both. Milestones defined on a contract line are automatically created in the associated project plan upon contract approval. Upon completion of a milestone in the project plan, the corresponding billing event is automatically updated as eligible for invoicing and revenue recognition processing.

Create a milestone: Method: post
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/Milestone
Delete a milestone: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/Milestone/{MilestoneUniqID}
Get a milestone: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/Milestone/{MilestoneUniqID}
Get all milestones: Method: get
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/Milestone
Update a milestone: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/Milestone/{MilestoneUniqID}

Contracts/Contract Lines/Sales Credits

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

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

Contracts/Contract Parties

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

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

Contracts/Contract Parties/Contract Party Contacts

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

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

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

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

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

Contracts/Contract Parties/Contract Party Flexfields

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

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

Contracts/External Shared Documents

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

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

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

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

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

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

Contracts/Internal Shared Documents

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

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

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

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

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

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

Contracts/Related Documents

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

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

Contracts/Revenue Plans

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

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

Contracts/Revenue Plans/Job Assignment Overrides

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

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

Contracts/Revenue Plans/Job Rate Overrides

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

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

Contracts/Revenue Plans/Labor Multiplier Overrides

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

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

Contracts/Revenue Plans/Non Labor Rate Overrides

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

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

Contracts/Revenue Plans/Person Rate Overrides

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

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

Contracts/Revenue Plans/Revenue Plan Flexfields

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

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

Contracts/Revenue Plans/Revenue Plan Translations

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

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

Contracts/Sales Credits

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

Contracts/Sections

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

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

Contracts/Sections/Clauses

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

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

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

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

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

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

Contracts/Sections/Sub Sections

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

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

Contracts/Supporting Documents

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

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

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

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

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

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

Conversation Messages

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

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

Conversation Messages/Attachments

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

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

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

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

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

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

Conversation Messages/Conversation Message Recipients

Message recipients.

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

Conversation Messages/Large Object (LOB) Attributes - MessageContent

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

Conversation Messages/Smart Actions

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

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

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

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

Conversation Messages/Smart Actions/Smart Action REST Payload Definitions

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

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

Conversation Messages/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

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

Conversations

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

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

Conversations/Conversation References

Conversation references.

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

Copy Maps

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

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

Credit Categories

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

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

Currencies

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

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

Customer Account with Technician Preferences

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

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

Customer Self-Service Users

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

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

Customer Self-Service Users/Customer Self-Service Roles

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

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

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

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

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

DaaS Smart Data

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

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

Deal Registrations

The deal registration resource is used to view, create, update, and delete a deal registration. A deal registration is a process by which a partner user registers a business opportunity with the brand owner in order to become eligible for benefits, such as exclusive rights to the opportunity, additional rebates, presales support, and so on.

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

Deal Registrations/Deal Approval Histories

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

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

Deal Registrations/Deal Attachments

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

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

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

The contents of the attachment.

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

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

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

Deal Registrations/Deal Products

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

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

Deal Registrations/Deal Team Members

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

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

Deal Registrations/Notes

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

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

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

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

Deal Registrations/Opportunities

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

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

Deal Registrations/Partner Owner Picker

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

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

Deal Registrations/Product Groups

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

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

Deal Registrations/Products

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

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

Deal Registrations/Smart Actions

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

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

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

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

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

Deal Registrations/Smart Actions/Smart Action REST Payload Definitions

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

Deal Registrations/Smart Actions/Smart Action User Interface Definitions

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

Deleted Records

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

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

Device Tokens

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

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

Dynamic Link Patterns

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

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

Dynamic Link Values

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

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

Email Footer Templates

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

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

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

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

Email Templates

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

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

Email Templates/Attachments

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

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

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

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

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

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

Email Templates/Email Template Translations

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

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

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

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

Email Templates/Email Template Usages

Email template usage tracks information about applications using an email template. This information is used to prevent deletion of email templates that are in use.

Create an email template usage: Method: post
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateUsages
Delete an email template usage: Method: delete
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateUsages/{TemplateUsageId}
Get all email template usages: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateUsages
Get an email template usage: Method: get
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateUsages/{TemplateUsageId}
Update an email template usage: Method: patch
Path: /crmRestApi/resources/11.13.18.05/emailTemplates/{TemplateNumber}/child/EmailTemplateUsages/{TemplateUsageId}

Email Templates/Large Object (LOB) Attributes - EmailBody

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

Email Verifications

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

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

Entitlements

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

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

Entitlements/Entitlement Details

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

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

Entitlements/Entitlement Details/Charge Adjustments

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

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

Entitlements/Entitlement Details/Entitlement Results

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

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

Entitlements/Entitlement Details/Standard Coverages

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

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

Export Activities

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

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

Export Activities/Export Attachments

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

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

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

The contents of the attachment.

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

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

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

Export Activities/Export Child Object Activities

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

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

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

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

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

The contents of the attached export error file.

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

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

The contents of the attached export file.

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

Feed Configurations

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

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

Feed Configurations/Feed Objects

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

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

Feed Configurations/Feed Objects/Feed Events

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

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

Feed Configurations/Feed Objects/Feed Events/Feed Attributes

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

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

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

The CLOB that contains additional information of JSON.

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

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

This CLOB field contains additional information of JSON.

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

Feed Configurations/Feed Objects/Feed Attributes

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

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

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

The CLOB that contains additional information of JSON.

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

Feed Configurations/Feed Objects/Feed Supported Attributes

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

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

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

This CLOB field contains the additional information of JSON.

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

Feed Configurations/Feed Supported Attributes

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

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

Feed Configurations/Feed Supported Objects

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

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

Field Groups

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

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

Field Groups/Field Group Fields

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

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

Field Groups/Field Group Permissions

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

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

Field Service Connections

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

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

Field Service Schedulers

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

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

Field Service Schedulers/Scheduler Filters

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

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

Field Service Schedulers/Scheduler Roles

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

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

Field Service Schedulers/Scheduler Translations

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

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

Forecasts

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

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

Forecasts/Adjustment Periods

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

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

Forecasts/Forecast Items

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

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

Forecasts/Forecast Products

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

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

Forecasts/Forecast Products/Product Adjustment Periods

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

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

Forecasts/Revenue Items

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

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

Geographies

The geographies resource is used to view a list of geographies.

Get a geography: Method: get
Path: /crmRestApi/resources/11.13.18.05/geographies/{GeographyId}
Get all geographies: Method: get
Path: /crmRestApi/resources/11.13.18.05/geographies

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.

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

HR Helpdesk Service Requests/Activities

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

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

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

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

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

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

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

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

HR Helpdesk Service Requests/Attachments

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

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

HR Helpdesk Service Requests/Attachments/Attached Documents Descriptive Flexfield

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

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

HR Helpdesk Service Requests/Attachments/Attachments Preview

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

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

HR Helpdesk Service Requests/Attachments/Large Object (LOB) Attributes - FileContents

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

HR Helpdesk Service Requests/Attachments/Large Object (LOB) Attributes - FileWebImage

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

HR Helpdesk Service Requests/Contact Members

The list of contacts associated to the serivce request.

Create a contact member: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/contacts
Delete a contact member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/contacts/{MemberId}
Get a contact member: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/contacts/{MemberId}
Get all contact members: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/contacts
Update a contact member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/contacts/{MemberId}

HR Helpdesk Service Requests/Interaction References

Indicates the list of interaction references for a service request.

Get a service request interaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srInteractionReferences/{ReferenceId}
Get all service request interactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srInteractionReferences

HR Helpdesk Service Requests/Interaction References/Large Object (LOB) Attributes - Payload

Delete a Payload: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload
Get a Payload: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload
Replace a Payload: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload

HR Helpdesk Service Requests/Messages

The list of service request messages.

Create a message: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages
Delete a message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}
Get a message: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}
Get all messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages
Update a message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}

HR Helpdesk Service Requests/Messages/Attachments

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

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

HR Helpdesk Service Requests/Messages/Attachments/Attached Documents Descriptive Flexfield

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

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

HR Helpdesk Service Requests/Messages/Attachments/Attachments Preview

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

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

HR Helpdesk Service Requests/Messages/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

HR Helpdesk Service Requests/Messages/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

HR Helpdesk Service Requests/Messages/Large Object (LOB) Attributes - MessageContent

Delete a MessageContent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent
Get a MessageContent: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent
Replace a MessageContent: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent

HR Helpdesk Service Requests/Messages/Service Request Message Communications

The channel communications resource is used to view, create, update, and delete a channel communication. It's information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.

Create a channel communication record for an SR message: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication
Delete a channel communication record for an SR message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}
Get a channel communication record for an SR message: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}
Get all channel communication records for an SR message: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication
Update a channel communication record for an SR message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}

HR Helpdesk Service Requests/Milestones

Indicates the milestone associated with the service request.

Get a service request milestone: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srMilestone/{SrMilestoneId}
Get all service request milestones: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srMilestone
Update a service request milestone: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srMilestone/{SrMilestoneId}

HR Helpdesk Service Requests/Milestones/Milestones History

The list of changes in the service request milestone status.

Get a service request milestone history: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory/{HistoryId}
Get all service request milestone history: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory

HR Helpdesk Service Requests/References

The list of other objects associated to the service request. E.g. Knowledge articles.

Create a service request reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srReferences
Delete a service request reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srReferences/{ReferenceId}
Get a service request reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srReferences/{ReferenceId}
Get all service request references: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srReferences
Update a service request reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srReferences/{ReferenceId}

HR Helpdesk Service Requests/Resources

The list of resources associated to the service request.

Create a resource member: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/resourceMembers
Delete a resource member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/resourceMembers/{MemberId}
Get a resource member: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/resourceMembers/{MemberId}
Get all resource members: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/resourceMembers
Update a resource member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/resourceMembers/{MemberId}

HR Helpdesk Service Requests/Service Request Message Communications

The channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.

Create a channel communication record for an SR: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/channelCommunication
Delete an SR channel communication record: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}
Get a channel communication record for an SR: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}
Get all channel communications records for an SR: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/channelCommunication
Update an SR channel communication record: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}

HR Helpdesk Service Requests/Smart Actions

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

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

HR Helpdesk Service Requests/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/enclosure/ActionIntent

HR Helpdesk Service Requests/Smart Actions/Smart Action REST Payload Definitions

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

Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionRequestPayload/{hrHelpDeskRequests_smartActions_UserActionRequestPayload_Id}

HR Helpdesk Service Requests/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionNavigation/{hrHelpDeskRequests_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/smartActions/{hrHelpDeskRequests_smartActions_Id}/child/UserActionURLBinding/{hrHelpDeskRequests_smartActions_UserActionURLBinding_Id}

HR Helpdesk Service Requests/Tags

The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.

Create a tag: Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srTags
Delete a tag: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srTags/{srTagsUniqID}
Get a tag: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srTags/{srTagsUniqID}
Get all tags: Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/srTags

Households

The household resource is used to view, create, update, and delete a household. A household is a party consisting of a collection of persons and organizations. A household, similar to a person or organization, can enter into a business relationship with other parties and can be assigned to opportunities and leads. A household can also have members of party type person or organization.

Create a household: Method: post
Path: /crmRestApi/resources/11.13.18.05/households
Delete a household: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}
Get a household: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}
Get all households: Method: get
Path: /crmRestApi/resources/11.13.18.05/households
Update a household: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}

Households/Additional Identifiers

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

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

Households/Additional Names

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

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

Households/Addresses

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

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

Households/Addresses/Address Locales

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

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

Households/Addresses/Address Purposes

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

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

Households/Attachments

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

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

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

The contents of the attachment.

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

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

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

Households/Aux Classifications

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

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

Households/Contact Points

The contact points 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/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/Smart Actions

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

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

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

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

Households/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/households/{PartyNumber}/child/smartActions/{households_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/smartActions/{households_smartActions_Id}/child/UserActionRequestPayload/{households_smartActions_UserActionRequestPayload_Id}

Households/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/households/{PartyNumber}/child/smartActions/{households_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/smartActions/{households_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/smartActions/{households_smartActions_Id}/child/UserActionNavigation/{households_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/smartActions/{households_smartActions_Id}/child/UserActionURLBinding/{households_smartActions_UserActionURLBinding_Id}

Households/Source System References

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

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

Hub Organizations

The organizations resource is used to view, create, update, and delete an organization. An organization is an entity with whom you have a business relationship.

Create an organization: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations
Delete an organization: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}
Find duplicates: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/action/findDuplicates
Get all organizations: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations
Get an organization: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}
Promote the selected account in the duplicate set: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/action/promoteDuplicateParty
Update an organization: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}

Hub Organizations/Additional Identifiers

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

Create an additional identifier: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifier
Delete an additional identifier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Get all additional identifiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifier
Get an additional identifier: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Update an additional identifier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}

Hub Organizations/Additional Names

The additional names resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.

Create an additional name: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalName
Delete an additional name: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalName/{NameId}
Get all additional names: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalName
Get an additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalName/{NameId}
Update an additional name: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalName/{NameId}

Hub Organizations/Addresses

The addresses resource is used to view, create, update, and delete an address. It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Address
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Address/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Address
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Address/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Address/{AddressNumber}

Hub Organizations/Contact Points

The contact points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The Contactpoint describes the types of contact points. For example, phone, email, web etc.

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/ContactPoint
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/ContactPoint
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/ContactPoint/{ContactPointId}

Hub Organizations/Customer Classifications

The customer classifications resource is used to view, create, update, and delete a customer classification. It is an object that includes attributes used to store values while creating or updating a code assignment. A code assignment represents the classification category and classification code information of an account, contact, or household.

Create a customer classification: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification
Delete a customer classification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get a customer classification: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get all customer classifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification
Update a customer classification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}

Hub Organizations/Duplicate Parties

The duplicate parties resource is used to view, create, and delete all the duplicate parties for the given organization.

Create a duplicate party: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/DuplicateParty
Delete a duplicate party: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/DuplicateParty/{PartyNumber2}
Get a duplicate party: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/DuplicateParty/{PartyNumber2}
Get all duplicate parties: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/DuplicateParty
Update a linked party: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/DuplicateParty/{PartyNumber2}

Hub Organizations/Large Object (LOB) Attributes - D&B Business Report

The Dun & Bradstreet business information report.

Delete a D&B Business Report: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/enclosure/BusinessReport
Get a D&B Business Report: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/enclosure/BusinessReport
Replace a D&B Business Report: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/enclosure/BusinessReport

Hub Organizations/Linked Parties

The linked parties resource is used to view, create, and delete all the linked parties for the given organization.

Create a link party: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty
Delete a link party: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty/{LinkedPartyUniqID}
Get a link party: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty/{LinkedPartyUniqID}
Get all link parties: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty
Update a linked party: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/LinkedParty/{LinkedPartyUniqID}

Hub Organizations/Notes

The notes resource is used to view, create, update, and delete a note. It is a note data object that captures comments, information or instructions for an Oracle Fusion Applications business object.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}

Hub Organizations/Notes/Large Object (LOB) Attributes - NoteTxt

Delete a NoteTxt: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a NoteTxt: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Hub Organizations/Organization Attachments

The organization attachments resource is used to view, create, update, and delete attachments of an organization.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}

Hub Organizations/Organization Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Hub Organizations/Organization Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Hub Organizations/Party Usage Assignments

The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member.

Create a usage assignment: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/UsageAssignment
Delete a usage assignment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}
Get a usage assignment: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}
Get all usage assignments: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/UsageAssignment
Update a usage assignment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}

Hub Organizations/Relationships

The relationships resource is used to view, create, update, and delete a relationship. It is an object that includes attributes used to store values while creating or updating a relationship. This object stores attributes that define and categorizes a relationship between 2 entities such as account, contact and household.

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Relationship
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Relationship
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Relationship/{RelationshipRecId}

Hub Organizations/Smart Actions

This VO stores the endpoint and security details for every user action.

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/generateSmartActions
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/action/processMassAction

Hub Organizations/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/enclosure/ActionIntent

Hub Organizations/Smart Actions/Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionRequestPayload/{hubOrganizations_smartActions_UserActionRequestPayload_Id}

Hub Organizations/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionNavigation/{hubOrganizations_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/smartActions/{hubOrganizations_smartActions_Id}/child/UserActionURLBinding/{hubOrganizations_smartActions_UserActionURLBinding_Id}

Hub Organizations/Source System References

The source system references resource is used to view, create, update, and delete a source system reference. It is an external system from which data can be imported into the trading community registry.

Create a source system reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReference
Delete a source system reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReference
Update a source system reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}

Hub Persons

The hub person resource is used to view, create, update, and delete person. An person is an entity with whom you have a business relationship.

Create a person: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons
Delete a person: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}
Find duplicates: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/action/findDuplicates
Get a person: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}
Get all persons: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons
Update a person: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}

Hub Persons/Additional Identifiers

The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.

Create an additional identifier: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalIdentifier
Delete an additional identifier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Get all additional identifiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalIdentifier
Get an additional identifier: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Update an additional identifier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}

Hub Persons/Additional Names

The additional name resource is used to view, create, update, and delete additional names associated with a person. The resource allows you to capture other names associated with a person such as a maiden name, or a brand name.

Create an additional name: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalName
Delete an additional name: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalName/{NameId}
Get all additional names: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalName
Get an additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalName/{NameId}
Update an additional name: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/AdditionalName/{NameId}

Hub Persons/Addresses

The addresses resource is used to view, create, update, and delete an address, It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Address
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Address/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Address
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Address/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Address/{AddressNumber}

Hub Persons/Attachments

The person attachments resource is used to view, create, update, and delete attachments of a person.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}

Hub Persons/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Hub Persons/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Hub Persons/Contact Points

The contact points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The contact point describes the types of contact points. For example, phone, email, or web.

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/ContactPoint
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/ContactPoint
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/ContactPoint/{ContactPointId}

Hub Persons/Customer Classifications

Create a customer classification: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/CustomerClassification
Delete a customer classification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get a customer classification: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get all customer classifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/CustomerClassification
Update a customer classification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}

Hub Persons/Notes

The notes resource is used to view, create, update, and delete a note. A note data object captures comments, information, or instructions for an Oracle Fusion Applications business object.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}

Hub Persons/Notes/Large Object (LOB) Attributes - NoteTxt

Delete a NoteTxt: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a NoteTxt: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt: Method: put
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Hub Persons/Relationships

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Relationship
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Relationship
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/Relationship/{RelationshipRecId}

Hub Persons/Source System References

Create a source system reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/SourceSystemReference
Delete a source system reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/SourceSystemReference
Update a source system reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}

Hub Persons/Usage Assignments

The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member.

Create a usage assignment: Method: post
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/UsageAssignment
Delete a usage assignment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}
Get a usage assignment: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}
Get all usage assignments: Method: get
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/UsageAssignment
Update a usage assignment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/UsageAssignment/{PartyUsageAssignmentId}

Import Activities

The import activities resource is used to view, create, and update data from a flat file into object related tables in the target database.

Create a file import activity: Method: post
Path: /crmRestApi/resources/11.13.18.05/importActivities
Get a file import activity: Method: get
Path: /crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}
Get all file import activities: Method: get
Path: /crmRestApi/resources/11.13.18.05/importActivities
Update a file import activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}

Import Activities/Import Activity Data Files

The import activity data files resource is used to view and create the data files that contain the information that is to be imported.

Create a file import activity data file: Method: post
Path: /crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}/child/DataFiles
Get a file import activity data file: Method: get
Path: /crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}/child/DataFiles/{InputFileContentId}
Get all file import activity data files: Method: get
Path: /crmRestApi/resources/11.13.18.05/importActivities/{ImportActivityId}/child/DataFiles

Import Activity Maps

The import activity maps resource is used to view, create, update, and delete a file import map which can be used for a file-based import activity.

Create a file import map: Method: post
Path: /crmRestApi/resources/11.13.18.05/importMappings
Delete a file import map: Method: delete
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}
Get a file import map: Method: get
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}
Get all file import maps: Method: get
Path: /crmRestApi/resources/11.13.18.05/importMappings
Update a file import map: Method: patch
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}

Import Activity Maps/Import Activity Map Columns

The import mapping columns resource is used to view, create, update, and delete an entry in a file import map which shows the mapping between a source CSV file column header and a file import object attribute.

Create a file import map column: Method: post
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns
Delete a file import map column: Method: delete
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns/{MappingColumnNumber}
Get a file import map column: Method: get
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns/{MappingColumnNumber}
Get all file import map columns: Method: get
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns
Update a file import map column: Method: patch
Path: /crmRestApi/resources/11.13.18.05/importMappings/{MappingNumber}/child/ImportMappingColumns/{MappingColumnNumber}

Import Export Objects Metadata

The import export object metadata resource is used to view the objects which support for file-based import and export.

Get a file import and export object: Method: get
Path: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata/{ObjectCode}
Get all file import and export objects: Method: get
Path: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata

Import Export Objects Metadata/Import Export Object Attributes

The import export object attributes resource is used to view the attributes of a specific object which support for file-based import and export.

Get a file import and export object attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata/{ObjectCode}/child/ObjectAttributes/{AttributeCode}
Get all file import and export object attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata/{ObjectCode}/child/ObjectAttributes

Import Export Objects Metadata/Large Object (LOB) Attributes - DownloadTemplate

Get a DownloadTemplate: Method: get
Path: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata/{ObjectCode}/enclosure/DownloadTemplate

Inbound Message Filters

The inbound message filter resource is used to view, create, and update the filters setup by the administrator to accept or reject inbound messages. For example, you can create a filter to reject messages from a specific domain.

Create an inbound message filter: Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMsgFilters
Delete an inbound message filter: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMsgFilters/{FilterId}
Get all inbound message filters: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMsgFilters
Get an inbound message filter: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMsgFilters/{FilterId}
Update an inbound message filter: Method: patch
Path: /crmRestApi/resources/11.13.18.05/inboundMsgFilters/{FilterId}

Inbound Messages

The inbound messages resource is used to create, process, view, update, and replace a list of inbound messages received from customers, that need a response. For example, a message indicating that a customer's mobile camera is not functional.

Delete an inbound message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}
Get all inbound messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages
Get an inbound message: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}
Process an unprocessed inbound message: Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMessages
Process inbound messages: Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/action/processInboundMessageList
Update an inbound message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}

Inbound Messages/Attachments

The attachments resource is used to create, view, update, and delete the list of files sent as attachments with the inbound messages. For example, a document with a screenshot of an error message.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}

Inbound Messages/Attachments/Large Object (LOB) Attributes - File Contents

The contents of the attachment.

Delete a File Contents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Inbound Messages/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

Inbound Messages/Inbound Message Parts

The inbound message parts resource is used to create, view, update, and delete the list of components of an inbound message, such as From, To, CC, and Importance.

Create an inbound message part: Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts
Delete an inbound message part: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts/{InboundMsgPartId}
Get all inbound message parts: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts
Get an inbound message part: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts/{InboundMsgPartId}
Update an inbound message part: Method: patch
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts/{InboundMsgPartId}

Inbound Messages/Large Object (LOB) Attributes - Body

The content of the inbound message.

Delete a Body: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/Body
Delete a Body: Method: delete
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/PlainTextBody
Get a Body: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/Body
Get a Body: Method: get
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/PlainTextBody
Replace a Body: Method: put
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/Body
Replace a Body: Method: put
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/enclosure/PlainTextBody

Incentive Compensation Credit Details

The incentive compensation credit details resource is used to view the details of the participant's credits.

Get a credit detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCreditDetails/{CreditId}
Get all credit details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCreditDetails

Incentive Compensation Earnings

The incentive compensation earnings resource is used to view the details of the participant earnings for a transaction, or a pay period. Incentive compensation earnings store the earnings amount, the compensation plan, and the plan component for which it was earned.

Get all earnings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEarnings
Get an earning: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEarnings/{EarningId}

Incentive Compensation Expressions

The incentive compensation expressions resource is used to view, create, update, and delete an expression. It can also be used to display all the details of an expression. An expression is used to calculate the attainment using the measure formula, the earning using the incentive formula, the 'from' and 'to' tiers of an expression type rate dimension, or the input to a rate table. A new expression can be created either with multiple expression details or individually with only one expression, and associate the expression details later.

Create an expression: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions
Delete an expression: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}
Get all expressions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions
Get an expression: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}
Update an expression: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}

Incentive Compensation Expressions/Expression Details

The expression details resource is used to view, create, update, and delete the expression details. It can also be used to display all values of the expression detail. An expression detail breaks up the entire expression into its components (including functions and operators), and allows us to build the expression component by component. If a new expression details record has to be added, you should ensure it's sequence number is after all the current records. If you provide a sequence number matching an existing expression details record, then it is added after the matching sequence record, and all the following records are moved down.

Create an expression detail: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails
Delete an expression detail: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails/{ExpressionDetailId}
Get all expression details: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails
Get an expression detail: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails/{ExpressionDetailId}
Update an expression detail: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionDetails/{ExpressionDetailId}

Incentive Compensation Expressions/Expression Usages

The expression usage resource is used to view how an expression can be used. The system automatically creates usages for a valid expression.

Get all expression usages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionUsages
Get an expression usage: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/child/ExpressionUsages/{ExpressionUsageId}

Incentive Compensation Expressions/Large Object (LOB) Attributes - Expression

Get an Expression: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressions/{incentiveCompensationExpressionsUniqID}/enclosure/Expression

Incentive Compensation Individual Earnings

The individual earnings resource is used to view the total incentive earnings for an individual participant.

Get all earnings of a participant: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationIndividualEarningTotals
Get an earning of a participant: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationIndividualEarningTotals/{incentiveCompensationIndividualEarningTotalsUniqID}

Incentive Compensation Rule Hierarchies

The rule hierarchies resource is used for direct crediting, classification, rollup crediting, team crediting, participant role assignment, and analyst approvals. Rule hierarchies are set of rules arranged in hierarchical fashion, where a child rule inherits the criterion of the parent rule. Rule hierarchies are created and managed for each rule type such as crediting, classification, or rollup.

Create a rule hierarchy: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies
Delete a rule hierarchy: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}
Get a rule hierarchy: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}
Get all rule hierarchies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies
Update a rule hierarchy: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}

Incentive Compensation Rule Hierarchies/Qualifying Criteria

The qualifying criteria resource is used create and view how the transactions are matched for classification and credit processing. Use the Configure Tables and Columns task in the Setup and Maintenance work area to enable application table columns for use as qualifying criteria attributes in classification, direct credit, and participant assignment rules. You can also define your own qualifiers based on a descriptive flex field.

Create a qualifying criterion: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria
Delete a qualifying criterion: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}
Get a qualifying criterion: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}
Get all qualifying criteria: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria
Update a qualifying criterion: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}

Incentive Compensation Rule Hierarchies/Qualifying Criteria/Qualifying Attribute Values

The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.

Create a qualifying attribute value: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues
Delete a qualifying attribute value: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues/{RuleAttributeValueId}
Get a qualifying attribute value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues/{RuleAttributeValueId}
Get all qualifying attribute values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues
Update a qualifying attribute value: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues/{RuleAttributeValueId}

Incentive Compensation Rule Hierarchies/Rule Assignments

The rule assignments resource is used create, view, update, or delete the receiver of the credits, for a matching transaction, when a rule wins. Classification adds credit categories to matching transactions, and Participant role assignment rules assign eligible roles to matching participants. The rule assignments for Rollup and Team rules are used to create indirect credits.

Create a rule assignment: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments
Delete a rule assignment: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments/{RuleAssignmentId}
Get a rule assignment: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments/{RuleAssignmentId}
Get all rule assignments: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments
Update a rule assignment: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments/{RuleAssignmentId}

Incentive Compensation Rule Hierarchies/Rules

The rules resource is used to create, view, update, or delete the child nodes for the rule hierarchy. The rules form the building blocks of a rule hierarchy and are date effective.

Create a rule: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules
Delete a rule and all its child rules: Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules/{RuleId2}
Get a rule: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules/{RuleId2}
Get all rules: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules
Update a rule: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules/{RuleId2}

Incentive Compensation Summarized Credits

The incentive compensation summarized credits resource is used to view summarized credit amount for a participant within the interval selected under calendar period type.

Get a credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedCredits/{incentiveCompensationSummarizedCreditsUniqID}
Get all credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedCredits

Incentive Compensation Summarized Earnings

The incentive compensation summarized earnings resource is used to view the summarized earnings for a compensation plan, plan component, and pay period by the participant and participant managers. Participant managers may also review the summarized earnings information for direct reports in their management hierarchy. In addition to total earnings amounts, this resource returns the total input achieved, total output achieved, and total transaction amount.

Get a summarized earning: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedEarnings/{incentiveCompensationSummarizedEarningsUniqID}
Get all summarized earnings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedEarnings

Incentive Compensation Summarized Earnings Per Intervals

The incentive compensation summarized earnings per intervals resource is used to view summarized earnings amount for a participant within the interval selected under calendar period type.

Get all earnings: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedEarningsPerInterval
Get an earning: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedEarningsPerInterval/{incentiveCompensationSummarizedEarningsPerIntervalUniqID}

Incentive Compensation Summarized Team Credits

The incentive compensation summarized team credits resource used to view the summarized team credits. It stores summarized credit amount for the first level directs under a participant manager within the interval selected under calendar period type.

Get a credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedTeamCredits/{incentiveCompensationSummarizedTeamCreditsUniqID}
Get all credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSummarizedTeamCredits

Incentive Compensation Transactions

The incentive compensation transactions resource is used to view, create, and update transactions, such as order, invoice, and so on.

Create a transaction: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions
Get a transaction: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}
Get all transactions: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions
Update a transaction: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}

Incentive Compensation Transactions/Credits

The credits resource is used to view, create, and update the credits for a transaction.

Create a credit: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits
Get a credit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits/{CreditId}
Get all credits: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits
Update a credit: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits/{CreditId}

Incentive Compensation Transactions/Transaction Descriptive Flex Fields

The transaction descriptive flex fields resource is used to view, create, and update additional attributes of the transaction that are used for classification, crediting, calculating, and reporting.

Create a transaction descriptive flex field: Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF
Get a transaction descriptive flex field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF/{TransactionId2}
Get all transactions descriptive flex field: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF
Update a transaction descriptive flex field: Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF/{TransactionId2}

Integration Instances v1

Integration instances represent the details of specific records integrated between Sales and other Oracle applications, such as routine identifier, status, integration payload, and integration map identifier.

Advanced query all integration instances: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/$query
Advanced query an integration instance: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}/$query
Create an integration instance: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances
Get all integration instances: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances
Get an integration instance: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}

Integration Instances v1/Integration Details v1

Integration details include information about an integration instance such as the integration level, inbound payload, outbound payload, and step name.

Advanced query all integration instance details: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}/integrationDetails/$query
Advanced query an integration instance detail: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}/integrationDetails/{integrationInstances-integrationDetails_id}/$query
Get all integration details: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}/integrationDetails
Get an integration detail: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}/integrationDetails/{integrationInstances-integrationDetails_id}

Integration Maps v1

Integration maps describe the attribute mappings between objects in Sales and objects in other Oracle applications. The integration process uses these mappings to determine the attributes that need to be synchronized from Sales to the other applications.

Advanced query all integration maps: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/$query
Advanced query an integration map: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/{integrationMaps_id}/$query
Create an integration map: Method: post
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps
Get all integration maps: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps
Get an integration map: Method: get
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/{integrationMaps_id}
Update an integration map: Method: patch
Path: /api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/{integrationMaps_id}

Intelligence Onboarding Data Sufficiency Jobs

The intelligence onboarding jobs resources lets you view and add data sufficiency check jobs.

Create a job: Method: post
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs
Delete a job: Method: delete
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}
Get a job: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}
Get all jobs: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs
Update a job: Method: patch
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}

Intelligence Onboarding Data Sufficiency Jobs/Feature Data Sufficiency Reports

The intelligence onboarding reports resources lets you view and add data sufficiency check reports.

Create a report: Method: post
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}/child/JobSelectedFeatures
Delete a report: Method: delete
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}/child/JobSelectedFeatures/{DataSufficiencyReportId}
Get a report: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}/child/JobSelectedFeatures/{DataSufficiencyReportId}
Get all reports: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}/child/JobSelectedFeatures
Update a report: Method: patch
Path: /crmRestApi/resources/11.13.18.05/iisDatasufficiencyJobs/{DataSufficiencyJobId}/child/JobSelectedFeatures/{DataSufficiencyReportId}

Intelligence in Sales Features

The intelligence feature resource lets you view and add the features.

Get a feature: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}
Get all features: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures
Update a feature: Method: patch
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}

Intelligence in Sales Features/Feature Data Sufficiency Reports

The intelligence onboarding reports resources lets you view and add data sufficiency check reports.

Create a report: Method: post
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/DatasufficiencyReports
Delete a report: Method: delete
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/DatasufficiencyReports/{DataSufficiencyReportId}
Get a report: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/DatasufficiencyReports/{DataSufficiencyReportId}
Get all reports: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/DatasufficiencyReports
Update a report: Method: patch
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/DatasufficiencyReports/{DataSufficiencyReportId}

Intelligence in Sales Features/Intelligence in Sales Feature Rules

The intelligence feature rules resource lets you view and add the feature rules.

Create a feature rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/FeatureRules
Delete a feature rule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/FeatureRules/{FeatureRuleId}
Get a feature rule: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/FeatureRules/{FeatureRuleId}
Get all feature rules: Method: get
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/FeatureRules
Update a feature rule: Method: patch
Path: /crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}/child/FeatureRules/{FeatureRuleId}

Interactions

The interaction resource is used to view, create, and update the interactions between a customer and an agent.

Create an interaction and interaction reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions
Delete an interaction: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}
Get an interaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}
Update an interaction: Method: patch
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}

Interactions/Child Interactions

The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.

Create a child interaction and interaction reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions
Delete an interaction: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}
Get a child interaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}
Get all child interactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions
Update a child interaction: Method: patch
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}

Interactions/Child Interactions/Large Object (LOB) Attributes - Payload

The payload associated with the interaction.

Delete a Payload: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}/enclosure/Payload
Get a Payload: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}/enclosure/Payload
Replace a Payload: Method: put
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{interactions_childInteractions_Id}/enclosure/Payload

Interactions/Interaction Participants

The interaction participant resource is used to view, create, and update participants in an interaction, usually a web conference.

Create an interaction participant: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants
Delete an interaction participant: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}
Get all interaction participants: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants
Get an interaction participant: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}
Update an interaction participant: Method: patch
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}

Interactions/Interaction Participants/Large Object (LOB) Attributes - Json

Delete a Json: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}/enclosure/Json
Get a Json: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}/enclosure/Json
Replace a Json: Method: put
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/InteractionParticipants/{interactions_InteractionParticipants_Id}/enclosure/Json

Interactions/Interaction References

The interaction references resource is used to view, create, and update the association between an interaction and another business object, for example Service Requests. The supported business objects and their codes are Activities (ZMM_ACTIVITIES), Opportunities (MOO_OPTY), Work Orders (SVC_WORK_ORDERS), Service Requests (SVC_SERVICE_REQUESTS), and Leads (MKL_LM_LEADS).

Create an interaction reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences
Delete an interaction reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences/{interactions_interactionReferences_Id}
Get all interaction references: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences
Get an interaction reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences/{interactions_interactionReferences_Id}
Update an interaction reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences/{interactions_interactionReferences_Id}

Interactions/Large Object (LOB) Attributes - Payload

The payload associated with the interaction.

Delete a Payload: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/enclosure/Payload
Get a Payload: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/enclosure/Payload
Replace a Payload: Method: put
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/enclosure/Payload

Interactions/Smart Actions

This VO stores the endpoint and security details for every user action.

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/generateSmartActions
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/action/processMassAction

Interactions/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/enclosure/ActionIntent

Interactions/Smart Actions/Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionRequestPayload/{interactions_smartActions_UserActionRequestPayload_Id}

Interactions/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionNavigation/{interactions_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/smartActions/{interactions_smartActions_Id}/child/UserActionURLBinding/{interactions_smartActions_UserActionURLBinding_Id}

Internal Service Requests

Copy service request attachments to messages.: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/action/copyAttachmentsToMessage
Create a service request: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests
Create an attachment for an internal service request: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/action/copySRAttachments
Delete a service request: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}
Get a service request: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}
Get all service requests: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests
Get service request milestone diagnostics: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/action/processSrMilestones
Refresh service request milestones: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/action/getSrMilestoneDiagnostics
Send an email to SR message recipients: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/action/sendEmailForSrMessage
Update a service request: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}

Internal Service Requests/Activities

The activities resource is used to view, create, update, and delete an activity.

Create activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/action/createActivitiesFromTemplate
Create an activity: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities
Create multiple activity from template: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/action/createMultipleActivitiesFromTemplate
Delete an activity: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}
Get all activities: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities
Get an activity: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}
Send notifications to resources: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/action/sendNotificationToResources
Update an activity: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}
Update an activity wrap up: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/action/updateActivityWrapup

Internal Service Requests/Activities/Large Object (LOB) Attributes - ActivityDescription

Delete an ActivityDescription: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityDescription
Get an ActivityDescription: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityDescription
Replace an ActivityDescription: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityDescription

Internal Service Requests/Activities/Large Object (LOB) Attributes - ActivityMtgMinutes

Delete an ActivityMtgMinutes: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes
Get an ActivityMtgMinutes: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes
Replace an ActivityMtgMinutes: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/ActivityMtgMinutes

Internal Service Requests/Activities/Large Object (LOB) Attributes - WebConferenceDetails

Delete a WebConferenceDetails: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/WebConferenceDetails
Get a WebConferenceDetails: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/WebConferenceDetails
Replace a WebConferenceDetails: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}/enclosure/WebConferenceDetails

Internal Service Requests/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}

Internal Service Requests/Attachments/Attached Documents Descriptive Flexfield

The operations from the Internal Service Requests/Attachments/Attached Documents Descriptive Flexfield category.

Create descriptive flexfield values for attached documents: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Get a descriptive flexfield value: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}
Get all descriptive flexfield values: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Update descriptive flexfield values for attached documents: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}

Internal Service Requests/Attachments/Attachments Preview

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

Internal Service Requests/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Internal Service Requests/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Internal Service Requests/Contact Members

The list of contacts associated to the serivce request.

Create a contact member: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts
Delete a contact member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts/{MemberId}
Get a contact member: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts/{MemberId}
Get all contact members: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts
Update a contact member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts/{MemberId}

Internal Service Requests/Interaction References

Indicates the list of interaction references for a service request.

Get a service request interaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences/{ReferenceId}
Get all service request interactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences

Internal Service Requests/Interaction References/Large Object (LOB) Attributes - Payload

Delete a Payload: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload
Get a Payload: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload
Replace a Payload: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srInteractionReferences/{ReferenceId}/enclosure/Payload

Internal Service Requests/Messages

The list of service request messages.

Create a message: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages
Delete a message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}
Get a message: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}
Get all messages: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages
Update a message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}

Internal Service Requests/Messages/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment
Delete an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}
Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}

Internal Service Requests/Messages/Attachments/Attached Documents Descriptive Flexfield

The operations from the Internal Service Requests/Messages/Attachments/Attached Documents Descriptive Flexfield category.

Create descriptive flexfield values for attached documents: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Get a descriptive flexfield value: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}
Get all descriptive flexfield values: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsDFFVL
Update descriptive flexfield values for attached documents: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsDFFVL/{AttachmentsDFFVLUniqID}

Internal Service Requests/Messages/Attachments/Attachments Preview

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID2}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

Internal Service Requests/Messages/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Internal Service Requests/Messages/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Internal Service Requests/Messages/Large Object (LOB) Attributes - MessageContent

Delete a MessageContent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent
Get a MessageContent: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent
Replace a MessageContent: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/enclosure/MessageContent

Internal Service Requests/Messages/Service Request Communications

Create a channel communication record for an SR message: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication
Delete a channel communication record for an SR message: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}
Get a channel communication record for an SR message: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}
Get all channel communication records for an SR message: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication
Update a channel communication record for an SR message: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{ViaId}

Internal Service Requests/Milestones

Indicates the milestone associated with the service request.

Get a service request milestone: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}
Get all service request milestones: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone
Update a service request milestone: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}

Internal Service Requests/Milestones/Milestones History

The list of changes in the service request milestone status.

Get a service request milestone history: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory/{HistoryId}
Get all service request milestone history: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory

Internal Service Requests/References

The list of other objects associated to the service request. E.g. Knowledge articles.

Create a service request reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences
Delete a service request reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences/{ReferenceId}
Get a service request reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences/{ReferenceId}
Get all service request references: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences
Update a service request reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srReferences/{ReferenceId}

Internal Service Requests/Resources

The list of resources associated to the service request.

Create a resource member: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/resourceMembers
Delete a resource member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/resourceMembers/{MemberId}
Get a resource member: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/resourceMembers/{MemberId}
Get all resource members: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/resourceMembers
Update a resource member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/resourceMembers/{MemberId}

Internal Service Requests/Service Request Communications

Create a channel communication record for an SR: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication
Delete an SR channel communication record: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}
Get a channel communication record for an SR: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}
Get all channel communications records for an SR: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication
Update an SR channel communication record: Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}

Internal Service Requests/Smart Actions

This VO stores the endpoint and security details for every user action.

Execute an action: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/action/executeAction
Generate smart actions: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/generateSmartActions
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions
Get an action: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/action/processMassAction

Internal Service Requests/Smart Actions/Large Object (LOB) Attributes - ActionIntent

Delete an ActionIntent: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/enclosure/ActionIntent
Get an ActionIntent: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/enclosure/ActionIntent
Replace an ActionIntent: Method: put
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/enclosure/ActionIntent

Internal Service Requests/Smart Actions/Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Get all action request payload definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionRequestPayload
Get an action request payload definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionRequestPayload/{internalServiceRequests_smartActions_UserActionRequestPayload_Id}

Internal Service Requests/Smart Actions/Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Get all action navigation definitions: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionNavigation
Get all action path parameters: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionURLBinding
Get an action navigation definition: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionNavigation/{internalServiceRequests_smartActions_UserActionNavigation_Id}
Get an action path parameter: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{internalServiceRequests_smartActions_Id}/child/UserActionURLBinding/{internalServiceRequests_smartActions_UserActionURLBinding_Id}

Internal Service Requests/Tags

The tags resource is used to create, view, and delete keywords or terms assigned to a service request. Tags help in describing and classifying a service request.

Create a tag: Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srTags
Delete a tag: Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srTags/{srTagsUniqID}
Get a tag: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srTags/{srTagsUniqID}
Get all tags: Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srTags

KPI

Create a KPI: Method: post
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators
Delete a KPI: Method: delete
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}
Get a KPI: Method: get
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}
Get all KPIs: Method: get
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators
Update a KPI: Method: patch
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}

KPI/KPI History Metadata

The KPI history metadata resource is used to view, create, update, and delete a KPI history metadata.

Create a KPI history metadata: Method: post
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/KPIHistoryMetadata
Delete a KPI history metadata: Method: delete
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/KPIHistoryMetadata/{KPIEventId}
Get a KPI history metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/KPIHistoryMetadata/{KPIEventId}
Get all KPI history metadata: Method: get
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/KPIHistoryMetadata
Update a KPI history metadata: Method: patch
Path: /crmRestApi/resources/11.13.18.05/keyPerformanceIndicators/{KPINumber}/child/KPIHistoryMetadata/{KPIEventId}

Lightbox Documents

The Lightbox document resource is used to view, create, update, and delete documents in the Lightbox content library, such as slide decks, web-based content, and so on.

Create a Lightbox document: Method: post
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments
Delete a Lightbox document: Method: delete
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}
Get a Lightbox document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}
Get all Lightbox documents: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments
Update a Lightbox document: Method: patch
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}

Lightbox Documents/Document-Viewed-Within-Lightbox Signals

The resource is used to view the signals that the document is viewed within Lightbox.

Get a document-viewed-within-Lightbox signal for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedInLightboxSignals/{documentViewedInLightboxSignalsUniqID}
Get all document-viewed-within-Lightbox signals for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedInLightboxSignals

Lightbox Documents/Document-shared-with-user Signals

The resource is used to view the signals captured when a document is shared with a user.

Get a document-shared-with-user signal for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentSharedToUserSignals/{documentSharedToUserSignalsUniqID}
Get all document-shared-with-user signals for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentSharedToUserSignals

Lightbox Documents/Document-unshared-with-user Signals

The resource is used to view the signals captured when a document share with a user is deleted.

Get a document-unshared-with-user signal for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentUnsharedFromUserSignals/{documentUnsharedFromUserSignalsUniqID}
Get all document-unshared-with-user signals for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentUnsharedFromUserSignals

Lightbox Documents/Document-viewed-outside-Lightbox Signals

The resource is used to view and create the signals captured when document is viewed by a process outside Lightbox.

Create a document-viewed-outside-Lightbox signal for a document: Method: post
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedOutsideLightboxSignals
Get a document-viewed-outside-Lightbox signal for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedOutsideLightboxSignals/{documentViewedOutsideLightboxSignalsUniqID}
Get all document-viewed-outside-Lightbox signals for document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentViewedOutsideLightboxSignals

Lightbox Documents/Large Object (LOB) Attributes - DocumentContents

The field used to upload and download the document through services.

Delete a DocumentContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/enclosure/DocumentContents
Get a DocumentContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/enclosure/DocumentContents
Replace a DocumentContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/enclosure/DocumentContents

Lightbox Documents/Large Object (LOB) Attributes - Thumbnail

The field used to get the document thumbnail through services.

Get a Thumbnail: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/enclosure/Thumbnail

Lightbox Documents/Lightbox Document Pages

The Lightbox document page resource is used to view and update the pages within a Lightbox document.

Get a Lightbox document page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}
Get all Lightbox document pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages
Update a Lightbox document page: Method: patch
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}

Lightbox Documents/Lightbox Document Pages/Downloaded-from-cart Signals

The resource is used to view the signals captured when pages within a cart are downloaded by the user.

Get a downloaded-from-cart signal for a page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageDownloadedInCartSignals/{pageDownloadedInCartSignalsUniqID}
Get all downloaded-from-cart signals for a page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageDownloadedInCartSignals

Lightbox Documents/Lightbox Document Pages/Large Object (LOB) Attributes - Page Thumbnail

The field used to get the page thumbnail through services.

Get a Page Thumbnail: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/enclosure/PageThumbnail

Lightbox Documents/Lightbox Document Pages/Page-added-to-cart Signals

The resource is used to view the signals captured when pages of a document are added to cart.

Get a page-added-to-cart signal for a page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageAddedToCartSignals/{pageAddedToCartSignalsUniqID}
Get all page-added-to-cart signals for pages: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageAddedToCartSignals

Lightbox Documents/Lightbox Document Pages/Page-viewed-outside-Lightbox Signals

The resource is used to view and create signals that a Lightbox document's pages are viewed outside Lightbox.

Create a page-viewed-outside-Lightbox signal for a page: Method: post
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageViewedOutsideLightboxSignals
Get a page-viewed-outside-Lightbox signal for a page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageViewedOutsideLightboxSignals/{pageViewedOutsideLightboxSignalsUniqID}
Get all page-viewed-outside-Lightbox signals for a page: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentPages/{LightboxDocumentPageId}/child/pageViewedOutsideLightboxSignals

Lightbox Documents/Lightbox Scoring Signals

The resource is used to view the signals captured when a document is downloaded.

Get a signal for a downloaded document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentDownloadSignals/{documentDownloadSignalsUniqID}
Get all signals for downloaded documents: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/documentDownloadSignals

Lightbox Documents/Shared-person Instances

The shared person resource is used to view, create, and delete document shares. A document share lets you share the Lightbox document with another user.

Create a shared-person instance for a document: Method: post
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/sharedPersons
Delete a shared-person instance for a document: Method: delete
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/sharedPersons/{sharedPersonsUniqID}
Get a shared-person instance for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/sharedPersons/{sharedPersonsUniqID}
Get all shared-person instances for a document: Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/sharedPersons

Lightbox Presentation Session Feedback

The lightbox presentation session feedback resource is used to view, create, update, and delete the ratings and comments from the attendees at a Lightbox presentation session. The feedback may apply to an individual Lightbox document page or to an overall Lightbox document presented during a presentation session.

Create a lightbox presentation session feedback item: Method: post
Path: /crmRestApi/resources/11.13.18.05/presentationSessionFeedback
Delete a lightbox presentation session feedback item: Method: delete
Path: /crmRestApi/resources/11.13.18.05/presentationSessionFeedback/{presentationSessionFeedbackUniqID}
Get a lightbox presentation session feedback item: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessionFeedback/{presentationSessionFeedbackUniqID}
Get all lightbox presentation session feedback items: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessionFeedback
Update a lightbox presentation session feedback item: Method: patch
Path: /crmRestApi/resources/11.13.18.05/presentationSessionFeedback/{presentationSessionFeedbackUniqID}

Lightbox Presentation Sessions

The lightbox presentation sessions resource is used to view, create, update, and delete the occasions when Lightbox documents were presented to an audience. A session may be directly correlated to an activity, such as an appointment, call report, or task, or may be an ad-hoc session presented at a particular date and time without any association with an activity.

Create a Lightbox presentation session: Method: post
Path: /crmRestApi/resources/11.13.18.05/presentationSessions
Delete a Lightbox presentation session: Method: delete
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}
Get a Lightbox presentation session: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}
Get all Lightbox presentation sessions: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions
Update a Lightbox presentation session: Method: patch
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}

Lightbox Presentation Sessions/Presentation Session Attendance Events

The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.

Create a Lightbox presentation session attendance event: Method: post
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionAttendanceEvents
Get a Lightbox presentation session attendance event: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionAttendanceEvents/{sessionAttendanceEventsUniqID}
Get all Lightbox presentation session attendance events: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionAttendanceEvents

Lightbox Presentation Sessions/Presentation Session Display Events

The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.

Create a Lightbox presentation session display event: Method: post
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionDisplayEvents
Get a Lightbox presentation session display event: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionDisplayEvents/{sessionDisplayEventsUniqID}
Get all Lightbox presentation session display events: Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionDisplayEvents

Link Templates

The work order link templates resource is used to view, create, update and delete work order link templates. A link template is a configuration record used to hold information about the type of link relationships that are available between field service customer work orders.

Create a link template: Method: post
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates
Delete a link template: Method: delete
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}
Get a link template: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}
Get all link templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates
Update a link template: Method: patch
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}

Link Templates/Link Template Translations

The work order link template translations resource shows all the translatable values for the work order link templates resource.

Create a link template translation: Method: post
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}/child/WoLinkTemplateTranslation
Delete a link template translation: Method: delete
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}/child/WoLinkTemplateTranslation/{WoLinkTemplateTranslationUniqID}
Get a link template translation: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}/child/WoLinkTemplateTranslation/{WoLinkTemplateTranslationUniqID}
Get all link template translations: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}/child/WoLinkTemplateTranslation
Update a link template translation: Method: patch
Path: /crmRestApi/resources/11.13.18.05/svcWoLinkTemplates/{LinkTemplateId}/child/WoLinkTemplateTranslation/{WoLinkTemplateTranslationUniqID}

Links

The work order link resource is used to view, create, and delete a customer work order link. A work order link is a transactional record, which is created when a customer needs to define a relationship between field service work orders.

Create a work order link: Method: post
Path: /crmRestApi/resources/11.13.18.05/svcWorkOrderLinks
Delete a work order link: Method: delete
Path: /crmRestApi/resources/11.13.18.05/svcWorkOrderLinks/{WoLinkId}
Get a work order link: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWorkOrderLinks/{WoLinkId}
Get all work order links: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWorkOrderLinks

List of Values/Access Group Relationships

The access group relationships resource is used to view the relationships between the source and target objects.

Get all access group relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupRelationships
Get an access group relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/accessGroupRelationships/{RelationshipId}

List of Values/Activity Functions

The activity function lookup resource is used to view the list of activity functions. Activity function types group activities as appointments, tasks and call reports.

Get all activity functions: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups
Get an activity function: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}

List of Values/Activity Functions/Activity Type Lookups

The activity type lookup resource is used to view the activity types for an activity function. Activity types are used to further define an activity function.

Get all activity types: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}/child/activityTypeLookup
Get an activity type: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}/child/activityTypeLookup/{activityTypeLookupUniqID}

List of Values/Activity Functions/Activity Type Lookups/Activity Subtypes

The activity subtype lookup resource is used to view the activity subtypes for an Activity type and Activity Function. The activity subtypes provide additional detail to track activities.

Get all activity subtypes: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}/child/activityTypeLookup/{activityTypeLookupUniqID}/child/activitySubtypeLookup
Get an activity subtype: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}/child/activityTypeLookup/{activityTypeLookupUniqID}/child/activitySubtypeLookup/{ActivitySubtypeId}

List of Values/Activity Subtypes

The activity subtype lookup resource is used to view the activity subtypes for an Activity type and Activity Function. The activity subtypes provide additional detail to track activities.

Get all activity subtypes: Method: get
Path: /crmRestApi/resources/11.13.18.05/activitySubtypesLOV
Get an activity subtype: Method: get
Path: /crmRestApi/resources/11.13.18.05/activitySubtypesLOV/{ActivitySubtypeId}

List of Values/Activity Type Lookups

The activity type lookup resource is used to view the activity types for an activity function. Activity types are used to further define an activity function.

Get all activity types: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTypeLookupsLOV
Get an activity type: Method: get
Path: /crmRestApi/resources/11.13.18.05/activityTypeLookupsLOV/{activityTypeLookupsLOVUniqID}

List of Values/Application Roles

The application roles resource is to view security roles. An application role is a security role in the system, and include both Duty roles and Job roles.

Get a single application role: Method: get
Path: /crmRestApi/resources/11.13.18.05/applicationRoles/{apiName}
Get all application roles: Method: get
Path: /crmRestApi/resources/11.13.18.05/applicationRoles

List of Values/Assessment Templates

The assessment templates resource is used to view the assessment templates. It stores the templates associated with assessments.

Create a deep copy template: Method: post
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV/action/deepCopyTemplate
Deploy template: Method: post
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV/action/deployTemplate
Get all assessment templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV
Get an assessment template: Method: get
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV/{AssessTemplateId}
Get total question weightage: Method: post
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV/action/getTotalQtnWeight
Setup score ranges: Method: post
Path: /crmRestApi/resources/11.13.18.05/assessmentTemplatesLOV/action/setupScoreRanges

List of Values/Attributes Values

The rule attribute values list of values resource is used to view the list of the values associated to a rule attribute or qualifier.

Get a rule attribute value: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleAttributeValuesLOV/{incentiveCompensationRuleAttributeValuesLOVUniqID}
Get all rule attribute values: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleAttributeValuesLOV

List of Values/Availability Resource

The Work Order Available Resources resource lets you view resources from Oracle Field Service for direct assignment based on criteria in the request.

Get a matched resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources/{ResourceId}
Get all matched resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources

List of Values/Availability Resource/Availability

The Availability resource lets you view availability for resources from Oracle Field Service.

Get all availability for a matched resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources/{ResourceId}/child/Availability
Get an availability for a matched resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources/{ResourceId}/child/Availability/{AvailabilityUniqID}

List of Values/Availability Resource/Time Slots

The time slot resource lets you view all times slots used in Oracle Field Service.

Get a time slot: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources/{ResourceId}/child/TimeSlotInfo/{Label}
Get all time slots: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoDAAvailableResources/{ResourceId}/child/TimeSlotInfo

List of Values/Benefits

The benefit list type values list of values resource is used to get the benefit list type values.

Get a benefit list type value: Method: get
Path: /crmRestApi/resources/11.13.18.05/benefitListTypeValuesLOV/{BenefitListTypeValId}
Get all benefit list type values: Method: get
Path: /crmRestApi/resources/11.13.18.05/benefitListTypeValuesLOV

List of Values/Business Units

The business units list of values resource is used to view the list of defined business units.

Get a business unit: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV/{incentiveCompensationBusinessUnitsLOVUniqID}
Get all business units: Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

List of Values/CRM Business Units

The CRM business units resource is used to view the business unit details.

Get a business unit: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}
Get all business units: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits

List of Values/CRM Business Units/Assessment Templates

The assesment templates resource is used to view the assesment templates. It stores the templates associated with assessments.

Create a deep copy template: Method: post
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates/action/deepCopyTemplate
Deploy template: Method: post
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates/action/deployTemplate
Get all assessment templates: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates
Get an assessment template: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates/{AssessTemplateId}
Get total question weightage: Method: post
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates/action/getTotalQtnWeight
Setup score ranges: Method: post
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates/action/setupScoreRanges

List of Values/CRM Business Units/Common Set Id Lookups

The common set id lookups resource is used to view lookup values for set id enabled lookup types.

Get a set id enabled lookup value: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/fndCommonSetIdLookups/{fndCommonSetIdLookupsUniqID}
Get all common set id enabled lookup values: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/fndCommonSetIdLookups

List of Values/CRM Business Units/Opportunity Status Values

The opportunity status values resource is used to view the opportunity status value. The configurable setup data is defined specifically for sales usage.

Get all opportunity status values: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/optyStatus
Get an opportunity status value: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/optyStatus/{LookupValuesId}

List of Values/CRM Business Units/Sales Methods

The sales methods resource is used to view an approach which is used in the sales process. A method can encompass every stage associated with the sales process such as prospecting, forecasting, or closing opportunities.

Get a sales method: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}
Get all sales methods: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods

List of Values/CRM Business Units/Sales Methods/Sales Stages

The sales stages resource is used to view the sales stage. The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.

Get a sales stage: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}
Get all sales stages: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage

List of Values/CRM Business Units/Sales Methods/Sales Stages/Attachments

The attachments resource is used to view, create, and update attachments.

Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments/{AttachmentsUniqID}

List of Values/CRM Business Units/Sales Methods/Sales Stages/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

List of Values/CRM Business Units/Sales Methods/Sales Stages/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

List of Values/CRM Business Units/Sales Methods/Sales Stages/Sales Stage Process Steps

The sales stage process steps resource is used view the sales stage process steps. It is a sequence of recommended steps tied to a particular sales stage which is used to guide the sales representative through the opportunity lifecycle.

Get a sales stage process step: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/SalesStageProcessSteps/{StgProcessStepId}
Get all sales stage process steps: Method: get
Path: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods/{SalesMethodId}/child/SalesStage/{StgId}/child/SalesStageProcessSteps

List of Values/Capacity Categories

The capacity categories resource is used to view capacity categories used in Oracle Field Service Cloud.

Get a capacity category: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}
Get all capacity catagories: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities

List of Values/Capacity Categories/Capacities

The capacities resource is used to view capacities used in Oracle Field Service Cloud.

Get a capacity: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/Capacity/{CapacityUniqID}
Get all capacities: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/Capacity

List of Values/Capacity Categories/Time Slots

The time slots resource is used to view all times slots used in Oracle Field Service Cloud.

Get a time slot: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/TimeSlotInfo/{Label}
Get all time slots: Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/TimeSlotInfo

List of Values/Channel Types

The channel types resource is used to view the list of communication channels, such as Phone, Email, SMS, Social, and so on.

Get a channel type: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/{LookupCode}
Get all channel types: Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV

List of Values/Channel Types/Channels

A list of channels associated with a channel type.

Get a channel asso