All REST Endpoints

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/{AccessGroupMemberId}
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/{AccessGroupMemberId}
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
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}
Get all accounts
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts
Get an account
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}
Update an account
Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}
Accounts/Account Attachments
The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.
Get all attachments
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment
Get an attachment
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachedDocumentId}
Remove an attachment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachedDocumentId}
Replace an attachment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachedDocumentId}
Upload an attachment
Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment
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/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 addtitional 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 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/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/Primary Addresses
The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.
Create a primary address
Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress
Delete a primary address
Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get a primary address
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get all primary addresses
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress
Update a primary address
Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Accounts/Relationships
The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.
Create a relationship
Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship
Delete a relationship
Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get a relationship
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get all relationships
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship
Update a relationship
Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Accounts/Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Get a smart action (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}
Get all smart actions
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions
Accounts/Smart Actions/Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Get all action URL bindings (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action URL binding (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}
Accounts/Smart Actions/Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Get all action request payload (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload
Get an action request payload (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}
Accounts/Smart Actions/Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Get all action navigations (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation
Get an action navigation (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Accounts/Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.
Create a source system reference
Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference
Delete a source system reference
Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references
Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference
Update a source system reference
Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Action 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}
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.
Adds adhoc actions to action plans
Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans
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}
Refresh an action plan
Method: post
Path: /crmRestApi/resources/11.13.18.05/actionplans
Update an Action Plan
Method: patch
Path: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}
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 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 an activity
Method: post
Path: /crmRestApi/resources/11.13.18.05/activities
Delete an activity
Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}
Get all activities
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities
Get an activity
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}
Update an activity
Method: patch
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}
Activities/Activity Assignees
The activity assignees resource is used to view, create, update, and delete the internal resources assigned to an activity.
Create an activity assignee
Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee
Delete an activity assignee
Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee/{ActivityAssigneeUniqID}
Get all activity assignees
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee
Get an activity assignee
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee/{ActivityAssigneeUniqID}
Update an activity assignee
Method: patch
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee/{ActivityAssigneeUniqID}
Activities/Activity Attachments
The activity attachments resource is used to view, create, update, and delete attachments of an activity. An attachment includes additional information about an activity.
Create an activity attachment
Method: post
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments
Delete an activity attachment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments/{AttachedDocumentId}
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/{AttachedDocumentId}
Update an activity attachment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/Attachments/{AttachedDocumentId}
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/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/Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Get a smart action (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{UserActionId}
Get all smart actions
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions
Activities/Smart Actions/Smart Action REST Path Parameter Definitions
The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
GET all action URL bindings (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding
GET an action URL binding (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}
Activities/Smart Actions/Smart Action REST Payload Definitions
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 payloads (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload
GET an action request payload (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}
Activities/Smart Actions/Smart Action User Interface Definitions
The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
GET all action navigations (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation
GET an action navigation (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
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.
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/{StyleFmtLayoutId}
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 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 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/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/{AttachedDocumentId}
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/{AttachedDocumentId}
Update an attachment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/attachments/{AttachedDocumentId}
Upload an attachment
Method: post
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/attachments
Assets/Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Get a smart action (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{UserActionId}
Get all smart actions
Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions
Assets/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/assets/{AssetId}/child/smartActions/{UserActionId}/child/UserActionURLBinding
GET an action URL binding (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}
Assets/Smart Actions/Smart Action REST Payload Definitions
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 payloads (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload
GET an action request payload (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}
Assets/Smart Actions/Smart Action User Interface Definitions
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/assets/{AssetId}/child/smartActions/{UserActionId}/child/UserActionNavigation
GET an action navigation (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Attribute Predictions
The attribute predictions resource is used to view, create, update, and delete an attribute prediction.
Create an attribute prediction
Method: post
Path: /crmRestApi/resources/11.13.18.05/attributePredictions
Delete an attribute prediction
Method: delete
Path: /crmRestApi/resources/11.13.18.05/attributePredictions/{AttrPredictionId}
Get all attribute predictions
Method: get
Path: /crmRestApi/resources/11.13.18.05/attributePredictions
Get an attribute prediction
Method: get
Path: /crmRestApi/resources/11.13.18.05/attributePredictions/{AttrPredictionId}
Update an attribute prediction
Method: patch
Path: /crmRestApi/resources/11.13.18.05/attributePredictions/{AttrPredictionId}
Attributes Values LOVs
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
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/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}
Business Plans
The business plans resource is used to view, create, update, and delete business plans. A business plan represents a mutual commitment between two or more parties to work together in order to achieve common goals.
Create a business plan
Method: post
Path: /crmRestApi/resources/11.13.18.05/businessPlans
Delete a business plan
Method: delete
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}
Get a business plan
Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}
Get all business plans
Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans
Update a business plan
Method: patch
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}
Business Plans/Business Plan Resources
Business plan resources is used to view, create, update, and delete the team members associated with a business plan.
Create a business plan resource
Method: post
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource
Delete a business plan resource
Method: delete
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}
Get a business plan resource
Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}
Get all business plan resources
Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource
Update a business plan resource
Method: patch
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}
Business Plans/Notes
The notes resource is used to view, create, update, and delete notes associated with a business plan. A note captures comments, information, or instructions related to an business plan.
Create a business plan note
Method: post
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note
Delete a business plan note
Method: delete
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note/{NoteId}
Get a business plan note
Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note/{NoteId}
Get all business plan notes
Method: get
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note
Update a business plan note
Method: patch
Path: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note/{NoteId}
Business Plans/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}
Business Units List of Values
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/{OrganizationId}
Get all business units
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV
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 Transactions
The simulation transactions resource is used to view, create, update, and delete transactions associated with a calculation simulation.
Create a simulation transaction
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions
Delete a simulation transaction
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}
Get a simulation transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}
Get all simulation transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions
Update a simulation transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}
Calculation Simulations/Simulation Transactions/Simulation Credits
The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.
Create a simulation credit
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits
Delete a simulation credit
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits/{CreditId}
Get a simulation credit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits/{CreditId}
Get all simulation credits
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits
Update a simulation credit
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits/{CreditId}
Calculation Simulations/Simulation Transactions/Simulation Transaction Descriptive Flex Fields
The simulation transaction descriptive flex fields resource is used to view and create additional attributes of the transaction that are used during the simulation.
Create a simulation transaction descriptive flex field
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/SimulationTransactionDFF
Get a simulation transaction descriptive flex field
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/SimulationTransactionDFF/{SimulationTransactionDFFUniqID}
Get all simulation transaction descriptive flex fields
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/SimulationTransactionDFF
Campaign Members
The campaign members resource is used to view, create, update, and delete the members associated with a sales campaign.
Create a campaign member
Method: post
Path: /crmRestApi/resources/11.13.18.05/campaignMembers
Delete a campaign member
Method: delete
Path: /crmRestApi/resources/11.13.18.05/campaignMembers/{CampaignMemberNumber}
Get a campaign member
Method: get
Path: /crmRestApi/resources/11.13.18.05/campaignMembers/{CampaignMemberNumber}
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/{CampaignMemberNumber}
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}
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}
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/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 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}
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
Method: post
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups
Delete a product group
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
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/{AttachedDocumentId}
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/{AttachedDocumentId}
Update an attachment.
Method: patch
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/Attachments/{AttachedDocumentId}
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
Method: post
Path: /crmRestApi/resources/11.13.18.05/catalogProductGroups/{ProductGroupDenormId}/child/ProductGroupTranslation
Delete a product group translation
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
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
Method: post
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems
Delete a product item
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
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/{AttachedDocumentId}
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/{AttachedDocumentId}
Update an attachment.
Method: patch
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments/{AttachedDocumentId}
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
Method: post
Path: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/ItemTranslation
Delete an item translation
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
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 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 (Not supported)
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}
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/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}
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, collaboration between Slack users and engagement cloud users to resolve an SR or a sales persons getting opportunity details from 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}
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/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 competitor accounts resource is used to view, create, and update a competitor account and manage competitor details. A competitor is an organization that competes with the deploying organization in the market for sales.
Create a competitor
Method: post
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts
Get a competitor
Method: get
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}
Get a competitor
Method: get
Path: /crmRestApi/resources/11.13.18.05/competitors/{PartyId}
Get all competitors
Method: get
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts
Get all competitors
Method: get
Path: /crmRestApi/resources/11.13.18.05/competitors
Update a competitor
Method: patch
Path: /crmRestApi/resources/11.13.18.05/competitorAccounts/{PartyId}
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}
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/{AttachedDocumentId}
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/{AttachedDocumentId}
Replace a contact's picture
Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{AttachedDocumentId}
Upload a contact's picture
Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment
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/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/{AttachedDocumentId}
Remove an attachment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachedDocumentId}
Replace an attachment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachedDocumentId}
Upload an attachment
Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment
Contacts/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/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/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/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
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Get a smart action (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}
Get all smart actions
Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions
Contacts/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/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action URL binding (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}
Contacts/Smart Actions/Smart Action REST Payload Definitions
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/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload
Get an action request payload (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}
Contacts/Smart Actions/Smart Action User Interface Definitions
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/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation
Get an action navigation (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Contacts/Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.
Create a source system reference
Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference
Delete a source system reference
Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference
Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references
Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference
Update a source system reference
Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Contest Scores
Contest Scores
Get a contest score
Method: get
Path: /crmRestApi/resources/11.13.18.05/contestScores/{contestScoresUniqID}
Get all contest scores
Method: get
Path: /crmRestApi/resources/11.13.18.05/contestScores
Contest Scores/Contest Score Details
Contest Score Details
Get a contest score detail record
Method: get
Path: /crmRestApi/resources/11.13.18.05/contestScores/{contestScoresUniqID}/child/ContestScoreDetails/{ContestScoreDetailsUniqID}
Get all contest score details
Method: get
Path: /crmRestApi/resources/11.13.18.05/contestScores/{contestScoresUniqID}/child/ContestScoreDetails
Contests
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
Conversation Messages
The conversation messages resource is used to view, create, update, and delete the messages sent and received by the application.
Create a conversation message
Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages
createConversationMessageForBusinessObject
Method: post
Path: /crmRestApi/resources/11.13.18.05/conversationMessages
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/{AttachedDocumentId}
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/{AttachedDocumentId}
Update an attachment.
Method: patch
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/attachments/{AttachedDocumentId}
Conversation Messages/Conversation Message Recipients
The conversation message recipients resource is used to view, create, update, and delete the recipients of a message.
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
Update a conversation message recipient
Method: patch
Path: /crmRestApi/resources/11.13.18.05/conversationMessages/{MessageNumber}/child/recipients/{RecipientId}
Conversations
The conversations resource is used to view and update the conversations between multiple people.
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
The conversation references resource is used to view, create, update, and delete the business objects associated with a conversation, such as Service Requests or Sales Leads.
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}
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: /crmRestApi/resources/11.13.18.05/fndCurrencies/{CurrencyCode}
Get all currencies.
Method: get
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
getBindCurrencyCode
Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
getBindCurrencyFlag
Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
getBindEnabledFlag
Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
getBindName
Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
getBindSysdate
Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
getCurrentDatabaseDate
Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
setBindCurrencyCode
Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
setBindCurrencyFlag
Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
setBindEnabledFlag
Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
setBindName
Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
setBindSysdate
Method: post
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies
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
Get address data
Method: post
Path: /crmRestApi/resources/11.13.18.05/daaSSmartData
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.
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/{DealId}
Get all deal registrations
Method: get
Path: /crmRestApi/resources/11.13.18.05/deals
Update a deal registration
Method: patch
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}
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/{DealId}/child/DealProduct
Delete a deal product
Method: delete
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/DealProduct/{DealProdId}
Get a deal product
Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/DealProduct/{DealProdId}
Get all deal products
Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/DealProduct
Update a deal product
Method: patch
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/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/{DealId}/child/DealResources
Delete a deal team member
Method: delete
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/DealResources/{DealResourceId}
Get a deal team member
Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/DealResources/{DealResourceId}
Get all deal team members
Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/DealResources
Update a deal team member
Method: patch
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/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/{DealId}/child/Note
Delete a note
Method: delete
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/Note/{NoteId}
Get a note
Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/Note/{NoteId}
Get all notes
Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/Note
Update a note
Method: patch
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/Note/{NoteId}
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/{DealId}/child/MatchedOpportunity
Copy matched opportunity
Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/MatchedOpportunity
Get all opportunities
Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/MatchedOpportunity
Get an opportunity
Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/MatchedOpportunity/{OptyId}
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/{DealId}/child/productGroups/{ProdGroupId}
Get all product groups
Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/productGroups
Set product group usage mode
Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/productGroups
Set product usage code
Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/productGroups
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/{DealId}/child/products/{productsUniqID}
Get all products
Method: get
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/products
Set product usage code
Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/products
Set product usage mode
Method: post
Path: /crmRestApi/resources/11.13.18.05/deals/{DealId}/child/products
Eligible Pay Groups List of Values
The eligible pay groups list of values resource is used to view the list of eligible pay groups that can be used for creating payment batches.
Get all eligible pay groups
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEligiblePayGroupsLOV
Get an eligible pay group
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEligiblePayGroupsLOV/{PayGroupId}
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 adjustment
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
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/{AttachedDocumentId}
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
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/{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}
Expression Detail Items List of Values
The expression detail items list of values resource is used to view the list of values pertaining to all the entities within an expression.
Get all expression detail items
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV
Get an expression detail item
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}
Expression Detail Items List of Values/Expression Detail Basic Attribute Groups
The basic attribute groups resource is used to view the primary attribute groups used in an expression.
Get a basic attribute group
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailBasicAttributeGroups/{expressionDetailBasicAttributeGroupsUniqID}
Get all basic attribute groups
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailBasicAttributeGroups
Expression Detail Items List of Values/Expression Detail Basic Attribute Groups/Expression Detail Basic Attribute Names
The basic attribute names resource is used to view the list of basic attribute names within a basic attribute group used in an expression.
Get a basic attribute name
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailBasicAttributeGroups/{expressionDetailBasicAttributeGroupsUniqID}/child/expressionDetailBasicAttributeNames/{expressionDetailBasicAttributeNamesUniqID}
Get all basic attribute names
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailBasicAttributeGroups/{expressionDetailBasicAttributeGroupsUniqID}/child/expressionDetailBasicAttributeNames
Expression Detail Items List of Values/Expression Detail Function Groups
The function groups resource is used to view the list of SQL functions groups based on the category of the functions they contain, that can be used in an expression.
Get a function group
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailFunctionGroups/{expressionDetailFunctionGroupsUniqID}
Get all function groups
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailFunctionGroups
Expression Detail Items List of Values/Expression Detail Function Groups/Expression Detail Function Names
The function names resource is used to view the list of SQL functions within a specific function group that can be used in an expression.
Get a function name
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailFunctionGroups/{expressionDetailFunctionGroupsUniqID}/child/expressionDetailFunctionNames/{FunctionCode}
Get all function names
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailFunctionGroups/{expressionDetailFunctionGroupsUniqID}/child/expressionDetailFunctionNames
Expression Detail Items List of Values/Expression Detail Operators
The operators resource is used to view the list of mathematical operators that can be used in an expression.
Get all operators
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailOperators
Get an operator
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailOperators/{expressionDetailOperatorsUniqID}
Expression Detail Items List of Values/Expression Detail Performance Measures
The performance measures list of values resource is used to view the list of performance measures for which its attributes can be used in an expression.
Get a performance measure
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPerformanceMeasures/{MeasureId}
Get all performance measures
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPerformanceMeasures
Expression Detail Items List of Values/Expression Detail Performance Measures/Expression Detail Performance Measure Attributes
The performance measure attributes list of values resource is used to view the list of attributes of a performance measure, that can be used in an expression.
Get a performance measure attribute
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPerformanceMeasures/{MeasureId}/child/expressionDetailPerformanceMeasureAttributes/{expressionDetailPerformanceMeasureAttributesUniqID}
Get all performance measure attributes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPerformanceMeasures/{MeasureId}/child/expressionDetailPerformanceMeasureAttributes
Expression Detail Items List of Values/Expression Detail Plan Components
The plan components list of values resource is used to view the list of plan components for which its attributes can be used in an expression.
Get a plan component
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}
Get all plan components
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents
Expression Detail Items List of Values/Expression Detail Plan Components/Expression Detail Plan Component Attributes
The plan component attributes list of values resource is used to view the list of attributes of a plan component that can be used in an expression.
Get a plan component attribute
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}
Get all plan component attributes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes
Expression Detail Items List of Values/Expression Detail Plan Components/Expression Detail Plan Component Attributes/Expression Detail Plan Component Measures
The plan component measures list of values resource is used to view the list of measures within a plan component for which it's attributes can be used in an expression.
Get a plan component performance measure
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}/child/expressionDetailPlanComponentsMeasures/{expressionDetailPlanComponentsMeasuresUniqID}
Get all plan component performance measures
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}/child/expressionDetailPlanComponentsMeasures
Expression Detail Items List of Values/Expression Detail Plan Components/Expression Detail Plan Component Attributes/Expression Detail Plan Component Measures/Expression Detail Plan Component Measure Result Attributes
The plan component measure result attributes list of values resource is used to view the list of attributes of a performance measure within a plan component that can be used in an expression.
Get a plan component measure result attribute
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}/child/expressionDetailPlanComponentsMeasures/{expressionDetailPlanComponentsMeasuresUniqID}/child/expressionDetailPlanComponentsMeasureResultAttributes/{expressionDetailPlanComponentsMeasureResultAttributesUniqID}
Get all plan component measure result attributes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailPlanComponents/{expressionDetailPlanComponentsUniqID}/child/expressionDetailPlanComponentAttributes/{expressionDetailPlanComponentAttributesUniqID}/child/expressionDetailPlanComponentsMeasures/{expressionDetailPlanComponentsMeasuresUniqID}/child/expressionDetailPlanComponentsMeasureResultAttributes
Expression Detail Items List of Values/Expression Detail User Defined Functions
The user defined functions list of values resource is used to view the list of predefined PL/SQL functions that can be used in an expression.
Get a user defined function
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailUserDefinedFunctions/{expressionDetailUserDefinedFunctionsUniqID}
Get all user defined functions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/expressionDetailUserDefinedFunctions
Expression Detail Items List of Values/Expression Detail User Defined Query Value Sets
The user defined query value sets list of values resource is used to view the list of user defined queries which were created using table value sets. These user defined queries can be used in an expression.
Get a user defined query
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/ExpressionDetailUserDefinedQueryValueSets/{ValueSetId}
Get all user defined queries
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionDetailItemsLOV/{incentiveCompensationExpressionDetailItemsLOVUniqID}/child/ExpressionDetailUserDefinedQueryValueSets
Expression Usages List of Values
The expression usages list of values resource is used to view the list of expression usages which indicate where an expression can be used.
Get all expression usages
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionUsagesLOV
Get an expression usage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionUsagesLOV/{ExpressionUsageId}
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/{ForecastItemId}
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/{ForecastItemId}
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/{RevnId}
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
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 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}
HCM Service Requests
The HR help desk service requests resource is used to view, create, update, and delete a request. It is a document to track a request for service from the time the person makes the request until the request is resolved. For example, an employee logs a service request that their last paycheck has not deposited.
Create a service request
Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests
Delete a service request
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}
Get a service request
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}
Get all service requests
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests
Update a service request
Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}
HCM Service Requests/Activities
This is used to capture task and appointment information.
(create a new item in activities)
Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/activities
(delete an item of activities)
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/activities/{ActivityId}
(query activities)
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/activities
(query activities)
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/activities/{ActivityId}
(update an item of activities)
Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/activities/{ActivityId}
HCM 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/{hrHelpDeskRequestsUniqID}/child/Attachment
Delete an attachment.
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/Attachment/{AttachedDocumentId}
Get all attachments.
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/Attachment
Get an attachment.
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/Attachment/{AttachedDocumentId}
Update an attachment.
Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/Attachment/{AttachedDocumentId}
HCM Service Requests/Channel 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
Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/channelCommunication
Delete a channel communication
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/channelCommunication/{channelCommunicationUniqID}
Get a channel communication
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/channelCommunication/{channelCommunicationUniqID}
Get all channel communications
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/channelCommunication
Update a channel communication
Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/channelCommunication/{channelCommunicationUniqID}
HCM Service Requests/Contact Members
The contacts resource is used to view, create, update, and delete contacts. It is a list of workers associated with a service request. For example, the agent can communicate with a worker and their manager. Agents communicate service request resolutions or other information with contacts. Communication channels include email and phone.
Create a contact member
Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/contacts
Delete a contact member
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/contacts/{MemberId}
Get a contact member
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/contacts/{MemberId}
Get all contact members
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/contacts
Update a contact member
Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/contacts/{MemberId}
HCM Service Requests/Interaction References
The interaction references resource is used to view an interaction reference. It indicates the relationship between an interaction and service request. For example, object attributes include interaction identifier and service request identifier.
Get a service request interaction
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srInteractionReferences/{ReferenceId}
Get all service request interactions
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srInteractionReferences
HCM Service Requests/Messages
The messages resource is used to view, create, update, and delete a message. It contains information about every communication update to the service request, both from the agent and the workers. An example stored message could be: We have corrected your hourly wage. You should see a the correction and retroactive pay in your next paycheck.
Create a message
Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages
Delete a message
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}
Get a message
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}
Get all messages
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages
Update a message
Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}
HCM 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/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}/child/Attachment
Delete an attachment.
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}/child/Attachment/{AttachedDocumentId}
Get all attachments.
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}/child/Attachment
Get an attachment.
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}/child/Attachment/{AttachedDocumentId}
Update an attachment.
Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}/child/Attachment/{AttachedDocumentId}
HCM Service Requests/Messages/Message Channels
The channel communications resource is used to view, create, update, and delete a channel communication. It is 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 message
Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}/child/channelCommunication
Delete a channel communication message
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}/child/channelCommunication/{channelCommunicationUniqID}
Get a channel communication message
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}/child/channelCommunication/{channelCommunicationUniqID}
Get all channel communication messages
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}/child/channelCommunication
Update a channel communication message
Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/messages/{MessageId}/child/channelCommunication/{channelCommunicationUniqID}
HCM Service Requests/Milestones
The milestones resource is used to view, create, update, and delete a milestone. It contains the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours, and a resolution time of 3 days for service requests with severity level 2.
Create a service request milestone
Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srMilestone
Delete a service request milestone
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srMilestone/{SrMilestoneId}
Get a service request milestone
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srMilestone/{SrMilestoneId}
Get all service request milestones
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srMilestone
Update a service request milestone
Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srMilestone/{SrMilestoneId}
HCM Service Requests/Milestones/Milestones History
The milestone history resource is used view, create, update, and delete a milestone history. It tracks the history of changes in the milestone status for a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.
Create a service request milestone history
Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory
Delete a service request milestone history
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory/{HistoryId}
Get a service request milestone history
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory/{HistoryId}
Get all service request milestone history
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory
Update a service request milestone history
Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory/{HistoryId}
HCM Service Requests/Resources
The resource members resource is used to view, create, update, and delete a resource member. It is a list of agents, agent managers and subject matter experts who are associated with a service request. Multiple service request resources may be involved in resolving a service request.
Create a resource member
Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/resourceMembers
Delete a resource member
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/resourceMembers/{MemberId}
Get a resource member
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/resourceMembers/{MemberId}
Get all resource members
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/resourceMembers
Update a resource member
Method: patch
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/resourceMembers/{MemberId}
HCM Service Requests/Service Request References
The service request references resource is used to view, create, and delete a reference. It is a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.
Create a service request reference
Method: post
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srReferences
Delete a service request reference
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srReferences/{ReferenceId}
Get a service request reference
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srReferences/{ReferenceId}
Get all service request references
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srReferences
HCM 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/{hrHelpDeskRequestsUniqID}/child/srTags
Delete a tag
Method: delete
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srTags/{srTagsUniqID}
Get a tag
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/child/srTags/{srTagsUniqID}
Get all tags
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{hrHelpDeskRequestsUniqID}/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/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 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/{AttachedDocumentId}
Remove an attachment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachedDocumentId}
Replace an attachment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachedDocumentId}
Upload an attachment
Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment
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 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/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/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
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/households/{PartyNumber}/child/SalesTeamMember
Delete a sales team member
Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get a sales team member
Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get all sales team members
Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember
Update a sales team member
Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Households/Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.
Create a source system reference
Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference
Delete a source system reference
Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference
Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references
Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference
Update a source system reference
Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
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}
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 view, create, process, and update a list of inbound customer messages that need a response. For example, a message indicating that a customer's mobile camera is not functional.
Create an inbound message
Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMessages
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 inbound messages
Method: post
Path: /crmRestApi/resources/11.13.18.05/inboundMessages
Update an inbound message
Method: patch
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}
Inbound Messages/Attachments
The attachments resource is used to view, create, 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/{AttachedDocumentId}
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/{AttachedDocumentId}
Update an attachment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments/{AttachedDocumentId}
Inbound Messages/Inbound Message Parts
The inbound message parts resource is used to view, create, update, and delete the list of components in 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}
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 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 Transactions
The incentive compensation transactions resource is used to view, create, and update transactions, such as order, invoice, and so on.
Create a transaction
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions
Get a transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}
Get all transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions
Update a transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}
Incentive Compensation Transactions/Credits
The credits resource is used to view, create, and update the credits for a transaction.
Create a credit
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits
Get a credit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits/{CreditId}
Get all credits
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits
Update a credit
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/Credits/{CreditId}
Incentive Compensation Transactions/Transaction Descriptive Flex Fields
The transaction descriptive flex fields resource is used to view, create, and update additional attributes of the transaction that are used for classification, crediting, calculating, and reporting.
Create a transaction descriptive flex field
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF
Get a transaction descriptive flex field
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF/{TransactionId2}
Get all transactions descriptive flex field
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF
Update a transaction descriptive flex field
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationTransactions/{TransactionId}/child/TransactionsDFF/{TransactionId2}
Interactions
The interaction resource is used to view, create, and update the interactions between a customer and an agent.
Create an interaction
Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions
Get all interactions
Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions
Get an interaction
Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}
Update an interaction
Method: patch
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}
Interactions/Child Interactions
The child interaction resource is used to view, create, and update all the child interactions associated with the current interaction.
Create a child interaction
Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions
Get a child interaction
Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/childInteractions/{InteractionId2}
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/{InteractionId2}
Interactions/Interaction References
The interaction reference resource is used to view, create, and update the association between a interaction and another business object, for example Service Requests.
Create an interaction reference
Method: post
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences
Get all interaction references
Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences
Get an interaction reference
Method: get
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences/{ReferenceId}
Update an interaction reference
Method: patch
Path: /crmRestApi/resources/11.13.18.05/interactions/{InteractionId}/child/interactionReferences/{ReferenceId}
Internal Service Requests
The HR help desk service requests resource is used to view, create, update, and delete a request. It is a document to track a request for service from the time the person makes the request until the request is resolved. For example, an employee logs a service request that their last paycheck has not deposited.
Create a service request
Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests
Delete a service request
Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}
Get a service request
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}
Get all service requests
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests
Update a service request
Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}
Internal Service Requests/Activities
This is used to capture task and appointment information.
Create a new activity
Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities
Delete an activity
Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}
Get all activities
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities
Get an activity
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}
Update an activity
Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/activities/{ActivityId}
Internal Service Requests/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/{AttachedDocumentId}
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/{AttachedDocumentId}
Update an attachment.
Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/Attachment/{AttachedDocumentId}
Internal Service Requests/Channel 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
Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication
Delete a channel communication
Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}
Get a channel communication
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}
Get all channel communications
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication
Update a channel communication
Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/channelCommunication/{channelCommunicationUniqID}
Internal Service Requests/Contact Members
The contacts resource is used to view, create, update, and delete contacts. It is a list of workers associated with a service request. For example, the agent can communicate with a worker and their manager. Agents communicate service request resolutions or other information with contacts. Communication channels include email and phone.
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
The interaction references resource is used to view an interaction reference. It indicates the relationship between an interaction and service request. For example, object attributes include interaction identifier and service request identifier.
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/Messages
The messages resource is used to view, create, update, and delete a message. It contains information about every communication update to the service request, both from the agent and the workers. An example stored message could be: We have corrected your hourly wage. You should see a the correction and retroactive pay in your next paycheck.
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/{AttachedDocumentId}
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/{AttachedDocumentId}
Update an attachment.
Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/Attachment/{AttachedDocumentId}
Internal Service Requests/Messages/Message Channels
The channel communications resource is used to view, create, update, and delete a channel communication. It is 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 message
Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication
Delete a channel communication message
Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{channelCommunicationUniqID}
Get a channel communication message
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{channelCommunicationUniqID}
Get all channel communication messages
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication
Update a channel communication message
Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/messages/{MessageId}/child/channelCommunication/{channelCommunicationUniqID}
Internal Service Requests/Milestones
The milestones resource is used to view, create, update, and delete a milestone. It contains the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours, and a resolution time of 3 days for service requests with severity level 2.
Create a service request milestone
Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone
Delete a service request milestone
Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}
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 milestone history resource is used view, create, update, and delete a milestone history. It tracks the history of changes in the milestone status for a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.
Create a service request milestone history
Method: post
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory
Delete a service request milestone history
Method: delete
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory/{HistoryId}
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
Update a service request milestone history
Method: patch
Path: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory/{HistoryId}
Internal Service Requests/Resources
The resource members resource is used to view, create, update, and delete a resource member. It is a list of agents, agent managers and subject matter experts who are associated with a service request. Multiple service request resources may be involved in resolving a 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 References
The service request references resource is used to view, create, and delete a reference. It is a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.
Create a service request reference
Method: post
Path: /crmRestApi/resources/11.13.18.05/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
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
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/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/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 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/{AttendanceEventId}
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/{DisplayEventId}
Get all Lightbox presentation session display events
Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionDisplayEvents
List of Values/Assessment Templates
The assessment templates resource is used to view the assessment templates. It stores the templates associated with assessments.
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}
List of Values/Benefit List Type Values
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/Capacity Categories
The capacity categories resource is used to view capacity categories used in Oracle Field Service Cloud.
Get a capacity category
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}
Get all capacity catagories
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities
List of Values/Capacity Categories/Capacities
The capacities resource is used to view capacities used in Oracle Field Service Cloud.
Get a capacity
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/Capacity/{CapacityUniqID}
Get all capacities
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/Capacity
List of Values/Capacity Categories/Time Slots
The time slots resource is used to view all times slots used in Oracle Field Service Cloud.
Get a time slot
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/TimeSlotInfo/{Label}
Get all time slots
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/TimeSlotInfo
List of Values/Channel Types
The channel types resource is used to view the list of communication channels, such as Phone, Email, SMS, Social, and so on.
Get a channel type
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/{LookupCode}
Get all channel types
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV
List of Values/Channel Types/Channels
A list of channels associated with a channel type.
Get a channel associated with a channel type.
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/{LookupCode}/child/svcChannelLookups/{ChannelId}
Get all channels associated with a channel type.
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/{LookupCode}/child/svcChannelLookups
List of Values/Class Codes
The class codes resource is used to view classification codes for a given classification category.
Get a classification code
Method: get
Path: /crmRestApi/resources/11.13.18.05/classCodes/{classCodesUniqID}
Get all classification codes
Method: get
Path: /crmRestApi/resources/11.13.18.05/classCodes
List of Values/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.
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
List of Values/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}
List of Values/Feedback Ratings
The feedback ratings resource lets you view the list of ratings for a Lightbox document or page.
Get a feedback rating
Method: get
Path: /crmRestApi/resources/11.13.18.05/feedbackRatingsLOV/{RatingValue}
Get all feedback ratings
Method: get
Path: /crmRestApi/resources/11.13.18.05/feedbackRatingsLOV
List of Values/Get Configurations
The get configurations resource is used to view the configuration information of the chat service. The resource can be invoked anonymously using a GET HTTP request with no Authorization header.
The resource is protected by the SVC_GET_CHAT_CONFIGURATIONS_PRIV entitlement that is assigned to the ORA_FND_ANONYMOUS_USER_ABSTRACT role.
By the means of a profile option SVC_CHAT_INLAYS_ACCESS_ENABLED, the customers will decide if they allow access to this method.
- If the profile option has the Y value, the getConfigs method can be called.
- If the profile option has the N value, the method will return a 403 FORBIDDEN http error.
Get a configuration (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/getConfigs/{billingId}
Get all configurations
Method: get
Path: /crmRestApi/resources/11.13.18.05/getConfigs
List of Values/HR Service Request Resolve Outcomes
The HR service request resolve outcomes resource is used to view the resolve outcomes. It contains the top level categories for describing the type of resolution achieved for the HR service request.
Get a resolve outcome
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrSRResolveOutcomeLookups/{LookupCode}
Get all resolve outcomes
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrSRResolveOutcomeLookups
List of Values/HR Service Request Resolve Outcomes/HR Service Request Resolve Outcome Resolutions
The HR service request resolve outcome resolutions resource is used to view the resolve request resolutions. It contains a detailed categorization describing how the chosen outcome was achieved for the HR service request.
Get a resolve outcome resolution
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrSRResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups/{srResolutionLookupsUniqID}
Get all resolve outcome resolutions
Method: get
Path: /crmRestApi/resources/11.13.18.05/hrSRResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups
List of Values/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
List of Values/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
List of Values/Internal Service Request Outcomes
The Internal Service Request outcomes resource lets you view, create, update and delete the top-level categories for describing the outcomes of Internal Service Requests.
Get all outcomes
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalSRResolveOutcomeLookups
Get an outcome
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalSRResolveOutcomeLookups/{LookupCode}
List of Values/Internal Service Request Outcomes/Internal Service Request Outcome Resolutions
The Internal Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for an Internal Service Request.
Get all outcome resolutions
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalSRResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups
Get an outcome resolution
Method: get
Path: /crmRestApi/resources/11.13.18.05/internalSRResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups/{srResolutionLookupsUniqID}
List of Values/KPI
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}
List of Values/Lightbox Document Types
The lightbox document type LOV resource is used to view all Lightbox document types. You can use this to view information specific to a document type.
Get a lightbox document type
Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocumentTypesLOV/{LightboxDocumentType}
Get all lightbox document types
Method: get
Path: /crmRestApi/resources/11.13.18.05/lightboxDocumentTypesLOV
List of Values/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/{SessionFeedbackId}
Get a lightbox presentation session feedback item
Method: get
Path: /crmRestApi/resources/11.13.18.05/presentationSessionFeedback/{SessionFeedbackId}
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/{SessionFeedbackId}
List of Values/Name and ID Types
The name and types resource is used to view the additional name and ID types.
Get a Name and Type
Method: get
Path: /crmRestApi/resources/11.13.18.05/nameAndIdTypes/{TypeCode}
Get All Name And Types
Method: get
Path: /crmRestApi/resources/11.13.18.05/nameAndIdTypes
List of Values/Opportunity Status Values
The opportunity status values resource is used to view the opportunity status values. The configurable setup data is defined specifically for sales usage.
Get all opportunity status values
Method: get
Path: /crmRestApi/resources/11.13.18.05/optyStatusesLOV
Get an opportunity status value
Method: get
Path: /crmRestApi/resources/11.13.18.05/optyStatusesLOV/{LookupValuesId}
List of Values/Partner Contact Managers List of Values
The partner contact managers list of values resource is used to view a list of partner contacts in a managerial role.
Get a partner contact manager
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContactManagersLOV/{GroupMemberId}
Get all partner contact managers
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContactManagersLOV
List of Values/Partner Enrolled Programs List of Values
The partner enrolled programs list of values resource is used to view a list of the partner programs a partner is enrolled in.
Get a partner enrolled program
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerEnrolledProgramsLOV/{ProgramEnrollmentId}
Get all partner enrolled programs
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerEnrolledProgramsLOV
List of Values/Partner Programs
The partner programs list of values resource is used to view the services to find partner programs.
Get a partner program
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramsLOV/{PartnerProgramId}
Get all partner programs
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramsLOV
List of Values/Partner Types List of Values
The partner types list of values resource is used to view a list of the business relationships that are shared with a partner.
Get a partner type
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerTypesLOV/{PartnerDimMembersId}
Get all partner types
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerTypesLOV
List of Values/Phone Country Codes
The country codes resource is used to get the country codes for phone numbers.
Get a Country Code
Method: get
Path: /crmRestApi/resources/11.13.18.05/countryCodes/{PhoneCountryCodeId}
Get all Country Codes
Method: get
Path: /crmRestApi/resources/11.13.18.05/countryCodes
List of Values/Product Groups
The product groups resource is used to view the product group.
Get a product group
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroups/{ProdGrpDetailsId}
Get all product groups
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroups
List of Values/Program Tiers
The program tiers list of values resource is used to view the partner program tiers defined by the channel organization. For example, the partner program tiers may be defined as Gold, Silver, and Bronze.
Get a program tier
Method: get
Path: /crmRestApi/resources/11.13.18.05/programTiersLOV/{ProgramTierId}
Get all program tiers
Method: get
Path: /crmRestApi/resources/11.13.18.05/programTiersLOV
List of Values/Relationship Types
The relationship types resource is used to view the relationship types.
Get a relationship type
Method: get
Path: /crmRestApi/resources/11.13.18.05/relationshipTypes/{relationshipTypesUniqID}
Get all relationship types
Method: get
Path: /crmRestApi/resources/11.13.18.05/relationshipTypes
List of Values/Sales Methods
The sales methods list of values resource is used to view the sales method. A sales method is an approach used in the sales process. A method can encompass every stage associated with the sales process such as prospecting, forecasting, and closing opportunities.
Get a sales method
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMethodsLOV/{SalesMethodId}
Get all sales methods
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesMethodsLOV
List of Values/Sales Stages
The sales stages list of values resource is used to view the sales stage. The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.
Get a sales stage
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesStagesLOV/{StgId}
Get all sales stages
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesStagesLOV
List of Values/Service Business Units
The service business units resource is used to view the units of an enterprise that have been configured to function as customer support or as a human resource help desk.
Get a service business unit
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}
Get all service business units
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits
List of Values/Service Business Units/Business Unit Lookups
The reference set enabled lookups resource is used to view the lookups associated with a business unit.
Get a reference set enabled lookup
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/fndSetEnabledLookups/{fndSetEnabledLookupsUniqID}
Get all reference set enabled lookups
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/fndSetEnabledLookups
List of Values/Service Business Units/Categories
The categories resource is used to view the categories associated with a business unit. Categories are used to group service requests.
Get a category
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/categories/{CategoryId}
Get all categories
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/categories
List of Values/Service Business Units/Channels
The channels resource is used to view the channels associated with a business unit. Channels used to listen and respond to customers.
Get a channel
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/channels/{ChannelId}
Get all channels
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/channels
List of Values/Service Business Units/Profile Options
The profile options resource is used to view the profile options associated with a business unit, such as product catalog usage or email template for service request responses.
Get a profile option
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/profileOptions/{OptionId}
Get all profile options
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/profileOptions
List of Values/Service Lookup Properties
The service lookup properties resource is used to view the list of properties applicable to a lookup code. These properties are used by the application to define the behavior of the lookup code.
Get a service lookup property
Method: get
Path: /crmRestApi/resources/11.13.18.05/lookupProperties/{PropertyId}
Get all service lookup properties
Method: get
Path: /crmRestApi/resources/11.13.18.05/lookupProperties
List of Values/Service Request Outcomes
The service request outcomes resource lets you view, create, update and delete the top-level categories for describing the outcomes of Service Requests.
Get a resolve outcome
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcResolveOutcomeLookups/{LookupCode}
Get all resolve outcomes
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcResolveOutcomeLookups
List of Values/Service Request Outcomes/Service Request Outcome Resolutions
The Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for a Service Request.
Get a resolve outcome resolution
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups/{srResolutionLookupsUniqID}
Get all resolve outcome resolutions
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcResolveOutcomeLookups/{LookupCode}/child/srResolutionLookups
List of Values/Service Request Statuses
The service request statuses resource is used to view a list of possible statuses that can be associated with a service request, such as New, In Progress, Resolved, and so on.
Get a service request status
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceDependentLookupsLOV/{serviceDependentLookupsLOVUniqID}
Get a service request status
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequestStatusesLOV/{serviceRequestStatusesLOVUniqID}
Get all service request statuses
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceDependentLookupsLOV
Get all service request statuses
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequestStatusesLOV
List of Values/Service Work Order Areas
The service work order areas resource is used to view the Oracle Field Service Cloud list of values indicating the bucket resources.
Get a work area
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoAreas/{Id}
Get all work areas
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoAreas
List of Values/Service Work Order Areas/Work Order Areas
The work order areas resource is used to view information about a bucket resource.
Get a work order area
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoAreas/{Id}/child/WorkOrderArea/{WorkOrderArea}
Get all work order areas
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoAreas/{Id}/child/WorkOrderArea
List of Values/Smart Text Folders and Texts
The smart text folders and texts resource is used to view smart text folders or smart texts.
Get a folder or smart text
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolderAndTexts/{UniqueIdentifier}
Get folders and smart texts
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolderAndTexts
List of Values/Smart Text Folders and Texts/Parents
The parents resource is used to view the parent smart text folders or texts.
Get parent folder or smart text
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolderAndTexts/{UniqueIdentifier}/child/ParentFolderIdStandardTextFolderAndText/{UniqueIdentifier2}
Get parent folders and smart texts
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolderAndTexts/{UniqueIdentifier}/child/ParentFolderIdStandardTextFolderAndText
List of Values/Smart Text Objects
The smart text objects resource is used to view business objects enabled for smart texts.
Get a smart text object
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextObjects
Get all smart text objects
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextObjects/{ObjectId}
List of Values/Smart Text Variables
The smart text resource is used to view all available smart text variables. You can use smart text variables to automatically populate information in a smart text.
Get a smart text variable
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextVariables/{VariableId}
Get all smart text variables
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextVariables
List of Values/Source Codes
The source codes resource is used to view the responses and leads generated by each marketing campaign execution, which helps gauge the effectiveness of each initiative. A marketing source code is a unique identifier representing a marketing campaign and its underlying execution.
Get a source code
Method: get
Path: /crmRestApi/resources/11.13.18.05/sourcecodes/{SourceCodeId}
Get all source codes
Method: get
Path: /crmRestApi/resources/11.13.18.05/sourcecodes
List of Values/Tags
The tags resource is used to create, view, and delete keywords or terms assigned to a business object such as service request. Tags help in describing and classifying a busines object.
Create a tag
Method: post
Path: /crmRestApi/resources/11.13.18.05/tags
Delete a tag
Method: delete
Path: /crmRestApi/resources/11.13.18.05/tags/{TagId}
Get a tag
Method: get
Path: /crmRestApi/resources/11.13.18.05/tags/{TagId}
Get all tags
Method: get
Path: /crmRestApi/resources/11.13.18.05/tags
Update a tag
Method: patch
Path: /crmRestApi/resources/11.13.18.05/tags/{TagId}
List of Values/Work Order Status Codes
The work order status codes resource is used to view the work order status. The list of values indicates the status of the work order such as Scheduled, Started, Canceled, Completed, and so on.
Get a work order status code
Method: get
Path: /crmRestApi/resources/11.13.18.05/woStatusCodeLookups/{woStatusCodeLookupsUniqID}
Get all work order status codes
Method: get
Path: /crmRestApi/resources/11.13.18.05/woStatusCodeLookups
List of Values/Work Order Type Mappings
The work order type mappings resource is used to view the work order type mappings. It provides a mapping of work order types to the corresponding integrated system type.
Get a work order type mapping
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoTypeMapLookups/{WoTypeId}
Get all work order type mappings
Method: get
Path: /crmRestApi/resources/11.13.18.05/svcWoTypeMapLookups
Lookups
The lookups resource is used to view standard lookup codes.
Get a lookup.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fndStaticLookups/{fndStaticLookupsUniqID}
Get all lookups.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fndStaticLookups
MDF Requests
The market development fund requests resource is used to view, create, update, and delete an MDF Request. An MDF request is a request for resources to develop and maintain sales and marketing activities.
Create an MDF request
Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfRequests
Delete an MDF request
Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}
Get all MDF requests
Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests
Get an MDF request
Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}
Update an MDF request
Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}
MDF Requests/Claims
The claims resource is used to create, view, create, update, and delete claims. A claim is a request for reimbursement of marketing expenses submitted by a partner.
Create a claim
Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim
Delete a claim
Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim/{ClaimId}
Get a claim
Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim/{ClaimId}
Get all claims
Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim
Update a claim
Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim/{ClaimId}
MDF Requests/MDF Request Teams
The Fund Request Teams resource is used to view, create, update, and delete a team member. An MDF request team member is a resource who is assigned to the MDF request team, and has the appropriate visibility and access to the MDF Request record.
Create a fund request resource
Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource
Delete a fund request resource
Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource/{FundRequestResourceId}
Get a fund request resource
Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource/{FundRequestResourceId}
Get all fund request resource
Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource
Update a fund request resource
Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource/{FundRequestResourceId}
MDF Requests/Notes
The note resource is used to view, create, update, and delete notes associated with an MDF request. A note captures comments, information, or instructions related to an MDF request.
Create a note
Method: post
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note
Delete a note
Method: delete
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note/{NoteId}
Get a note
Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note/{NoteId}
Get all notes
Method: get
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note
Update a note
Method: patch
Path: /crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note/{NoteId}
Milestones
The milestone resource lets you view, create, update, and delete milestones.
Create a milestone
Method: post
Path: /crmRestApi/resources/11.13.18.05/milestones
Delete a milestone
Method: delete
Path: /crmRestApi/resources/11.13.18.05/milestones/{MilestoneConfigId}
Get a milestone
Method: get
Path: /crmRestApi/resources/11.13.18.05/milestones/{MilestoneConfigId}
Get all milestones
Method: get
Path: /crmRestApi/resources/11.13.18.05/milestones
Update a milestone
Method: patch
Path: /crmRestApi/resources/11.13.18.05/milestones/{MilestoneConfigId}
Multi Channel Adapter Events
The multi-channel adapter event is used to view, create, update, and delete the details of an event initiated through the multi-channel adapter. An event can be created and updated through the process event action of the resource for a number of different event names, like newCommEvent, startCommEvent, closeCommEvent, and more.
Create an event
Method: post
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents
Delete an event
Method: delete
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents/{McaEventId}
Fetch the toolbar configuration for the current user used to process multi-channel adapter events.
Method: post
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents
Get all events
Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents
Get an event
Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents/{McaEventId}
Process a multi-channel adapter event
Method: post
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents
Update an event
Method: patch
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents/{McaEventId}
Multi-Channel Adapter Toolbars
The multi-channel adapter toolbars resource is used to view, create, update, and delete toolbars used by the multi-channel adapter framework. It provides configuration of multi-channel adapter toolbars. It support telephony, chat, and other real time integrations.
Create all toolbars
Method: post
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars
Delete a toolbar
Method: delete
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}
Get a toolbar
Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}
Get all toolbars
Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars
Update a toolbar
Method: patch
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}
Multi-Channel Adapter Toolbars/Multi-Channel Adapter Toolbar Additions
The adapter toolbar additions resource is used to view, create, update, and delete additional secondary user areas about a multi-channel adapter toolbar. It provides alternative configuration data for the multi-channel adapter toolbar parent.
Create all toolbar additions
Method: post
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition
Delete a toolbar addition
Method: delete
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition/{ToolbarAddlId}
Get a toolbar addition
Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition/{ToolbarAddlId}
Get all toolbar additions
Method: get
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition
Update a toolbar addition
Method: patch
Path: /crmRestApi/resources/11.13.18.05/multiChannelAdapterToolbars/{ToolbarId}/child/McaToolbarAddition/{ToolbarAddlId}
My Self-Service Roles
The my self-service roles resource is used to view, create, and delete the roles for the self-service user who is currently logged in.
Create a self-service role
Method: post
Path: /crmRestApi/resources/11.13.18.05/mySelfServiceRoles
Delete a self-service role
Method: delete
Path: /crmRestApi/resources/11.13.18.05/mySelfServiceRoles/{RoleId}
Get a self-service role
Method: get
Path: /crmRestApi/resources/11.13.18.05/mySelfServiceRoles/{RoleId}
Get all the self-service roles
Method: get
Path: /crmRestApi/resources/11.13.18.05/mySelfServiceRoles
Non-Duplicate Records
The resolution non-duplicate resource is used to view, create, and update non-duplicate records. Non-duplicate records prevent specified parties from appearing in future duplicate identification results.
Create a non-duplicate record
Method: post
Path: /crmRestApi/resources/11.13.18.05/nonDuplicates
Get a non-duplicate record
Method: get
Path: /crmRestApi/resources/11.13.18.05/nonDuplicates/{NonDuplicateId}
Get all non-duplicate records
Method: get
Path: /crmRestApi/resources/11.13.18.05/nonDuplicates
Update a non-duplicate record
Method: patch
Path: /crmRestApi/resources/11.13.18.05/nonDuplicates/{NonDuplicateId}
Objectives
The objectives resource is used to view, create, update, and delete sales objectives. Objectives are measurable tactical goals that partners need to meet to achieve a higher level strategic goal defined in the partner business plan. For example, objectives establish tactical goals, such as target revenue for a quarter, completing number of sales calls within a specific tenure of the business plan, and organizing a certain number of sales presentations.
Create an objective
Method: post
Path: /crmRestApi/resources/11.13.18.05/salesObjectives
Delete an objective
Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}
Get all objectives
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives
Get an objective
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}
Update an objective
Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}
Objectives/Objective Splits
The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters.
Create an objective split
Method: post
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits
Delete an objective split
Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits/{ObjectiveSplitId}
Get all objective splits
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits
Get an objective split
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits/{ObjectiveSplitId}
Update an objective split
Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits/{ObjectiveSplitId}
Opportunities
The opportunities resource is used to view, create, update, and delete an opportunity. An opportunity is a business object that is used to track and store data about potential sales.
Assign matched opportunity
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities
Copy matched opportunity
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities
Create an opportunity
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities
Delete an opportunity
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}
Get all opportunities
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities
Get an opportunity
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}
Update an opportunity
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}
Opportunities/Assessments
The assessments resource is used to view, create, update, and delete the assessment of an opportunity.
Create an assessment
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments
Delete an assessment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}
Get all assessments
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments
Get an assessment
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}
Update an assessment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}
Opportunities/Assessments/Assessment Answer Groups
The assessment answer groups resource is used to view and update the question groups in an assessment.
Get all assessment answer groups
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups
Get an assessment answer group
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}
Update an assessment answer group
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}
Opportunities/Assessments/Assessment Answer Groups/Assessment Answers
The assessment answers resource is used to view and update a response to a question in the question group.
Get all assessment answers
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer
Get an assessment answer
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}
Update an assessment answer
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}
Opportunities/Notes
The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.
Create a note
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note
Delete a note
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note/{NoteId}
Get a note
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note/{NoteId}
Get all notes
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note
Update a note
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note/{NoteId}
Opportunities/Opportunity Competitors
The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.
Create an opportunity competitor
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2
Delete an opportunity competitor
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2/{OptyCompetitorId}
Get all opportunity competitors
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2
Get an opportunity competitor
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2/{OptyCompetitorId}
Update an opportunity competitor
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2/{OptyCompetitorId}
Opportunities/Opportunity Contacts
The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.
Create an opportunity contact
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact
Delete an opportunity contact
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact/{OptyConId}
Get all opportunity contacts
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact
Get an opportunity contact
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact/{OptyConId}
Update an opportunity contact
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact/{OptyConId}
Opportunities/Opportunity Deals
The opportunity deals resource is used to view the deals associated with an opportunity.
Get all opportunity deals
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityDeal
Get an opportunity deal
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityDeal/{OptyDealId}
Opportunities/Opportunity Leads
The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.
Create an opportunity lead
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead
Delete an opportunity lead
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead/{OptyLeadId}
Get all opportunity leads
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead
Get an opportunity lead
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead/{OptyLeadId}
Update an opportunity lead
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead/{OptyLeadId}
Opportunities/Opportunity Partners
The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.
Create an opportunity revenue partner
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary
Delete an opportunity revenue partner
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary/{RevnPartOrgPartyId}
Get all opportunity revenue partners
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary
Get an opportunity revenue partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary/{RevnPartOrgPartyId}
Update an opportunity revenue partner
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary/{RevnPartOrgPartyId}
Opportunities/Opportunity Sources
The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.
Create an opportunity source
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySource1
Delete an opportunity source
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySource1/{OptySrcId}
Get all opportunity sources
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySource1
Get an opportunity source
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySource1/{OptySrcId}
Update an opportunity source
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySource1/{OptySrcId}
Opportunities/Opportunity Stage Snapshots
The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.
Get all opportunity stage snapshots
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/opportunityStageSnapshots
Get an opportunity stage snapshot
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/opportunityStageSnapshots/{OptyStgSnapshotId}
Opportunities/Opportunity Team Members
The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.
Create an opportunity team member
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource
Delete an opportunity team member
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource/{OptyResourceId}
Get all opportunity team members
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource
Get an opportunity team member
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource/{OptyResourceId}
Update an opportunity team member
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource/{OptyResourceId}
Opportunities/Revenue Items
The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.
Create an opportunity revenue
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue
Delete an opportunity revenue
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}
Get all opportunity revenues
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue
Get an opportunity revenue
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}
Update an opportunity revenue
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}
Opportunities/Revenue Items/Child Split Revenues
The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.
Create a child split revenue
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/ChildSplitRevenue
Delete a child split revenue
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/ChildSplitRevenue/{RevnId2}
Get a child split revenue
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/ChildSplitRevenue/{RevnId2}
Get all child split revenues
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/ChildSplitRevenue
Update a child split revenue
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/ChildSplitRevenue/{RevnId2}
Opportunities/Revenue Items/Opportunity Revenue Territories
The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.
Create a territory for an opportunity revenue
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/RevenueTerritory
Delete an opportunity revenue territory
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/RevenueTerritory/{RevenueTerritoryUniqID}
Get all opportunity revenue territories
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/RevenueTerritory
Get an opportunity revenue territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/RevenueTerritory/{RevenueTerritoryUniqID}
Update an opportunity revenue territory
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/RevenueTerritory/{RevenueTerritoryUniqID}
Opportunities/Revenue Items/Product Groups
The product group resource is used to view the product groups associated with an opportunity. A product group is a business object that groups related products, so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.
Get a product group
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/productGroups/{ProdGroupId}
Get all product groups
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/productGroups
Opportunities/Revenue Items/Products
The products resource is used to view the products associated with an opportunity.
Get a product
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/products/{productsUniqID}
Get all products
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/products
Opportunities/Revenue Items/Recurring Revenues
The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.
Create a recurring revenue
Method: post
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/RecurringRevenue
Delete a recurring revenue
Method: delete
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/RecurringRevenue/{RevnId2}
Get a recurring revenue
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/RecurringRevenue/{RevnId2}
Get all recurring revenues
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/RecurringRevenue
Update a recurring revenue
Method: patch
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{RevnId}/child/RecurringRevenue/{RevnId2}
Opportunities/Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Get a smart action (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{UserActionId}
Get all smart actions
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions
Opportunities/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/opportunities/{OptyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action URL binding (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}
Opportunities/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/opportunities/{OptyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload
Get an action request payload (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}
Opportunities/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/opportunities/{OptyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation
Get an action navigation (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Participant Compensation Plans
The participant compensation plans resource is used to view and update the participant plan. A participant compensation plan defines how to calculate earnings for a participant.
Get a participant compensation plan
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}
Get all participant compensation plans
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans
Update a participant compensation plan
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}
Participant Compensation Plans/Descriptive Flex Fields
The participant compensation plan descriptive flex fields resource is used to view and update custom attributes for a participant compensation plan. You can configure and deploy participant plan flex fields using the Setup and Maintenance, Manage Incentive Compensation Descriptive Flexfields task.
Get all descriptive flex fields for a participant plan
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantCompensationPlansDFFs
Get descriptive flex fields for a participant plan
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantCompensationPlansDFFs/{SrpCompPlanId}
Update descriptive flex fields for a participant plan
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantCompensationPlansDFFs/{SrpCompPlanId}
Participant Compensation Plans/Plan Components
The participant compensation plan components resource is used to view and update the plan components for a participant compensation plan. It can also be used to update the plan component target percentage and enable or disable further individualization of goals and rates.
Get a plan component
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}
Get all plan components
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents
Update a plan component
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}
Participant Compensation Plans/Plan Components/Performance Measures
The plan component performance measures resource is used to view the participant performance measures for a plan component. A performance measure is used to measure the performance attainment.
Get a performance measure
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}
Get all performance measures
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures
Participant Compensation Plans/Plan Components/Performance Measures/Goals
The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.
Get a performance measure goal
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}
Get all performance measure goals
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals
Update a performance measure goal
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}
Participant Compensation Plans/Plan Components/Performance Measures/Goals/Interval Goals
The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.
Get all interval goals
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalIntervalGoals
Get an interval goal
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalIntervalGoals/{ParticipantIntervalGoalId}
Participant Compensation Plans/Plan Components/Performance Measures/Goals/Period Goals
The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.
Get a period goal
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalPeriodGoals/{ParticipantPeriodGoalId}
Get all period goals
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalPeriodGoals
Update a period goal
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureGoals/{ParticipantGoalId}/child/ParticipantGoalPeriodGoals/{ParticipantPeriodGoalId}
Participant Compensation Plans/Plan Components/Performance Measures/Scorecards
The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.
Get a performance measure scorecard
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards/{ParticipantPerformanceMeasureScorecardId}
Get all performance measure scorecards
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards
Participant Compensation Plans/Plan Components/Performance Measures/Scorecards/Scorecard Rates
The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component.
Create a scorecard rate
Method: post
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards/{ParticipantPerformanceMeasureScorecardId}/child/ParticipantScorecardRates
Get a scorecard rate
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards/{ParticipantPerformanceMeasureScorecardId}/child/ParticipantScorecardRates/{ParticipantScorecardRateId}
Get all scorecard rates
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards/{ParticipantPerformanceMeasureScorecardId}/child/ParticipantScorecardRates
Update a scorecard rate
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentPerformanceMeasures/{ParticipantPerformanceMeasureId}/child/ParticipantPerformanceMeasureScorecards/{ParticipantPerformanceMeasureScorecardId}/child/ParticipantScorecardRates/{ParticipantScorecardRateId}
Participant Compensation Plans/Plan Components/Rate Tables
The plan component rate tables resource is used to view the rate tables for a participant plan component. The plan component rate table determines the compensation rate for earning calculations.
Get a plan component rate table
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}
Get all plan component rate tables
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables
Participant Compensation Plans/Plan Components/Rate Tables/Rate Table Rates
The rate table rates resource is used to view, create, and update the rates for a participant rate table that can be individualized. You enable individualization for a rate table by setting the Individualize option to Yes for the related participant plan component.
Create a rate table rate
Method: post
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}/child/ParticipantRateTableRates
Get a rate table rate
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}/child/ParticipantRateTableRates/{ParticipantRateTableRateId}
Get all rate table rates
Method: get
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}/child/ParticipantRateTableRates
Update a rate table rate
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/participantCompensationPlans/{ParticipantPlanNumber}/child/ParticipantPlanComponents/{ParticipantPlanComponentId}/child/ParticipantPlanComponentRateTables/{ParticipantPlanComponentRateTableId}/child/ParticipantRateTableRates/{ParticipantRateTableRateId}
Participants
The participants resource is used to view and update a participant. A participant is anyone in the system who could receive a credit or is an associate in the sales hierarchy, e.g.: a Sales Manager or a Sales Representative.
Get a participant
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}
Get all participants
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants
Update a participant
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}
Participants List of Values
The participants list of values resource is used to view the list of existing participants.
Get a participant
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipantsLOV/{ParticipantId}
Get all participants
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipantsLOV
Participants/Participant Details
The participant details resource is used to view, create, and update the details of a participant, such as the cost center, location, etc.
Create a participant detail
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantDetails
Get a participant detail
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantDetails/{ParticipantDetailId}
Get all participant details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantDetails
Update a participant detail
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantDetails/{ParticipantDetailId}
Participants/Participant Details/Participant Details Descriptive Flex Fields
The participant details descriptive flex fields resource is used to view, create, or update custom attributes for a participant details resource and define validations for them. It is also used to delete an existing participant details flex field.
Create a descriptive flex field
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantDetails/{ParticipantDetailId}/child/participantDetailsDFF
Get a descriptive flex field
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantDetails/{ParticipantDetailId}/child/participantDetailsDFF/{ParticipantDetailId2}
Get all descriptive flex fields
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantDetails/{ParticipantDetailId}/child/participantDetailsDFF
Update a descriptive flex field
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantDetails/{ParticipantDetailId}/child/participantDetailsDFF/{ParticipantDetailId2}
Participants/Participant Roles
The participant roles resource is used to view, create, update, and delete a role associated with a participant, such as a sales representative or a sales manager.
Create a participant role
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantRoles
Delete a participant role
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantRoles/{ParticipantRoleId}
Get a participant role
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantRoles/{ParticipantRoleId}
Get all participant roles
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantRoles
Update a participant role
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/ParticipantRoles/{ParticipantRoleId}
Participants/Participants Descriptive Flex Fields
The participant descriptive flex fields resource is used to view, create, or update custom attributes for a participant resource and define validations for them. It is also used to delete an existing participant flex field.
Create a descriptive flex field
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/participantsDFF
Get a descriptive flex field
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/participantsDFF/{ParticipantId2}
Get all descriptive flex fields
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/participantsDFF
Update a descriptive flex field
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{ParticipantId}/child/participantsDFF/{ParticipantId2}
Partner Contacts
Partner contacts resource is used to view, create, update, and delete a partner contact.
Create a partner contact
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts
Delete a partner contact
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}
Get a partner contact
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}
Get all partner contacts
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts
Update a partner contact
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}
Partner Contacts/Partner Contact User Details
The user details resource is used to view, create, update, and delete an user detail.
Create an user detail
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/userdetails
Delete an user detail
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/userdetails/{Username}
Get all user details
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/userdetails
Get an user detail
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/userdetails/{Username}
Update an user detail
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/userdetails/{Username}
Partner Programs
The partner programs resource is used to view, create, update, and delete partner programs. Partner programs are used to set up a program structure to distinguish and reward your partners, based on their performance and contributions to the business.
Create a partner program
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms
Delete a partner program
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}
Get a partner program
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}
Get all partner programs
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms
Update a partner program
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}
Partner Programs/Countries
The countries resource is used to view, create, update, and delete the countries associated with partner programs. The countries resource is used to determine the scope of availability of partner programs in specific countries.
Create a country for a partner program
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries
Delete a country from a partner program
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries/{ProgramCountryId}
Get a country for a partner program
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries/{ProgramCountryId}
Get all countries for a partner program
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries
Update a country for a partner program
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries/{ProgramCountryId}
Partner Programs/Program Benefit Details
The program benefit details resource is used to view, create, update, and delete the program benefits added to a partner program.
Create a program benefit for a partner program
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails
Delete a program benefit from a partner program
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}
Get a program benefit for a partner program
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}
Get all program benefits for a partner program
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails
Update a program benefit for a partner program
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}
Partner Programs/Tiers
The partner program tiers resource is used to view, create, update, and delete the tiers for a given program. Partner programs can be arranged into tiers and assigned to partners based on their level of contribution to the business.
Create a tier for a partner program
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers
Delete a tier from a partner program
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers/{ProgramTierId}
Get a tier for a partner program
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers/{ProgramTierId}
Get all tiers for a partner program
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers
Update a tier for a partner program
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramTiers/{ProgramTierId}
Partner Tiers
The partner tiers resource is used to view, create, update, and delete the tiers a partner can be added to. Partner tiers help with the assignment of partners and partner programs.
Create a partner tier
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerTiers
Delete a partner tier
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}
Delete a product tier and its hierarchy
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}
Downgrade partner tier ranking
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}
Get a partner tier
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}
Get all partner tiers
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerTiers
Update a partner tier
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}
Upgrade partner tier ranking
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerTiers/{TierId}
Partners
The partners resource is used to view, create, and update partners. A partner is an independent business that works with one or many channel organizations. A partner could engage with an organization in sales or service, as an influencer, as support, and so on. Note: The FiscalYearendMonth attribute is not supported in the Partner REST resource though it is listed for the Partner object in the App Composer.
Create a partner
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners
Get a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}
Get all partners
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners
Update a partner
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}
Partners/Addresses
The addresses resource is used to view, create, update, and delete addresses of a partner.
Create an address
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses
Delete an address
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses/{AddressNumber}
Get all addresses
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses
Get an address
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses/{AddressNumber}
Update an address
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses/{AddressNumber}
Partners/Attachments
An attachments resource is used to view, create, modify or delete the partner's attachments.
Create a partner attachment
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments
Delete a partner attachment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{AttachedDocumentId}
Get a partner attachment
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{AttachedDocumentId}
Get all partner attachments
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments
Update a partner attachment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{AttachedDocumentId}
Partners/Expertises
The expertise resource is used to view, create, and delete the partner's expertise. Partner expertise indicates areas where the partner has special knowledge or skill.
Create an expertise for a partner
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises
Delete an expertise for a partner
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises/{PartnerMultivalLovId}
Get all expertises for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises
Get an expertise for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises/{PartnerMultivalLovId}
Partners/Focus Areas
The focus areas resource is used to view, create, or delete the partner's focus areas. For example, a partner's focus area can be green servers.
Create a product specialty for a partner
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities
Delete a product specialty for a partner
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities/{PartnerDimMembersId}
Get a product specialty for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities/{PartnerDimMembersId}
Get all product specialties for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities
Partners/Geographies
The partner geographies resource is used to view, create, delete the geographies that the partner operates in, such as US, CA, and so on.
Create a geography for a partner
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies
Delete a geography for a partner
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies/{PartnerDimMembersId}
Get a geography for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies/{PartnerDimMembersId}
Get all geographies for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies
Partners/Industries
The industries resource is used to view, create, and delete the industries that a channel partner works with. For example, a partner's industry can be manufacturing or automotive.
Create an industry for a partner
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries
Delete an industry for a partner
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries/{PartnerDimMembersId}
Get all industries for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries
Get an industry for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries/{PartnerDimMembersId}
Partners/Notes
The note resource is used to view, create, update, and delete notes associated with a partner. A note captures comments, information, or instructions related to a partner.
Create a note for a partner
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes
Delete a note for a partner
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}
Get a note for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}
Get all notes for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes
Update a note for a partner
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}
Partners/Partner Account Team Members
The partner account team members resource is used to view, create, update, and delete the team members who will work with the partner. The team members are responsible for a partner account, and have access to edit the partner account information.
Create a partner account team member for a partner
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers
Delete a partner account team member for a partner
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers/{PartnerAccountResourceId}
Get a partner account team member for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers/{PartnerAccountResourceId}
Get all partner account team members for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers
Update a partner account team member for a partner
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers/{PartnerAccountResourceId}
Partners/Partner Certifications
The partner certifications resource is used to view, create, and delete the certifications of a partner. Through certifications, partners can qualify for competencies offered by the channel organization and become eligible for higher partner levels (Gold, Silver, Bronze), increased discounts, and so on.
Create a certification for a partner
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications
Delete a certification for a partner
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications/{PartnerMultivalLovId}
Get a certification for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications/{PartnerMultivalLovId}
Get all certifications for a partner
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications
Partners/Partner Contacts
The partner contacts resource is used to view, create, update, and delete the contacts of a partner company. For example, a partner sales rep, a partner sales manager, a partner administrator, and so on. Note: The following attributes are not supported in the Partner Contacts resource, though they are listed for the Partner object in the App Composer: ContactRole, ContactStatus, RegistrationStatus, SalesProfileStatus, RecordSet, DataCloudStatus, and TimezoneCode.
Create a partner contact
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts
Delete a partner contact
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}
Get a partner contact
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}
Get all partner contacts
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts
Update a partner contact
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}
Partners/Partner Contacts/User Account Details
The user account details resource is used to view, create, update, and delete the user account details of a partner contact.
Create a partner contact user detail
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails
Delete a partner contact user detail
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails/{Username}
Get a partner contact user details
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails/{Username}
Get all partner contact user details
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails
Update a partner contact user detail
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails/{Username}
Partners/Partner Types
The partner types resource is used to view, create, and delete the type of the partner. The partner type record enables you to categorize the partner account based on the type of business the partner performs. For example, a partner can be a reseller, a distributor, a manufacturer, and so on.
Create a partner type
Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types
Delete a partner type
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types/{PartnerDimMembersId}
Get a partner type
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types/{PartnerDimMembersId}
Get all partner types
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types
Partners/Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Get a smart action (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{UserActionId}
Get all smart actions
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions
Partners/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/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action URL binding (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}
Partners/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/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload
Get an action request payload (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}
Partners/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/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation
Get an action navigation (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Passive Beacon Service Statuses
The passive beacon service statuses resource is internally used to view the available information of the chat service. In order to call this API, a Provider and a Service have to be registered.
This API is related to the Chat "ProviderName": "RTENG" and its only service "ServiceName": "RTENG_SERVICE".
This method returns the Chat Server availability information. This method can be called using a GET HTTP request containing an Authorization header.
The passiveBeaconProviderStatus method is protected by the entitlement SVC_DETERMINE_SERVICE_STATUS_PRIV assigned to ORA_SVC_SERVICE_STATUS_COMPUTATION role.
Get a passive beacon provider status (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/passiveBeaconProviderStatus/{ProviderId}
Get all passive beacon provider statuses
Method: get
Path: /crmRestApi/resources/11.13.18.05/passiveBeaconProviderStatus
Passive Beacon Service Statuses/Passive Beacon Provider Statuses
The passive beacon provider statuses resource is internally used to view the available information of the chat service.
Get a passive beacon service status (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/passiveBeaconProviderStatus/{ProviderId}/child/PassiveBeaconServiceStatus/{ServiceId}
Get all passive beacon service statuses
Method: get
Path: /crmRestApi/resources/11.13.18.05/passiveBeaconProviderStatus/{ProviderId}/child/PassiveBeaconServiceStatus
Pay Groups
The pay groups resource is used to view, create, update, and delete an incentive compensation pay group. A pay group is used to gather participants that are on the same payment cycle and are paid by the same payment application.
Create a pay group
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups
Delete a pay group
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}
Get a pay group
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}
Get all pay groups
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups
Update a pay group
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}
Pay Groups/Pay Group Assignments
The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group.
Create a pay group assignments
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupAssignments
Delete a pay group assignment
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupAssignments/{ParticipantPayGroupId}
Get a pay group assignment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupAssignments/{ParticipantPayGroupId}
Get all pay group assignments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupAssignments
Update a pay group assignments
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupAssignments/{ParticipantPayGroupId}
Pay Groups/Pay Group Roles
The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group.
Create a pay group role
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles
Delete a pay group role
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles/{RolePayGroupId}
Get a pay group role
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles/{RolePayGroupId}
Get all pay group roles
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles
Update a pay group role
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles/{RolePayGroupId}
Payment Batch Participant Plan Components List of Values
The payment batch participant plan components list of values resource is used to view the plan components assigned to a participant when a paysheet is being created or updated for the participant within a payment batch.
Get a payment batch participant plan component
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paybatchParticipantPlanComponentsLOV/{PlanComponentId}
Get all payment batch participant plan components
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paybatchParticipantPlanComponentsLOV
Payment Batches
The payment batches resource is used to view and create payment batches. Payment batches are used to generate the paysheets for each participant who meets the payment batch selection criteria.
Create a payment batch
Method: post
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches
Get a payment batch
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}
Get all payment batches
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches
Payment Batches/Payment Transactions
The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.
Create a manual adjustment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paymentTransactions
Delete a manual adjustment
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paymentTransactions/{ParticipantPayId}
Get a payment transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paymentTransactions/{ParticipantPayId}
Get all payment transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paymentTransactions
Update a payment transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paymentTransactions/{ParticipantPayId}
Payment Batches/Paysheets
The paysheets resource is used to view and update participant paysheets. A payment batch generates paysheets for each incentive compensation participant who meets the payment batch criteria. Individual paysheets are generated for each plan component and a summarized paysheet is generated for all plan components.
Get a paysheet
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}
Get all paysheets
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets
Update a paysheet
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}
Payment Batches/Paysheets/Payment Transactions
The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.
Create a manual adjustment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}/child/paymentTransactions
Delete a manual adjustment
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}
Get a payment transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}
Get all payment transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}/child/paymentTransactions
Update a payment transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}
Payment Plans
The payment plans resource is used to view, create, update, and delete an incentive compensation payment plan. The payment plan contains rules for payment draw, draw recovery, and cap amounts to pay to assigned participants.
Create a payment plan
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans
Delete a payment plan
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}
Get a payment plan
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}
Get all payment plans
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans
Update a payment plan
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}
Payment Plans/Payment Plans Assignments
The assignments resource is used to view, create, update, or delete an incentive compensation assignment for a payment plan.
Create a payment plan assignment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments
Delete a payment plan assignment
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments/{ParticipantPaymentPlanId}
Get a payment plan assignment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments/{ParticipantPaymentPlanId}
Get all payment plan assignment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments
Update a payment plan assignment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanAssignments/{ParticipantPaymentPlanId}
Payment Plans/Payment Plans Roles
The roles resource is used to view, create, update, or delete an incentive compensation role assignment for a payment plan.
Create a payment plan role
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanRoles
Delete a payment plan role
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanRoles/{RolePaymentPlanId}
Get a payment plan role
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanRoles/{RolePaymentPlanId}
Get all payment plan roles
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanRoles
Update a payment plan role
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans/{PaymentPlanId}/child/PaymentPlanRoles/{RolePaymentPlanId}
Payment Transactions
The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.
Create a manual adjustment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/paymentTransactions
Delete a manual adjustment
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/paymentTransactions/{ParticipantPayId}
Get a payment transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentTransactions/{ParticipantPayId}
Get all payment transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentTransactions
Update a payment transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paymentTransactions/{ParticipantPayId}
Paysheets
The paysheet resource is used to view and update participant paysheets. A payment batch generates paysheets for each incentive compensation participant who meets the payment batch criteria. Individual paysheets are generated for each plan component and a summarized paysheet is generated for all plan components.
Get a paysheet
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}
Get all paysheets
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paysheets
Update a paysheet
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}
Paysheets/Payment Transactions
The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.
Create a manual adjustment for a paysheet
Method: post
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}/child/paymentTransactions
Delete a manual adjustment for a paysheet
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}
Get a payment transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}
Get all payment transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}/child/paymentTransactions
Update a payment transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}/child/paymentTransactions/{ParticipantPayId}
Performance Intervals List of Values
The performance intervals list of values resource is used to view the interval types list of values that are associated with a performance measure interval. The interval type affects the accumulation results for a performance measure calculation.
Get all interval types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceIntervalsLOV
Get an interval type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceIntervalsLOV/{incentiveCompensationPerformanceIntervalsLOVUniqID}
Performance Measures
The performance measures resource is used to view, create, update, and delete a performance measure. It can also be used to display all the details of a performance measure. A performance measure is a determination of the accomplishment of a participant. It could include a goal/target, an eligibility criteria, a measure formula, and a score card.
A new performance measure can be created in five different ways, with an incentive formula (output expression), with a credit category (with or without credit factors and transaction factors), with a scorecard (without an rate dimensional input expression - this input expression should be assigned only after the scorecard has been assigned), with any combination of the above, or individually where only the performance measure is created (association with other components needs to be done separately.)
When a performance measure is created, Goals, Interval Goals, and Period Goals are created with a default value of 0. The user can then update the total goal or the period goals.
Create a performance measure
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures
Delete a performance measure
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}
Get a performance measure
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}
Get all performance measures
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures
Update a performance measure
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}
Performance Measures/Credit Categories
The credit categories resource is used to view, create, and delete the association of a credit category with a performance measure. It can also be used to display all the details of the credit categories under a performance measure. A credit category is used to define which transaction is eligible for crediting by the Incentive Compensation system. A performance measure credit category record links the credit category to a performance measure and provides additional details at this level.
A credit category needs to exist before creating this record.
Create a credit category
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories
Delete a credit category
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}
Get a credit category
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}
Get all credit categories
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories
Performance Measures/Credit Categories/Credit Factors
The credit factors resource is used to view, create, update, and delete the credit factor or earning factor within a credit category associated to a performance measure.
The credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time.
The earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time.
Create a credit factor
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors
Delete a credit factor
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors/{PerformanceMeasureCreditFactorId}
Get a credit factor
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors/{PerformanceMeasureCreditFactorId}
Get all credit factors
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors
Update a credit factor
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureCreditFactors/{PerformanceMeasureCreditFactorId}
Performance Measures/Credit Categories/Transaction Factors
The transaction factors resource is used to view, create, update, and delete the transaction factor associated with a performance measure credit category. A transaction factor is used to decide the influence of the sales stage (Invoicing, PO stage, etc.) on the sales credit.
Create a transaction factor
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureTransactionFactors
Delete a transaction factor
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureTransactionFactors/{PerformanceMeasureTransactionFactorId}
Get a transaction factor
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureTransactionFactors/{PerformanceMeasureTransactionFactorId}
Get all transaction factors
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureTransactionFactors
Update a transaction factor
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureCreditCategories/{PerformanceMeasureCreditCategoryId}/child/performanceMeasureTransactionFactors/{PerformanceMeasureTransactionFactorId}
Performance Measures/Descriptive Flex fields
The Descriptive Flex Field resource is used to create, view, and update user defined values for the performance measure.
A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.
Create a descriptive flex field
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureDFF
Get a descriptive flex field
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureDFF/{FormulaId}
Get all descriptive flex fields
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureDFF
Update a descriptive flex field
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureDFF/{FormulaId}
Performance Measures/Goals
The goals resource is used to view and update a goal. It can also be used to display all the details of a goal. A goal under a performance measure defines the target applicable to a participant and could be assigned across a timeline.
This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Get a goal
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}
Get all goals
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals
Update a goal
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}
Performance Measures/Goals/Interval Goals
The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals.
This is created when creating a Performance Measure with a default value of 0.
Get all interval goals
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals
Get an interval goal
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}
Update an interval goal
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}
Performance Measures/Goals/Interval Goals/Period Goals
The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods.
This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Get a period goal
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}/child/performanceMeasurePeriodGoals/{PeriodGoalId}
Get all period goals
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}/child/performanceMeasurePeriodGoals
Update a period goal
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureGoals/{GoalId}/child/performanceMeasureIntervalGoals/{IntervalGoalId}/child/performanceMeasurePeriodGoals/{PeriodGoalId}
Performance Measures/Rate Dimensional Input Expressions
The Rate Dimensional Input Expressions resource is used to view and update the association of an input expression with a performance measure. It can also be used to display all the details of the input expressions under a performance measure. This record specifies the inputs of a rate dimension of a scorecard and provides additional details at this level.
A valid expression which also has a valid usage needs to exist before creating this record. This should be assigned only after the scorecard has been assigned.
Get a rate dimensional input
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureRateDimensionalInputs/{PerformanceMeasureInputExpressionId}
Get all rate dimensional inputs
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureRateDimensionalInputs
Update a rate dimensional input
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureRateDimensionalInputs/{PerformanceMeasureInputExpressionId}
Performance Measures/Scorecards
The scorecards resource is used to view, create, update, and delete the association of a scorecard with a performance measure. It can also be used to display all the details of a scorecard associated with a performance measure. This resource links the scorecard to a performance measure and provides additional details at this level.
A scorecard needs to exist before creating this record.
Create a scorecard
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards
Delete a scorecard
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards/{PerformanceMeasureScorecardId}
Get a scorecard
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards/{PerformanceMeasureScorecardId}
Get all scorecards
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards
Update a scorecard
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}/child/performanceMeasureScorecards/{PerformanceMeasureScorecardId}
Periods List of Values
The periods list of values resource is used to view the list of incentive compensation periods defined for a calendar associated with a business unit.
Get a period
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPeriodsLOV/{incentiveCompensationPeriodsLOVUniqID}
Get all periods
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPeriodsLOV
Plan Components
The plan components resource is used to create, update or delete a plan component. It can also be used to display all the details of plan components. A plan component defines the earnings of a participant based on their performance.
A new plan component can be created with a performance measure assignment, a with plan component DFFs, with any combination of the above , or Individually where only the plan component is created initially & the association with child resources is done later.
Create a plan component
Method: post
Path: /fscmRestApi/resources/11.13.18.05/planComponents
Delete a plan component
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}
Get a plan component
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}
Get all plan components
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents
Update a plan component
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}
Plan Components/Plan Component - Incentive Formulas
The plan component - incentive formulas resource is used to update the association of an incentive formula to the plan component. It can also be used to display all the details of a incentive formula associated to a plan component. This record specifies the formula used to calculate the earnings and provides additional details at this level.
This is created automatically, without any values, when a plan component is created and has to be updated later.
Get all incentive formulas
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas
Get an incentive formula
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}
Update an incentive formula
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}
Plan Components/Plan Component - Incentive Formulas/Plan Component - Rate Dimensional Input Expressions
The plan component - rate dimensional input expressions resource is used to update the association of a input expression with a plan component. It can also be used to display all the details of input expressions associated with a plan component. This record specifies the inputs of a rate dimension of a rate table and provides additional details at this level.
A valid expression which also has a valid usage needs to exist before creating this record. You should assign the input expression only after the rate table is assigned.
Get a rate dimensional input
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateDimensionalInputs/{PlanComponentInputExpressionId}
Get all rate dimensional inputs
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateDimensionalInputs
Update a rate dimensional input
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateDimensionalInputs/{PlanComponentInputExpressionId}
Plan Components/Plan Component - Incentive Formulas/Plan Component - Rate Tables
The plan component - rate tables resource is used to create, update or delete the association of a rate table with a plan component. It can also be used to display all the details of rate table associated with a performance measure. This record links the rate table to a performance measure and provides additional details at this level.
A rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created.
Create a rate table
Method: post
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables
Delete a rate table
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables/{PlanComponentRateTableId}
Get a rate table
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables/{PlanComponentRateTableId}
Get all rate tables
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables
Update a rate table
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables/{PlanComponentRateTableId}
Plan Components/Plan Component - Performance Measures
The plan component - performance measures resource is used to create, update or delete the association of a performance measure with a plan component. It can also be used to display all the details of performance measures under a plan component. A plan component - performance measure record links the performance measure to a plan component and provides additional details at this level.
A performance measure needs to exist before creating this record.
Create a performance measure
Method: post
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures
Delete a performance measure
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures/{PlanComponentPerformanceMeasureId}
Get a performance measure
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures/{PlanComponentPerformanceMeasureId}
Get all performance measures
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures
Update a performance measure
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures/{PlanComponentPerformanceMeasureId}
Plan Components/Plan Component Descriptive Flex Fields
The plan component - descriptive flex fields resource is used to store user defined values for the plan component. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.
Create a descriptive flex field
Method: post
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF
Get a descriptive flex field
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF/{planComponentsDFFUniqID}
Get all descriptive flex fields
Method: get
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF
Update a descriptive flex field
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF/{planComponentsDFFUniqID}
Plan Document Templates List of Values
The plan document template list of values resource is used to view the list of template names associated with a plan document. The plan document which gets distributed to the participant is a BIP report which can have multiple templates associated with it.
Get a plan document template
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPlanDocumentTemplatesLOV/{TemplateName}
Get all plan document templates
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPlanDocumentTemplatesLOV
Price Book Headers
The Price Book Header resource is used to view, create, update, and delete the name, description, and status of a price book. It also includes the unique identifier, unique code, and the currency on which the price book amount is based.
Create a pricebook
Method: post
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders
Delete a pricebook
Method: delete
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{PricebookId}
Get a pricebook
Method: get
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{PricebookId}
Get all pricebooks
Method: get
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders
Update a pricebook
Method: patch
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{PricebookId}
Price Book Headers/Price Book Items
The Price Book Line resource is used to view, create, update, and delete the item identifier, unique identifier, and unique identifier of the item selected in the price book. It also includes the description, price and unit of measurement of the item.
Create a pricebook item
Method: post
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{PricebookId}/child/PriceBookItem
Delete a pricebook item
Method: delete
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{PricebookId}/child/PriceBookItem/{PricebookItemId}
Get a pricebook item
Method: get
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{PricebookId}/child/PriceBookItem/{PricebookItemId}
Get all pricebook items
Method: get
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{PricebookId}/child/PriceBookItem
Update a pricebook item
Method: patch
Path: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{PricebookId}/child/PriceBookItem/{PricebookItemId}
Product Group Usages
The product group usages resource is used to view the product group usage.
Get a product group usage
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}
Get all product group usages
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages
Product Group Usages/Product Group Usage Functions
The product group usage engines resource is used to view the usage engines of the product group.
Get a product group usage engine
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageEngine/{ProductGroupUsageEngineUniqID}
Get all product group usage engines
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageEngine
Product Group Usages/Product Group Usage Modes
The product group usage modes resource is used to view the usage mode of the product group.
Get a product group usage mode
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageModeSetup/{ProductGroupUsageModeSetupUniqID}
Get all product group usage modes
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageModeSetup
Product Group Usages/Product Group Usage Preferences
The product group usage preferences resource is used to view the usage preferences of the product group.
Get a product group usage preference
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsagePreferenceSetup/{ProductGroupUsagePreferenceSetupUniqID}
Get all product group usage preferences
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsagePreferenceSetup
Product Group Usages/Product Group Usage Roots
The product group usage roots resource is used to view the usage roots of the product group.
Get a root product group
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageRootProdGrpSetup/{ProdGrpRootsId}
Get all root product groups
Method: get
Path: /crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageRootProdGrpSetup
Product Groups
The product groups resource is used to view, create, update, delete, lock, publish, and release product groups. A product group is a business object that groups related products. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog. Locking a product group makes it inaccessible or non editable for other users while you are making some changes. Unlocking releases the lock and rolls the changes back. Publishing the product group makes the changes available to the users at runtime.
Create a product group
Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs
Delete a product group
Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}
Get a product group by product group ID
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}
Get all product groups
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs
Lock a product group for editing
Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs
Publish product groups locked or edited by the user
Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs
Release lock on a product group
Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}
Update a product group
Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}
Product Groups/Attachments
The attachments resource is used to view, create, update, and delete the attachments associated with a product group. The attachments are typically used to associate images to the product groups so that you can identify the product groups visually in browse sales catalog.
Delete an attachment on the product group
Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{AttachedDocumentId}
Get all attachment for a product group
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments
Get an attachment
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{AttachedDocumentId}
Update an attachment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{AttachedDocumentId}
Upload an attachment to the product group
Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments
Product Groups/Filter Attributes
The filter attributes resource is used to view, create, update, and delete the filter attributes associated with a product group. Filter attributes allows a customer to sort through the products based on their preference, such as Color, Texture, and other such material properties.
Create an attribute for the product group
Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup
Delete an attribute from a product group
Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}
Get all attributes on a product group
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup
Get an attribute by product group attribute ID
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}
Update an attribute by product group attribute ID
Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}
Product Groups/Filter Attributes/Filter Attribute Values
The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.
Create an attribute value
Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup
Delete an attribute value
Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}
Get all attribute values for a given attribute setup
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup
Get an attribute value by attribute ID
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}
Update an attribute value
Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}
Product Groups/Products
The products resource is used to view, create, update, and delete the product association to a product group. Typically, products are associated to the leaf most nodes of the product group hierarchy. These products are sourced from items defined in Product Information Management.
Create a product for the product group
Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup
Delete a product on a product group
Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}
Get a product relationship details
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}
Get all product relationships on a product group
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup
Update a product relationship on a product group
Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}
Product Groups/Products/EligibilityRules
The eligibility rules resource is used to view, create, update, and delete the various eligibility rules so that only a few products are available for selection at run time. For each item, you can add one or more eligibility rules specifying whether a rule is valid for a particular country or for all countries.
Create an eligibility rule
Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules
Delete an eligibility rule
Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules/{EligibilityRuleId}
Get all eligibility rules
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules
Get an eligibility rule
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules/{EligibilityRuleId}
Update an eligibility rule
Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules/{EligibilityRuleId}
Product Groups/Related Groups
The related groups resource is used to view, create, update, and delete the association between sub product groups and parent product groups. While the Subgroups resource can be used to create or update the product group to sub group association, the deletion of such association can only be done using the Related Groups resource.
Create a subgroup relationship
Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup
Delete a subgroup relationship
Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup/{ProdGroupRelationshipId}
Get a subgroup relationship
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup/{ProdGroupRelationshipId}
Get all subgroup relationships
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup
Update a subgroup relationship
Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup/{ProdGroupRelationshipId}
Product Groups/Subgroups
The subgroups resources is used to view, create, and update the association of a sub product group to a parent product group so that a hierarchy of product groups can be built.
Create a subgroup
Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration
Get a subgroup details
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration/{ProdGroupId2}
Get all subgroups within a product group
Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration
Update a subgroup
Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration/{ProdGroupId2}
Products
The product resource is used to view, create, or modify a product. A product is an item that an organization or company intends to sell.
Create a product
Method: post
Path: /crmRestApi/resources/11.13.18.05/products
Get a product
Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}
Get all products
Method: get
Path: /crmRestApi/resources/11.13.18.05/products
Update a product
Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}
Products/Product Attachments
The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.
Create an attachment for a product
Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments
Delete an attachment for a product
Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{AttachedDocumentId}
Get all attachments for a product
Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments
Get an attachment for a product
Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{AttachedDocumentId}
Update an attachment for a product
Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{AttachedDocumentId}
Products/Product Image Attachments
The attachment resource is used to view, create, and update image attachments of a product.
Create an image attachment for a product
Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments
Delete an image attachment for a product
Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{AttachedDocumentId}
Get all image attachments for a product
Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments
Get an image attachment for a product
Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{AttachedDocumentId}
Update an image attachment for a product
Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{AttachedDocumentId}
Program Benefits
The program benefits resource is used to view, create, update, and delete the benefits that can be added to partner programs from the benefits library.
Create a program benefit
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits
Delete a program benefit
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}
Get a program benefit
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}
Get all program benefits
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits
Update a program benefit
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}
Program Benefits/Benefit List Values
The benefit list values resource is used to view, create, update, and delete the benefit list values that are required to associate a program benefit with a partner program.
Create a benefit list type value
Method: post
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues
Delete a benefit list type value
Method: delete
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues/{BenefitListTypeValId}
Get a benefit list type value
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues/{BenefitListTypeValId}
Get all benefit list type values
Method: get
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues
Update a benefit list type value
Method: patch
Path: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues/{BenefitListTypeValId}
Program Enrollments
The program enrollments resource is used to view, create, and update partner enrollments into a partner program. Partner program enrollments also includes additional information, such as details about the enrollment contracts, who is enrolled in these programs, and attachments containing enrollment information.
Create an enrollment
Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments
Get all enrollments
Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments
Get an enrollment
Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}
Update an enrollment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}
Program Enrollments/Notes
The notes resource is used to view, create, update, and delete notes associated with a partner program. A note captures comments, information, or instructions related to a partner program.
Create a note for an enrollment
Method: post
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes
Delete a note for an enrollment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes/{NoteId}
Get a note for an enrollment
Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes/{NoteId}
Get all notes for an enrollment
Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes
Update a note for an enrollment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/Notes/{NoteId}
Program Enrollments/Partner Programs
The partner programs resource is used to view information about the partner programs, such as the name of the program, program description, validity period, and so on.
Get a partner program for the enrollment
Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/PartnerProgram/{PartnerProgramId}
Get all the partner programs for the enrollment
Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/PartnerProgram
Program Enrollments/Program Benefit Details
The program benefit details resource is used to view the details of a program benefit.
Get a program benefit for an enrollment
Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}
Get all program benefit details for an enrollment
Method: get
Path: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/ProgramBenefitDetails
Queues
The queues resource is used to view, create, update, and delete the list of unassigned requests awaiting assignment to members of a service team. Team members can select the requests to work on, or assign the requests to an appropriate team member depending on the queue. For example, queues can be based on location, such as a North America Queue or an EMEA Queue.
Create a queue
Method: post
Path: /crmRestApi/resources/11.13.18.05/queues
Delete a queue
Method: delete
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}
Get a queue
Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}
Get all queues
Method: get
Path: /crmRestApi/resources/11.13.18.05/queues
Update a queue
Method: patch
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}
Queues/Overflow Queues
The overflow queues resource is used to view, create, update, and delete an overflow queue. Overflow queues are backup queues containing alternative resources that can be made available when the currently assigned resources are unavailable, or are unable to keep up with the incoming work.
Create an overflow queue
Method: post
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues
Delete an overflow queue
Method: delete
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues/{QueueResourceId}
Get all overflow queues
Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues
Get an overflow queue
Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues/{QueueResourceId}
Update an overflow queue
Method: patch
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues/{QueueResourceId}
Queues/Queue Resource Members
The queue resource members resource is used to view, create, update, and delete a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.
Create a resource member
Method: post
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers
Delete a resource member
Method: delete
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers/{QueueResourceId}
Get a resource member
Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers/{QueueResourceId}
Get all resource members
Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers
Update a resource member
Method: patch
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers/{QueueResourceId}
Queues/Queue Resource Teams
The queue resource team resource is used to view, create, update, and delete a resource team assigned to a queue. Resource teams are groups of employees or partners who can take ownership of items in a queue.
Create a resource team
Method: post
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams
Delete a resource team
Method: delete
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams/{QueueResourceId}
Get a resource team
Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams/{QueueResourceId}
Get all resource teams
Method: get
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams
Update a resource team
Method: patch
Path: /crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceTeams/{QueueResourceId}
Rate Dimensions
The rate dimensions resource is used to create, update or delete a rate dimension. It can also be used to display all the details of rate dimensions. Rate tables contain one or more dimensions. Rate dimensions define the nature of the tiers that is used in a rate table.
Create a rate dimension
Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions
Delete a rate dimension
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}
Get a rate dimension
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}
Get all rate dimensions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions
Update a rate dimension
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}
Rate Dimensions/Rate Dimension - Tiers
The rate dimensions tiers resource is used to create, update, or delete the association of tiers to a rate dimension. It can also be used to display all the details of the tiers in a dimension.
Create a rate dimension tier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers
Delete a rate dimension tier
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers/{RateDimTierId}
Get a rate dimension tier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers/{RateDimTierId}
Get all rate dimension tiers
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers
Update a rate dimension tier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers/{RateDimTierId}
Rate Tables
The rate table resource is used to create, update or delete a rate table. It can also be used to display all details of rate tables. The plan component rate table determines the compensation rate for the earnings calculations. The performance measure scorecard is used to establish attainment rates or fixed amounts for different performance levels.
Create a rate table
Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateTables
Delete a rate table
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}
Get a rate table detail
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}
Get all rate table details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables
Update a rate table
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}
Rate Tables/Rate Table Dimensions
The rate table - dimensions resource is used to create, update, or delete the association of dimensions to a rate table. It can also be used to display all details of the dimensions in a rate table. You can only add up to ten rate dimensions to a rate table using REST Services.
Create a rate dimension association with a rate table
Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions
Delete a rate dimension association with a rate table
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions/{RateTableDimId}
Get a rate dimension details within a rate table
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions/{RateTableDimId}
Get all rate dimension details within a rate table
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions
Rate Tables/Rate Table Dimensions/Rate Dimensions Tiers
The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.
Get a rate dimension tier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions/{RateTableDimId}/child/RateTableDimensionTiers/{RateTableDimensionTiersUniqID}
Get all rate dimension tiers
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions/{RateTableDimId}/child/RateTableDimensionTiers
Rate Tables/Rate Table Rates
The rate table rates resource is used to create, view, or update the rates for a rate table or a scorecard. It can also be used to display all the rates of a rate table or a scorecard. You can only create rates with non-zero values.
Create a rate table rate
Method: post
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableRates
Get a rate table rate
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableRates/{RateTableRateId}
Get all rate table rates
Method: get
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableRates
Update a rate table rate
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableRates/{RateTableRateId}
Resolution Links
The resolution link resource is used to view, create, and update resolution links. A resolution link indicates that party records have duplicate information, and includes information about the linked parties. A link has a master record and link member record which can be removed from, or restored to, the link.
Create a link
Method: post
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks
Get a link
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}
Get all links
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks
Update a link
Method: patch
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}
Resolution Links/Link Members
The link member resource is used to view, create, and update the members of a link.
Create a link member for the link
Method: post
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}/child/LinkMember
Get a link member
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}/child/LinkMember/{PartyNumber}
Get all link members for the link
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}/child/LinkMember
Update a link member
Method: patch
Path: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}/child/LinkMember/{PartyNumber}
Resolution Requests
The resolution requests resource is used to view and create resolution requests. A resolution request includes information about duplicate party (account, contact, and so on) records, and attempts to duplicate parties in the system or resolve duplicate detail information for a party. The request is then immediately processed or sent to the data steward for review and approval.
Create a resolution request
Method: post
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests
Get a resolution request
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}
Get all resolution requests
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests
Resolution Requests/Duplicate Parties
The duplicate parties resource is used to view and create duplicate parties in a resolution request. The duplicate parties resource include details of the duplicate party, such as its name, identifier, and so on.
Create a duplicate party
Method: post
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty
Get a duplicate party
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty/{DetailId}
Get all duplicate parties
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty
Resolution Requests/Duplicate Parties/Source System References
The source system references resource is used to view the unique identifier of the duplicate record in the source system. Source system is the system from the duplicate record originated.
Get a source system reference
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty/{DetailId}/child/SourceSystemReference/{DetailId2}
Get all source system references
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/DuplicateParty/{DetailId}/child/SourceSystemReference
Resolution Requests/Resolution Details
The resolution details resource is used to view and create a master record of the surviving entities after the resolution of duplicate records.
Create a detailed record for a duplicate party resolution
Method: post
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/ResolutionDetail
Get a detailed record for a duplicate party resolution
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/ResolutionDetail/{DetailId}
Get all detailed records for all duplicate party resolutions
Method: get
Path: /crmRestApi/resources/11.13.18.05/resolutionRequests/{RequestId}/child/ResolutionDetail
Resource Capacities
The resource capacity resource is used to view, create, update, and delete resource capacities. A resource capacity indicates the maximum number of objects a resource can be assigned per channel type.
Create a resource capacity
Method: post
Path: /crmRestApi/resources/11.13.18.05/resourceCapacities
Delete a resource capacity
Method: delete
Path: /crmRestApi/resources/11.13.18.05/resourceCapacities/{CapacityId}
Get a resource capacity
Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceCapacities/{CapacityId}
Get all resource capacities
Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceCapacities
Update a resource capacity
Method: patch
Path: /crmRestApi/resources/11.13.18.05/resourceCapacities/{CapacityId}
Resource Users
The resource users resource is used to view, create, update, and delete a resource user. A resource user can manage the various stages of a resource's lifecycle, such as hiring, promotion, demotion, and so on.
Create a resource user
Method: post
Path: /crmRestApi/resources/11.13.18.05/resourceUsers
Delete a resource user
Method: delete
Path: /crmRestApi/resources/11.13.18.05/resourceUsers/{ResourcePartyNumber}
Get a resource user
Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceUsers/{ResourcePartyNumber}
Get all resource users
Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceUsers
Update a resource user
Method: patch
Path: /crmRestApi/resources/11.13.18.05/resourceUsers/{ResourcePartyNumber}
Resource Users/Resource Role Assignments
The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.
Get a resource role assignment
Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceUsers/{ResourcePartyNumber}/child/ResourceRoleAssign/{RoleRelateId}
Get all role assignments for a resource
Method: get
Path: /crmRestApi/resources/11.13.18.05/resourceUsers/{ResourcePartyNumber}/child/ResourceRoleAssign
Resources
Resources is used to view the details of a resource. A resource is a person within the deploying company who can be assigned work to accomplish business objectives, such as sales persons or partner members.
Get a resource
Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}
Get all resources
Method: get
Path: /crmRestApi/resources/11.13.18.05/resources
Resources/Picture Attachments
The picture attachments resource is used to view the picture of a resource.
Get a resource's picture
Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment/{AttachedDocumentId}
Get all resources' pictures
Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment
Roles
The incentive compensation roles resource is used to view, create, update, and delete an incentive compensation role. Incentive compensation roles match plans, pay groups, and payment plans to participants by grouping them under a specific role.
Create an incentive compensation role
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles
Delete an incentive compensation role
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}
Get a specific incentive compensation role detail
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}
Get all incentive compensation role details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles
Update an incentive compensation role
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}
Roles/Role - Participants
The role - participants resource is used to view, create, update, and delete the participants that can be assigned an incentive compensation role.
Create a participant for a role
Method: post
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants
Delete a participant from a role
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants/{ParticipantRoleId}
Get a participant for a role
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants/{ParticipantRoleId}
Get all participants for a role
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants
Update a participant for a role
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/{RoleId}/child/RoleParticipants/{ParticipantRoleId}
Rule Attributes List of Values
The rule attributes list of values resource is used to view the list of the qualifiers, their operators, and the rule types the qualifiers are used in.
Get a rule attribute
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleAttributesLOV/{incentiveCompensationRuleAttributesLOVUniqID}
Get all rule attributes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleAttributesLOV
Rule Types List of Values
The rule types list of values resource is used to view the list of rule types. It indicates the specific usage of the rule such as classification, crediting and other usages.
Get a rule type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleTypesLOV/{incentiveCompensationRuleTypesLOVUniqID}
Get all rule types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleTypesLOV
Sales Leads
The sales lead resource is used to view, create, or modify a lead. A lead is a transaction record created when a party has expressed an interest in a product or service. It represents a selling opportunity.
Create a sales lead
Method: post
Path: /crmRestApi/resources/11.13.18.05/leads
Delete a sales lead
Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}
Get a sales lead
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}
Get all sales leads
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads
Update a sales lead
Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}
Sales Leads/Lead Qualifications
The assessments resource is used to view, create and update qualifications of a lead.
Create a lead qualification
Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Assessments
Delete a lead qualification
Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Assessments/{AssessmentId}
Get a lead qualification
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Assessments/{AssessmentId}
Get all lead qualifications
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Assessments
Update a lead qualification
Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Assessments/{AssessmentId}
Sales Leads/Lead Qualifications/Assessment Answer Groups
The assessment answer groups resource is used to view question groups in an assessment.
Get a lead qualification answer group
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}
Get all lead qualification answer groups
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups
Sales Leads/Lead Qualifications/Assessment Answer Groups/Assessment Answers
The assessment answer resource is used to view and update a response for a question in a question group.
Get a lead qualification answer
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}
Get all lead qualification answers
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer
Update a lead qualification answer
Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}
Sales Leads/Notes
The note resource is used to capture comments, information, or instructions for a sales lead.
Create a note
Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Note
Delete a note
Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Note/{NoteId}
Get a note
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Note/{NoteId}
Get all notes
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Note
Update a note
Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/Note/{NoteId}
Sales Leads/Opportunities
The opportunity resource is used to view, create, or modify an opportunity generated from a lead. An opportunity list associated with the lead represents leads that have already been converted to the list of opportunities.
Get all opportunities
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/LeadOpportunity
Get an opportunity
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/LeadOpportunity/{LeadNumber}
Sales Leads/Product Groups
The product groups resource is used to capture the name of the product group associated with the sales lead. A product group is a business object that groups related products, so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.
Get a product group
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/productGroups/{ProdGroupId}
Get all product groups
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/productGroups
Set product usage code
Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/productGroups
Set product usage mode
Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/productGroups
Sales Leads/Products
The product resource is used to capture the name of the product associated with the sales lead.
Get a product
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/products/{productsUniqID}
Get all products
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/products
Set product usage code
Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/products
Set product usage mode
Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/products
Sales Leads/Sales Lead Contacts
The sales lead contacts resource is used to capture a contact associated with the sales lead.
Create a sales lead contact
Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadTcMembers1
Delete a sales lead contact
Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadTcMembers1/{LeadMemberId}
Get a sales lead contact
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadTcMembers1/{LeadMemberId}
Get all sales lead contacts
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadTcMembers1
Update a sales lead contact
Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadTcMembers1/{LeadMemberId}
Sales Leads/Sales Lead Products
The sales lead products resource is used to capture a product associated with the sales lead.
Create a sales lead product
Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklProdAssoc1
Delete a sales lead product
Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklProdAssoc1/{LeadProductId}
Get a sales lead product
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklProdAssoc1/{LeadProductId}
Get all sales lead products
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklProdAssoc1
Update a sales lead product
Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklProdAssoc1/{LeadProductId}
Sales Leads/Sales Lead Resources
The sales lead resources data object (resource) is used to capture a resource associated with the sales lead team. A lead resource is a business object that is used to represent resources who are team members that form part of the lead sales team.
Create a sales lead resource
Method: post
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadResources
Delete a sales lead resource
Method: delete
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadResources/{LeadResourceId}
Get a sales lead resource
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadResources/{LeadResourceId}
Get all sales lead resources
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadResources
Update a sales lead resource
Method: patch
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadResources/{LeadResourceId}
Sales Leads/Sales Lead Territories
The sales lead terrritories resource is used to view the associated sales lead territories.
Get a sales lead territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadTerritoryAssoc/{LeadTerritoryId}
Get all sales lead territories
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/MklLeadTerritoryAssoc
Sales Leads/Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Get a smart action (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/smartActions/{UserActionId}
Get all smart actions
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/smartActions
Sales Leads/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/leads/{LeadId}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action URL binding (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}
Sales Leads/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/leads/{LeadId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload
Get an action request payload (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}
Sales Leads/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/leads/{LeadId}/child/smartActions/{UserActionId}/child/UserActionNavigation
Get an action navigation (Not Supported)
Method: get
Path: /crmRestApi/resources/11.13.18.05/leads/{LeadId}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}
Sales Order CPQ Integration Configurations
The sales order CPQ integration configurations resource is used to view the sales order CPQ integration configurations.
Get a quote integration configuration
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations/{OrderSetupRefId}
Get all quote integration configurations
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations
Sales Order CPQ Integration Configurations/Sales Order Setup Disabled Revenue Fields
The sales order setup disabled revenue fields resource is used to view the disabled revenue fields after a opportunity is quoted. The foreign key is used for identifying the relation between disabled revenue field and order setup reference identifier.
Get a disabled revenue field
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations/{OrderSetupRefId}/child/SalesOrdersSetupDsbldRevnFields/{OrdersDsbldRevnFieldId}
Get all disabled revenue fields
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations/{OrderSetupRefId}/child/SalesOrdersSetupDsbldRevnFields
Sales Order CPQ Integration Configurations/Sales Order Setup Reference Details
The sales order setup reference details is used to view the sales order setup detail rows.
Get a quote setup reference detail
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations/{OrderSetupRefId}/child/SalesOrdersSetupRefDetails/{OrderSetupRefDetailId}
Get all quote setup reference details
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations/{OrderSetupRefId}/child/SalesOrdersSetupRefDetails
Sales Orders
The sales order resource is used to view, create, update, and delete sales orders. A sales order is an order issued for product or services by a party. The sales order resource captures the quote and the order header information such as name, version, status, and amount.
Create a quote
Method: post
Path: /crmRestApi/resources/11.13.18.05/salesOrders
Delete a quote
Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}
Get a quote
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}
Get all quotes
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesOrders
Update a quote
Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}
Sales Promotions
The sales promotion resource is used to view, create, update, or delete a sales promotion. A sales promotion is a business object that is used to offer special pricing to your customers to promote products.
Create a sales promotion
Method: post
Path: /crmRestApi/resources/11.13.18.05/salesPromotions
Delete a sales promotion
Method: delete
Path: /crmRestApi/resources/11.13.18.05/salesPromotions/{SalesPromotionId}
Get a sales promotion
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesPromotions/{SalesPromotionId}
Get all sales promotions
Method: get
Path: /crmRestApi/resources/11.13.18.05/salesPromotions
Update a sales promotion
Method: patch
Path: /crmRestApi/resources/11.13.18.05/salesPromotions/{SalesPromotionId}
Sales Territories
The sales territories resource represents the list of sales territories that the logged-in user can view. A sales territory is an organizational domain with boundaries defined by attributes of customers, products, services, resources, and so on. Sales territories can be created based on multiple criteria including postal code, area code, country, vertical market, size of company, product expertise, and geographical location.
Sales territories form the fundamental infrastructure of sales management as they define the jurisdiction that salespeople have over sales accounts, or the jurisdiction that channel sales managers have over partners and partner transactions.
Create a territory
Method: post
Path: /crmRestApi/resources/11.13.18.05/territories
Delete a territory
Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}
Get a territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}
Get all territories
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories
Update a territory
Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}
Sales Territories/Line of Business
The line of business resource is used to view the lines of business associated with a sales territory. A line of business is a general term that describes the products or services offered by the company or organization. The line of business object contains all lines of business for historical, active, and draft territory versions. It is optional for a sales territory to have associated lines of business.
Create a line of business for a territory
Method: post
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness
Delete a line of business for a territory
Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness/{TerrLobId}
Get a line of business for a territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness/{TerrLobId}
Get all lines of business for a territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness
Update a line of business for a territory
Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness/{TerrLobId}
Sales Territories/Resources
The resources resource is used to view the resources, such as owner or sales people associated with a sales territory. The equivalent functional term for resource is team member. The resources object contains all team members for historical, active, and draft territory versions. Each sales territory must have an owner, so each of the sales territory versions has at least one resource record.
Create a resource for a territory
Method: post
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource
Delete a resource for a territory
Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource/{TerrResourceId}
Get a resource for a territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource/{TerrResourceId}
Get all resources for a territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource
Update a resource for a territory
Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource/{TerrResourceId}
Sales Territories/Rules
The rules resource is used to view the territory rules associated with a sales territory. The equivalent functional term for rule is coverage. The coverage is what identifies the scope of responsibility of the sales territory team in the market space. The rules object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.
Create a rule for a territory
Method: post
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule
Delete a rule for a territory
Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}
Get a rule for a territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}
Get all rules for a territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule
Update a rule for a territory
Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}
Sales Territories/Rules/Rule Boundaries
The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.
Create a rule boundary for a territory
Method: post
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1
Delete a rule boundary for a territory
Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}
Get a rule boundary for a territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}
Get all rule boundaries for a territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1
Update a rule boundary for a territory
Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}
Sales Territories/Rules/Rule Boundaries/Rule Boundary Values
The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.
Create a rule boundary value for a territory
Method: post
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1
Delete a rule boundary value for a territory
Method: delete
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1/{TerrRuleBndryValueId}
Get a rule boundary value for a territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1/{TerrRuleBndryValueId}
Get all rule boundary values for a territory
Method: get
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1
Update a rule boundary value for a territory
Method: patch
Path: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1/{TerrRuleBndryValueId}
Sales Territory Proposals
The sales territory proposals resource is used to view, create, update, and delete territory proposals. A territory proposal is a container used to model territory changes without affecting the active territories. Sales executives, administrators, and managers use territory proposals to model different ways to partition their territories and view the results until they are satisfied with a model. They can then activate the preferred territory proposals.
Create a proposal
Method: post
Path: /crmRestApi/resources/11.13.18.05/proposals
Delete a proposal
Method: delete
Path: /crmRestApi/resources/11.13.18.05/proposals/{TerrProposalId}
Get a proposal
Method: get
Path: /crmRestApi/resources/11.13.18.05/proposals/{TerrProposalId}
Get all proposals
Method: get
Path: /crmRestApi/resources/11.13.18.05/proposals
Update a proposal
Method: patch
Path: /crmRestApi/resources/11.13.18.05/proposals/{TerrProposalId}
Screen Pop Pages
The screen pop pages resource is used to view the pages that are displayed as an initial starting point in a media based interaction. After identifying the contact, screen pop rules are run to determine which page is shown to the agent.
Get a screen pop page
Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages/{Name}
Get all screen pop pages
Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages
Screen Pop Pages/Screen Pop Page Parameters
The screen pop page parameters resource is used to view the parameters accepted by a screen pop page. The parameters indicate data needed to display the correct content on a page.
Get a page parameter
Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages/{Name}/child/McaParameters/{ParamId}
Get all page parameters
Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages/{Name}/child/McaParameters
Screen Pop Pages/Screen Pop Page Parameters/Screen Pop Page Map Parameters
The screen pop page map parameters resource is used to view a screen pop page parameter of the type map. Map type parameters can contain a variable number of other parameters, and are used to pass initial pre-populated fields to a create type page.
Get a page map parameter
Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages/{Name}/child/McaParameters/{ParamId}/child/MapParameters/{ParamId2}
Get all page map parameters
Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopPages/{Name}/child/McaParameters/{ParamId}/child/MapParameters
Screen Pop Tokens
The screen pop tokens resource is used to view the data passed to the screen pop pages. A token can represent a business object attribute value or can contain literal values. Tokens are interpreted by the screen pop page at run time.
Get a screen pop token
Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopTokens/{TokenCode}
Get all screen pop tokens
Method: get
Path: /crmRestApi/resources/11.13.18.05/screenPopTokens
Self-Service Registrations
The self-service registrations resource is used to view, create, and update self-service registration requests. Self-registration, allows users to create their own login and password for the application.
Create a self-service registration request
Method: post
Path: /crmRestApi/resources/11.13.18.05/selfRegistrations
Get a self-service registration request
Method: get
Path: /crmRestApi/resources/11.13.18.05/selfRegistrations/{RegistrationId}
Get all self-service registration requests
Method: get
Path: /crmRestApi/resources/11.13.18.05/selfRegistrations
Update a self-service registration request
Method: patch
Path: /crmRestApi/resources/11.13.18.05/selfRegistrations/{RegistrationId}
Self-Service Roles
The self-service roles resource is used to view, create, and delete roles for self-service users.
Create a role for a self-service user
Method: post
Path: /crmRestApi/resources/11.13.18.05/selfServiceRoles
Delete a role from a self-service user
Method: delete
Path: /crmRestApi/resources/11.13.18.05/selfServiceRoles/{RoleId}
Get a role for a self-service user
Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceRoles/{RoleId}
Get all roles for a self-service user
Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceRoles
Self-Service Users
The self-service users resource is used to view the users associated with the self-service functionality.
Get a self-service user
Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}
Get all the self-service users
Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers
Self-Service Users/Self-Service Roles
The self-service roles resource is used to view, create, update, and delete roles for self-service users.
(update an item of SelfServiceRoles)
Method: patch
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRoles/{RoleId}
Create a self-service role
Method: post
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRoles
Delete a self-service role
Method: delete
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRoles/{RoleId}
Get a self-service role
Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRoles/{RoleId}
Get all self-service roles
Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRoles
Self-Service Users/Self-Service Roles Histories
The self-service roles histories resource is used to view when a role was granted to or revoked from a self-service user.
Get a self-service role history
Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRolesHistory/{HistoryId}
Get all self-service role histories
Method: get
Path: /crmRestApi/resources/11.13.18.05/selfServiceUsers/{UserId}/child/SelfServiceRolesHistory
Service Details
The service details resource is used view the details of a service provided by an organization.
Get a service detail
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceDetails/{ServiceId}
Get all service details
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceDetails
Service Providers
The service providers resource is used to view, create, update, and delete the details of all service providers.
Create a service provider
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceProviders
Delete a service provider
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}
Get a service provider
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}
Get all service providers
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders
Update a service provider
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}
Service Providers/Services
The services resource is used view, create, update, and delete the details of services that are under the purview of a service provider.
Create a service
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services
Delete a service
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}
Get a service
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}
Get all services
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services
Update a service
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}
Service Providers/Services/Service Histories
The service histories resource is used to view the historical information about the availability of a service.
Get a service history
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}/child/serviceHistories/{HistoryId}
Get all service histories
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}/child/serviceHistories
Service Requests
The service requests resource is used to view, create, update, and delete service requests. A service request is a document to track a request from a customer for a service from the time the customer makes the request until the request is resolved.
Create a service request
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests
Delete a service request
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}
Get a service request
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}
Get all service requests
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests
Get Service Request milestone diagnostics
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}
Refresh Service Request Milestones
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}
Update a service request
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}
Service Requests/Activities
The activities resource is used to view, create, update, and delete the activities associated with a service request. Activities are the tasks that resource members work on to resolve or complete a service request.
Create an activity
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities
Delete an activity
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}
Get all activities
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities
Get an activity
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}
Update an activity
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/activities/{ActivityId}
Service Requests/Attachments
The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.
Create an attachment
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment
Delete an attachment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachedDocumentId}
Get all attachments
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment
Get an attachment
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachedDocumentId}
Update an attachment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment/{AttachedDocumentId}
Service Requests/Channel Communications
The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.
Create a channel communication
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/channelCommunication
Delete a channel communication
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/channelCommunication/{channelCommunicationUniqID}
Get a channel communication
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/channelCommunication/{channelCommunicationUniqID}
Get all channel communications
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/channelCommunication
Update a channel communication
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/channelCommunication/{channelCommunicationUniqID}
Service Requests/Contact Members
The contact members resource is used to view, create, update, and delete contact members. Contacts are a list of customer contacts associated with a service request. For example, the contact for a corporate customer requesting support for software installation may be the organization's IT manager. Agents also communicate service request resolutions, or other information, with contacts. The communication channels include e-mail, Twitter accounts, and telephone.
Create a contact
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts
Delete a contact
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts/{MemberId}
Get a contact
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts/{MemberId}
Get all contacts
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts
Update a contact
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/contacts/{MemberId}
Service Requests/Interaction References
The interaction references resource is used to view the relationship between an interaction and a service request.
Get a service request interaction
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferences/{ReferenceId}
Get all service request interactions
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferences
Service Requests/Messages
The messages resource is used to view, create, update, and delete service request messages. Messages contain information about every communication update to the service request from both, the internal agent and the customer. For example, "We have credited your account for the value of the call. You should see a credit in your next monthly bill." or "We have notified the billing department about the issue. This issue should not recur.".
Create a message
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages
Delete a message
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}
Get a message
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}
Get all messages
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages
Update a message
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}
Service Requests/Messages/Attachments
The attachments resource is used to view, create, update, and delete attachments of a service request. An attachment includes additional information about a service request.
Create an attachment
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment
Delete an attachment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachedDocumentId}
Get all attachments
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment
Get an attachment
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachedDocumentId}
Update an attachment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/Attachment/{AttachedDocumentId}
Service Requests/Messages/Channel Communications
The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.
Create a channel communication
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication
Delete a channel communication
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication/{channelCommunicationUniqID}
Get a channel communication
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication/{channelCommunicationUniqID}
Get all channel communications
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication
Update a channel communication
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication/{channelCommunicationUniqID}
Service Requests/Milestones
The milestones resource is used to view, create, update, and delete the milestones that are set in the lifecycle of a service request, such as first response time of 24 hours for a customer with Gold coverage, or a resolution time of three days for service requests with severity level 2.
Get a service request milestone
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone/{SrMilestoneId}
Get all service request milestones
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone
Update a service request milestone
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone/{SrMilestoneId}
Service Requests/Milestones/Milestone Codes
The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.
Get a service request milestone history
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory/{HistoryId}
Get all service request milestone history
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory
Service Requests/Resources
Resources is used to view, create, update, and delete resource members. Resource members are a list of employees or partners, such as service representatives, service managers, or product managers, who can take ownership of items, such as service or knowledge authoring requests, in a queue.
Create a resource member
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers
Delete a resource member
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers/{MemberId}
Get a resource member
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers/{MemberId}
Get all resource members
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers
Update a resource member
Method: patch
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers/{MemberId}
Service Requests/Service Request References
The service request references resource is used to view, create, and delete service request references. Service request references are a list of objects linked to the service request. For example, a list of knowledge articles linked to the service request.
Create a service request reference
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences
Delete a service request reference
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences/{ReferenceId}
Get a service request reference
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences/{ReferenceId}
Get all service request references
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srReferences
Service Requests/Tags
The tags resource is used to view, create, and delete keywords or terms assigned to a service request. Tags help describe and classify a service request.
Create a tag
Method: post
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srTags
Delete a tag
Method: delete
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srTags/{srTagsUniqID}
Get a tag
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srTags/{srTagsUniqID}
Get all tags
Method: get
Path: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srTags
Smart Text Folders
The smart text folder resource is used to view, create, delete, and update the smart text folders.
Create a smart text folder
Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders
Delete a smart text folder
Method: delete
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}
Get a smart text folder
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}
Get all smart text folders
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders
Update a smart text folder
Method: patch
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}
Smart Text Folders/Smart Text Child Folders
The smart text child folder resource is used to view, create, delete, and update the smart text child folders.
Create smart text child folders
Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFolders
Delete a smart text child folder
Method: delete
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFolders/{FolderId2}
Get a smart text child folder
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFolders/{FolderId2}
Get all smart text child folders
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFolders
Update a smart text child folder
Method: patch
Path: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFolders/{FolderId2}
Smart Text User Variables
The smart text user variables resource is used to view, create, update, and delete user defined smart text variables. Smart text user variables can be defined to derive values from business objects such as service requests, defined as a literal value, or be presented as a prompt variable.
Create a smart text user variable
Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTextUserVariables
Delete a smart text user variable
Method: delete
Path: /crmRestApi/resources/11.13.18.05/smartTextUserVariables/{VariableId}
Get a smart text user variable
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextUserVariables/{VariableId}
Get all smart text user variables
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTextUserVariables
Update a smart text user variable
Method: patch
Path: /crmRestApi/resources/11.13.18.05/smartTextUserVariables/{VariableId}
Smart Texts
The Smart Text resource is used to view, create, update, and delete smart texts. A SmartText entry is a reusable fragment of text that you can use in SR messages.
A JSON Object represented as a string that provides necessary information to do the variable substitution including those needed for deriving values for the referenced object and any variable values for the purpose of overriding derived values.
Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}
Create a smart text
Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTexts
Delete a smart text
Method: delete
Path: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}
Get a smart text
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTexts
Get all smart texts
Method: get
Path: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}
Get Smart Text Variable Values
Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTexts
Process smart text variable substitution
Method: post
Path: /crmRestApi/resources/11.13.18.05/smartTexts
Update a smart text
Method: patch
Path: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}
Social Posts
The social posts resource is used view, create, and delete the details of a social post received from the Oracle Social Cloud application that the customer service personnel review and respond to. For example, posts such as "Is the oracle_support email server down? Our customers are unable to receive any email responses from our agent.".
Create a social post
Method: post
Path: /crmRestApi/resources/11.13.18.05/socialPosts
Delete a social post
Method: delete
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}
Get a social post
Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}
Get all social posts
Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts
Social Posts/Social Post Tags
The social post tags resource is used to view, create, and delete the tags associated with a social post, such as Customer_Churn, Billing Customer Service, etc.
Create a social post tag
Method: post
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/SocialPostTags
Delete a social post tag
Method: delete
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/SocialPostTags/{SocialPostTagsUniqID}
Get a social post tag
Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/SocialPostTags/{SocialPostTagsUniqID}
Get all social post tags
Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/SocialPostTags
Social Posts/Social Post URLs
The social post URLs resource is used to view, create, and delete the URLs associated with service objects such as social posts or service requests. An example of an URL is the link to a photo sent by a customer along with a social post.
Add a social post URL
Method: post
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/socialPostUrls
Delete a social post URL
Method: delete
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/socialPostUrls/{socialPostUrlsUniqID}
Get a social post URL
Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/socialPostUrls/{socialPostUrlsUniqID}
Get all social post URLs
Method: get
Path: /crmRestApi/resources/11.13.18.05/socialPosts/{PostId}/child/socialPostUrls
Social Users
The social users resource is used to view, create, and update the details of the social network user who created a social post that was captured by the Oracle Social Cloud application and sent to Engagement Cloud. For example, the details of a Twitter user who created a social post.
Create a social user
Method: post
Path: /crmRestApi/resources/11.13.18.05/socialUsers
Get a social user
Method: get
Path: /crmRestApi/resources/11.13.18.05/socialUsers/{UserId}
Get all social users
Method: get
Path: /crmRestApi/resources/11.13.18.05/socialUsers
Update a social user
Method: patch
Path: /crmRestApi/resources/11.13.18.05/socialUsers/{UserId}
Subscription AI Features
The subscription AI features resource lets you view the churn feature details. It has details such as start and end dates, item, unit price, amount, bill-to details, billing frequency, invoice rule, payment method, and account details such as account length, renewals, average renewal durations, product terminations, open/closed service requests, and average bill amounts.
Create a product churn feature
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAiFeatures
Delete a product churn feature
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAiFeatures/{SubscriptionProductPuid}
Get all product churn features
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAiFeatures
Get product churn feature
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAiFeatures/{SubscriptionProductPuid}
Update a product churn feature
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAiFeatures/{SubscriptionProductPuid}
Subscription Accounts
The subscription accounts resource is used to view, create, update, and delete a subscription account. It lists all the subscription accounts with details.
Create a subscription account
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts
Delete a subscription account
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}
Get a subscription account
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}
Get all subscription accounts
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts
Update a subscription account
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}
Subscription Accounts Roles
The subscription account roles resource is used to view, created, update, and delete roles associated with your subscription accounts.
Create a subscription account role
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccountRoles
Delete a subscription account role
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccountRoles/{SubscrAccRoleNumber}
Get a subscription account role
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccountRoles/{SubscrAccRoleNumber}
Get all subscription account roles
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccountRoles
Update a subscription account role
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccountRoles/{SubscrAccRoleNumber}
Subscription Accounts/Attachments
The attachments resource is used to view, create, update, and delete an attachment. The attachments are associated with the subscription account.
Create an attachment
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments
Delete an attachment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments/{AttachedDocumentId}
Get all attachments
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments
Get an attachment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments/{AttachedDocumentId}
Update an attachment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Attachments/{AttachedDocumentId}
Subscription Accounts/Billing Profiles
The billing profiles resource is used view, create, update, and delete a billing profile. It lists all the billing profiles for the given subscription account.
Create a billing profile
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles
Delete a billing profile
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles/{BillingProfileNumber}
Get a billing profile
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles/{BillingProfileNumber}
Get all billing profiles
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles
Update a billing profile
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/billingProfiles/{BillingProfileNumber}
Subscription Accounts/Notes
The notes resource is used to view, create, update, and delete notes associated with the subscription account. A note captures comments, information, or instructions related to an account.
Create a note
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note
Delete a note
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note/{NoteId}
Get a note
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note/{NoteId}
Get all notes
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note
Update a note
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/Note/{NoteId}
Subscription Accounts/Subscription Account Addresses
The subscription account addresses resource is used to view, create, update, and delete an account resource. It lists all the subscription account addresses with details.
Create an address
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress
Delete an address
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress/{AddressNumber}
Get all addresses
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress
Get an address
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress/{AddressNumber}
Update an address
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress/{AddressNumber}
Subscription Accounts/Subscription Account Relationships
(Resource of subscriptionAccountRelationship)
Create a subscription account relationship
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship
Delete a subscription account relationship
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship/{SubscriptionAccountRelationshipNumber}
Get a subscription account relationship
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship/{SubscriptionAccountRelationshipNumber}
Get all subscription account relationships
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship
Update a subscription account relationship
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship/{SubscriptionAccountRelationshipNumber}
Subscription Accounts/Subscription Account Roles
The subscription account roles resource is used to view, create, update, and delete an account role. It lists all the subscription account roles with details.
Create a subscription account role
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRoles
Delete a subscription account role
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRoles/{SubscrAccRoleNumber}
Get a subscription account role
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRoles/{SubscrAccRoleNumber}
Get all subscription account roles
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRoles
Update a subscription account role
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRoles/{SubscrAccRoleNumber}
Subscription Asset Transactions
The subscription asset transactions resource is used to view and create the asset transactions. The subscription asset transaction object has details such as customer asset, transaction type, transaction date etc.
Create a subscription asset transaction
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions
Get a subscription asset transaction
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}
Get all subscription asset transactions
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions
Notify fulfillemtn completed
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}
Notify pending fulfillment canceled
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}
Notify return completed
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}
Notify shipment completed
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}
Subscription Asset Transactions/Asset Fulfillment Lines
The asset fulfillment lines resource to view and create the asset fulfillment details in a replacement or upgrade transaction. The Asset Fulfillment Lines object has details such as replaced or upgraded customer asset, fulfillment date, fulfillment type etc.
Create a fulfillment line
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetFulfillmentLines
Get a fulfillment line
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetFulfillmentLines/{FulfillmentLineNumber}
Get all fulfillment lines
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetFulfillmentLines
Subscription Asset Transactions/Asset Split Lines
The asset split lines resource to is used view and create the asset split details in a split transaction. The Asset Split Lines object has details such as customer asset, quantity etc.
Create a split line
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetSplitLines
Get a split line
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetSplitLines/{SplitLineNumber}
Get all split lines
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetSplitLines
Subscription Coverage Exceptions
The subscription coverage exceptions resource is used to view the availability exception details. The availability exception object has details such as exception name, PUID.
Get a subscription availability exception
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}
Get all subscription availability exceptions
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions
Subscription Coverage Exceptions/Subscription Coverage Availabilities
The subscription coverage availability resource is used to view the availability schedule details. The availability schedule object has details such as schedule name, timezone code,exception name, PUID.
Get a subscription availability schedule
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}
Get all subscription availability schedules
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}/child/SubscriptionCoverageAvailability
Subscription Coverage Exceptions/Subscription Coverage Availabilities/Subscription Coverage Breaks
The subscription coverage break resource is used to view the availability schedule breaks. The availability schedule break object has details such as start hour, start minute,end hour, end minute.
Get a subscription availability break
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}/child/SubscriptionCoverageBreak/{BreakPuid}
Get all subscription availability breaks
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageExceptions/{ExceptionPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}/child/SubscriptionCoverageBreak
Subscription Coverage Schedules
The subscription coverage schedule resource is used to view the availability schedule details. The availability schedule object has details such as schedule name, time zone code, schedule PUID , exception PUID
Get a subscription coverage availability schedule
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}
Get all subscription coverage availability schedules
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules
Subscription Coverage Schedules/Subscription Coverage Intervals
The subscription coverage schedule interval resource is used to view the availability schedule interval details. The availability schedule interval object has details such as availability, start date , end date
Get a subscription coverage availability schedule interval
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}
Get all subscription coverage availability schedule intervals
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval
Subscription Coverage Schedules/Subscription Coverage Intervals/Subscription Coverage Availabilities
The subscription coverage schedule availability resource is used to view the schedule availability details. The availability object has details such as start hour, start minute, end hour, end minute
Get a subscription coverage availability detail
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}
Get all subscription coverage availability details
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}/child/SubscriptionCoverageAvailability
Subscription Coverage Schedules/Subscription Coverage Intervals/Subscription Coverage Availabilities/Subscription Coverage Breaks
The subscription coverage break resource is used to view the schedule break details. The break object has details such as start hour, start minute, end hour, end minute
Get a subscription coverage availability break
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}/child/SubscriptionCoverageBreak/{BreakPuid}
Get all subscription coverage availability breaks
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCoverageSchedules/{SchedulePuid}/child/SubscriptionCoverageInterval/{IntervalPuid}/child/SubscriptionCoverageAvailability/{AvailabilityPuid}/child/SubscriptionCoverageBreak
Subscription Customer Assets List of Values
The customer asset LOV resource is used to view the assets. The customer asset LOV object has details such as asset number, serial number
Get a customer asset
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCustomerAssetsLOV/{AssetNumber}
Get all customer assets
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionCustomerAssetsLOV
Subscription Products
The subscription products resource is used to view, create, update, and delete subscription product details, such as start and end dates, items, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.
Cancel Subscription
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Close Subscription
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Create a subscription product
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts
Delete a subscription product
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Get a subscription product
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts
Get a subscription product
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Put Hold
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Remove Hold
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Resume Subscription
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Suspend Subscription
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Update a subscription product
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}
Subscription Products/Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.
Create a bill line
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines
Delete a bill line
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}
Get a bill line
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines
Get a bill line
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}
Update a bill line
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}
Subscription Products/Bill Lines/Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.
Create a bill adjustment
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Delete a bill adjustment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Get a bill adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Get a bill adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Update a bill adjustment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Subscription Products/Charges
The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.
Create a charge
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges
Delete a charge
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}
Get a charge
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges
Get a charge
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}
Update a charge
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}
Subscription Products/Charges/Adjustments
The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.
Create an adjustment
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments
Delete an adjustment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Get an adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments
Get an adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Update an adjustment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Subscription Products/Charges/Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.
Create a charge tier
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers
Delete a charge tier
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Get a charge tier
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers
Get a charge tier
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Update a charge tier
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Subscription Products/Covered Levels
The covered levels resource is used to create, view, update, or delete the subscription covered levels details, such as subscription ID, subscription product ID, covered asset and its associated details.
Create a covered level
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels
Delete a covered level
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}
Get a covered level
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels
Get a covered level
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}
Update a covered level
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}
Subscription Products/Covered Levels/Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.
Create a bill line
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines
Delete a bill line
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}
Get a bill line
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines
Get a bill line
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}
Update a bill line
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}
Subscription Products/Covered Levels/Bill Lines/Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.
Create a bill adjustment
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Delete a bill adjustment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Get a bill adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Get a bill adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Update a bill adjustment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Subscription Products/Covered Levels/Charges
The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.
Create a charge
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges
Delete a charge
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}
Get a charge
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges
Get a charge
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}
Update a charge
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}
Subscription Products/Covered Levels/Charges/Adjustments
The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.
Create an adjustment
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments
Delete an adjustment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Get an adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments
Get an adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Update an adjustment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Subscription Products/Covered Levels/Charges/Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.
Create a charge tier
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers
Delete a charge tier
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Get a charge tier
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers
Get a charge tier
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Update a charge tier
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Subscription Products/Covered Levels/Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.
Create a relationship
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships
Delete a relationship
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships/{OperationLinksPuid}
Get a relationship
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships
Get a relationship
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships/{OperationLinksPuid}
Update a relationship
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/relationships/{OperationLinksPuid}
Subscription Products/Credit Cards
The credit cards resource is used to view, create, and update the credit cards associated with a subscription.
Create a credit card
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards
Get a credit card
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards
Get a credit card
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards/{CreditCardPuid}
Update a credit card
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/creditCards/{CreditCardPuid}
Subscription Products/Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.
Create a relationship
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationships
Delete a relationship
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationships/{OperationLinksPuid}
Get a relationship
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationships
Get a relationship
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationships/{OperationLinksPuid}
Update a relationship
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/relationships/{OperationLinksPuid}
Subscription Products/Sales Credits
The sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.
Create a sales credit
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits
Delete a sales credit
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}
Get a sales credit
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits
Get a sales credit
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}
Update a sales credit
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}
Subscription Profiles
The subscriptions profiles resource to view the subscription profile details. The subscriptions profile has details such as accounting rule, invoicing rule, billing frequency, invoice text, and so on.
Get a subscription profile
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProfiles/{SubscriptionProfileId}
Get all subscription profiles
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptionProfiles
Subscriptions
The subscriptions resource is used to view, create, update, and delete subscriptions. A subscription includes information such as start and end dates, customer, subscription profile, and total contract value.
Create a subscription
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions
Delete a subscription
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}
Get a subscription
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}
Get all subscriptions
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions
Update a subscription
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}
Subscriptions/Credit Cards
The credit cards resource is used to view, create, and update the credit card information associated with a subscription.
Create a credit card
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/creditCards
Get a credit card
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/creditCards/{CreditCardPuid}
Get all credit cards
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/creditCards
Update a credit card
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/creditCards/{CreditCardPuid}
Subscriptions/Parties
The parties resource to view, create, update, and delete the subscription parties.
Create subscription parties
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties
Delete a subscription party
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}
Get a subscription party
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}
Get all subscription parties
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties
Update a subscription party
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}
Subscriptions/Parties/Contacts
The contacts resource to view, create, update, and delete the contacts in a subscription party.
Create subscription contacts
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/contacts
Delete a subscription contact
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/contacts/{ContactPuid}
Get a subscription contact
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/contacts/{ContactPuid}
Get all subscription contacts
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/contacts
Update a subscription contact
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/contacts/{ContactPuid}
Subscriptions/Products
The products resource is used to view, create, update, and delete the product details for a subscription, such as start and end dates, item, unit price, amount, bill-to details, ship-to details, billing frequency, invoice rule, and payment method.
Cancel the subscription product.
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Close the subscription product.
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Create a subscription product
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products
Delete a subscription product
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Get a subscription product
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Get all subscription products
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products
Put a subscription product on hold
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Remove hold on a subscription product
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Resume the subscription product.
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Suspend the subscription product.
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Update a subscription product
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Subscriptions/Products/Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details.
Create subscription bill lines
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines
Delete a subscription bill line
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}
Get a subscription bill line
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}
Get all subscription bill lines
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines
Update a subscription bill line
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}
Subscriptions/Products/Bill Lines/Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.
Create subscription bill adjustments
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Delete a subscription bill adjustment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Get a subscription bill adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Get all subscription bill adjustments
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Update a subscription bill adjustment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Subscriptions/Products/Charges
The charges resource is used to view, create, update, and delete the charges for a subscription.
Create subscription charges
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges
Delete a subscription charge
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}
Get a subscription charge
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}
Get all subscription charges
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges
Update a subscription charge
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}
Subscriptions/Products/Charges/Adjustments
The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.
Create subscription adjustments
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments
Delete a subscription adjustment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Get a subscription adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Get all subscription adjustments
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments
Update a subscription adjustment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Subscriptions/Products/Charges/Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.
Create subscription charge tiers
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers
Delete a subscription charge tier
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Get a subscription charge tier
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Get all subscription charge tiers
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers
Update a subscription charge tier
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Subscriptions/Products/Covered Levels
The covered levels resource is used to view, create, update, and delete the subscription covered levels.
Create a covered level
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels
Delete a covered level
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}
Get a covered level
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}
Get all covered levels
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels
Update a covered level
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}
Subscriptions/Products/Covered Levels/Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details.
Create subscription bill lines
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines
Delete a subscription bill line
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}
Get a subscription bill line
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}
Get all subscription bill lines
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines
Update a subscription bill line
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}
Subscriptions/Products/Covered Levels/Bill Lines/Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.
Create subscription bill adjustments
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Delete a subscription bill adjustment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Get a subscription bill adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Get all subscription bill adjustments
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments
Update a subscription bill adjustment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid}/child/billAdjustments/{BillAdjustmentPuid}
Subscriptions/Products/Covered Levels/Charges
The charges resource is used to view, create, update, and delete the charges for a subscription.
Create subscription charges
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges
Delete a subscription charge
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}
Get a subscription charge
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}
Get all subscription charges
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges
Update a subscription charge
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}
Subscriptions/Products/Covered Levels/Charges/Adjustments
The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.
Create subscription adjustments
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments
Delete a subscription adjustment
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Get a subscription adjustment
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Get all subscription adjustments
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments
Update a subscription adjustment
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments/{ChargeAdjustmentPuid}
Subscriptions/Products/Covered Levels/Charges/Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.
Create subscription charge tiers
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers
Delete a subscription charge tier
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Get a subscription charge tier
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Get all subscription charge tiers
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers
Update a subscription charge tier
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/chargeTiers/{ChargeTierPuid}
Subscriptions/Products/Covered Levels/Child Covered Levels
The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.
Create a child covered level
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels
Delete a child covered level
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}
Get a child covered level
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}
Get all child covered levels
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels
Update a child covered level
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}
Subscriptions/Products/Covered Levels/Child Covered Levels/Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details.
Create subscription bill lines
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}/child/billLines
Delete a subscription bill line
Method: delete
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}/child/billLines/{BillLinePuid}
Get a subscription bill line
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}/child/billLines/{BillLinePuid}
Get all subscription bill lines
Method: get
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}/child/billLines
Update a subscription bill line
Method: patch
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels/{CoveredLevelPuid2}/child/billLines/{BillLinePuid}
Subscriptions/Products/Covered Levels/Child Covered Levels/Bill Lines/Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.
Create subscription bill adjustments
Method: post
Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{Cover