REST API for Sales Cloud Industry Solutions

Transcription

1 June 2017 REST API for Sales Cloud Industry Solutions Release 13 (update 17B)

2 REST API for Sales Cloud Industry Solutions Part Number E Copyright 2005, 2017 Oracle and/or its affiliates. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are commercial computer software pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at Access to Oracle Support Oracle customers have access to electronic support through My Oracle Support. For information, visit

3 or visit if you are hearing impaired. REST API for Sales Cloud Industry Solutions 3

4

5 Contents 1 Architecture Resources: Overview Resource Types Singular Collection Resource Actions Get Post Patch Delete Custom Action Batch Actions Request Response Authentication Authorization Additional Information Supported Headers HTTP Response Codes Error Message Resource Metadata Resource Description Lifecycle Management REST API for Sales Cloud Industry Solutions 5

6 Contents 9 Accessing REST APIs Example: Creating an Account Request Payload Response Introduction to Oracle Sales Cloud RESTful Web Services Overview RESTful Web Services RESTful Web Services for Oracle Sales Cloud for Communications RESTful Web Services for Oracle Sales Cloud for Consumer Goods List of Values in Standard Resources Resource Attributes in Standard Resources RESTful Web Services for Oracle Sales Cloud for High Tech and Manufacturing.. 55 RESTful Web Services for Oracle Sales Cloud for Financial Services Managing Account Plans Account Plans Overview Account Plans Tasks List of Values Resource Attributes Account Plans: Earlier Plans Tasks List of Values Resource Attributes Managing Audit History Audit History Overview Audit History Tasks REST API for Sales Cloud Industry Solutions

7 Architecture Get List of Values Resource Attributes Managing Cases Cases Overview Tasks Cases List of Values Resource Attributes Managing CaseToContact Managing Case to Contact Resources: Overview Tasks Managing Case to Contact Resources List of Values Resource Attributes Managing CaseToResource Managing Case to Resource: Overview Tasks Managing Case to Resource Resources List of Values Resource Attributes Managing Daily Balances Daily Balance Overview Tasks Daily Balance List of Values Resource Attributes Managing Financial Accounts REST API for Sales Cloud Industry Solutions 7

8 Contents Financial Account Overview Tasks Financial Account List of Values Resource Attributes Managing Financial Account Contacts Financial Account Contact Overview Tasks Financial Account Contact List of Values Resource Attributes Managing Integration Configuration Integration Configuration Overview Integration Configuration Tasks List of Values Resource Attributes Managing Integration Map Lookup Integration Map Lookup Overview Integration Map Lookup Tasks List of Values Resource Attributes Managing Inventories Inventories Overview Inventories Tasks REST API for Sales Cloud Industry Solutions

9 Architecture Get List of Values Resource Attributes Managing Orders Orders Overview Orders Tasks List of Values Resource Attributes Orders: Order Items Tasks List of Values Resource Attributes Managing Participating Accounts Participating Accounts Overview List of Values Resource Attributes Managing Plan Activities Plan Activities Overview List of Values Resource Attributes Managing Plan Contacts Plan Contacts Overview List of Values Resource Attributes Managing Plan Leads Plan Leads Overview List of Values REST API for Sales Cloud Industry Solutions 9

10 Contents Resource Attributes Managing Plan Opportunities Plan Opportunities Overview List of Values Resource Attributes Managing Plan Teams Plan Teams Overview List of Values Resource Attributes Managing Program Territories Program Territories Overview Program Territories Tasks List of Values Resource Attributes Managing Promotions Promotions Overview Promotions Tasks List of Values Resource Attributes Promotions: Promotion Groups Tasks List of Values Resource Attributes Promotions: Promotion Products Tasks REST API for Sales Cloud Industry Solutions

11 Architecture Get List of Values Resource Attributes Managing Promotion Programs Promotion Programs Overview Promotion Programs Tasks List of Values Resource Attributes Promotion Programs: Program Groups Tasks List of Values Resource Attributes Promotion Programs: Program Products Tasks List of Values Resource Attributes Managing Shopping Carts Shopping Carts Overview Shopping Carts Tasks List of Values Resource Attributes Managing Tickets Tickets Tasks List of Values Resource Attributes REST API for Sales Cloud Industry Solutions 11

12 Contents 35 Managing Ticket Contacts Ticket Contacts Overview Ticket Contacts Tasks List of Values Resource Attributes Managing Transactions Transaction Overview Tasks Transaction List of Values Resource Attributes REST API for Sales Cloud Industry Solutions

13 Architecture Get REST API for Sales Cloud Industry Solutions 13

14

15 1 Architecture Oracle Applications Cloud REST APIs adhere to the RESTful architecture style and use simple HTTP requests to create, update, read, and delete data. Note: This document describes the Oracle Sales Cloud RESTful Web APIs that are supported in Release 13. Only those APIs that are included in this document are currently supported. Please contact Oracle Support if you require assistance with RESTful APIs. A RESTful architecture: Is stateless: The client holds the session state. Each request from the client contains the necessary information for the server to respond to it. Uses caching: Resource caching is supported whenever possible. The response header indicates whether data is suitable for caching or not. Cache headers are used to improve performance. In Oracle Applications Cloud, the etag header is used for caching. Is a layered system: An intermediary can exist between a client and a resource server. Has a uniform-interface: The following aspects help in keeping resources uniform: o Named URLs identify all resources. o A resource representation is used to manipulate objects. o Each resource provides the relevant self-descriptive metadata. o Each response contains hypermedia links. Additionally, Hypermedia as the Engine of Application State (HATEOAS) includes hypermedia links with responses to facilitate dynamic navigation of interfaces. Notes: In all APIs: Data interchange uses JavaScript Object Notation (JSON) format. Data compression is implemented using x-gzip/gzip and deflate encoding compression methods. REST API for Sales Cloud Industry Solutions 15

16

17 2 Resources: Overview A resource in a REST API is an object with a type, associated data, relationships to other resources, and a set of methods that operate on it. Resources in Oracle Applications Cloud are organized in a hierarchy that includes: Root resource: A logical object, such as an opportunity or a lead. Sub resource: A resource within the context of a parent resource, such as contact for an opportunity, or lead products. List-of-values (LOV) resource: A resource that provides a list of valid values that are used when setting the value for a field. List-of-values resources are of two types: o Lookup: A short static list containing values used in a field. For example, an opportunity has a CurrencyCode field. The available currency codes for that field are defined in a separate list-of-values resource. o Dynamic: The list of valid values is dynamically based on the context of the current resource. For example, each opportunity has a contact. The list of selectable contacts is driven by the region and other contextual details of the opportunity. A hierarchical structure provides the following benefits: Better organization of resources because related data is grouped together. Improved performance because a single HTTP request can handle multiple resources. REST API for Sales Cloud Industry Solutions 17

18

19 3 Resource Types REST APIs provide two types of resources: Singular Collection Singular A singular resource represents a single entity resource, such as an employee or a purchase order. It may be hierarchical and can have either child resources or a parent resource. A singular resource has a links property to support HATEOAS, which is one of the most important constraints of REST resources. The links property defines the links to related resources. Each link object includes the following properties: rel: Defines the relation to the target resource. The common relations are: o Self link (rel="self"): Identifies the link's context in the response. o Canonical link (rel="canonical"): Provides the preferred version of the resource URL. o Child link (rel=child"): Provides a link to a child resource. o LOV link (rel="lov"): Provides a link to a resource containing a valid list of values to be used when setting a field. o Parent link (rel="parent"): Links back to its parent resource. href: A URL for accessing the resource. name: A unique identifier within the links. kind: Indicates the type of target resource. This property can have either a collection (for a collection resource) or an item as its value. Collection A collection resource represents a list of items, such as a list of employees or purchase orders. It has the following characteristics: Extends a singular resource, supporting the links property. Supports requests in parts resulting in a paginated response. The client can get a portion of the collection in one request followed by multiple such requests for the next or previous portion. Hence, the links section may have the following navigation options: o Previous link (rel=prev): It points to the previous page. o Next link (rel=next): It points to the next page. Functions either as a top-level resource or a sub resource. REST API for Sales Cloud Industry Solutions 19

20 Contents Contains an array of singular resources of the same type. The client can use the orderby command to enforce a specific order. Otherwise, the order of the items returned can't be determined. In addition, collection resources support the following parameters related to querying and paging. Table 1. of a collection resource Parameter Purpose items hasmore totalresult limit count offset Includes an array of items in the collection. Each item is a singular resource. A Boolean value that indicates whether there are more items to be retrieved. For example, the client runs a GET command on an opportunities resource. The server stores 100 opportunities, but the current request returns only 25 opportunities. To indicate that there are more values to retrieve, the server sets the read-only property hasmore to true. After retrieving all records, the server sets the property to false. An integer value that specifies the total number of the resource instances. It includes instances in the current response and the instances not yet retrieved. An integer value that specifies the paging size that the server uses when serving a client request. For example, the client may request a paging size value of 100, but the server may adjust the value to 25 to improve application performance. An integer value that specifies the number of items in the paging response. This value matches the value in the items property. An integer value that specifies the index of the first item to be returned. The offset property index begins at 0 and can't be negative. For example: If the offset parameter is set to zero (offset=0), then the response contains all items starting from the first item in the collection. If the offset parameter is set to zero (offset=10) and the count set to 20 (count=20), then the response contains resources from 11 to REST API for Sales Cloud Industry Solutions

21 Resource Types Get REST API for Sales Cloud Industry Solutions 21

22

23 4 Resource Actions You can execute the following standard methods to interact with either a singular resource or a resource collection, using their URLs. The following table shows the feasibility of executing standard methods and lists the methods for singular resource and resource collections. Method Singular Resource Resource Collection Get Yes Yes Post No Yes Patch Yes No Delete Yes No For custom methods, the POST method applies to both a singular resource and a resource collection. Each method is discussed in detail in the following sections. Get Use this method to query and retrieve information. Parameters in a GET method are common for both singular resource and resource collection. However, the parameters used in the query to refine the search or filter the results in a singular resource are different from those used in a resource collection. The following common parameters are used in the method for querying both singular resources and resource collections. Parameter expand Description When querying a hierarchical resource, use this parameter to retrieve the child resource along with its parent resource. By default, the server doesn't return any child resource. You can set the query parameter value to one of the following: Name of a single child resource. Comma-separated list of child resource names to REST API for Sales Cloud Industry Solutions 23

24 Contents Parameter fields onlydata Description specify multiple values. Keyword all to expand all child resources Selects only certain fields for which the information is required. You can set the query parameter to one of the following: Name of a single property Comma-separated list of property names to specify multiple values. Retrieves data without requesting the links because by default all links are returned. So, run the command as shown in this example: GET /salesapi/resources/latest/opportunities/cdrm_7 50?onlyData=true&fields=name,statuscode This command returns only the Name and Status without any link. The following parameters are used in a GET method for querying a collection resource, in addition to the common parameters. Parameter limit Description Positive integer value that specifies the maximum number of items that a server returns. The server may override the value to improve performance. If the client doesn't specify a limit value, then the server uses a default limit value. Positive integer value that specifies the index of the first item to be returned. The offset index begins at 0. For example, to return items in a collection, use: offset=0 to return all items starting from the first item in the collection. offset=10 to return all items starting from the 11 th item. offset Note: Specify values for both the limit and offset query parameters to 24 REST API for Sales Cloud Industry Solutions

25 Resource Actions Get Parameter Description obtain a paginated response. For example, if 100 opportunities exist and a client sends the request GET /opportunities?offset=10&limit=20, then the response contains opportunities from 11 to 30. Note: No order is implied if the client specifies only the limit and offset parameter. Therefore, it is recommended that the client specifies an order to ensure consistent paging results. For limit and offset parameters, the client may encounter inconsistencies if the collection resource is updated between paging requests Specifies a filter (using where clause) to restrict the items returned in the collection. The value of this query parameter contains one or more expressions separated by a semicolon. For example: q=deptno>=10 and <= 30;loc!=NY q Supported operators: Greater than: > Less than: < Greater than or equal to: >= Less than or equal to: <= Not equal:!= And: AND Equals: = Like: LIKE Special characters: The double and single quotation marks define literals. A backslash symbol (\) is used as an escape character. An asterisk (*) defines a wildcard character. REST API for Sales Cloud Industry Solutions 25

26 Contents Parameter Description A Boolean value that specifies how to return the total number of items that match the q query parameter. totalresults orderby finder dependency For example, if the employees collection contains employees with id=1..100, you use the following code: GET/employees?q=id>10&limit=5&totalResults=true The response is as follows: { "items": [ {"id": 11}, {"id": 12}, {"id": 13}, {"id": 14}, {"id": 15} ], "totalresults": 90 } Specifies the order of items returned in the response payload. The query parameter value is a commaseparated of field names, each optionally followed by a colon and asc or desc to determine the ascending or descending order. For example:?orderby=field1:asc,field2:desc Uses the predefined where clause that includes certain bind parameters. For example, opportunities resource defines a finder named MyOpportunitiesFinder, with one of the bind parameters named Name. A client can use this finder to fetch all opportunities with the name Auto that the current user owns. For example: finder=myopportunitiesfinder;name=auto In this command, the format of the query parameter value is: <finder>;<attr1>=<val1>,<attr2>=<val2> Used for the List of Values resources. For example, a location resource has a state field, whose values are 26 REST API for Sales Cloud Industry Solutions

27 Resource Actions Post Parameter Description derived from a States resource. For example, location has the following fields: { "Country" : "US", "State" : "CA" } The State resource has a list of values that depends on the Country resource. When the user changes the Country to BR at the client side only (the change isn't communicated to the server yet), the client side must know the new valid list of states. In this case, the client can make a request: States?dependency=Country=BR This request uses BR as the country field value and returns the associated list of states. Post Use this method to create a new item. The request media type is as follows: application/vnd.oracle.adf.resourceitem+json. Patch Use this method for making partial updates to a resource. Only the fields contained in the request body are updated. The request media type is as follows: application/vnd.oracle.adf.resourceitem+json. Delete REST API for Sales Cloud Industry Solutions 27

28 Contents Use this method to delete a resource. It doesn t require a request body. Custom Action Sometimes a resource exposes a custom action that isn't the standard Create, Read, Update, and Delete (CRUD) action. A custom action is always initiated using a POST method. The relevant request media type is as follows: application/vnd.oracle.adf.action+json, The response media type is as follows: application/vnd.oracle.adf.actionresult+json. The following request always contains a custom action, and optionally an array of input parameters for the custom action: application/vnd.oracle.adf.action+json The JSON schema of the media type is: { "$schema": " "type": "object", "title": "Action execution representation.", "description": "Represents the action execution and its parameters.", "properties": { "name": { "type": "", "description": "Action name." }, "parameters": { "type": "array", "description": "Parameter name/value pair.", } }, "required": [ "name" ] } 28 REST API for Sales Cloud Industry Solutions

29 5 Batch Actions You can combine multiple operations into a single HTTP request to improve performance. For example, the following request retrieves an existing employee and updates another employee s details: POST /myapi/resources/latest/hremployees HTTP/1.1 Host: example.oracle.com Content-type:application/vnd.oracle.adf.batch+json { "parts": [ { "id": "part1", "path": "/latest/hremployees/101", "operation": "get" }, { "id": "part2", "path": "/latest/hremployees/102", "operation": "update", "payload": { "Salary": } } ] } Request The request body is a JSON object with a field named parts, which is an array of objects. Each object in the array contains the following: A unique ID A relative path to the resource An operation A payload (optional) The JSON schema of the request is as follows: { REST API for Sales Cloud Industry Solutions 29

30 Contents "$schema": " "type": "object", "title": "Batch execution", "description": "Group multiple requests together ('part').", "definitions": { "Part": { "type": "object", "allof": [ { "properties": { "id": { "type": "", "description": "An identification provided by the client to distinguish each part provided in the batch request." }, "path": { "type": "", "description": "Resource's location." }, "operation": { "type": "", "enum": [ "get", "create", "update", "replace", "delete" ], "description": "The operation that will be performed." }, "preconditionsucceeded": { "type": "boolean", "description": "This attribute is set in the batch response only when ifmatch or ifnonematch are provided in the request. It will be 'true' if the precondition (ifmatch/ifnonematch) was satisfied, otherwise 'false'." }, "payload": { "oneof": [ { "$ref": "resource-item.json", "description": "The payload that will be used in the operation. Example: a resource instance should be provided in order to execute a 'create'." }, { "type": "null" } ] } 30 REST API for Sales Cloud Industry Solutions

31 Batch Actions Custom Action }, "required": [ "id", "path", "operation" ] } ], "anyof": [ { "properties": { "ifmatch": { "type": "", "description": "This attribute is analogous to the If-Match header. It represents a precondition to execute this operation. The value can be null (same effect of 'If- Match: *') or an array of resource versions." } } }, { "properties": { "ifnonematch": { "type": "", "description": "This attribute is analogous to the If-None-Match header. It represents a precondition to execute this operation. The value can be null (same effect of 'If-None-Match: *') or an array of resource versions." } } } ], "description": "Represents a request." } }, "properties": { "parts": { "type": "array", "items": { "$ref": "#/definitions/part" }, "description": "Array that represents multiple requests." } }, "required": [ "parts" ] } REST API for Sales Cloud Industry Solutions 31

32 Contents Response The response body contains the result, and it uses the same media type as the request, such as: {"parts":[ { "id":"part1", "path":"/latest/hremployees/101", "operation":"get", "payload" : { "EmployeeId" : 101 }, { "id" : "part2", "path" : "/latest/hremployees/102", "operation" : "update", "payload" : { "EmployeeId" : 102, } ]} 32 REST API for Sales Cloud Industry Solutions

33 6 Authentication REST APIs in Oracle Applications Cloud use the following global server-side security policy: oracle/multi_token_over_ssl_rest_service_policy The policy supports the following mechanisms that the client uses to send authentication credentials: Basic authentication over SSL: Ensures secure and encrypted access to data over a network. SAML 2.0 Bearer token in the HTTP header over SSL: Extracts SAML 2.0 Bearer assertion in the HTTP header. JWT token in the HTTP header over SSL: Extracts the user name from the JWT token in the HTTP header REST API for Sales Cloud Industry Solutions 33

34

35 7 Authorization Any user having access to the UI page and privileges to manage an object has access to its corresponding REST resource. For additional details, such as specific roles to access a REST resource, refer to the relevant security guides on the Oracle Help Center at REST API for Sales Cloud Industry Solutions 35

36

37 8 Additional Information More information that can be used as reference. Supported Headers A REST API can interpret the following media types. Description application/vnd.oracle.adf.resourcecollection+json Represents a collection resource, such as opportunities. application/vnd.oracle.adf.resourceitem+json application/vnd.oracle.adf.action+json application/vnd.oracle.adf.actionresult+json application/vnd.oracle.adf.description+json application/vnd.oracle.adf.batch+json Represents a resource item, such as one opportunity. Describes an action. Describes the result of an action. Indicates the metadata of the resource. Supports a batch request. A REST API can parse a compressed request that uses an encoding provided in the following table. Encoding Identity Description This encoding doesn't compress the payload. It has the same behavior when the encoding is omitted. REST API for Sales Cloud Industry Solutions 37

38 Contents x-gzip (and gzip) Deflate An encoding format produced by the file compression program gzip (GNU zip) as described in RFC This format is a Lempel-Ziv coding (LZ77) with a 32-bit Cycle Redundancy Check (CRC). The zlib format defined in RFC 1950 in combination with the deflate compression mechanism described in RFC The supported headers also include the following: Accept: The content-type that is acceptable to the response. Accept-Encoding: The encoding that is acceptable to the response. Location: When a new resource is created, a location header is included in the response to indicate the URL of the newly created resource. ETag: ETag is generated if the resource has a change indicator. The client can use ETag for caching control. If-Match: This header is supported to execute conditional requests. If-None-Match: This header is supported to execute conditional requests. X-HTTP-Method-Override: This is a custom header (not in the HTTP specifications) that contains the name of a HTTP method as value. This value (if valid) is used to define the HTTP method. This header will only be considered in a POST request. Cache-Control: To avoid intermediate proxies to cache or store framework payloads, this header is being configured for every HTTP response. Its value is: nocache, no-store, must-revalidate. X-Requested-By: When the anti-csrf mechanism is turned on, the presence of this header is enforced for every request, except when the following methods are being used: GET, OPTIONS and HEAD. If the header isn't found, then the response, 400 (Bad Request), is returned. HTTP Response Codes The following table lists the common HTTP response codes. Code Description 200 OK Request executed and the response has content. 38 REST API for Sales Cloud Industry Solutions

39 Additional Information Error Message Code 201 Created 204 No Content 304 Not Modified 400 Bad Request Description Resource created and the response contains the created resource. Request executed, but the response doesn't have content. Resource wasn't modified according to the ETag that was provided. Request to the server failed because of malformed syntax. 404 Not Found Requested resource wasn't found. 406 Not Acceptable 412 Precondition failed 415 Unsupported Media Type 500 Internal Server Error Resource identified by the request can generate response entities that have content characteristics that aren't acceptable, according to the accept headers sent in the request. Resource state on the server side doesn't match the provided ETag. Server failed to service the request because the entity of the request is in a format that's not supported by the requested resource for the requested method. Server encountered an unexpected condition that prevented it from fulfilling the request. Error Message If a REST request generates an error, then the response contains the error code and a short error message in the response status line. A detailed error message is included in the response body. Resource Metadata Metadata is provided for each resource. For example, the following command returns the metadata for the opportunities resources: REST API for Sales Cloud Industry Solutions 39

40 Contents GET /salesapi/resources/latest/opportunities/describe The returned metadata contains the fields included in the resource, the actions that can be taken in this resource, and the child and list-of-value resources. Resource Description The following command returns the metadata for all the resources hosted in the current application: GET /salesapi/resources/latest/describe The format of the metadata is the same as the metadata for each individual resource. Lifecycle Management For each new Oracle Applications Cloud release version, there is a corresponding REST API version. However, versions aren't assigned to a REST resource at each individual resource level. Previous versions will continue to be supported for multiple releases. To check the versions supported, you can use the root API, such as: /salesapi/resources Each version has islatest status and life cycle fields. The predecessor-version and successor-version links indicate the previous and next versions. { "items": [ { "version": " ", "islatest": true, "links": [ { "rel": "self", "href": " example.oracle.com/salesapi/resources/ ", "name": "self", "kind": "item" }, { "rel": "canonical", "href": " example.oracle.com/salesapi/resources/ ", "name": "canonical", "kind": "item" }, 40 REST API for Sales Cloud Industry Solutions

41 Additional Information Lifecycle Management { "rel": "predecessor-version", "href": " example.oracle.com/salesapi/resources/ ", "name": "predecessor-version", "kind": "item" } ] }, { "version": " ", "links": [ { "rel": "self", "href": " example.oracle.com/salesapi/resources/ ", "name": "self", "kind": "item" }, { "rel": "canonical", "href": " example.oracle.com/salesapi/resources/ ", "name": "canonical", "kind": "item" }, { "rel": "predecessor-version", "href": " example.oracle.com/salesapi/resources/ ", "name": "predecessor-version", "kind": "item" }, { "rel": "successor-version", "href": " example.oracle.com/salesapi/resources/ ", "name": "successor-version", "kind": "item" } ] }, { "version": " ", "links": [ { "rel": "self", "href": " example.oracle.com/salesapi/resources/ ", "name": "self", "kind": "item" }, REST API for Sales Cloud Industry Solutions 41

42 Contents { "rel": "canonical", "href": " example.oracle.com/salesapi/resources/ ", "name": "canonical", "kind": "item" }, { "rel": "successor-version", "href": " example.oracle.com/salesapi/resources/ ", "name": "successor-version", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": " "name": "self", "kind": "collection" }, { "rel": "canonical", "href": " "name": "canonical", "kind": "collection" }, { "rel": "current", "href": " example.oracle.com/salesapi/resources/ ", "name": "current", "kind": "item" } ] } 42 REST API for Sales Cloud Industry Solutions

43 9 Accessing REST APIs You can access a REST API in one of the following ways: curl: A command line tool to transfer data from or to a server using one of the supported protocols, such as HTTP or HTTPS. Advanced REST Client: A browser plug-in or extension that supports initiating and testing the REST APIs. To access a REST API: 1. Obtain the REST URL from the reference guide. For example: Note: Ensure that you can edit the Application UI and also access the REST resource using your security credentials. If you have difficulty accessing the resource, contact your administrator. 2. Run the following command in the curl tool to initiate an HTTP request on the resource: curl user <username> The response is as follows: { "items" : [ { "PartyId" : , "PartyNumber" : "CDRM_2260", "SourceSystem" : null, "SourceSystemReferenceValue" : null, "OrganizationName" : "DLAKWRVBBU", "UniqueNameSuffix" : "US)", "PartyUniqueName" : "DLAKWRVBBU US)", "Type" : "ZCA_CUSTOMER", "OwnerPartyId" : , "OwnerPartyNumber" : " ", "Owner Address" : "sendmail-test-discard@oracle.com",... }, {... } ], REST API for Sales Cloud Industry Solutions 43

44 Contents "count" : 25, "hasmore" : true, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : " "name" : "accounts", "kind" : "collection" } ] } In the response, you can also see the links to the exposed child resources. You can use these links to view information for the child resources. 3. Run the following command in the curl tool to fetch the resource metadata: curl -u <username> The response is as follows: { "Resources" : { "accounts" : { "discrcolumntype" : false, "title" : "Sales Cloud Account SDO", "attributes" : [ { "name" : "PartyId", "type" : "integer", "updatable" : false, "mandatory" : true, "queryable" : true, "precision" : 18, "properties" : { "fnd:globally_unique" : "true" } }, { "name" : "PartyNumber", "type" : "", "updatable" : true, "mandatory" : true, "queryable" : true, "precision" : 30, "maxlength" : "30", "properties" : { "DISPLAYWIDTH" : "40" } }, { "name" : "SourceSystem", 44 REST API for Sales Cloud Industry Solutions

45 Accessing REST APIs Lifecycle Management "type" : "", "updatable" : true, "mandatory" : false, "queryable" : true }, {...], "links" : [ { "rel" : "self", "href" : " "name" : "self", "kind" : "collection" } ], "actions" : [ { "name" : "get", "method" : "GET", "responsetype" : [ "application/json", "application/vnd.oracle.adf.resourcecollection+json" ] }, { "name" : "create", "method" : "POST", "requesttype" : [ "application/vnd.oracle.adf.resourceitem+json" ], "responsetype" : [ "application/json", "application/vnd.oracle.adf.resourceitem+json" ] } ] }... In the metadata a POST command is issued on the account resource to create a new account. REST API for Sales Cloud Industry Solutions 45

46

47 10 Example: Creating an Account The following example shows how to use a REST API to create an account. You must include at least the organization name in the request payload to create an account. To provide additional information for the account, you must include the required attributes and their values in the payload. The following example URL shows the method call to create an account: curl -X POST -H "Content- Type:application/vnd.oracle.adf.resourceitem+json" -u <username>:<password> --data "@path_to_payload.json" (where path_to_payload.json contains the request payload). Request Payload The following sample payload creates the organization Pinnacle Flowers of the type customer with a primary address: { "OrganizationName": "Pinnacle Flowers", "YearEstablished": "1940", "Type": "ZCA_CUSTOMER", "PrimaryAddress": [{ "AddressLine1": "500 oracle parkway", "City": "Redwood Shores", "State": "CA", "Country": "US" }] } Response The following sample payload includes the details of the account created. The sample payload is an abstract of the response payload. Response Header REST API for Sales Cloud Industry Solutions 47

48 Contents HTTP/ Created Cache-Control: no-cache, no-store, must-revalidate Date: Mon, 11 May :50:32 GMT Location: Content-Length: 4188 Content-Type: application/json... Content-Encoding: gzip Link: < 8383>;rel="self";kind="item";name="accounts" Response Body { PartyId: , PartyNumber: "CDRM_ ", SourceSystem: null, SourceSystemReferenceValue: null, OrganizationName: "Pinnacle Flowers", UniqueNameSuffix: "(Redwood Shores, US)", PartyUniqueName: "Pinnacle Flowers (Redwood Shores, US)", Type: "ZCA_CUSTOMER" OwnerPartyId: , OwnerPartyNumber: " ", PrimaryAddress: [ { AddressId: AddressNumber: "CDRM_170960" SourceSystem: null SourceSystemReferenceValue: null AddressLine1: "500 oracle parkway" City: "Redwood Shores" Country: "US" State: "CA" } ] } 48 REST API for Sales Cloud Industry Solutions

49 11 Introduction to Oracle Sales Cloud RESTful Web Services Overview Oracle Sales Cloud comes with RESTful Web services that you can use to: Develop cloud applications that call on and integrate with Oracle Sales Cloud to deliver some of their functionality. You could sell these applications in the Oracle Cloud Marketplace. These applications might deliver other functionality independently or by integrating with third-party applications. Integrate suites of applications from third party vendors to Oracle Sales Cloud. Integrate different types of Oracle applications suites, such as Oracle E-Business Suite, with Oracle Sales Cloud. Customize and extend Oracle Sales Cloud applications to your business needs. Note: This document describes the Oracle Sales Cloud RESTful Web APIs that are supported in Release 13. Only those APIs that are included in this document are currently supported. Please contact Oracle Support if you require assistance with RESTful APIs. RESTful Web Services Oracle Sales Cloud includes the following RESTful web services. For more information, see REST API for Oracle Sales Cloud Release 13. Oracle Sales Cloud RESTful services include child resources that let you manage the child objects such as addresses, relationships, and so on. Some of the child resources may in turn have other child resources. The child resources are documented in the parent resource. Resource Title Account Activity Competitor Contact Deal Registrations Resource Name accounts activities competitors contacts deal registrations REST API for Sales Cloud Industry Solutions 49

50 Contents Household Lead Opportunity Partner Programs Benefits Partner Programs Partner Tiers Partners Program Enrollments Program Territories Promotions Promotion programs Resource Sales Orders Source Code Territory Forecast Custom Object households leads opportunities partnerprogrambenefits partnerprograms partnertiers partners program enrollments program territory promotions promotion programs resources Sales Orders Source Codes Territory Forecasts Custom object RESTful Web Services for Oracle Sales Cloud for Communications Oracle Sales Cloud for Communications is a comprehensive and integrated solution for communications companies. The users of the solution are sales representatives and sales executives. The sales process is stream lined to configure, price, and quote capabilities with pre-integration to Siebel contract, E-Billing and service requests. Oracle Sales Cloud includes the following RESTful web services for the Oracle Sales Cloud for Communications solution. Resource Title Integration Description The integration configuration resource is used to store all the 50 REST API for Sales Cloud Industry Solutions

51 Introduction to Oracle Sales Cloud RESTful Web Services RESTful Web Services for Oracle Sales Cloud for Consumer Goods Resource Title Configuration Integration Map Lookup Description configuration values required for Siebel CRM integration in the form of key-value pairs. URI: crmcommonapi/resources/<version>/ ORATC O_INT_IntegConfig_c The integration map lookup resource indicates the lookup value mappings between Oracle Sales Cloud and Siebel CRM. URI: crmcommonapi/resources/<version>/ ORATC O_INT_SBL_MAP_LKP_c RESTful Web Services for Oracle Sales Cloud for Consumer Goods Oracle Sales Cloud for Consumer Goods is a retail execution and trade promotions solution. Using retail execution, sales persons can review, plan, and schedule appointments to carry out retail visits. During a retail visit, sales persons can perform inventory audits, place orders, and gather feedback from retail store managers. Sales persons can leverage reporting and analytics capabilities to stay up to date on key performance indicators via dashboards and infolets. Using trade promotions, marketing and account personnel can create and manage corporate or account promotions to generate incremental revenue and brand awareness. The personnel can use surveys to evaluate the effectiveness of the promotions. Oracle Sales Cloud includes the following RESTful web services for the Oracle Sales Cloud for Consumer Goods solution. Resource Title Audit History Inventories Order Description The audit history resource lets you manage the results of the past audits. An audit history record is created every time a sales representative performs an inventory audit during a store visit. URI: /salesapi/resources/<version>/ ORACO AuditHistory_c The inventory resource lets you manage the list of products available at the retailer and enables you to maintain sufficient levels of inventory in the stores. URI: crmcommonapi/resources/<version>/ ORACO Inventory_c The order resource lets you manage orders for a retail store. REST API for Sales Cloud Industry Solutions 51

52 Contents Resource Title Order Items Program Territories Promotions Promotion Product Promotion Group Promotion programs Promotion Product Description URI: crmcommonapi/resources/<version>/ ORACO Order_c The order items resource lets you manage information about each item in an order. Parent resource: Order URI: crmcommonapi/resources/<version>/ ORACO Order_c/{OrderId}/c hild/ ORACO OrderItemsCollection_c The territory resource lets you manage the relationship between a promotion program and its territories. URI: salesapi/resources/<version>/ ORACO ProgramTerritory_c The promotion resource lets you create and manage promotions. This includes information on promotion duration, promoted products, promotion tactics, and target account. URI: salesapi/resources/<version>/ ORACO Promotion_c The promotion product collection resource lets you specify products and tactics information for each promoted product in the Promotion resource. Parent resource: Promotion URI: salesapi/resources/<version>/ ORACO Promotion_c/{PromotionId}/chi ollection_c The promotion group collection resource lets you specify the grouping criteria and tactics information for each promoted product group in the Promotion resource. Parent resource: Promotion URI: salesapi/resources/<version>/ ORACO Promotion_c/{PromotionId}/chi lection_c The promotion program resource lets you manage promotion templates that are used for creating new promotions. This resource contains information on promotion duration, promoted products, promotions tactics and, target territories. URI: salesapi/resources/<version>/ ORACO PromotionProgram_c The promotion product resource lets you manage all products in a promotion program. You can use the resource to specify the product 52 REST API for Sales Cloud Industry Solutions

53 Introduction to Oracle Sales Cloud RESTful Web Services RESTful Web Services for Oracle Sales Cloud for Consumer Goods Resource Title Shopping Carts Description and tactics information for each promoted product. Parent resource: Promotion Program URI: salesapi/resources/<version>/ ORACO Promotion_c/{PromotionId}/c hild/ ORACO PromotionProductCollection_c The shopping cart resource lets you manage the orders of an account. The shopping cart holds selected order items before the order is placed. URI: crmcommonapi/resources/<version>/ ORACO ShoppingCart_c List of Values in Standard Resources The Consumer Goods vertical has the following List of Values (LOVs) in standard resources: Standard Resource LOV Name Source Attribute in LOV Target Attribute in Resource Account OrganizationDEO_ LOVVA_For OR ACO OnHoldFla g_c Value OrganizationDEO ORACO OnHoldFlag_c Activity LOVVA_For OR ACO StoreVisit_ Value ORACO StoreVisit_c Resource Attributes in Standard Resources The Consumer Goods vertical has the following attributes in standard resources: Standard Resource Account Attribute Name OrganizationDEO ORACO Ac counttype_c Attribute Type Display Label Account Type Description Display Width: 30 Maximum Length: 500 Account OrganizationDEO ORACO Nex tvisit_c Next Visit The next scheduled visit to the account. REST API for Sales Cloud Industry Solutions 53

54 Contents Account True indicates the account has overdue payments for orders. OrganizationDEO ORACO On HoldFlag_c boolean On Hold Flag Display Width:10 Default Value: N Account OrganizationDEO ORACO Ord eramount_c number Order Amount Amount of the order. Maximum Length: 20 Decimal Place: 4 Account OrganizationDEO ORACO Ow ner_c Owner The name of the sales representative who owns the account. Activity ORACO Assig nee_c Assignee The name of the sales rep who owns the account for which an activity is created. Maximum length:1000 Activity ORACO Store Visit_c boolean Store Visit True indicates the activity is a retail store visit. Activity ORACO Acc ountnametext_c Account The name of the account involved in an appointment. Maximum length:1000 Activity ORACO App ointmentname_ c Name The name of an appointment. Maximum length:1000 Activity ORACO VisitS tatus_c Visit Status User assignable status for a visit, such as In Progress Maximum length: REST API for Sales Cloud Industry Solutions

55 Introduction to Oracle Sales Cloud RESTful Web Services RESTful Web Services for Oracle Sales Cloud for High Tech and Manufacturing RESTful Web Services for Oracle Sales Cloud for High Tech and Manufacturing Oracle Sales Cloud for High Tech and Manufacturing leverages the underlying Oracle Sales Cloud Partner Relationship Management features to provide you complete functionality for managing channel sales execution tasks. Channel account managers perform overall partner management, including signing up new partners and providing them with portal access, managing partner teams, and managing partner program enrollments. High Tech and Manufacturing usually sells through indirect sales channels and enables you to perform channel sales execution tasks such as lead to deal and deal to opportunity conversion with ease, and simplifies creating and managing account plans and tickets. Oracle Sales Cloud includes the following RESTful web services for the Oracle Sales Cloud for High Tech and Manufacturing solution. Resource Title Account Plan Earlier Plan Plan Activity Plan Account Description The account plan resource lets you capture and manage planning attributes such as plan start and end date, plan target and actual revenue amount, plan target customer visit. URI: crmcommonapi/resources/<version>/ ORAHT AccountPlan_c The earlier plan resource lets you manage an account plan that was created for a previous planning period. Parent resource: Account Plan URI: crmcommonapi/resources/<version>/ ORAHT AccountPlan_c/{id}/chi ld/ ORAHT EarlierPlanCollection_c The plan activity resource lets you plan and use activities such as tasks and appointments. URI: crmcommonapi/resources/<version>/ ORAHT PlanActivity_c The plan account resource is the participating account of the account plan. URI: REST API for Sales Cloud Industry Solutions 55

56 Contents Resource Title Description crmcommonapi/resources/<version>/ ORAHT PlanAccount_c Plan Contact Ticket Contact Deal Registrations Plan Team Plan Lead Plan Opportunity Ticket The plan contact resource is the point of contact identified as a representative of the account. URI: crmcommonapi/resources/<version>/ ORAHT PlanContact_c The ticket contact resource is the point of contact associated to the account in a service ticket. URI: crmcommonapi/resources/<version>/ ORAHT TicketContact_c The deal registration resource lets you capture deal registration details such as Name, Owner, Status, Partner, and Additional Partner. URI: salesapi/resources/<version>/ ORAHT SalesLeadDeals_c The plan team resource contains the sales team members associated with the participating accounts of the account plan. URI: crmcommonapi/resources/<version>/ ORAHT PlanTeam_c The plan lead resource is the lead associated with any one of the accounts included in account plan. URI: crmcommonapi/resources/<version>/ ORAHT PlanLead_c The plan opportunity resource is the opportunity associated with any of the participating accounts in an account plan. URI: crmcommonapi/resources/<version>/ ORAHT PlanOpportunity_c The ticket resource is a service request associated with an account. URI: crmcommonapi/resources/<version>/ ORAHT ServiceRequest_c 56 REST API for Sales Cloud Industry Solutions

57 Introduction to Oracle Sales Cloud RESTful Web Services RESTful Web Services for Oracle Sales Cloud for Financial Services RESTful Web Services for Oracle Sales Cloud for Financial Services Oracle Sales Cloud for Financial Services leverages the integration of Oracle Sales Cloud with Oracle Marketing Cloud. Financial institutions can use this solution to modernize their branches and automate the process of identifying, nurturing and creating referrals to cross-sell products across any channel including social, mobile and web. The Financial Services solution provides a quick and complete view of customer information and interactions, which the banks can use to build a personalized relationship with each customer and offer financial products and services that best suit a customer s unique needs. You can stay up to date on the status through dashboard and analytics that provide a snapshot of key performance indicators during the financial services cycle. You can leverage the functionality of Oracle Marketing Cloud and Oracle Sales Cloud to work with some of the standard functionality and concepts. You seamlessly manage appointments, accounts, contacts, lead, and opportunities to understand and engage with your customer. Oracle Sales Cloud includes the following RESTful web services for the Oracle Sales Cloud for Financial Services solution. Resource Title Case Daily Balance Fin Account Contact Description The cases resource is used to manage financial transactions resulting due to life changing events that necessitate liquidation or transfer of funds to a different account either internally or externally, sell funds, or write a check. URL: crmcommonapi/resources/<version>/ ORAFS Cases_c The daily balance resource is used to manage the daily closing balance of the financial account. URL: crmcommonapi/resources/<version>/ ORAFS DailyBalance_c The financial account contact resource is used to manage the relationship between a financial account and a contact. A financial account such as joint account can have multiple contacts associated with it. Conversely, a contact can have multiple financial accounts associated with it. Financial account contact is the intersection that stores the relationship between financial accounts and contacts. A financial account record consists of a financial account ID and a contact ID. All the remaining information is obtained from parent objects. URL: REST API for Sales Cloud Industry Solutions 57

58 Contents Resource Title Description crmcommonapi/resources/<version>/ ORAFS FinAccountContact_c Financial Account Transacti on Case To Contact CaseToR esource The financial account resource is used to manage unique accounts of customers. URL: crmcommonapi/resources/<version>/ ORAFS FinancialAccount_c The transaction resource is used to manage monetary transactions for financial accounts. URL: crmcommonapi/resources/<version>/ ORAFS Transaction_c The case to contact resource is used to manage the relationship between heirs and cases. A case can have multiple heirs and a contact can appear as an heir under multiple cases. The case to contact resource manages many-to-many relationships between cases and contacts. URL: crmcommonapi/resources/<version>/ ORAFS CaseToContact_c The case to resource object is used to manage the relationship between a resource team and cases. A case can have multiple service team members and a resource can be a team member for multiple cases. The case to resource object manages many-to-many relationships between cases and resources. URL: crmcommonapi/resources/<version>/ ORAFS CaseToResource_c 58 REST API for Sales Cloud Industry Solutions

59 12 Managing Account Plans This chapter describes the following resources: Account Plans Account Plans: Earlier Plans Account Plans Overview An account plan captures planning attribute such as plan start and end date, plan target and actual revenue amount, plan target customer visit. Use this resource to get, create, update, and delete an account plan. Resource Plural Label Resource Name Account Plans ORAHT AccountPlan_c The table below lists tasks supported by this resource. Task Request URI Account Plans Get all account plans Create account plans Get an account plan Update an account plan GET POST GET PATCH /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 59

60 Contents Delete an account plan Refresh an account plan DELETE POST /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/< Replace with system generated unique ID> Not applicable Account Plans: Earlier Plans Get all earlier account plans Create earlier account plans Get an earlier account plan Update an earlier account plan Delete an earlier account plan GET POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/{id}/child/ ORAHT EarlierPlanCollection_c /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/{id}/child/ ORAHT EarlierPlanCollection_c /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/{id}/child/ ORAHT EarlierPlanCollection_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/{id}/child/ ORAHT EarlierPlanCollection_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/{id}/child/ ORAHT EarlierPlanCollection_c/< Replace with system generated unique ID> Account Plans This section covers the following topics: Tasks List of Values Resource Attributes 60 REST API for Sales Cloud Industry Solutions

61 Managing Account Plans Account Plans An account plan captures planning attribute such as plan start and end date, plan target and actual revenue amount, plan target customer visit. Use this resource to get, create, update, and delete an account plan. Resource Plural Label Resource Name Account Plans ORAHT AccountPlan_c Tasks The table below lists tasks supported by this resource. Task Request URI Account Plans Get all account plans Create account plans Get an account plan Update an account plan Delete an account plan Refresh an account plan GET POST GET PATCH DELETE POST /crmcommonapi/resources/<version>/ ORAHT A ccountplan_c /crmcommonapi/resources/<version>/ ORAHT A ccountplan_c /crmcommonapi/resources/<version>/ ORAHT A ccountplan_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT A ccountplan_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT A ccountplan_c/< Replace with system generated unique ID> Not applicable Get all Account Plans Request GET REST API for Sales Cloud Industry Solutions 61

62 Contents URI /crmcommonapi/resources/<version>/ ORAHT AccountPlan_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description Finds account plans with the specified account plan ID. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all account plans. Example Command: curl --user sales_cloud_user ORAHT Acco untplan_c Example Response Body { "items" : [ { "Id" : , "RowType" : " ORAHT AccountPlan_c", "RecordName" : "HPAccountplan", 62 REST API for Sales Cloud Industry Solutions

63 Managing Account Plans Account Plans "CreatedBy" : "bala.gupta", "CreationDate" : " T10:08:43+00:00", "LastUpdatedBy" : "bala.gupta", "LastUpdateDate" : " T10:09:16+00:00", "LastUpdateLogin" : null, "CpdrfVerSor" : null, "UserLastUpdateDate" : null, "CpdrfLastUpd" : null, "CpdrfVerPillar" : null, "JobDefinitionPackage" : null, "RequestId" : null,. }, { }.. } Create Account Plans Request POST URI /crmcommonapi/resources/<version>/ ORAHT AccountPlan_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: REST API for Sales Cloud Industry Solutions 63

64 Contents application/json application/vnd.oracle.adf.resourcecollection+json Example This example creates an account plan. Example command: curl sales_cloud_user X POST ORAHT Acco untplan_c Get an Account Plan Request GET URI /crmcommonapi/resources/<version>/ ORAHT AccountPlan_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plans with the specified account plan ID. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets an account plan. Example Command: curl --user sales_cloud_user ORAHT Acco untplan_c/ REST API for Sales Cloud Industry Solutions

65 Managing Account Plans Account Plans Update an Account Plan Request PATCH URI /crmcommonapi/resources/<version>/ ORAHT AccountPlan_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plans with the specified account plan ID. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Delete an Account Plan Request DELETE URI /crmcommonapi/resources/<version>/ ORAHT AccountPlan_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: REST API for Sales Cloud Industry Solutions 65

66 Contents Name Type Description Id integer Finds account plans with the specified account plan ID. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an account plan. Example Command: curl --user sales_cloud_user X DELETE ORAHT Acco untplan_c/ Refresh an Account Plan Request POST URI Not applicable Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plans with the specified account plan ID. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: 66 REST API for Sales Cloud Industry Solutions

67 Managing Account Plans Account Plans application/json application/vnd.oracle.adf.resourceitem+json List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod CurrencyCode Currency e FK_LOVVA_For ORAHT Pl ORAHT PlanOwner_Id_c Plan Owner anowner_c LOVVA_For ORAHT Plan ORAHT PlanOwner_c Plan Owner Owner_c LOVVA_For ORAHT PlanS tatus_c ORAHT PlanStatus_c Plan Status Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. CreatedBy The user who created the Account Plan record. The maximum length is 32. REST API for Sales Cloud Industry Solutions 67

68 Contents Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. Last Update Login CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateD ate A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. User last Update Date CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPac kage A system-generated read-only attribute used by the application framework. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. 68 REST API for Sales Cloud Industry Solutions

69 Managing Account Plans Account Plans JobDefinitionNa me A system-generated read-only attribute used by the application framework. The maximum length is 100. CurrencyCode The currency code associated with the account plan. The maximum length is 15. CurcyConvRateT ype CorpCurrencyCo de Currency The currency conversion rate type associated with the account plan. The maximum length is 15. Currency Conversion Rate Type The corporate currency used by the account plan. The maximum length is 15. Corporate Currency Code SourceType A system-generated read-only attribute used by the application framework. AttachmentEntity Name A system-generated read-only attribute used by the application framework. Attachment PKProxy A system-generated read-only attribute used by the application framework. IsOwner A system-generated read-only attribute used by the application framework. ORAHT Custo merstrategydrive rs_c The customer strategy drivers of the account plan. The maximum length is 300. Customer Strategy Drivers ORAHT Indust The industry drivers of the account plan. REST API for Sales Cloud Industry Solutions 69

70 Contents rydrivers_c ORAHT Oppo rtunities_c ORAHT PlanA ctual_c ORAHT PlanE nddate_c ORAHT PlanO wner_id_c ORAHT PlanO wner_c ORAHT PlanSt atus_c ORAHT PlanT arget_c number integer number The maximum length is 300. Industry Drivers The opportunities associated with the account plan. The maximum length is 300. Opportunities The actual plan name. Precision: 38 Decimal Place: 2 Plan Actual The date when the plan ends. Plan End Date The identifier of the owner of the plan. Plan Owner The name of the owner of the plan. The maximum length is Plan Owner The status of the plan. The maximum length is Plan Status The target amount of the plan. Precision: 38 Decimal Place: 2 Plan Target Amount 70 REST API for Sales Cloud Industry Solutions

71 Managing Account Plans Account Plans ORAHT PlanVi sits_c ORAHT Rece ntmergersandac quisitions_c ORAHT Stake holders_c ORAHT Streng ths_c ORAHT Threat s_c ORAHT Weak nesses_c ORAHT Acco unts_c integer Plan Visits Plan Visits The recent mergers and acquisitions associated with the account plan. The maximum length is 300. Recent Mergers and Acquisitions The stakeholders associated with the plan. The maximum length is 300. Stakeholders The strengths associated with the plan. The maximum length is 300. Strengths The threats associated with the plan. The maximum length is 300. Threats The weakness associated with the plan. The maximum length is 300. Weaknesses The accounts associated with the plan. The maximum length is 0. Accounts REST API for Sales Cloud Industry Solutions 71

72 Contents ORAHT Refres h ORAHT Extn ORAHT Accoun tplan_cfusecrea telayouturl ORAHT Extn ORAHT Accoun tplan_cfusecrea telayoutdrivers ORAHT Extn ORAHT Accoun tplan_cfusedetai llayouturl ORAHT Extn ORAHT Accoun tplan_cfusedetai llayoutdrivers ORAHT Acco unt_c Extn ORAHT A ccountplan_cfus ecreatelayoutu RL Extn ORAHT A ccountplan_cfus ecreatelayoutdr ivers Extn ORAHT A ccountplan_cfus edetaillayoutdri vers Refresh The maximum length is 0. Refresh A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. The account record. The maximum length is 0. Account A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. Account Plans: Earlier Plans This section covers the following topics: 72 REST API for Sales Cloud Industry Solutions

73 Managing Account Plans Account Plans: Earlier Plans Tasks List of Values Resource Attributes An earlier plan is an account plan created for a previous planning period. Resource Plural Label Resource Name Earlier Plans ORAHT EarlierPlanCollection_c Tasks The table below lists tasks supported by this resource. Task Request URI Account Plans: Earlier Plans Get all earlier account plans Create earlier account plans Get an earlier account plan Update an earlier account plan Delete an earlier account GET POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/{id}/child/ ORAHT EarlierPlanCollection_c /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/{id}/child/ ORAHT EarlierPlanCollection_c /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/{id}/child/ ORAHT EarlierPlanCollection_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/{id}/child/ ORAHT EarlierPlanCollection_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT AccountPl an_c/{id}/child/ ORAHT EarlierPlanCollection_c/< REST API for Sales Cloud Industry Solutions 73

74 Contents plan Replace with system generated unique ID> Get all Earlier Account Plans Request GET URI /crmcommonapi/resources/<version>/ ORAHT AccountPlan_c/{id}/child/ ORAHT EarlierPlanCollection_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description Finds earlier account plans with the specified account plan ID. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all the account plans. Example command: curl sales_cloud_user ORAHT Acco untplan_c/ /child/ ORAHT EarlierPlanCollection_c 74 REST API for Sales Cloud Industry Solutions

75 Managing Account Plans Account Plans: Earlier Plans Example Response Body { "items" : [ { "Id" : , "RowType" : " ORAHT EarlierPlan_c", "RecordName" : "Plan B", "CreatedBy" : "bala.gupta", "CreationDate" : " T14:00:08+00:00", "LastUpdatedBy" : "bala.gupta", "LastUpdateDate" : " T14:01:08+00:00", " ORAHT AccountPlan_Id_c" : ,.. } Create Earlier Account Plans Request POST URI /crmcommonapi/resources/<version>/ ORAHT AccountPlan_c/{id}/child/ ORAHT EarlierPlanCollection_c Request Path Parameters There are no required path parameters for this task. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json REST API for Sales Cloud Industry Solutions 75

76 Contents application/vnd.oracle.adf.resourceitem+json Example This example gets all the account plans. Example command: curl sales_user_cloud X POST example_request_payload.json ORAHT Acco untplan_c/ /child/ ORAHT EarlierPlanCollection_c Get an Earlier Account Plan Request GET URI /crmcommonapi/resources/<version>/ ORAHT AccountPlan_c/{id}/child/ ORAHT EarlierPlanCollection_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Finder Name Type Description PrimaryKey Integer Finds earlier account plans with the specified account plan ID. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json 76 REST API for Sales Cloud Industry Solutions

77 Managing Account Plans Account Plans: Earlier Plans Example This example gets all the account plans. Example command: curl sales_user_cloud ORAHT Acco untplan_c/ /child/ ORAHT EarlierPlanCollection_c/ Update an Earlier Account Plan Request PATCH URI /crmcommonapi/resources/<version>/ ORAHT AccountPlan_c/{id}/child/ ORAHT EarlierPlanCollection_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Finder Name Type Description PrimaryKey Integer Finds earlier account plans with the specified account plan ID. Finder Variables Id o Type: Integer Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json REST API for Sales Cloud Industry Solutions 77

78 Contents Delete an Earlier Account Plan Request DELETE URI /crmcommonapi/resources/<version>/ ORAHT AccountPlan_c/{id}/child/ ORAHT EarlierPlanCollection_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds earlier account plans with the specified account plan ID. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes and earlier account plan. Example command: curl -- sales_cloud_user X DELETE ORAHT Acco untplan_c/ /child/ ORAHT EarlierPlanCollection_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod CurrencyCode Currency e FK_LOVVA_For ORAHT Pl ORAHT PlanName_Id_c Plan ID anname_c LOVVA_For ORAHT PlanN ame_c ORAHT PlanName_c Plan Name 78 REST API for Sales Cloud Industry Solutions

79 Managing Account Plans Account Plans: Earlier Plans Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName The name of the Earlier Plan. The maximum length is 80. Earlier Plan CreatedBy The user who created the record. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. ORAHT Acco untplan_id_c integer Last Update Date The identifier of the account plan. Account Plan ID REST API for Sales Cloud Industry Solutions 79

80 Contents ORAHT Acco untplan_c LastUpdateLogi n object The name of the account plan. Account Plan Name The login of the user who last updated the record. The maximum length is 32. Last Update Login CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdate Date A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. User last Update Date CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPa ckage A system-generated read-only attribute used by the application framework. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. JobDefinitionNa me A system-generated read-only attribute used by the application framework. The maximum length is 100. CurrencyCode The currency code associated with the earlier plan. The maximum length is 15. Currency CurcyConvRate The currency conversion rate type associated with 80 REST API for Sales Cloud Industry Solutions

81 Managing Account Plans Account Plans: Earlier Plans Type the earlier plan. CorpCurrencyC ode The maximum length is 15. Currency Conversion Rate Type The corporate currency used by the earlier plan. The maximum length is 15. Corporate Currency Code IsOwner A system-generated read-only attribute used by the application framework. ORAHT Plan Name_Id_c integer The identifier of the earlier plan. Plan ID ORAHT Plan Name_c The name of the earlier plan. The maximum length is ORAHT Curre ncy_c ORAHT Plan Actual_c ORAHT PlanE nddate_c ORAHT PlanT arget_c Plan Name The currency associated with the earlier plan. The maximum length is 0. Currency The actual name of the earlier plan. The maximum length is 0. Plan Actual The date when the plan ends. Plan End Date The target amount of the plan. REST API for Sales Cloud Industry Solutions 81

82 Contents ORAHT Plan Visits_c ORAHT Plan Name_Obj_c integer object The maximum length is 0. Plan Target Amount The number of customer visits planned Plan Visits The Plan Object Plan Object 82 REST API for Sales Cloud Industry Solutions

83 13 Managing Audit History This chapter describes the following resources: Audit History Audit History Overview The Audit History object is a history record for inventory audit results. The audit history resource is used to view, create, or modify an audit history. Use this resource to create, update, find, and delete audit histories. Resource Plural Label Resource Name Audit History ORACO AuditHistory_c The table below lists tasks supported by this resource. Task Request URI Audit History Get all Audit Histories Get an Audit History Create an Audit History Update an Audit History Delete an Audit History GET GET POST PATCH DELETE /crmcommonapi/resources/<version>/ ORACO AuditHis tory_c /crmcommonapi/resources/<version>/ ORACO AuditHis tory_c/{id} /crmcommonapi/resources/<version>/ ORACO AuditHis tory_c /crmcommonapi/resources/<version>/ ORACO AuditHis tory_c/{id} /crmcommonapi/resources/<version>/ ORACO AuditHis tory_c/{id} REST API for Sales Cloud Industry Solutions 83

84 Contents Audit History This section covers the following topics: Tasks List of Values Resource Attributes The Audit History object is a history record for inventory audit results. The audit history resource is used to view, create, or modify an audit history. Use this resource to create, update, find, and delete audit histories. Resource Plural Label Resource Name Audit History ORACO AuditHistory_c Tasks The table below lists tasks supported by this resource. Task Request URI Audit History Get all Audit Histories Get an Audit History Create an Audit History Update an Audit History Delete an Audit History GET GET POST PATCH DELETE /crmcommonapi/resources/<version>/ ORACO AuditHis tory_c /crmcommonapi/resources/<version>/ ORACO AuditHis tory_c/{id} /crmcommonapi/resources/<version>/ ORACO AuditHis tory_c /crmcommonapi/resources/<version>/ ORACO AuditHis tory_c/{id} /crmcommonapi/resources/<version>/ ORACO AuditHis tory_c/{id} 84 REST API for Sales Cloud Industry Solutions

85 Managing Audit History Audit History Get all Audit Histories Request GET URI /crmcommonapi/resources/<version>/ ORACO AuditHistory_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description Finds the audit histories. Finder Variables: Id o integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all audit histories. Example Command: curl --user sales_cloud_user ORACO Audit History_c Get an Audit History Request GET REST API for Sales Cloud Industry Solutions 85

86 Contents URI /crmcommonapi/resources/<version>/ ORACO AuditHistory_c/{Id} Request Path Parameters The following are required path parameters for this task: The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Audit History. You can get the Audit History Id by examining the response payload of a Get All Audit Histories request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets an audit history with the Id Example Command: curl --user sales_cloud_user ORACO AuditH istory_c/ Create an Audit History Request POST URI /crmcommonapi/resources/<version>/ ORACO AuditHistory_c Request Path Parameters There are no required path parameters for this task. 86 REST API for Sales Cloud Industry Solutions

87 Managing Audit History Audit History Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update an Audit History Request PATCH URI /crmcommonapi/resources/<version>/ ORACO AuditHistory_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Audit History. You can get the Audit History Id by examining the response payload of a Get All Audit Histories request. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json REST API for Sales Cloud Industry Solutions 87

88 Contents Delete an Audit History Request DELETE URI /crmcommonapi/resources/<version>/ ORACO AuditHistory_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Audit History. You can get the Audit History Id by examining the response payload of a Get All Audit Histories request. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an existing audit history with the Id Example Command: curl --user sales_cloud_user X DELETE ORACO AuditH istory_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod e CurrencyCode Currency Resource Attributes This resource has the following attributes: 88 REST API for Sales Cloud Industry Solutions

89 Managing Audit History Audit History Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Audit History Name CreatedBy The user who created the audit history record. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. LastUpdateLogi n Last Update Date The login of the user who last updated the record. The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the REST API for Sales Cloud Industry Solutions 89

90 Contents application framework. UserLastUpdate Date A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database (i.e. a different mobile database or the server). CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPa ckage A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the row. JobDefinitionNa me A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name of the job that created or last updated the row. The maximum length is 100. CurrencyCode The currency code associated with the audit history. The maximum length is 15. CurcyConvRate Type Currency The conversion rate of a currency associated with the audit history. The maximum length is 15. CorpCurrencyC The corporate currency code associated with the 90 REST API for Sales Cloud Industry Solutions

91 Managing Audit History Audit History ode audit history. The maximum length is 15. SourceType Not for external use. This attribute is used by the Extensibility framework. The maximum length is 0. AttachmentEntit yname A system-generated read-only attribute used by the application framework. PKProxy A system-generated read-only attribute used by the application framework. The maximum length is 18. IsOwner A system-generated read-only attribute used by the application framework. ORACO Aud itdate_c The date of the inventory audit. Display Width: 30 The maximum length is 80. ORACO Aud itid_c ORACO Faci ng_c ORACO Loc ation_c integer Audit Date The unique identifier of an audit. Display Width:30 The maximum length is 80. Audit ID The facing quantity. Must be less than the Shelf Stock quantity. Minimum Value: 0 Facing The location of the product. Display Width: 30 The maximum length is REST API for Sales Cloud Industry Solutions 91

92 Contents ORACO Pro duct_c ORACO Shel fstock_c ORACO Unit Price_c ORACO UO M_c Organization_Id ORACO Ac count_audithist ory integer number integer Location The name of the product. Display Width: 40 The maximum length is Product The Shelf Stock quantity. Must be greater than the Facing quantity. Minimum Value: 0 The maximum length is 10. Shelf Stock The unit price of an item. Precision: 10 Decimal Places: 2 Unit Price The Unit of Measure of an item. Display Width: 30 The maximum length is 500. UOM Foreign Key 92 REST API for Sales Cloud Industry Solutions

93 14 Managing Cases This chapter describes the following resources: Cases Cases Overview The Case resource is used to track particular actions for a contact. A case assists customers with necessary financial transactions during life-changing events that require transfer or liquidation of assets. Resource Plural Label Resource Name Cases ORAFS Cases_c Tasks The table below lists tasks supported by this resource. Task Request URI Get all Case records View a Case record Create a Case record Update a Case record Delete a Case record GET GET POST PATCH DELETE /crmcommonapi/resources/ / ORAFS Cases_c /crmcommonapi/resources/ / ORAFS Cases_c/< Replace with system generated unique ID> /crmcommonapi/resources/ / ORAFS Cases_c /crmcommonapi/resources/ / ORAFS Cases_c/< Replace with system generated unique ID> /crmcommonapi/resources/ / ORAFS Cases_c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 93

94 Contents Cases This section covers the following topics: Tasks List of Values Resource Attributes Resource Plural Label Resource Name Cases ORAFS Cases_c Get all Case Records Request GET URI crmcommonapi/resources/ / ORAFS Cases_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name Id Description Finds case records by ID. Finder Variables: PrimaryKey o Type: Integer o Description: The unique identifier of the 94 REST API for Sales Cloud Industry Solutions

95 Managing Cases Cases Case record. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Description Returns an array of Case resources. Example Gets all Case records. Example Command: curl --user sales_cloud_user / ORAFS Cases_c Example Response Body { "Id" : , "RowType" : " ORAFS Cases_c", "RecordName" : "CC ", "CreatedBy" : "fusion", "CreationDate" : " T07:31:02+00:00", "LastUpdatedBy" : "SALES.MGR_US@ap6023fems.us.oracle.com", "LastUpdateDate" : " T09:08:42+00:00", "LastUpdateLogin" : null, "CpdrfVerSor" : null, "UserLastUpdateDate" : null, "CpdrfLastUpd" : null, "CpdrfVerPillar" : null, "JobDefinitionPackage" : null, "RequestId" : null, REST API for Sales Cloud Industry Solutions 95

96 Contents "JobDefinitionName" : null, "CurrencyCode" : "USD", "CurcyConvRateType" : "Corporate", "CorpCurrencyCode" : "USD", "SourceType" : " ORAFS CASES_C", "AttachmentEntityName" : " ORAFS Cases_c", "PKProxy" : " ", "IsOwner" : "false", " ORAFS PrimaryContact_Id_c" : , " ORAFS PrimaryContact_c" : "Simoneta Aamos", " ORAFS DateOfBirth_c" : " ", " ORAFS DateOfDeath_c" : " ", " ORAFS Owner_Id_c" : null, " ORAFS Owner_c" : null, " ORAFS Status_c" : "ORA_AFS_IN_PROCESS", " ORAFS Type_c" : "ORA_AFS_LOAN", " ORAFS TotalAssets_c" : 12052, " ORAFS Currency_c" : null, " ORAFS Extn ORAFS Cases_cFuseCreateLayoutURL" : "/cust/apps/ extension / ORAFS Cases_c/ ORAFS Cases_cFuseCreate/ OR AFS Cases_cFuseCreate_Layout4.jsff", " ORAFS Extn ORAFS Cases_cFuseCreateLayoutDrivers" : " ORAFS Type_c", " ORAFS Extn ORAFS Cases_cFuseDetailLayoutURL" : "/cust/apps/ extension / ORAFS Cases_c/ ORAFS Cases_cFuseDetail/ OR AFS Cases_cFuseDetail_Layout3.jsff", " ORAFS Extn ORAFS Cases_cFuseDetailLayoutDrivers" : "null", " ORAFS PrimaryHeir_Id_c" : , " ORAFS PrimaryHeir_c" : "Ray Aamos", "Extn ORAFS Cases_cFuseCreate ORAFS Layout1Expr" : "true", " ORAFS LoanApplicationName_Id_c" : , " ORAFS LoanApplicationName_c" : "Mgr Opty", "Extn ORAFS Cases_cFuseDetail ORAFS Layout1Expr" : "true", "Extn ORAFS Cases_cFuseCreateLayoutURL" : "/cust/apps/ extension / ORAFS Cases_c/ ORAFS Cases_cFuseCreate/ OR AFS Cases_cFuseCreate_Layout4.jsff", "Extn ORAFS Cases_cFuseCreateLayoutDrivers" : null, "Extn ORAFS Cases_cFuseDetailLayoutURL" : "/cust/apps/ extension / ORAFS Cases_c/ ORAFS Cases_cFuseDetail/ OR AFS Cases_cFuseDetail_Layout3.jsff", "Extn ORAFS Cases_cFuseDetailLayoutDrivers" : null, "Extn ORAFS Cases_cFuseCreateLayout3Expr" : "false", "Extn ORAFS Cases_cFuseDetailLayout4Expr" : "false", "links" : [ { "rel" : "self", "href" : " ORAFS Cases_c/ ", "name" : " ORAFS Cases_c", "kind" : "item", "properties" : { "changeindicator" : "ACED A E C2E C D21D99C7619D A A E6D E REST API for Sales Cloud Industry Solutions

97 Managing Cases Cases D616C54C71557F981284F C654C E C C6A F6D F E B A E6C616E672 E4E756D AC951D0B94E08B A E6C616E672E4F626A A E6D E E CFC9F1FA93BFB1D F756E C656E E6F6E7A65726F E756D49000C6C6F E756D5B00096D61676E B E0004FFFFFFF FFFFFFFFFFFFFFFFEFFFFFFFE B42ACF317F E E B787878" } }, { "rel" : "canonical", "href" : " ORAFS Cases_c/ ", "name" : " ORAFS Cases_c", "kind" : "item" }, { "rel" : "lov", "href" : " ORAFS Cases_c/ /lov/FK_LOVVA_For ORAFS Owner_c", "name" : "FK_LOVVA_For ORAFS Owner_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS Cases_c/ /lov/FK_LOVVA_For ORAFS PrimaryContact_c", "name" : "FK_LOVVA_For ORAFS PrimaryContact_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS Cases_c/ /lov/LOVVA_For ORAFS Type_c", "name" : "LOVVA_For ORAFS Type_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS Cases_c/ /lov/LOVVA_For ORAFS PrimaryContact_c", "name" : "LOVVA_For ORAFS PrimaryContact_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS Cases_c/ /lov/FK_LOVVA_For ORAFS LoanApplicationName_c", "name" : "FK_LOVVA_For ORAFS LoanApplicationName_c", "kind" : "collection" }, { "rel" : "lov", REST API for Sales Cloud Industry Solutions 97

98 Contents "href" : " ORAFS Cases_c/ /lov/LOVVA_For ORAFS PrimaryHeir_c", "name" : "LOVVA_For ORAFS PrimaryHeir_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS Cases_c/ /lov/FK_LOVVA_For ORAFS PrimaryHeir_c", "name" : "FK_LOVVA_For ORAFS PrimaryHeir_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS Cases_c/ /lov/ViewAccessor_CurrencyCode", "name" : "ViewAccessor_CurrencyCode", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS Cases_c/ /lov/LOVVA_For ORAFS Status_c", "name" : "LOVVA_For ORAFS Status_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS Cases_c/ /lov/LOVVA_For ORAFS LoanApplicationName_c", "name" : "LOVVA_For ORAFS LoanApplicationName_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS Cases_c/ /lov/LOVVA_For ORAFS Owner_c", "name" : "LOVVA_For ORAFS Owner_c", "kind" : "collection" }, { "rel" : "enclosure", "href" : " ORAFS Cases_c/ /enclosure/ ORAFS Description_c", "name" : " ORAFS Description_c", "kind" : "other" } ] } 98 REST API for Sales Cloud Industry Solutions

99 Managing Cases Cases Create a Case Record Request POST URI crmcommonapi/resources/ / ORAFS Cases_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Description Accepts a Case resource item. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Description Returns a Case resource item. Example Creates a new Case record. Example Command: curl --user sales_cloud_user REST API for Sales Cloud Industry Solutions 99

100 Contents / ORAFS Cases_c View a Case Record Request GET URI crmcommonapi/resources/ / ORAFS Cases_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Case record. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns a Case resource item. 100 REST API for Sales Cloud Industry Solutions

101 Managing Cases Cases Example Gets a Case record. Example Command: curl --user sales_cloud_user ORAFS Cases _c/ Update a Case Record Request PATCH URI crmcommonapi/resources/ / ORAFS Cases_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Case record. Request Body application/vnd.oracle.adf.resourceitem+json Description Accepts a Case resource item. Response Body The following table summarizes the supported response body content types: application/json REST API for Sales Cloud Industry Solutions 101

102 Contents application/vnd.oracle.adf.resourceitem+json Description Returns a Case resource item. Example Updates an existing Case record. Example Command: curl --user sales_cloud_user ORAFS Cases _c/ Delete a Case Record Request DELETE URI crmcommonapi/resources/ / ORAFS Cases_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Case record. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example Deletes an existing Case record. Example Command: curl --user 102 REST API for Sales Cloud Industry Solutions

103 Managing Cases Cases sales_cloud_user ORAFS Cases _c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod e CurrencyCode Currency Code FK_LOVVA_For ORAFS Pri marycontact_c LOVVA_For ORAFS Primar ycontact_c FK_LOVVA_For ORAFS O wner_c LOVVA_For ORAFS Owne r_c LOVVA_For ORAFS Status _c LOVVA_For ORAFS Type_ c FK_LOVVA_For ORAFS Pri maryheir_c LOVVA_For ORAFS Primar yheir_c ORAFS PrimaryContact_I d_c ORAFS PrimaryContact_c ORAFS Owner_Id_c ORAFS Owner_c ORAFS Status_c ORAFS Type_c ORAFS PrimaryHeir_Id_c ORAFS PrimaryHeir_c Contact Contact Owner Owner Status Type Primary Heir Primary Heir Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer The unique identifier of the Case record. REST API for Sales Cloud Industry Solutions 103

104 Contents Record ID RowType The name of the Case object. In this case ORAFS Cases_c. The maximum length is 80. RecordName An auto-generated unique identifier for the Case record. This field is unique for each Case. The maximum length is 80. Case ID CreatedBy The user who created the Case record. The maximum length is 32. Created By CreationDate The date and time when the Case record was created. Creation Date LastUpdatedBy The user who last updated the Case record. The maximum length is 32. Last Updated By LastUpdateDate The date and time when the Case record was last updated. LastUpdateLogin Last Update Date 104 REST API for Sales Cloud Industry Solutions

105 Managing Cases Cases The maximum length is 32. CurrencyCode The currency code associated with the Case. The maximum length is 15. Currency Code SourceType The name of the the Case object. In this case ORAFS Cases_c. ORAFS PrimaryContact_I d_c integer The maximum length is 0. The unique identifier of the contact selected in the Contact field in the Case record. Contact ORAFS PrimaryContact_c The name of the contact selected in the Contact field in the Case record. The maximum length is Contact ORAFS DateOfBirth_c The date when the contact was born to be entered in the Case record. Date of Birth ORAFS DateOfDeath_c The date when the person died to be entered in the Case record. Date of Death ORAFS Description_c attachment The description of the Case. The maximum length is REST API for Sales Cloud Industry Solutions 105

106 Contents Description ORAFS Owner_Id_c integer The unique identifier of the Case owner. Owner ORAFS Owner_c The name of the Case owner. The maximum length is Owner ORAFS Status_c The status of the Case. A list of accepted values is defined in the lookup type ORA_AFS_SUCC_CASE_STATU S. The maximum length is Status ORAFS Type_c The type of the Case. A list of accepted values is defined in the lookup type ORA_AFS_SUCC_CASE_TYPE. The maximum length is Type ORAFS TotalAssets_c integer The auto-calculated total assets of the contact selected in the Contact field in the Case record. Total Assets ORAFS Currency_c integer The Currency field in the Case record. 106 REST API for Sales Cloud Industry Solutions

107 Managing Cases Cases Currency ORAFS PrimaryHeir_Id_c Integer The unique identifier of the contact selected in the Primary Heir field in the Case record. Primary Heir ORAFS PrimaryHeir_c The name of the contact selected in the Primary Heir field in the Case record. The maximum length is Primary Heir REST API for Sales Cloud Industry Solutions 107

108

109 15 Managing CaseToContact This chapter describes the following resources: CaseToContact Managing Case to Contact Resources: Overview The CaseToContact resource is used to store information about relationship between heirs and cases. A case has multiple heirs and a contact can appear as an heir under multiple cases. Therefore a many-to-many relationship is maintained between a case and a contact through this object. Resource Plural Label Resource Name CaseToContact ORAFS CaseToContact_c Tasks The table below lists tasks supported by this resource. Task Request URI Get all CaseToContact records View a CaseToContact record Create a CaseToContact record Update a CaseToContact record GET GET POST PATCH /crmcommonapi/resources/ / ORAFS CaseTo Contact_c /crmcommonapi/resources/ / ORAFS CaseTo Contact_c/< Replace with system generated unique ID> /crmcommonapi/resources/ / ORAFS CaseTo Contact_c /crmcommonapi/resources/ / ORAFS CaseTo Contact_c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 109

110 Contents Delete a CaseToContact record DELETE /crmcommonapi/resources/ / ORAFS CaseTo Contact_c/< Replace with system generated unique ID> Managing Case to Contact Resources This section covers the following topics: Tasks List of Values Resource Attributes Resource Plural Label Resource Name CaseToContact ORAFS CaseToContact_c Get all CaseToContact Records Request GET URI crmcommonapi/resources/ / ORAFS CaseToContact_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name Id Description Finds CaseToContact records by ID. 110 REST API for Sales Cloud Industry Solutions

111 Managing CaseToContact Managing Case to Contact Resources Finder Variables: PrimaryKey o o Type: Integer Description: The unique identifier of the CaseToContact record. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Description Returns an array of CaseToContact resources. Example Gets all CaseToContact records. Example Command: curl --user sales_cloud_user / ORAFS CaseToContact_c Example Response Body { "Id" : , "RowType" : " ORAFS CaseToContact_c", "RecordName" : " ", "CreatedBy" : "SALES.MGR_US@AP6023FEMS.US.ORACLE.COM", "CreationDate" : " T18:39:44+00:00", "LastUpdatedBy" : "SALES.MGR_US@AP6023FEMS.US.ORACLE.COM", "LastUpdateDate" : " T18:39:44+00:00", "LastUpdateLogin" : null, "CpdrfVerSor" : null, REST API for Sales Cloud Industry Solutions 111

112 Contents "UserLastUpdateDate" : null, "CpdrfLastUpd" : null, "CpdrfVerPillar" : null, "JobDefinitionPackage" : null, "RequestId" : null, "JobDefinitionName" : null, "CurrencyCode" : "USD", "CurcyConvRateType" : "Corporate", "CorpCurrencyCode" : "USD", "IsOwner" : "false", "Cases_Id ORAFS Src ORAFS Cases_cTo ORAFS CaseToContact_c" : , "Person_Id ORAFS Tgt_PersonTo ORAFS CaseToContact_c" : , " ORAFS Primary_c" : false, "links" : [ { "rel" : "self", "href" : " ORAFS CaseToContac t_c/ ", "name" : " ORAFS CaseToContact_c", "kind" : "item", "properties" : { "changeindicator" : "ACED A E C2E C D21D99C7619D A A E6D E D616C54C71557F981284F C654C E C C6A F6D F E B A E6C616E672 E4E756D AC951D0B94E08B A E6C616E672E4F626A A E6D E E CFC9F1FA93BFB1D F756E C656E E6F6E7A65726F E756D49000C6C6F E756D5B00096D61676E B E0004FFFFFFF FFFFFFFFFFFFFFFFEFFFFFFFE B42ACF317F E E " } }, { "rel" : "canonical", "href" : " ORAFS CaseToContac t_c/ ", "name" : " ORAFS CaseToContact_c", "kind" : "item" }, { "rel" : "lov", "href" : " ORAFS CaseToContac 112 REST API for Sales Cloud Industry Solutions

113 Managing CaseToContact Managing Case to Contact Resources t_c/ /lov/viewaccessor_currencycode", "name" : "ViewAccessor_CurrencyCode", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS CaseToContac t_c/ /lov/lovva_for ORAFS Primary_c", "name" : "LOVVA_For ORAFS Primary_c", "kind" : "collection" } ] } Create a CaseToContact Record Request POST URI crmcommonapi/resources/ / ORAFS CaseToContact_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Description Accepts a CaseToContact item. Response Body The following table summarizes the supported response body content types: REST API for Sales Cloud Industry Solutions 113

114 Contents application/json application/vnd.oracle.adf.resourcecollection+json Description Returns a CaseToContact resource item. Example Gets all CaseToContact records. Example Command: curl --user sales_cloud_user / ORAFS CaseToContact_c View a CaseToContact Record Request GET URI crmcommonapi/resources/ / ORAFS CaseToContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the CaseToContact record. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json 114 REST API for Sales Cloud Industry Solutions

115 Managing CaseToContact Managing Case to Contact Resources application/vnd.oracle.adf.resourceitem+json Description Returns a CaseToContact resource item. Example Gets a CaseToContact record. Example Command: curl --user sales_cloud_user ORAFS CaseT ocontact_c/ Update a CaseToContact Record Request PATCH URI crmcommonapi/resources/ / ORAFS CaseToContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the CaseToContact record. Request Body application/vnd.oracle.adf.resourceitem+json Description REST API for Sales Cloud Industry Solutions 115

116 Contents Accepts a CaseToContact resource item. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns a CaseToContact resource item. Example Updates an existing CaseToContact record. Example Command: curl --user sales_cloud_user ORAFS CaseT ocontact_c/ Delete a CaseToContact Record Request DELETE URI crmcommonapi/resources/ / ORAFS CaseToContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description 116 REST API for Sales Cloud Industry Solutions

117 Managing CaseToContact Managing Case to Contact Resources Id Integer The unique identifier of the CaseToContact record. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example Deletes an existing CaseToContact record. Example Command: curl --user sales_cloud_user ORAFS CaseT ocontact_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod e LOVVA_For ORAFS Primar y_c CurrencyCode ORAFS Primary_c Currency Primary Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer The unique identifier of the CaseToContact record. Record ID REST API for Sales Cloud Industry Solutions 117

118 Contents RowType The name of the CaseToContact object. In this case ORAFS CaseToContact_c. The maximum length is 80. RecordName An auto-generated unique identifier for the CaseToContact record. The maximum length is 80. CaseToContactRecordName CreatedBy The user who created the CaseToContact record. The maximum length is 32. Created By CreationDate The date and time when the CaseToContact record was created. Creation Date LastUpdatedBy The user who last updated the CaseToContact record. The maximum length is 32. Last Updated By LastUpdateDate The date and time when the CaseToContact record was last updated. Last Update Date CurrencyCode The currency code associated with the CaseToContact 118 REST API for Sales Cloud Industry Solutions

119 Managing CaseToContact Managing Case to Contact Resources record. The maximum length is 15. Currency Cases_Id ORAFS Src ORAFS C ases_cto ORAFS CaseToContact_ c Person_Id ORAF S Tgt_PersonTo ORAFS CaseToC ontact_c ORAFS Primary _c integer integer boolean The unique identifier of the case associated with the CaseToContact record. The unique idenfitier of the heir associated with the CaseToContact record. Indicates if the heir is primary. The maximum length is 10. Primary REST API for Sales Cloud Industry Solutions 119

120

121 16 Managing CaseToResource This chapter describes the following resources: CaseToResource Managing Case to Resource: Overview The CaseToResource resource is used to view, create, or modify CaseToResource records. The CaseToResource object stores information on relationship between resource team and cases. The object maintains a many-to-many relationship between a case and a resource. Resource Plural Label Resource Name CaseToResource ORAFS CaseToResource_c Tasks The table below lists tasks supported by this resource. Task Request URI Get all CaseToReso urce records View a CaseToReso urce record Create a CaseToReso urce record Update a CaseToReso urce record GET GET POST PATCH /crmcommonapi/resources/ / ORAFS CaseToReso urce_c /crmcommonapi/resources/ / ORAFS CaseToReso urce_c/< Replace with system generated unique ID> /crmcommonapi/resources/ / ORAFS CaseToReso urce_c /crmcommonapi/resources/ / ORAFS CaseToReso urce_c/< Replace with system generated unique ID> Delete a DELETE /crmcommonapi/resources/ / ORAFS CaseToReso REST API for Sales Cloud Industry Solutions 121

122 Contents CaseToReso urce record urce_c/< Replace with system generated unique ID> Managing Case to Resource Resources This section covers the following topics: Tasks List of Values Resource Attributes Resource Plural Label Resource Name CaseToResource ORAFS CaseToResource_c Get all CaseToResource Records Request GET URI crmcommonapi/resources/ / ORAFS CaseToResource_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name Id Description Finds CaseToResource records by ID. Finder Variables: PrimaryKey 122 REST API for Sales Cloud Industry Solutions

123 Managing CaseToResource Managing Case to Resource Resources o o Type: Integer Description: The unique identifier of the CaseToResource record. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Description Returns an array of CaseToResource resources. Example Gets all CaseToResource records. Example Command: curl --user sales_cloud_user / ORAFS CaseToResource_c Example Response Body { "Id" : , "RowType" : " ORAFS CaseToResource_c", "RecordName" : " ", "CreatedBy" : "SALES.REP1_US@AP6023FEMS.US.ORACLE.COM", "CreationDate" : " T05:13:14+00:00", "LastUpdatedBy" : "SALES.REP1_US@AP6023FEMS.US.ORACLE.COM", "LastUpdateDate" : " T05:13:15+00:00", "LastUpdateLogin" : null, "CpdrfVerSor" : null, "UserLastUpdateDate" : null, REST API for Sales Cloud Industry Solutions 123

124 Contents "CpdrfLastUpd" : null, "CpdrfVerPillar" : null, "JobDefinitionPackage" : null, "RequestId" : null, "JobDefinitionName" : null, "CurrencyCode" : "USD", "CurcyConvRateType" : "Corporate", "CorpCurrencyCode" : "USD", "IsOwner" : "false", "Cases_Id ORAFS Src ORAFS Cases_cTo ORAFS CaseToResource_c" : , "Resource_Id ORAFS Tgt_ResourceTo ORAFS CaseToResource_c" : , " ORAFS Function_c" : null, " ORAFS Owner_c" : true, "links" : [ { "rel" : "self", "href" : " ORAFS CaseToResour ce_c/ ", "name" : " ORAFS CaseToResource_c", "kind" : "item", "properties" : { "changeindicator" : "ACED A E C2E C D21D99C7619D A A E6D E D616C54C71557F981284F C654C E C C6A F6D F E B A E6C616E672 E4E756D AC951D0B94E08B A E6C616E672E4F626A A E6D E E CFC9F1FA93BFB1D F756E C656E E6F6E7A65726F E756D49000C6C6F E756D5B00096D61676E B E0004FFFFFFF FFFFFFFFFFFFFFFFEFFFFFFFE B42ACF317F E E " } }, { "rel" : "canonical", "href" : " ORAFS CaseToResour ce_c/ ", "name" : " ORAFS CaseToResource_c", "kind" : "item" }, { "rel" : "lov", "href" : " ORAFS CaseToResour 124 REST API for Sales Cloud Industry Solutions

125 Managing CaseToResource Managing Case to Resource Resources ce_c/ /lov/lovva_for ORAFS Function_c", "name" : "LOVVA_For ORAFS Function_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS CaseToResour ce_c/ /lov/viewaccessor_currencycode", "name" : "ViewAccessor_CurrencyCode", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS CaseToResour ce_c/ /lov/lovva_for ORAFS Owner_c", "name" : "LOVVA_For ORAFS Owner_c", "kind" : "collection" } ] } Create a CaseToResource Record Request POST URI crmcommonapi/resources/ / ORAFS CaseToResource_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Description REST API for Sales Cloud Industry Solutions 125

126 Contents Accepts a CaseToResource resource item. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Description Returns a CaseToResource resource item. Example Creates a new CaseToResource record. Example Command: curl --user sales_cloud_user / ORAFS CaseToResource_c View a CaseToResource Record Request GET URI crmcommonapi/resources/ / ORAFS CaseToResource_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the CaseToResource record. 126 REST API for Sales Cloud Industry Solutions

127 Managing CaseToResource Managing Case to Resource Resources Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns a CaseToResource resource item. Example Gets a CaseToResource record. Example Command: curl --user sales_cloud_user ORAFS CaseT oresource_c/ Update a CaseToResource Record Request PATCH URI crmcommonapi/resources/ / ORAFS CaseToResource_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description REST API for Sales Cloud Industry Solutions 127

128 Contents Id Integer The unique identifier of the CaseToResource record. Request Body application/vnd.oracle.adf.resourceitem+json Description Accepts a CaseToResource resource item. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns a CaseToResource resource item. Example Updates an existing CaseToResource record. Example Command: curl --user sales_cloud_user ORAFS CaseT oresource_c/ Delete a CaseToResource Record Request DELETE 128 REST API for Sales Cloud Industry Solutions

129 Managing CaseToResource Managing Case to Resource Resources URI crmcommonapi/resources/ / ORAFS CaseToResource_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the CaseToResource record. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example Deletes an existing CaseToResource record. Example Command: curl --user sales_cloud_user ORAFS CaseT oresource_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_Currency Code LOVVA_For ORAFS Fu nction_c LOVVA_For ORAFS O wner_c CurrencyCode ORAFS Function_c ORAFS Owner_c Currency Function Owner REST API for Sales Cloud Industry Solutions 129

130 Contents Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer The unique identifier of the CaseToResource record. Record ID RowType The name of the CaseToResource object. In this case ORAFS CaseToContact_c. The maximum length is 80. RecordName An auto-generated unique identifier for the CaseToResource record. The maximum length is 80. CaseToResourceRecordName CreatedBy The user who created the CaseToResource record. The maximum length is 32. Created By CreationDate The date and time when the CaseToResource record was created. Creation Date LastUpdatedBy The user who last updated the CaseToResource record. 130 REST API for Sales Cloud Industry Solutions

131 Managing CaseToResource Managing Case to Resource Resources The maximum length is 32. Last Updated By LastUpdateDate The date and time when the CaseToResource record was last updated. Last Update Date CurrencyCode The currency code associated with the CaseToResource record. The maximum length is 15. Currency Cases_Id ORAFS Src ORAFS C ases_cto ORAFS CaseToResource_ c Resource_Id OR AFS Tgt_Resource To ORAFS Case ToResource_c ORAFS Functio n_c integer integer String The unique identifier of the case associated with the CaseToResource record. The unique identifier of the team member associated with the CaseToResource record. Indicates if the heir is primary. The maximum length is Function REST API for Sales Cloud Industry Solutions 131

132

133 17 Managing Daily Balances This chapter describes the following resources: Daily Balance Daily Balance Overview The Daily Balance resource is used to manage the daily closing balance of a financial account. Resource Plural Label Resource Name Daily Balance ORAFS DailyBalance_c Tasks The table below lists tasks supported by this resource. Task Request URI Get all Daily Balance records View a Daily Balance record Create a Daily Balance record Update a Daily Balance record Delete a Daily Balance GET GET POST PATCH DELETE /crmcommonapi/resources/ / ORAFS DailyBalance _c /crmcommonapi/resources/ / ORAFS DailyBalance _c/< Replace with system generated unique ID> /crmcommonapi/resources/ / ORAFS DailyBalance _c /crmcommonapi/resources/ / ORAFS DailyBalance _c/< Replace with system generated unique ID> /crmcommonapi/resources/ / ORAFS DailyBalance _c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 133

134 Contents record Daily Balance This section covers the following topics: Tasks List of Values Resource Attributes Resource Plural Label Resource Name Daily Balance ORAFS DailyBalance_c Get all Daily Balance Records Request GET URI crmcommonapi/resources/ / ORAFS DailyBalance_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name Id Description Finds Daily Balance records by ID. Finder Variables: PrimaryKey 134 REST API for Sales Cloud Industry Solutions

135 Managing Daily Balances Daily Balance o o Type: Integer Description: The unique identifier of the Daily Balance record. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Description Returns an array of Daily Balance resources. Example Gets all Daily Balance records. Example Command: curl --user sales_cloud_user /_ORAFS DailyBalance_c Example Response Body { "Id" : , "RowType" : " ORAFS DailyBalance_c", "RecordName" : "123", "CreatedBy" : "aic_1", "CreationDate" : " T11:28:56+00:00", "LastUpdatedBy" : "SALES.REP1_US@ap6023fems.us.oracle.com", "LastUpdateDate" : " T05:26:04+00:00", "LastUpdateLogin" : null, "CpdrfVerSor" : null, "UserLastUpdateDate" : null, "CpdrfLastUpd" : null, "CpdrfVerPillar" : null, REST API for Sales Cloud Industry Solutions 135

136 Contents "JobDefinitionPackage" : null, "RequestId" : null, "JobDefinitionName" : null, "CurrencyCode" : "USD", "CurcyConvRateType" : "Corporate", "CorpCurrencyCode" : "USD", "SourceType" : " ORAFS DAILYBALANCE_C", "AttachmentEntityName" : " ORAFS DailyBalance_c", "PKProxy" : " ", "IsOwner" : "false", " ORAFS FinancialAccount_Id_c" : , " ORAFS FinancialAccount_c" : " ", " ORAFS ClosingBalance_c" : 13123, " ORAFS ClosingDate_c" : " ", "FinancialSummary_Id ORAFS HistoricalAccountSummary" : , " ORAFS Extn ORAFS DailyBalance_cFuseCreateLayoutURL" : "/cust/apps/ extension / ORAFS DailyBalance_c/ ORAFS DailyBalance_cF usecreate/ ORAFS DailyBalance_cFuseCreate_Layout2.jsff", " ORAFS Extn ORAFS DailyBalance_cFuseCreateLayoutDrivers" : "null", " ORAFS Extn ORAFS DailyBalance_cFuseDetailLayoutURL" : "/cust/apps/ extension / ORAFS DailyBalance_c/ ORAFS DailyBalance_cF usedetail/ ORAFS DailyBalance_cFuseDetail_Layout2.jsff", " ORAFS Extn ORAFS DailyBalance_cFuseDetailLayoutDrivers" : "null", "Extn ORAFS DailyBalance_cFuseCreateLayoutURL" : "/cust/apps/ extension / ORAFS DailyBalance_c/ ORAFS DailyBalance_cF usecreate/ ORAFS DailyBalance_cFuseCreate_Layout2.jsff", "Extn ORAFS DailyBalance_cFuseCreateLayoutDrivers" : null, "Extn ORAFS DailyBalance_cFuseDetailLayoutURL" : "/cust/apps/ extension / ORAFS DailyBalance_c/ ORAFS DailyBalance_cF usedetail/ ORAFS DailyBalance_cFuseDetail_Layout2.jsff", "Extn ORAFS DailyBalance_cFuseDetailLayoutDrivers" : null, "links" : [ { "rel" : "self", "href" : " ORAFS DailyBalance _c/ ", "name" : " ORAFS DailyBalance_c", "kind" : "item", "properties" : { "changeindicator" : "ACED A E C2E C D21D99C7619D A A E6D E D616C54C71557F981284F C654C E C REST API for Sales Cloud Industry Solutions

137 Managing Daily Balances Daily Balance 0164C6A F6D F E B A E6C616E672 E4E756D AC951D0B94E08B A E6C616E672E4F626A A E6D E E CFC9F1FA93BFB1D F756E C656E E6F6E7A65726F E756D49000C6C6F E756D5B00096D61676E B E0004FFFFFFF FFFFFFFFFFFFFFFFEFFFFFFFE B42ACF317F E E " } }, { "rel" : "canonical", "href" : " ORAFS DailyBalance _c/ ", "name" : " ORAFS DailyBalance_c", "kind" : "item" }, { "rel" : "lov", "href" : " ORAFS DailyBalance _c/ /lov/fk_lovva_for ORAFS FinancialAccount_c", "name" : "FK_LOVVA_For ORAFS FinancialAccount_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS DailyBalance _c/ /lov/lovva_for ORAFS FinancialAccount_c", "name" : "LOVVA_For ORAFS FinancialAccount_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS DailyBalance _c/ /lov/viewaccessor_currencycode", "name" : "ViewAccessor_CurrencyCode", "kind" : "collection" } ] } Create a Daily Balance Record Request POST REST API for Sales Cloud Industry Solutions 137

138 Contents URI crmcommonapi/resources/ / ORAFS DailyBalance_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Description Accepts a Daily Balance item. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Description Returns a Daily Balance resource item. Example Creates a new Daily Balance record. Example Command: curl --user sales_cloud_user /_ORAFS DailyBalance_c 138 REST API for Sales Cloud Industry Solutions

139 Managing Daily Balances Daily Balance View a Daily Balance Record Request GET URI crmcommonapi/resources/ / ORAFS DailyBalance_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Daily Balance record. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns a Daily Balance resource item. Example Gets a Daily Balance record. Example Command: curl --user sales_cloud_user ORAFS DailyB alance_c/ REST API for Sales Cloud Industry Solutions 139

140 Contents Update a Daily Balance Record Request PATCH URI crmcommonapi/resources/ / ORAFS DailyBalance_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Daily Balance record. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns a Daily Balance resource item. Example Updates an existing Daily Balance record. Example Command: curl --user 140 REST API for Sales Cloud Industry Solutions

141 Managing Daily Balances Daily Balance sales_cloud_user ORAFS DailyB alance_c/ Delete a Daily Balance Record Request DELETE URI crmcommonapi/resources/ / ORAFS DailyBalance_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Daily Balance record. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example Deletes an existing Daily Balance record. Example Command: curl --user sales_cloud_user ORAFS DailyB alance_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in REST API for Sales Cloud Industry Solutions 141

142 Contents ViewAccessor_Currency Code FK_LOVVA_For ORAFS FinancialAccount_c LOVVA_For ORAFS Fin ancialaccount_c CurrencyCode _ORAFS FinancialAccou nt_id_c ORAFS FinancialAcco unt_c Resource Currency Code Financial Account Financial Account Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer The unique identifier of the Daily Balance record. Record ID RowType The name of the Daily Balance object. In this case ORAFS DailyBalance_ c. The maximum length is 80. RecordName An auto-generated unique identifier for the Daily Balance record. The maximum length is 80. Daily Balance # CreatedBy The user who created the Daily Balance record. 142 REST API for Sales Cloud Industry Solutions

143 Managing Daily Balances Daily Balance The maximum length is 32. Created By CreationDate The date and time when the Daily Balance record was created. Creation Date LastUpdatedBy The user who last updated the Daily Balance record. The maximum length is 32. Last Updated By LastUpdateDate The date and time when the Daily Balance record was last updated. Last Update Date CurrencyCode The currency code associated with the Daily Balance record. The maximum length is 15. Currency Code REST API for Sales Cloud Industry Solutions 143

144 Contents ORAFS FinancialAcco unt_id_c integer The unique identifier of the financial account for which the Daily Balance information is entered. ORAFS FinancialAcco unt_c Financial Account The financial account for which the Daily Balance information is entered. The maximum length is ORAFS ClosingBalanc e_c number Financial Account The closing balance of the financial account. Closing Balance ORAFS ClosingDate_c The date for which the closing balance information is entered. Closing Date 144 REST API for Sales Cloud Industry Solutions

145 18 Managing Financial Accounts This chapter describes the following resources: Financial Accounts Financial Account Overview The financial account resource is used to manage all financial accounts that belong to a household. Resource Plural Label Resource Name Financial Accounts ORAFS FinancialAccount_c Tasks The table below lists tasks supported by this resource. Task Request URI Get all Financial Account records View a Financial Account record Create a Financial Account record Update a Financial Account record GET GET POST PATCH /crmcommonapi/resources/ / ORAFS FinancialAcc ount_c /crmcommonapi/resources/ / ORAFS FinancialAcc ount_c/< Replace with system generated unique ID> /crmcommonapi/resources/ / ORAFS FinancialAcc ount_c /crmcommonapi/resources/ / ORAFS FinancialAcc ount_c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 145

146 Contents Delete a Financial Account record DELETE /crmcommonapi/resources/ / ORAFS FinancialAcc ount_c/< Replace with system generated unique ID> Financial Account This section covers the following topics: Tasks List of Values Resource Attributes Resource Plural Label Resource Name Financial Accounts ORAFS FinancialAccount_c Get all Financial Account Records Request GET URI crmcommonapi/resources/ / ORAFS FinancialAccount_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name Id Description Finds Financial Account records by ID. 146 REST API for Sales Cloud Industry Solutions

147 Managing Financial Accounts Financial Account Finder Variables: PrimaryKey o o Type: Integer Description: The unique identifier of the Financial Account record. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Description Returns an array of Financial Account resources. Example Gets all Financial Account records. Example Command: curl --user sales_cloud_user / ORAFS FinancialAccount_c Create a Financial Account Record Request POST URI crmcommonapi/resources/ / ORAFS FinancialAccount_c REST API for Sales Cloud Industry Solutions 147

148 Contents Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Description Returns a Financial Account resource item. Example Creates a new Financial Account record. Example Command: curl --user sales_cloud_user / ORAFS FinancialAccount_c Example Response Body { "Id" : , "RowType" : " ORAFS FinancialAccount_c", "RecordName" : " ", "CreatedBy" : "FAAdmin", "CreationDate" : " T10:03:23+00:00", "LastUpdatedBy" : "FAAdmin", "LastUpdateDate" : " T10:07:03+00:00", "LastUpdateLogin" : null, "CpdrfVerSor" : null, "UserLastUpdateDate" : null, "CpdrfLastUpd" : null, 148 REST API for Sales Cloud Industry Solutions

149 Managing Financial Accounts Financial Account "CpdrfVerPillar" : null, "JobDefinitionPackage" : null, "RequestId" : null, "JobDefinitionName" : null, "CurrencyCode" : null, "CurcyConvRateType" : null, "CorpCurrencyCode" : null, "SourceType" : " ORAFS FINANCIALACCOUNT_C", "AttachmentEntityName" : " ORAFS FinancialAccount_c", "PKProxy" : " ", "IsOwner" : "true", " ORAFS Description_c" : null, " ORAFS Type_c" : "ORA_AFS_PORTFOLIO", " ORAFS Joint_c" : false, " ORAFS Balance_c" : null, " ORAFS BalanceAsOfDate_c" : " ", " ORAFS DateOpened_c" : null, " ORAFS HomeBranch_c" : null, " ORAFS Status_c" : "ORA_AFS_NORMAL", " ORAFS Asset_c" : true, " ORAFS ProductName_Id_c" : , " ORAFS ProductName_c" : "FP ", " ORAFS Product_c" : "15 Year Home Loan", " ORAFS Household_Id_c" : , " ORAFS Household_c" : "Mahesh Family", " ORAFS Owner_Id_c" : null, " ORAFS Owner_c" : null, " ORAFS OwnerManager_c" : "", " ORAFS OwnerOrganization_c" : "", " ORAFS CustomerID_c" : " ", " ORAFS ExternalSystemId_c" : null, " ORAFS LastImported_c" : null, " ORAFS FinancialSummary_Id_c" : null, " ORAFS FinancialSummary_c" : null, " ORAFS Extn ORAFS FinancialAccount_cFuseDetailLayoutURL" : "/cust/apps/ extension / ORAFS FinancialAccount_c/ ORAFS FinancialAc count_cfusedetail/ ORAFS FinancialAccount_cFuseDetail_Layout2.jsff", " ORAFS Extn ORAFS FinancialAccount_cFuseDetailLayoutDrivers" : "null", " ORAFS Extn ORAFS FinancialAccount_cFuseCreateLayoutURL" : "/cust/apps/ extension / ORAFS FinancialAccount_c/ ORAFS FinancialAc count_cfusecreate/ ORAFS FinancialAccount_cFuseCreate_Layout2.jsff", " ORAFS Extn ORAFS FinancialAccount_cFuseCreateLayoutDrivers" : "null", REST API for Sales Cloud Industry Solutions 149

150 Contents " ORAFS HeldAwayInstitution_c" : null, "Extn ORAFS FinancialAccount_cFuseCreateLayoutURL" : "/cust/apps/ extension / ORAFS FinancialAccount_c/ ORAFS FinancialAc count_cfusecreate/ ORAFS FinancialAccount_cFuseCreate_Layout2.jsff", "Extn ORAFS FinancialAccount_cFuseCreateLayoutDrivers" : null, "Extn ORAFS FinancialAccount_cFuseDetailLayoutURL" : "/cust/apps/ extension / ORAFS FinancialAccount_c/ ORAFS FinancialAc count_cfusedetail/ ORAFS FinancialAccount_cFuseDetail_Layout2.jsff", "Extn ORAFS FinancialAccount_cFuseDetailLayoutDrivers" : null, "links" : [ { "rel" : "self", "href" : " ORAFS FinancialAcc ount_c/ ", "name" : " ORAFS FinancialAccount_c", "kind" : "item", "properties" : { "changeindicator" : "ACED A E C2E C D21D99C7619D A A E6D E D616C54C71557F981284F C654C E C C6A F6D F E B A E6C616E672 E4E756D AC951D0B94E08B A E6C616E672E4F626A A E6D E E CFC9F1FA93BFB1D F756E C656E E6F6E7A65726F E756D49000C6C6F E756D5B00096D61676E B E0004FFFFFFF FFFFFFFFFFFFFFFFEFFFFFFFE B42ACF317F E E " } }, { "rel" : "canonical", "href" : " ORAFS FinancialAcc ount_c/ ", "name" : " ORAFS FinancialAccount_c", "kind" : "item" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/lovva_for ORAFS Asset_c", "name" : "LOVVA_For ORAFS Asset_c", "kind" : "collection" }, { "rel" : "lov", "href" : " 150 REST API for Sales Cloud Industry Solutions

151 Managing Financial Accounts Financial Account ext.us.oracle.com:443/crmcommonapi/resources/ / ORAFS FinancialAcc ount_c/ /lov/fk_lovva_for ORAFS Owner_c", "name" : "FK_LOVVA_For ORAFS Owner_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/lovva_for ORAFS Joint_c", "name" : "LOVVA_For ORAFS Joint_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/lovva_for ORAFS FinancialSummary_c", "name" : "LOVVA_For ORAFS FinancialSummary_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/viewaccessor_currencycode", "name" : "ViewAccessor_CurrencyCode", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/lovva_for ORAFS Owner_c", "name" : "LOVVA_For ORAFS Owner_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/fk_lovva_for ORAFS Household_c", "name" : "FK_LOVVA_For ORAFS Household_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/lovva_for ORAFS Type_c", "name" : "LOVVA_For ORAFS Type_c", REST API for Sales Cloud Industry Solutions 151

152 Contents "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/fk_lovva_for ORAFS ProductName_c", "name" : "FK_LOVVA_For ORAFS ProductName_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/lovva_for ORAFS ProductName_c", "name" : "LOVVA_For ORAFS ProductName_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/lovva_for ORAFS Household_c", "name" : "LOVVA_For ORAFS Household_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/lovva_for ORAFS Status_c", "name" : "LOVVA_For ORAFS Status_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinancialAcc ount_c/ /lov/fk_lovva_for ORAFS FinancialSummary_c", "name" : "FK_LOVVA_For ORAFS FinancialSummary_c", "kind" : "collection" } ] } 152 REST API for Sales Cloud Industry Solutions

153 Managing Financial Accounts Financial Account View a Financial Account Record Request GET URI crmcommonapi/resources/ / ORAFS FinancialAccount_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Financial Account record. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns a Financial Account resource item. Example Gets a Financial Account record. Example Command: curl --user sales_cloud_user ORAFS Finan cialaccount_c/ REST API for Sales Cloud Industry Solutions 153

154 Contents Update a Financial Account Record Request PATCH URI crmcommonapi/resources/ / ORAFS FinancialAccount_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Financial Account record. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns a Financial Account resource item. Example Updates an existing Financial Account record. Example Command: curl --user sales_cloud_user ORAFS Finan cialaccount_c/ REST API for Sales Cloud Industry Solutions

155 Managing Financial Accounts Financial Account Delete a Financial Account Record Request DELETE URI crmcommonapi/resources/ / ORAFS FinancialAccount_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Financial Account record. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example Deletes an existing Financial Account record. Example Command: curl --user sales_cloud_user ORAFS Finan cialaccount_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_Currency Code CurrencyCode Currency Code REST API for Sales Cloud Industry Solutions 155

156 Contents LOVVA_For ORAFS Ty pe_c LOVVA_For ORAFS Jo int_c LOVVA_For ORAFS St atus_c LOVVA_For ORAFS As set_c FK_LOVVA_For ORAFS ProductName_c LOVVA_For ORAFS Pr oductname_c FK_LOVVA_For ORAFS Household_c LOVVA_For ORAFS H ousehold_c FK_LOVVA_For ORAFS Owner_c LOVVA_For ORAFS O wner_c ORAFS Type_c ORAFS Joint_c ORAFS Status_c ORAFS Asset_c ORAFS ProductName _Id_c ORAFS ProductName _c ORAFS Household_Id_ c ORAFS Household_c ORAFS Owner_Id_c ORAFS Owner_c Type Joint Status Asset Product Name Product Household Household Owner Owner Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer The unique identifier of the Financial Account record. Record ID RowType The name of the Financial Account object. In this case ORAFS Financial Account_c. 156 REST API for Sales Cloud Industry Solutions

157 Managing Financial Accounts Financial Account The maximum length is 80. RecordName An auto-generated unique identifier for the Financial Account record. The maximum length is 80. Financial Account CreatedBy The user who created the Financial Account record. The maximum length is 32. Created By CreationDate The date and time when the Financial Account record was created. Creation Date LastUpdatedBy The user who last updated the Financial Account record. The maximum length is 32. Last Updated By REST API for Sales Cloud Industry Solutions 157

158 Contents LastUpdateDate The date and time when the Financial Account record was last updated. Last Update Date CurrencyCode The currency code associated with the Financial Account record. The maximum length is 15. Currency Code SourceType The name of the Financial Account object. In this case ORAFS Financial Account_c. The maximum length is 0. ORAFS Description_c The description of the Financial Account record. The maximum length is 200. Description ORAFS Type_c The financial account type for the associated Financial Account. 158 REST API for Sales Cloud Industry Solutions

159 Managing Financial Accounts Financial Account The maximum length is Type ORAFS Joint_c boolean Indicates whether the Financial Account is joint or not. The maximum length is 10. Joint ORAFS Balance_c number The balance of the associated Financial Account. Balance ORAFS BalanceAsOfD ate_c The balance as of date of the associated Financial Account. ORAFS DateOpened_ c Balance as of Date The date when the associated Financial Account opened. ORAFS HomeBranch_ c Date Opened The home branch of the Financial Account. The maximum length is 200. REST API for Sales Cloud Industry Solutions 159

160 Contents Home Branch ORAFS Status_c The status of the Financial Account. The maximum length is Status ORAFS Asset_c boolean Indicates whetehr the Financial Account is a Cash Account or a Credit Account. The maximum length is 10. Asset ORAFS ProductName _Id_c integer The unique identifier of the financial product of the associated product. ORAFS ProductName _c Product Name The name of the financial product of the associated product. The maximum length is Product Name ORAFS Product_c This calculates the SCM Item Name from the 160 REST API for Sales Cloud Industry Solutions

161 Managing Financial Accounts Financial Account Financial Product associated. This is the Product Name displayed in the Application. The maximum length is 0. Product ORAFS Household_Id_ c integer The unique identifier of the household associated with the Financial Account record. Household ORAFS Household_c The name of the household associated with the Financial Account record. The maximum length is Household ORAFS Owner_Id_c integer The unique identifier of the owner of the Financial Account record. Owner ORAFS Owner_c The name of the owner of the Financial Account record. REST API for Sales Cloud Industry Solutions 161

162 Contents The maximum length is ORAFS OwnerManag er_c Owner The name of the owner's manager. The value is calculated using the Owner field value. The maximum length is 0. ORAFS OwnerOrganiz ation_c Owner Manager The name of the owner's Organization. The value is calculated using the Owner field value. The maximum length is 0. Owner Organization ORAFS CustomerID_c The unique identifier of the customer for this Financial Account record. This is calculated from the ID field. The maximum length is 0. Customer ID ORAFS ExternalSystem Id_c The external IDs from where Financial Accounts are migrated. 162 REST API for Sales Cloud Industry Solutions

163 Managing Financial Accounts Financial Account The maximum length is 80. External System Id ORAFS LastImported_ c The date when the file import was done last for the Financial Account record. ORAFS HeldAwayInstit ution_c Last Imported The name of the held away institution of the Financial Account when the Account status is Held Away. This is a mandatory field when status is Held Away. The maximum length is 80. Held Away Institution REST API for Sales Cloud Industry Solutions 163

164

165 19 Managing Financial Account Contacts This chapter describes the following resources: Financial Account Contacts Financial Account Contact Overview The Financial Account Contact resource is used to store the relationship between a Financial Account and a Contact. A Financial Account can have multiple Contacts associated with it (Joint Account) and a Contact can have multiple Financial Accounts associated with it. Fin Account Contact is the intersection object which stores the relationship between Financial Accounts and Contacts. A Fin Account record consists of a Financial Account ID and a Contact ID. All other data is read from its parent objects. Resource Plural Label Resource Name Fin Account Contacts ORAFS FinAccountContact_c Tasks The table below lists tasks supported by this resource. Task Request URI Get all Fin Account Contact records View a Fin Account Contact record Create a Fin Account Contact record GET GET POST /crmcommonapi/resources/ / ORAFS FinAccountC ontact_c /crmcommonapi/resources/ / ORAFS FinAccountC ontact_c/< Replace with system generated unique ID> /crmcommonapi/resources/ / ORAFS FinAccountC ontact_c REST API for Sales Cloud Industry Solutions 165

166 Contents Update a Fin Account Contact record Delete a Fin Account Contact record PATCH DELETE /crmcommonapi/resources/ / ORAFS FinAccountC ontact_c/< Replace with system generated unique ID> /crmcommonapi/resources/ / ORAFS FinAccountC ontact_c/< Replace with system generated unique ID> Financial Account Contact This section covers the following topics: Tasks List of Values Resource Attributes Resource Plural Label Resource Name Fin Account Contacts ORAFS FinAccountContact_c Get all Financial Account Contact Records Request GET URI crmcommonapi/resources/ / ORAFS FinAccountContact_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: 166 REST API for Sales Cloud Industry Solutions

167 Managing Financial Account Contacts Financial Account Contact Finder Name Id Description Finds Fin Account Contact records by ID. Finder Variables: PrimaryKey o o Type: Integer Description: The unique identifier of the Fin Account Contact record. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Description Returns an array of Fin Account Contact resources. Example Gets all Fin Account Contact records. Example Command: curl --user sales_cloud_user / ORAFS FinAccountContact_c Example Response Body { "Id" : , "RowType" : " ORAFS FinAccountContact_c", "RecordName" : " ", REST API for Sales Cloud Industry Solutions 167

168 Contents "CreatedBy" : "aic_1", "CreationDate" : " T11:15:52+00:00", "LastUpdatedBy" : "SALES.REP1_US@ap6023fems.us.oracle.com", "LastUpdateDate" : " T05:26:04+00:00", "LastUpdateLogin" : null, "CpdrfVerSor" : null, "UserLastUpdateDate" : null, "CpdrfLastUpd" : null, "CpdrfVerPillar" : null, "JobDefinitionPackage" : null, "RequestId" : null, "JobDefinitionName" : null, "CurrencyCode" : "USD", "CurcyConvRateType" : "Corporate", "CorpCurrencyCode" : "USD", "SourceType" : " ORAFS FINACCOUNTCONTACT_C", "AttachmentEntityName" : " ORAFS FinAccountContact_c", "PKProxy" : " ", "IsOwner" : "false", " ORAFS FinancialAccount_Id_c" : , " ORAFS FinancialAccount_c" : " ", " ORAFS Contact_Id_c" : , " ORAFS Contact_c" : "Mark Smith", " ORAFS Type_c" : "Portfolio", " ORAFS Product_c" : "", " ORAFS Balance_c" : 0, " ORAFS BalanceAsOfDate_c" : " T00:00:00+00:00", " ORAFS DateOpened_c" : " T00:00:00+00:00", " ORAFS _c" : "mark.smith@citrix.com", "FinancialSummary_Id ORAFS HolderSummary" : , " ORAFS Extn ORAFS FinAccountContact_cFuseCreateLayoutURL" : "/cust/apps/ extension / ORAFS FinAccountContact_c/ ORAFS FinAccount Contact_cFuseCreate/ ORAFS FinAccountContact_cFuseCreate_Layout2.jsff", " ORAFS Extn ORAFS FinAccountContact_cFuseCreateLayoutDrivers" : "null", " ORAFS Extn ORAFS FinAccountContact_cFuseDetailLayoutURL" : "/cust/apps/ extension / ORAFS FinAccountContact_c/ ORAFS FinAccount Contact_cFuseDetail/ ORAFS FinAccountContact_cFuseDetail_Layout2.jsff", " ORAFS Extn ORAFS FinAccountContact_cFuseDetailLayoutDrivers" : "null", "Extn ORAFS FinAccountContact_cFuseCreateLayoutURL" : "/cust/apps/ extension / ORAFS FinAccountContact_c/ ORAFS FinAccount Contact_cFuseCreate/ ORAFS FinAccountContact_cFuseCreate_Layout2.jsff", "Extn ORAFS FinAccountContact_cFuseCreateLayoutDrivers" : null, "Extn ORAFS FinAccountContact_cFuseDetailLayoutURL" : 168 REST API for Sales Cloud Industry Solutions

169 Managing Financial Account Contacts Financial Account Contact "/cust/apps/ extension / ORAFS FinAccountContact_c/ ORAFS FinAccount Contact_cFuseDetail/ ORAFS FinAccountContact_cFuseDetail_Layout2.jsff", "Extn ORAFS FinAccountContact_cFuseDetailLayoutDrivers" : null, "links" : [ { "rel" : "self", "href" : " ORAFS FinAccountCo ntact_c/ ", "name" : " ORAFS FinAccountContact_c", "kind" : "item", "properties" : { "changeindicator" : "ACED A E C2E C D21D99C7619D A A E6D E D616C54C71557F981284F C654C E C C6A F6D F E B A E6C616E672 E4E756D AC951D0B94E08B A E6C616E672E4F626A A E6D E E CFC9F1FA93BFB1D F756E C656E E6F6E7A65726F E756D49000C6C6F E756D5B00096D61676E B E0004FFFFFFF FFFFFFFFFFFFFFFFEFFFFFFFE B42ACF317F E E " } }, { "rel" : "canonical", "href" : " ORAFS FinAccountCo ntact_c/ ", "name" : " ORAFS FinAccountContact_c", "kind" : "item" }, { "rel" : "lov", "href" : " ORAFS FinAccountCo ntact_c/ /lov/lovva_for ORAFS Contact_c", "name" : "LOVVA_For ORAFS Contact_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinAccountCo ntact_c/ /lov/fk_lovva_for ORAFS Contact_c", "name" : "FK_LOVVA_For ORAFS Contact_c", "kind" : "collection" }, { "rel" : "lov", REST API for Sales Cloud Industry Solutions 169

170 Contents "href" : " ORAFS FinAccountCo ntact_c/ /lov/fk_lovva_for ORAFS FinancialAccount_c", "name" : "FK_LOVVA_For ORAFS FinancialAccount_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinAccountCo ntact_c/ /lov/lovva_for ORAFS FinancialAccount_c", "name" : "LOVVA_For ORAFS FinancialAccount_c", "kind" : "collection" }, { "rel" : "lov", "href" : " ORAFS FinAccountCo ntact_c/ /lov/viewaccessor_currencycode", "name" : "ViewAccessor_CurrencyCode", "kind" : "collection" } ] } Create a Financial Account Contact Record Request POST URI crmcommonapi/resources/ / ORAFS FinAccountContact_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json 170 REST API for Sales Cloud Industry Solutions

171 Managing Financial Account Contacts Financial Account Contact Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Description Returns a Fin Account Contact resource item. Example Creates a new Fin Account Contact record. Example Command: curl --user sales_cloud_user / ORAFS FinAccountContact_c View a Financial Account Contact Record Request GET URI crmcommonapi/resources/ / ORAFS FinAccountContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Fin Account Contact record. Request Body There are no elements in the request body for this task. REST API for Sales Cloud Industry Solutions 171

172 Contents Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns a Fin Account Contact resource item. Example Gets a Fin Account Contact record. Example Command: curl --user sales_cloud_user ORAFS FinAc countcontact_c/ Update a Financial Account Contact Record Request PATCH URI crmcommonapi/resources/ / ORAFS FinAccountContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Fin Account Contact record. Request Body application/vnd.oracle.adf.resourceitem+json 172 REST API for Sales Cloud Industry Solutions

173 Managing Financial Account Contacts Financial Account Contact Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns a Fin Account Contact resource item. Example Updates an existing Fin Account Contact record. Example Command: curl --user sales_cloud_user ORAFS FinAc countcontact_c/ Delete a Financial Account Contact Record Request DELETE URI crmcommonapi/resources/ / ORAFS FinAccountContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Fin Account Contact record. REST API for Sales Cloud Industry Solutions 173

174 Contents Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example Deletes an existing Fin Account Contact record. Example Command: curl --user sales_cloud_user ORAFS FinAc countcontact_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyC ode FK_LOVVA_For ORAFS FinancialAccount_c LOVVA_For ORAFS Fin ancialaccount_c FK_LOVVA_For ORAFS Contact_c LOVVA_For ORAFS Co ntact_c CurrencyCode ORAFS FinancialAccount_Id_c ORAFS FinancialAccount_c ORAFS Contact_Id_c ORAFS Contact_c Currency Code Financial Account Financial Account Contact Contact Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer The unique identifier of the Fin Account Contact record. 174 REST API for Sales Cloud Industry Solutions

175 Managing Financial Account Contacts Financial Account Contact Record ID RowType The name of the Fin Account Contact object. In this case ORAFS FinAccountCo ntact_c. The maximum length is 80. RecordName An auto-generated unique identifier for the Fin Account Contact record. The maximum length is 80. Record # CreatedBy The user who created the Fin Account Contact record. The maximum length is 32. Created By CreationDate The date and time when the Fin Account Contact record was created. Creation Date LastUpdatedBy The user who last updated the Fin Account Contact record. REST API for Sales Cloud Industry Solutions 175

176 Contents The maximum length is 32. Last Updated By LastUpdateDate The date and time when the Fin Account Contact record was last updated. Last Update Date CurrencyCode The currency code associated with the Fin Account Contact record. The maximum length is 15. Currency Code SourceType The name of the Fin Account Contact object. In this case ORAFS DailyBalance_ c. The maximum length is 0. ORAFS FinancialAcco unt_id_c integer The unique identifier for which Fin Account Contact information is entered. ORAFS FinancialAcco unt_c Financial Account The financial account for which Fin Account 176 REST API for Sales Cloud Industry Solutions

177 Managing Financial Account Contacts Financial Account Contact Contact information is entered. The maximum length is Financial Account ORAFS Contact_Id_c integer The unique identifier of the contact for which Fin Account Contact information is entered. Contact ORAFS Contact_c The name of the contact for which Fin Account Contact information is entered. The maximum length is Contact ORAFS Type_c The financial account type for the associated Fin Account Contact. This is a read-only field. The maximum length is 0. Type ORAFS Product_c The name of the product for the associated financial account. REST API for Sales Cloud Industry Solutions 177

178 Contents The maximum length is 0. Product ORAFS Balance_c integer The balance of the associated financial account. Balance ORAFS BalanceAsOfD ate_c The balance as of date of the associated financial account. ORAFS DateOpened_ c Balance as of Date The date when the associated financial account opened. Date Opened ORAFS _c The address of the contact associated with the financial account. The maximum length is REST API for Sales Cloud Industry Solutions

179 20 Managing Integration Configuration This chapter describes the Integration Configuration resource. Integration Configuration Overview This is used to store all the configuration values required for Siebel integration in the form of key or value pairs. Resource Plural Label Resource Name Integration Configuration integration configuration The table below lists tasks supported by this resource. Task Request URI Integration Configuration Get All Records GET /crmcommonapi/resources/<version>/ ORATC O_INT_ IntegConfig_c/ Create a Record View Single Record Update an Existing Record Delete an Existing Record POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORATC O_INT_ IntegConfig_c/ /crmcommonapi/resources/<version>/ ORATC O_INT_ IntegConfig_c/ /crmcommonapi/resources/<version>/ ORATC O_INT_ IntegConfig_c/ /crmcommonapi/resources/<version>/ ORATC O_INT_ IntegConfig_c/ Integration Configuration This section covers the following topics: Tasks REST API for Sales Cloud Industry Solutions 179

180 Contents List of Values Resource Attributes This is used to capture task and appointment information. Resource Plural Label Resource Name Integration Configuration ORATC O_INT_IntegConfig_c Tasks The table below lists tasks supported by this resource. Task Request URI Integration Configuration Get All Records Create a Record View Single Record Update an Existing Record Delete an Existing Record GET POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORATC O_INT_ IntegConfig_c /crmcommonapi/resources/<version>/ ORATC O_INT_ IntegConfig_c /crmcommonapi/resources/<version>/ ORATC O_INT_ IntegConfig_c /crmcommonapi/resources/<version>/ ORATC O_INT_ IntegConfig_c /crmcommonapi/resources/<version>/ ORATC O_INT_ IntegConfig_c Get All Records Request GET URI /crmcommonapi/resources/<version>/ ORATC O_INT_IntegConfig_c Request Path Parameters The following are required path parameters for this task: Name Type Description 180 REST API for Sales Cloud Industry Solutions

181 Managing Integration Configuration Integration Configuration Integration Configuration integer The unique identifier of the Integration Configuration. Request Query Parameters Use the following finder parameter/parameters to query the resource: Finder Name PrimaryKey Description The unique identifier of the integration configuration. Finder Variables: Id o Type: integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Stores an array of configuration values for the Integration Configuration resource item. Create a Record Request POST URI /crmcommonapi/resources/<version>/ ORATC O_INT_IntegConfig_c/ Request Path Parameters The following are required path parameters for this task: REST API for Sales Cloud Industry Solutions 181

182 Contents Name Type Description Integration Configuration integer The unique identifier of the Integration Configuration. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Stores an array of configuration values for the Integration Configuration resource item. View Records Request GET URI /crmcommonapi/resources/<version>/ ORATC O_INT_IntegConfig_c/ Request Path Parameters The following are required path parameters for this task: Name Type Description Integration Configuration integer The unique identifier of the integration configuration. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description 182 REST API for Sales Cloud Industry Solutions

183 Managing Integration Configuration Integration Configuration Stores an array of configuration values for the Integration Configuration resource item. Update an Existing Record Request PATCH URI /crmcommonapi/resources/<version>/ ORATC O_INT_IntegConfig_c/ Request Path Parameters The following are required path parameters for this task: Name Type Description Integration Configuration integer The unique identifier of the integration configuration. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Stores an array of configuration values for the Integration Configuration resource item. Delete an Existing Record Request DELETE URI /crmcommonapi/resources/<version>/ ORATC O_INT_IntegConfig_c/ Request Path Parameters The following are required path parameters for this task: Name Type Description REST API for Sales Cloud Industry Solutions 183

184 Contents Integration Configuration integer The unique identifier of the integration configuration. List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource CurrencyCode CurrencyCode CurrencyCode Resource Attributes This resource has the following attributes: Name Type Description Id The unique identifier of the integration integer configuration. UI Display Label Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80 characters. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80 characters. UI Display Label Configuration ID CreatedBy A system-generated read-only attribute used by the application framework. The maximum length is 32 characters. UI Display Label Created By CreationDate A system-generated read-only attribute used by the application framework. 184 REST API for Sales Cloud Industry Solutions

185 Managing Integration Configuration Integration Configuration Name Type Description LastUpdatedBy LastUpdateDate LastUpdateLogin CpdrfVerSor UserLastUpdateDate CpdrfLastUpd integer date-time UI Display Label Creation Date A system-generated read-only attribute used by the application framework. The maximum length is 32 characters. UI Display Label Last Updated By A system-generated read-only attribute used by the application framework. date-time UI Display Label Last Update Date A system-generated read-only attribute used by the application framework. The maximum length is 32 characters. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. date-time A system-generated read-only attribute used by the application framework. CpdrfVerPillar JobDefinitionPackage integer The maximum length is 15 characters. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. REST API for Sales Cloud Industry Solutions 185

186 Contents Name Type Description RequestId JobDefinitionName CurrencyCode CurcyConvRateType CorpCurrencyCode SourceType AttachmentEntityName PKProxy integer The maximum length is 900 characters. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. The maximum length is 100 characters. A system-generated read-only attribute used by the application framework. The maximum length is 15 characters. UI Display Label Currency A system-generated read-only attribute used by the application framework. The maximum length is 15 characters. A system-generated read-only attribute used by the application framework. The maximum length is 15 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 18 characters. UI Display Label 186 REST API for Sales Cloud Industry Solutions

187 Managing Integration Configuration Integration Configuration Name Type Description Last Updated Login IsOwner A system-generated read-only attribute used by the application framework. ORATC RemoteSyste mid_c ORATC Key_c ORATC Value_c ORATC Extn ORATC O_INT_IntegConfig_cF usecreatelayouturl ORATC Extn ORATC O_INT_IntegConfig_cF usecreatelayoutdrivers ORATC Extn ORATC O_INT_IntegConfig_cF usedetaillayouturl Required field that shows the key values The maximum length is 0 characters. Required field that shows the name of the remote application. Example: Siebel. The maximum length is 80 characters. UI Display Label Remote Application Required field that shows the key values The maximum length is 100 characters. UI Display Label Key Required field that shows the values for the keys The maximum length is 500 characters. UI Display Label Value A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. REST API for Sales Cloud Industry Solutions 187

188 Contents Name Type Description ORATC Extn ORATC O_INT_IntegConfig_cF usedetaillayoutdrivers Extn ORATC O_INT_Int egconfig_cfusecreatel ayouturl Extn ORATC O_INT_Int egconfig_cfusecreatel ayoutdrivers Extn ORATC O_INT_Int egconfig_cfusedetailla youturl Extn ORATC O_INT_Int egconfig_cfusedetailla youtdrivers A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. 188 REST API for Sales Cloud Industry Solutions

189 21 Managing Integration Map Lookup This chapter describes the Integration Map Lookup resource. Integration Map Lookup Overview This indicates the lookup value mappings between Oracle Sales Cloud and Siebel CRM. Resource Plural Label Resource Name Integration Map Lookup integration map lookup The table below lists tasks supported by this resource. Task Request URI Integration Map Lookup Get All Records GET /crmcommonapi/resources/<version>/ ORATC O_INT_ SBL_MAP_LKP_c Create a Record View Single Record Update an Existing Record Delete an Existing Record POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORATC O_INT_ SBL_MAP_LKP_c /crmcommonapi/resources/<version>/ ORATC O_INT_ SBL_MAP_LKP_c /crmcommonapi/resources/<version>/ ORATC O_INT_ SBL_MAP_LKP_c /crmcommonapi/resources/<version>/ ORATC O_INT_ SBL_MAP_LKP_c Integration Map Lookup This section covers the following topics: Tasks REST API for Sales Cloud Industry Solutions 189

190 Contents List of Values Resource Attributes This is used to capture task and appointment information. Resource Plural Label Resource Name Integration Map Lookup ORATC O_INT_SBL_MAP_LKP_c Tasks The table below lists tasks supported by this resource. Task Request URI Integration Map Lookup Get All Records Create a Record View Single Record Update an Existing Record Delete an Existing Record GET POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORATC O_INT_ SBL_MAP_LKP_c /crmcommonapi/resources/<version>/ ORATC O_INT_ SBL_MAP_LKP_c /crmcommonapi/resources/<version>/ ORATC O_INT_ SBL_MAP_LKP_c /crmcommonapi/resources/<version>/ ORATC O_INT_ SBL_MAP_LKP_c /crmcommonapi/resources/<version>/ ORATC O_INT_ SBL_MAP_LKP_c Get All Records Request GET URI /crmcommonapi/resources/<version>/ ORATC O_INT_SBL_MAP_LKP_c Request Path Parameters The following are required path parameters for this task: Name Type Description 190 REST API for Sales Cloud Industry Solutions

191 Managing Integration Map Lookup Integration Map Lookup Integration Map Lookup integer The unique identifier of the Integration Map Lookup. Request Query Parameters Use the following finder parameter/parameters to query the resource: Finder Name PrimaryKey Description The unique identifier of the integration map lookup. Finder Variables: Id o Type: integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns an array of mapping values for the Integration Map Lookup resource item. Create a Record Request POST URI /crmcommonapi/resources/<version>/ ORATC O_INT_SBL_MAP_LKP_c Request Path Parameters The following are required path parameters for this task: REST API for Sales Cloud Industry Solutions 191

192 Contents Name Type Description Integration Map Lookup integer The unique identifier of the Integration Map Lookup. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns an array of mapping values for the Integration Map Lookup resource item. View a Single Record Request GET URI /crmcommonapi/resources/<version>/ ORATC O_INT_SBL_MAP_LKP_c Request Path Parameters The following are required path parameters for this task: Name Type Description Integration Map Lookup integer The unique identifier of the Integration Map Lookup. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description 192 REST API for Sales Cloud Industry Solutions

193 Managing Integration Map Lookup Integration Map Lookup Returns an array of mapping values for the Integration Map Lookup resource item. Update an Existing Record Request PATCH URI /crmcommonapi/resources/<version>/ ORATC O_INT_SBL_MAP_LKP_c Request Path Parameters The following are required path parameters for this task: Name Type Description Integration Map Lookup integer The unique identifier of the Integration Map Lookup. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Description Returns an array of mapping values for the Integration Map Lookup resource item. Delete an Existing Record Request DELETE URI /crmcommonapi/resources/<version>/ ORATC O_INT_SBL_MAP_LKP_c Request Path Parameters The following are required path parameters for this task: Name Type Description REST API for Sales Cloud Industry Solutions 193

194 Contents Integration Map Lookup integer The unique identifier of the Integration Map Lookup. List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource CurrencyCode CurrencyCode CurrencyCode Resource Attributes This resource has the following attributes: Name Type Description Id The unique identifier of the integration map lookup. RowType RecordName CreatedBy CreationDate integer UI Display Label Record ID A system-generated read-only attribute used by the application framework. The maximum length is 80 characters. A system-generated read-only attribute used by the application framework. The maximum length is 80 characters. UI Display Label Lookup ID A system-generated read-only attribute used by the application framework. The maximum length is 32 characters. UI Display Label Created By A system-generated read-only attribute used by the application framework. 194 REST API for Sales Cloud Industry Solutions

195 Managing Integration Map Lookup Integration Map Lookup Name Type Description date-time LastUpdatedBy LastUpdateDate LastUpdateLogin CpdrfVerSor UserLastUpdateDate CpdrfLastUpd integer UI Display Label Creation Date A system-generated read-only attribute used by the application framework. The maximum length is 32 characters. UI Display Label Last Updated By A system-generated read-only attribute used by the application framework. date-time UI Display Label Last Update Date A system-generated read-only attribute used by the application framework. The maximum length is 32 characters. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. date-time A system-generated read-only attribute used by the application framework. CpdrfVerPillar JobDefinitionPackage integer The maximum length is 15 characters. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. REST API for Sales Cloud Industry Solutions 195

196 Contents Name Type Description The maximum length is 900 characters. RequestId JobDefinitionName CurrencyCode CurcyConvRateType CorpCurrencyCode SourceType AttachmentEntityName PKProxy integer A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. The maximum length is 100 characters. A system-generated read-only attribute used by the application framework. The maximum length is 15 characters. UI Display Label Currency A system-generated read-only attribute used by the application framework. The maximum length is 15 characters. A system-generated read-only attribute used by the application framework. The maximum length is 15 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 18 characters. UI Display Label Last Updated Login 196 REST API for Sales Cloud Industry Solutions

197 Managing Integration Map Lookup Integration Map Lookup Name Type Description IsOwner A system-generated read-only attribute used by the application framework. ORATC RemoteAppli cationid_c ORATC OBJ_NAME_ c Required field that shows the key values The maximum length is 0 characters. Required field that shows the name of the remote application. Example: Siebel. The maximum length is 80 characters. UI Display Label Remote Application Required field that shows the name of the standard object in Oracle Sales Cloud. Example: Opportunity ORATC OBJ_ATTRIB_ c ORATC S_LOOKUP_V ALUE_c ORATC S_LKUP_PARE NT_VAL_c The maximum length is 80 characters. UI Display Label Object Name Required field that shows the name of the attributes in the standard object in Oracle Sales Cloud. The maximum length is 500 characters. UI Display Label Object Attribute Required field that shows the values for the attributes in the standard object in Oracle Sales Cloud. The maximum length is 0 characters. UI Display Label Source Value Required field that shows the source parent value. Example: Standard Sales Process or Renewal Sales Process. REST API for Sales Cloud Industry Solutions 197

198 Contents Name Type Description ORATC T_LOOKUP_V ALUE_c ORATC Extn ORATC O_INT_SBL_MAP_LKP_c FuseCreateLayoutURL ORATC Extn ORATC O_INT_SBL_MAP_LKP_c FuseCreateLayoutDriver s ORATC Extn ORATC O_INT_SBL_MAP_LKP_c FuseDetailLayoutURL ORATC Extn ORATC O_INT_SBL_MAP_LKP_c FuseDetailLayoutDrivers Extn ORATC O_INT_SB L_MAP_LKP_cFuseCreat elayouturl Extn ORATC O_INT_SB L_MAP_LKP_cFuseCreat elayoutdrivers The maximum length is 0 characters. UI Display Label Source Parent Value Required field that shows the remote value. The maximum length is 0 characters. UI Display Label Remote Value A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. 198 REST API for Sales Cloud Industry Solutions

199 Managing Integration Map Lookup Integration Map Lookup Name Type Description The maximum length is 0 characters. Extn ORATC O_INT_SB L_MAP_LKP_cFuseDetail LayoutURL Extn ORATC O_INT_SB L_MAP_LKP_cFuseDetail LayoutDrivers A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. A system-generated read-only attribute used by the application framework. The maximum length is 0 characters. REST API for Sales Cloud Industry Solutions 199

200

201 22 Managing Inventories This chapter describes the following resources: Inventories Inventories Overview The Inventory object reflects the inventory at the retailer at a given point of time. It contains attributes to track products in the store and its current placing. The inventory resource is used to view, create, or modify an inventory. Use this resource to create, update, find, and delete inventories. Resource Plural Label Resource Name Inventories ORACO Inventory_c The table below lists tasks supported by this resource. Task Request URI Inventory Get all Inventories Get an Inventory Create an Inventory Update an Inventory Delete an Inventory GET GET POST PATCH DELETE /crmcommonapi/resources/<version>/ ORACO Inventor y_c /crmcommonapi/resources/<version>/ ORACO Inventor y_c/{id} /crmcommonapi/resources/<version>/ ORACO Inventor y_c /crmcommonapi/resources/<version>/ ORACO Inventor y_c/{id} /crmcommonapi/resources/<version>/ ORACO Inventor y_c/{id} REST API for Sales Cloud Industry Solutions 201

202 Contents Inventories This section covers the following topics: Tasks List of Values Resource Attributes The Inventory object reflects the inventory at the retailer at a given point of time. It contains attributes to track products in the store and its current placing. The inventory resource is used to view, create, or modify an inventory. Use this resource to create, update, find, and delete inventories. Resource Plural Label Resource Name Inventory ORACO Inventory_c Tasks The table below lists tasks supported by this resource. Task Request URI Inventory Get all Inventories Get an Inventory Create an Inventory Update an Inventory Delete an Inventory GET GET POST PATCH DELETE /crmcommonapi/resources/<version>/ ORACO Inventor y_c /crmcommonapi/resources/<version>/ ORACO Inventor y_c/{id} /crmcommonapi/resources/<version>/ ORACO Inventor y_c /crmcommonapi/resources/<version>/ ORACO Inventor y_c/{id} /crmcommonapi/resources/<version>/ ORACO Inventor y_c/{id} 202 REST API for Sales Cloud Industry Solutions

203 Managing Inventories Inventories Get All Inventories Request GET URI /crmcommonapi/resources/<version>/ ORACO Inventory_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description The unique identifier of the Inventory. You can get the Inventory Id by examining the response payload of a Get All Inventories request. Finder Variables: Id o Type: integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all inventories. Example Command: curl --user sales_cloud_user ORACO Invent ory_c REST API for Sales Cloud Industry Solutions 203

204 Contents Get an Inventory Request GET URI /crmcommonapi/resources/<version>/ ORACO Inventory_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Inventory. You can get the Inventory Id by examining the response payload of a Get All Inventories request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets an inventory with the Id Example Command: curl -- user sales_cloud_user ORACO Invent ory_c/ Create an Inventory Request POST URI /crmcommonapi/resources/<version>/ ORACO Inventory_c 204 REST API for Sales Cloud Industry Solutions

205 Managing Inventories Inventories Request Path Parameters There are no required path parameters for this task. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update an Inventory Request PATCH URI /crmcommonapi/resources/<version>/ ORACO Inventory_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Inventory. You can get the Inventory Id by examining the response payload of a Get All Inventories request. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json REST API for Sales Cloud Industry Solutions 205

206 Contents application/vnd.oracle.adf.resourceitem+json Delete an Inventory Request DELETE URI /crmcommonapi/resources/<version>/ ORACO Inventory_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Inventory. You can get the Inventory Id by examining the response payload of a Get All Inventories request. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an existing inventory with the Id Example Command: curl --user sales_cloud_user X DELETE ORACO Invent ory_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod CurrencyCode Currency e FK_LOVVA_For ORACO P ORACO Product_Id1_c Product roduct_c LOVVA_For ORACO Prod ORACO Product_c Product 206 REST API for Sales Cloud Industry Solutions

207 Managing Inventories Inventories uct_c Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Audit History Name CreatedBy The user who created the inventory record. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. REST API for Sales Cloud Industry Solutions 207

208 Contents Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateDat e A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (i.e. a different mobile database or the server). CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPack age A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the row. JobDefinitionNam e A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name of the job that created or last updated the row. The maximum length is 100. CurrencyCode The currency code associated with the inventory. The maximum length is REST API for Sales Cloud Industry Solutions

209 Managing Inventories Inventories CurcyConvRateTy pe Currency The currency conversion rate type associated with the inventory. CorpCurrencyCod e The maximum length is 15. The corporate currency code of the inventory. The maximum length is 15. SourceType A system-generated read-only attribute used by the application framework. The maximum length is 0. AttachmentEntityN ame A system-generated read-only attribute used by the application framework. PKProxy A system-generated read-only attribute used by the application framework. The maximum length is 18. IsOwner A system-generated read-only attribute used by the application framework. ORACO AuditD ate_c The date of an inventory audit. Audit Date ORACO Facing _c integer The facing quantity. Must be less than the Shelf Stock quantity. Minimum Value: 0 The maximum length is 10. ORACO Locati on_c ORACO Produ ct_id1_c integer Facing The location of the product. Display Width: 30 The maximum length is Location The product identifier. REST API for Sales Cloud Industry Solutions 209

210 Contents ORACO Produ ct_id2_c ORACO Produ ct_c ORACO ShelfSt ock_c ORACO UnitPri ce_c ORACO UOM_ c Organization_Id ORACO Account _Inventory integer integer integer Product Not visible in UI. Foreign Key. ORACO Product_Id2_c The name of the product. Display Width: 40 The maximum length is Product The Shelf Stock quantity. Must be greater than the Facing quantity. Minimum Value: 0 The maximum length is 10. Shelf Stock The unit price of an item. Precision: 10 Decimal Places: 2 Unit Price The Unit of Measure of an item. Display Width: 30 The maximum length is 500. UOM Foreign Key 210 REST API for Sales Cloud Industry Solutions

211 23 Managing Orders This chapter describes the following resources: Orders Orders: Order Items Orders Overview An Order is a set of products ordered by an account. An order is comprised of one or more order items. An item is a product. Use this resource to view, create, update, find, and delete orders. Resource Plural Label Resource Name Orders ORACO Order_c The table below lists tasks supported by this resource. Task Request URI Orders Get all Orders GET /crmcommonapi/resources/<version>/ ORACO O rder_c Get an Order GET /crmcommonapi/resources/<version>/ ORACO O rder_c /{Id} Create an Order POST /crmcommonapi/resources/<version>/ ORACO O rder_c Update an Order PATCH /crmcommonapi/resources/<version>/ ORACO O rder_c /{Id} Delete an Order DELETE /crmcommonapi/resources/<version>/ ORACO O rder_c /{Id} REST API for Sales Cloud Industry Solutions 211

212 Contents Orders : Order Items Get all Order Items Get an Order Item Create an Order Item Update an Order Item Delete an Order Item GET GET POST PATCH DELETE /crmcommonapi/resources/<version>/ ORACO O rder_c/{id}/child/ ORACO OrderItemsCollect ion_c /crmcommonapi/resources/<version>/ ORACO O rder_c/{id}child/ ORACO OrderItemsCollecti on_c/{id} /crmcommonapi/resources/<version>/ ORACO O rder_c/{id}/child/ ORACO OrderItemsCollect ion_c /crmcommonapi/resources/<version>/ ORACO O rder_c/{id}child/ ORACO OrderItemsCollecti on_c/{id} /crmcommonapi/resources/<version>/ ORACO O rder_c/{id}child/ ORACO OrderItemsCollecti on_c/{id} Orders This section covers the following topics: Tasks List of Values Resource Attributes An Order is a set of products ordered by an account. An order is comprised of one or more order items. An item is a product. Use this resource to view, create, update, find, and delete orders. Resource Plural Label Resource Name Orders ORACO Order_c Tasks The table below lists tasks supported by this resource. Task Request URI Orders Get all Orders GET /crmcommonapi/resources/<version>/ ORACO Order_c 212 REST API for Sales Cloud Industry Solutions

213 Managing Orders Orders Get an Order Create an Order Update an Order Delete an Order GET POST PATCH DELETE /crmcommonapi/resources/<version>/ ORACO Order_c /{Id} /crmcommonapi/resources/<version>/ ORACO Order_c /crmcommonapi/resources/<version>/ ORACO Order_c /{Id} /crmcommonapi/resources/<version>/ ORACO Order_c /{Id} Get All Orders Request GET URI /crmcommonapi/resources/<version>/ ORACO Order_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description The unique identifier of the Order. You can get the Order ID by examining the response payload of a Get All Orders request. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: REST API for Sales Cloud Industry Solutions 213

214 Contents application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all orders. Example Command: curl --user sales_cloud_user ORACO Order _c Get an Order Request GET URI /crmcommonapi/resources/<version>/ ORACO Order_c /{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Order. You can get the Order Id by examining the response payload of a Get All Orders request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets an order. Example Command: curl --user sales_cloud_user ORACO Order_ c/ REST API for Sales Cloud Industry Solutions

215 Managing Orders Orders Create an Order Request POST URI /crmcommonapi/resources/<version>/ ORACO Order_c Request Path Parameters There are no required path parameters for this task. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update an Order Request PATCH URI /crmcommonapi/resources/<version>/ ORACO Order_c /{Id} Request Path Parameters The following are required path parameters for this task: Finder Name Type Description PrimaryKey Integer The unique identifier of the Order. You can get the Order ID by examining the response payload of a Get All Orders request. Finder Variables REST API for Sales Cloud Industry Solutions 215

216 Contents Id o Type: Integer Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Delete an Order Request DELETE URI /crmcommonapi/resources/<version>/ ORACO Order_c /{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Order. You can get the Order Id by examining the response payload of a Get All Orders request. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an existing Orders resource with the ID Example Command: curl --user sales_cloud_user X DELETE 216 REST API for Sales Cloud Industry Solutions

217 Managing Orders Orders ORACO Order_ c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod e LOVVA_For ORACO Ord erstatus_c LOVVA_For ORACO Pay mentmode_c LOVVA_For ORACO Pay mentstatus_c LOVVA_For ORACO Type _c CurrencyCode ORACO OrderStatus_c ORACO PaymentMode_ c ORACO PaymentStatus_ c ORACO Type_c Currency Order Status Payment Mode Payment Status Type Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Audit History Name CreatedBy The user who created the order record. REST API for Sales Cloud Industry Solutions 217

218 Contents The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateD ate The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (i.e. a different mobile database or the server). CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPack age A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the record. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. 218 REST API for Sales Cloud Industry Solutions

219 Managing Orders Orders JobDefinitionNam e Enterprise Service Scheduler: The request identifier of the job that created or last updated the record. A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name of the job that created or last updated the record. The maximum length is 100. CurrencyCode The currency code associated with the order. The maximum length is 15. CurcyConvRateTy pe CorpCurrencyCo de Currency The currency conversion rate type associated with the order. The maximum length is 15. Default currency code. The corporate currency used by the account. The maximum length is 15. SourceType A system-generated read-only attribute used by the application framework. AttachmentEntity Name A system-generated read-only attribute used by the application framework. PKProxy A system-generated read-only attribute used by the application framework. The maximum length is 18. IsOwner A system-generated read-only attribute used by the application framework. ORACO Order AmountBI_c number The amount of the order. Precision: 20 Decimal Places: 4 ORACO Order Date_c Amount Date stamp of the order. REST API for Sales Cloud Industry Solutions 219

220 Contents ORACO Order Status_c ORACO Owne rbi_c ORACO Paym entmode_c ORACO Paym entstatus_c ORACO Type_ c Organization_Id ORACO Accou nt_order ORACO Acco unt_c integer Order Date The status of the order. The maximum length is Order Status The account owner value used in reports and analytics. Display Width: 30 The maximum length is 500. Owner The payment mode of the order. The maximum length is Payment Mode The payment status of the order. The maximum length is Payment Status The type of the order. The maximum length is Type Foreign Key The account name to which the order is associated. Account ORACO Submi UI button. Do not use. 220 REST API for Sales Cloud Industry Solutions

221 Managing Orders Orders: Order Items t_order Submit Order Orders: Order Items This section covers the following topics: Tasks List of Values Resource Attributes The Order Items object contains a set of products, product costs, and quantities for an order within an account. Resource Plural Label Resource Name Order Items ORACO OrderItemsCollection_c Tasks The table below lists tasks supported by this resource. Task Request URI Orders: Order Items Get all Order Items Get an Order Item Create an Order Item Update an Order Item Delete an Order Item GET GET POST PATCH DELETE /crmcommonapi/resources/<version>/ ORACO Order_c/ {Id}/child/ ORACO OrderItemsCollection_c /crmcommonapi/resources/<version>/ ORACO Order_c/ {Id}child/ ORACO OrderItemsCollection_c/{Id} /crmcommonapi/resources/<version>/ ORACO Order_c/ {Id}/child/ ORACO OrderItemsCollection_c /crmcommonapi/resources/<version>/ ORACO Order_c/ {Id}child/ ORACO OrderItemsCollection_c/{Id} /crmcommonapi/resources/<version>/ ORACO Order_c/ {Id}child/ ORACO OrderItemsCollection_c/{Id} REST API for Sales Cloud Industry Solutions 221

222 Contents Get All Order Items Request GET URI /crmcommonapi/resources/<version>/ ORACO Order_c/{Id}/child/ ORACO Order ItemsCollection_c Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Order Item. You can get the Order Item ID by examining the response payload of a Get All Order Items request. Request Query Parameters Use the following finder parameters to query the resource: Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example retrieves all order items for the Order Id Example Command: curl --user sales_cloud_user ORACO Ord er_c/ /child/ ORACO OrderItemsCollection_c Get an Order Item Request GET 222 REST API for Sales Cloud Industry Solutions

223 Managing Orders Orders: Order Items URI /crmcommonapi/resources/<version>/ ORACO Order_c/{Id}child/ ORACO OrderI temscollection_c/{id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer An Order is a set of products ordered by an account. An order is comprised of 1 or more order items. An item is a product. Use this resource to view, create, update, find, and delete orders. Id Integer The unique identifier of the Order Item. You can get the Order Item ID by examining the response payload of a Get All Order Items request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets an order item. Example Command: curl --user sales_cloud_user /crmcommonapi/resources/ / ORACO Order_c/ /child/ ORA CO OrderItemsCollection_c/ Create an Order Item Request POST URI /crmcommonapi/resources/<version>/ ORACO Order_c/{Id}/child/ ORACO Order ItemsCollection_c REST API for Sales Cloud Industry Solutions 223

224 Contents Request Path Parameters The following are required path parameters for this task: Name Type Description Id Integer The unique identifier of the Order. You can get the Order Id by examining the response payload of a Get All Orders request. Request Body The following table summarizes the supported request body content types: application/json application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update an Order Item Request PATCH URI /crmcommonapi/resources/<version>/ ORACO Order_c/{Id}child/ ORACO OrderI temscollection_c/{id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Order. You can get the Order Id by examining the response payload of a Get All Orders request. 224 REST API for Sales Cloud Industry Solutions

225 Managing Orders Orders: Order Items Id integer The unique identifier of the Order Item. You can get the Order Item Id by examining the response payload of a Get All Order Items request. Request Body The following table summarizes the supported request body content type: application/json application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Delete an Order Item Request DELETE URI /crmcommonapi/resources/<version>/ ORACO Order_c/{Id}child/ ORACO OrderI temscollection_c/{id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id Id integer The unique identifier of the Order. You can get the Order Id by examining the response payload of a Get All Orders request. integer The unique identifier of the Order Item. You can get the Order Item Id by examining the response payload of a Get All Order Items request. REST API for Sales Cloud Industry Solutions 225

226 Contents Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an existing order item resource with the Order Id of and Order Items Id Example Command: curl --user sales_cloud_user X DELETE /crmcommonapi/resources/ / ORACO Order_c/ /child/ ORA CO OrderItemsCollection_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCode CurrencyCode CurrencyCode Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is REST API for Sales Cloud Industry Solutions

227 Managing Orders Orders: Order Items Audit History Name CreatedBy The user who created the order record. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateDate Not for external use. This attribute is used by the Extensibility framework. The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (i.e. a different mobile database or the server). CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPackage Not for external use. This attribute is used REST API for Sales Cloud Industry Solutions 227

228 Contents by the Extensibility framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the record. The maximum length is 900. RequestId integer Not for external use. This attribute is used by the Extensibility framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the record. JobDefinitionName Not for external use. This attribute is used by the Extensibility framework. Enterprise Service Scheduler: The short name the job that created or last updated the record. The maximum length is 100. CurrencyCode The currency code associated with the order item. The maximum length is 15. Currency CurcyConvRateType The currency conversion rate type associated with the order item. The maximum length is 15. CorpCurrencyCode Default currency code. The corporate currency used by the account. The maximum length is 15. IsOwner A system-generated read-only attribute used by the application framework. ORACO Discount_c number The discount in percentage term. Precision:10 Decimal Places: 4 The maximum length is REST API for Sales Cloud Industry Solutions

229 Managing Orders Orders: Order Items Discount ORACO ItemName_c The name of an Order Item. Display Width: 30 The maximum length is Product ORACO Quantity_c integer The quantity of an Order Item. Minimum value: 1 Quantity ORACO UnitPrice_c number The Unit price of an Order Item. Precision: 10 Decimal Places: 2 Unit Price ORACO UOM_c The Unit of Measure of an Order Item. Display Width: 30 The maximum length is 500. ORACO DiscountedPrice _c UOM The calculated discount price of an Order Item. Discounted Price ORACO TotalPrice_c The calculated total amount of an Order Item. Total Price ORACO Order_Id_c Integer A copy of the unique identifier of an order. ORACO Order_c object The Order object. REST API for Sales Cloud Industry Solutions 229

230

231 24 Managing Participating Accounts This chapter describes the following resources: Participating Accounts Participating Accounts Overview A participating account object is a mapping of accounts and business plans. Use this resource to view, update, and delete participating accounts. Resource Plural Label Resource Name Participating Accounts ORAHT PlanAccount_c The table below lists tasks supported by this resource. Task Request URI Participating Accounts Get all plan accounts Create a plan account Get a plan account Update a plan account Delete a plan account GET POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORAHT Pl anaccount_c /crmcommonapi/resources/<version>/ ORAHT Pl anaccount_c /crmcommonapi/resources/<version>/ ORAHT Pl anaccount_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT Pl anaccount_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT Pl anaccount_c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 231

232 Contents Get All Plan Accounts Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanAccount_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description Finds the plan account resource by the primary key. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all participating accounts. Example command: curl sales_cloud_user ORAHT PlanA ccount_c Example Response Body 232 REST API for Sales Cloud Industry Solutions

233 Managing Participating Accounts Participating Accounts Overview { "items" : [ { "Id" : , "RowType" : " ORAHT PlanAccount_c", "RecordName" : " ", "CreatedBy" : "bala.gupta", "CreationDate" : " T08:12:55+00:00", "LastUpdatedBy" : "bala.gupta", "LastUpdateDate" : " T08:12:55+00:00", },. } Create a Plan Account Request POST URI /crmcommonapi/resources/<version>/ ORAHT PlanAccount_c Request Path Parameters There are no required path parameters for this task. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json REST API for Sales Cloud Industry Solutions 233

234 Contents application/vnd.oracle.adf.resourceitem+json Example This example creates a participating account. Example command: curl sales_cloud_user X POST ORAHT PlanA ccount_c Get a Plan Account Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanAccount_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds the plan account resource by the primary key. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a participating account. Example command: curl sales_cloud_user ORAHT PlanA ccount_c/ REST API for Sales Cloud Industry Solutions

235 Managing Participating Accounts Participating Accounts Overview Update a Plan Account Request PATCH URI /crmcommonapi/resources/<version>/ ORAHT PlanAccount_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds the plan account resource by the primary key. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Delete a Plan Account Request DELETE URI /crmcommonapi/resources/<version>/ ORAHT PlanAccount_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description REST API for Sales Cloud Industry Solutions 235

236 Contents Id integer Finds the plan account resource by the primary key. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes a participating account. Example command: curl sales_cloud_user X DELETE ORAHT PlanA ccount_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod CurrencyCode Currency e Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is REST API for Sales Cloud Industry Solutions

237 Managing Participating Accounts Participating Accounts Overview Plan Account CreatedBy The user who created the participating account record. The maximum length is 32. Created By CreationDate The date when the record was created, Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. Last Update Login CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateD ate A system-generated read-only attribute used by the application framework. The date and time when the record was last updated from mobile. User last update Date CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the REST API for Sales Cloud Industry Solutions 237

238 Contents JobDefinitionPack age application framework. A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the record. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the record. JobDefinitionNam e A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name of the job that created or last updated the record. The maximum length is 100. CurrencyCode The currency code associated with the plan account. The maximum length is 15. CurcyConvRateTy pe CorpCurrencyCo de Currency The currency conversion rate type associated with the plan account. The maximum length is 15. Currency Conversion Rate Type The corporate currency used by the plan account. The maximum length is 15. Corporate Currency IsOwner A system-generated read-only attribute used by the application framework. 238 REST API for Sales Cloud Industry Solutions

239 Managing Participating Accounts Participating Accounts Overview AccountPlan_Id ORAHT Src O RAHT AccountPl an_cto ORAHT PlanAccount_c ORAHT Accou ntowner_c integer The maximum length is 0. A system-generated read-only attribute used by the application framework. The account owner, Account Owner REST API for Sales Cloud Industry Solutions 239

240

241 25 Managing Plan Activities This chapter describes the following resources: Plan Activities Plan Activities Overview Plan activity captures the plan tasks and appointments. Use this resource to view, update, and delete plan activities. Resource Plural Label Resource Name Plan Activities ORAHT PlanActivity_c The table below lists tasks supported by this resource. Task Request URI Plan Activities Get all account plan activities Create all account plan activities Get an account plan activity Update an account plan activity Delete an account plan activity GET POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORAHT Pla nactivity_c /crmcommonapi/resources/<version>/ ORAHT Pla nactivity_c /crmcommonapi/resources/<version>/ ORAHT Pla nactivity_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT Pla nactivity_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT Pla nactivity_c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 241

242 Contents Get All Account Plan Activities Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanActivity_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description Finds account plan activity with the specified account plan activity ID. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all the plan activities. Example command: curl sales_cloud_user ORAHT PlanA ctivity_c Example Response Body { "items" : [ { 242 REST API for Sales Cloud Industry Solutions

243 Managing Plan Activities Plan Activities Overview "Id" : , "RowType" : " ORAHT PlanActivity_c", "RecordName" : " ", "CreatedBy" : "bala.gupta", "CreationDate" : " T13:42:11+00:00", "LastUpdatedBy" : "bala.gupta", "LastUpdateDate" : " T13:42:14+00:00",.. }, } Create All Account Plan Activities Request POST URI /crmcommonapi/resources/<version>/ ORAHT PlanActivity_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json REST API for Sales Cloud Industry Solutions 243

244 Contents Get an Account Plan Activity Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanActivity_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plan activity with the specified account plan activity ID. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a plan activity. Example command: curl sales_cloud_user ORAHT PlanA ctivity_c/ Update an Account Plan Activity Request PATCH URI /crmcommonapi/resources/<version>/ ORAHT PlanActivity_c/< Replace with system generated unique ID> 244 REST API for Sales Cloud Industry Solutions

245 Managing Plan Activities Plan Activities Overview Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plan activity with the specified account plan activity ID. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Delete an Account Plan Activity Request DELETE URI /crmcommonapi/resources/<version>/ ORAHT PlanActivity_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plan activity with the specified account plan activity ID. Request Body There are no elements in the request body for this task. REST API for Sales Cloud Industry Solutions 245

246 Contents Response Body There are no elements in the response body for this task. Example This example gets a plan activity. Example command: curl sales_cloud_user X DELETE ORAHT PlanA ctivity_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_Curr CurrencyCode Currency encycode Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Plan Activity CreatedBy The user who created the Plan Activity record. The maximum length is REST API for Sales Cloud Industry Solutions

247 Managing Plan Activities Plan Activities Overview Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. Last Update Login CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateDat e A system-generated read-only attribute used by the application framework. The date and time when the record was last updated from mobile. User Last Update Date CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPacka ge A system-generated read-only attribute used by the application framework. The maximum length is 900. RequestId integer A system-generated read-only attribute used by REST API for Sales Cloud Industry Solutions 247

248 Contents the application framework. JobDefinitionName A system-generated read-only attribute used by the application framework. The maximum length is 100. CurrencyCode The currency code associated with the plan activity. The maximum length is 15. CurcyConvRateTyp e Currency The currency conversion rate type associated with the plan activity. The maximum length is 15. Currency Conversion Rate CorpCurrencyCode The corporate currency used by the plan activity. The maximum length is 15. Corporate Currency IsOwner A system-generated read-only attribute used by the application framework. Activity_Id ORAH T Tgt_ActivityTo ORAHT PlanActivit y_c integer A system-generated read-only attribute used by the application framework. 248 REST API for Sales Cloud Industry Solutions

249 26 Managing Plan Contacts This chapter describes the following resources: Plan Contacts Plan Contacts Overview The point of contact identified as a representative of the account. Use this resource to view, update, and delete plan contacts. Resource Plural Label Resource Name Plan Contacts ORAHT PlanContact_c The table below lists tasks supported by this resource. Task Request URI Plan Contacts Get all account plan contacts Create all account plan contacts Get an account plan contact Update an account plan contact Delete an account plan contact GET POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORAHT P lancontact_c /crmcommonapi/resources/<version>/ ORAHT P lancontact_c /crmcommonapi/resources/<version>/ ORAHT P lancontact_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT P lancontact_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT P lancontact_c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 249

250 Contents Get All Account Plan Contacts Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanContact_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description Finds account plans with the specified Account Plan contact ID. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all the plan contacts. Example command curl sales_cloud_user ORAHT Plan Contact_c Example Response Body 250 REST API for Sales Cloud Industry Solutions

251 Managing Plan Contacts Plan Contacts Overview { "items" : [ { "Id" : , "RowType" : " ORAHT PlanContact_c", "RecordName" : " ", "CreatedBy" : "bala.gupta", "CreationDate" : " T13:42:11+00:00", "LastUpdatedBy" : "bala.gupta", "LastUpdateDate" : " T13:42:14+00:00",.. },.. } Create All Account Plan Contacts Request POST URI /crmcommonapi/resources/<version>/ ORAHT PlanContact_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json REST API for Sales Cloud Industry Solutions 251

252 Contents Get an Account Plan Contact Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plans with the specified Account Plan contact ID. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a plan contact. Example command curl sales_cloud_user ORAHT Plan Contact_c/ Update an account plan contact Request PATCH 252 REST API for Sales Cloud Industry Solutions

253 Managing Plan Contacts Plan Contacts Overview URI /crmcommonapi/resources/<version>/ ORAHT PlanContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plans with the specified Account Plan contact ID. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Delete an Account Plan Contact Request DELETE URI /crmcommonapi/resources/<version>/ ORAHT PlanContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plans with the specified Account Plan contact ID. REST API for Sales Cloud Industry Solutions 253

254 Contents Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes a plan contact. Example command curl sales_cloud_user X DELETE ORAHT Plan Contact_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCode CurrencyCode Currency Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Plan Contact CreatedBy The user who created the Plan Contact record. 254 REST API for Sales Cloud Industry Solutions

255 Managing Plan Contacts Plan Contacts Overview The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. Last Update Login CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateDate A system-generated read-only attribute used by the application framework. The date and time when the record was last updated from mobile. User Last Update Date CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPackag e A system-generated read-only attribute used by the application framework. REST API for Sales Cloud Industry Solutions 255

256 Contents The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. JobDefinitionName A system-generated read-only attribute used by the application framework. The maximum length is 100. CurrencyCode The currency code of the contact associated with the plan. The maximum length is 15. Currency CurcyConvRateType The currency conversion rate type associated with the contact. The maximum length is 15. Currency Conversion Rate Type CorpCurrencyCode The corporate currency used by the contact. The maximum length is 15. Corporate Currency IsOwner A system-generated read-only attribute used by the application framework. AccountPlan_Id O RAHT Src ORAHT AccountPlan_cTo ORAHT PlanConta ct_c ORAHT Account_ c integer A system-generated read-only attribute used by the application framework. The name of the account. Account 256 REST API for Sales Cloud Industry Solutions

257 27 Managing Plan Leads This chapter describes the following resources: Plan Leads Plan Leads Overview The lead associated with any one of accounts included in the account plan. Use this resource view, update, and, delete plan leads. Resource Plural Label Resource Name Plan Leads ORAHT PlanLead_c The table below lists tasks supported by this resource. Task Request URI Plan Leads Get all account plan leads Create account plan leads Get an account plan lead Update an account plan lead Delete an account plan lead GET POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORAHT Pla nlead_c /crmcommonapi/resources/<version>/ ORAHT Pla nlead_c /crmcommonapi/resources/<version>/ ORAHT Pla nlead_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT Pla nlead_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT Pla nlead_c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 257

258 Contents Get All Account Plan Leads Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanLead_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description Finds account plans with the specified account plan lead ID. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all the plan leads. Example command: curl sales_cloud_user ORAHT PlanL ead_c Example Response Body { 258 REST API for Sales Cloud Industry Solutions

259 Managing Plan Leads Plan Leads Overview "items" : [ { "Id" : , "RowType" : " ORAHT PlanLead_c", "RecordName" : " ", "CreatedBy" : "bala.gupta", "CreationDate" : " T13:42:11+00:00", "LastUpdatedBy" : "bala.gupta", "LastUpdateDate" : " T13:42:14+00:00",.. },.. } Create Account Plan Leads Request POST URI /crmcommonapi/resources/<version>/ ORAHT PlanLead_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json REST API for Sales Cloud Industry Solutions 259

260 Contents Example This example creates a plan lead. Example command: curl sales_cloud_user X POST ORAHT PlanL ead_c Get an Account Plan Lead Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanLead_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plans with the specified account plan lead ID. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a plan lead. Example command: curl sales_cloud_user ORAHT PlanL ead_c/ REST API for Sales Cloud Industry Solutions

261 Managing Plan Leads Plan Leads Overview Update an Account Plan Lead Request PATCH URI /crmcommonapi/resources/<version>/ ORAHT PlanLead_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plans with the specified account plan lead ID. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example updates a plan lead. Example command: curl sales_cloud_user X PATCH ORAHT PlanL ead_c/ Delete an Account Plan Lead Request DELETE REST API for Sales Cloud Industry Solutions 261

262 Contents URI /crmcommonapi/resources/<version>/ ORAHT PlanLead_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plans with the specified account plan lead ID. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes a plan lead. Example command: curl sales_cloud_user X DELETE ORAHT PlanL ead_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCode CurrencyCode Currency Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. 262 REST API for Sales Cloud Industry Solutions

263 Managing Plan Leads Plan Leads Overview The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Plan Lead CreatedBy The user who created the Plan Lead record. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. Last Update Login CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateD ate A system-generated read-only attribute used by the application framework. The date and time when the record was last updated from mobile. REST API for Sales Cloud Industry Solutions 263

264 Contents User Last Update Date CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPac kage A system-generated read-only attribute used by the application framework. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. JobDefinitionNa me A system-generated read-only attribute used by the application framework. The maximum length is 100. CurrencyCode The currency code of the lead associated with the plan. The maximum length is 15. CurcyConvRateT ype CorpCurrencyCo de Currency The currency conversion rate type associated with the lead. The maximum length is 15. Currency Conversion Rate Type The corporate currency used by the lead associated with the plan. The maximum length is 15. Corporate Currency IsOwner A system-generated read-only attribute used by the application framework. 264 REST API for Sales Cloud Industry Solutions

265 Managing Plan Leads Plan Leads Overview Lead_Id ORAH T Tgt_LeadTo ORAHT PlanLea d_c integer The maximum length is 0. A system-generated read-only attribute used by the application framework. REST API for Sales Cloud Industry Solutions 265

266

267 28 Managing Plan Opportunities This chapter describes the following resources: Plan Opportunities Plan Opportunities Overview The opportunity associated with any participating account in account plan. Use this resource to view, create, update, and delete plan opportunities. Resource Plural Label Resource Name Plan Opportunities ORAHT PlanOpportunity_c The table below lists tasks supported by this resource. Task Request URI Plan Opportunities Get all account plan opportunities Create all account plan opportunities Get an account plan opportunity Update an account plan opportunity Delete an account plan opportunity GET POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORAHT Pla nopportunity_c /crmcommonapi/resources/<version>/ ORAHT Pla nopportunity_c /crmcommonapi/resources/<version>/ ORAHT Pla nopportunity_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT Pla nopportunity_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT Pla nopportunity_c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 267

268 Contents Get All Account Plan Opportunities Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanOpportunity_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description Finds account plan opportunity with the specified account plan opportunity ID. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all the plan opportunities. Example command: curl sales_cloud_user ORAHT Plan Opportunity_c 268 REST API for Sales Cloud Industry Solutions

269 Managing Plan Opportunities Plan Opportunities Overview Create All Account Plan Opportunities Request POST URI /crmcommonapi/resources/<version>/ ORAHT PlanOpportunity_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Get an Account Plan Opportunity Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanOpportunity_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plan opportunity with the specified account plan opportunity ID. REST API for Sales Cloud Industry Solutions 269

270 Contents Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a plan opportunity. Example command: curl sales_cloud_user ORAHT Plan Opportunity_c/ Update an Account Plan Opportunity Request PATCH URI /crmcommonapi/resources/<version>/ ORAHT PlanOpportunity_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plan opportunity with the specified account plan opportunity ID. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json 270 REST API for Sales Cloud Industry Solutions

271 Managing Plan Opportunities Plan Opportunities Overview application/vnd.oracle.adf.resourceitem+json Example This example updates a plan opportunity. Example command: curl sales_cloud_user X PATCH ORAHT Plan Opportunity_c/ Delete an Account Plan Opportunity Request DELETE URI /crmcommonapi/resources/<version>/ ORAHT PlanOpportunity_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plan opportunity with the specified account plan opportunity ID. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes a plan opportunity. Example command: curl sales_cloud_user X DELETES ORAHT Plan Opportunity_c/ REST API for Sales Cloud Industry Solutions 271

272 Contents List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCode CurrencyCode Currency Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Plan Opportunity CreatedBy The user who created the Plan Opportunity record. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is REST API for Sales Cloud Industry Solutions

273 Managing Plan Opportunities Plan Opportunities Overview Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. Last Update Login CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateDat e A system-generated read-only attribute used by the application framework. The date and time when the record was last updated from mobile. User Last Update Date CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPacka ge A system-generated read-only attribute used by the application framework. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. JobDefinitionName A system-generated read-only attribute used by the application framework. The maximum length is 100. CurrencyCode The currency code of the opportunity associated with the lead. The maximum length is 15. REST API for Sales Cloud Industry Solutions 273

274 Contents CurcyConvRateTyp e Currency The currency conversion rate type associated with opportunity. The maximum length is 15. Currency Conversion Rate Type CorpCurrencyCode The corporate currency used by the lead associated with the plan. The maximum length is 15. Corporate Currency IsOwner A system-generated read-only attribute used by the application framework. Opportunity_Id O RAHT Tgt_Opportu nityto ORAHT Pla nopportunity_c integer Is Owner A system-generated read-only attribute used by the application framework. 274 REST API for Sales Cloud Industry Solutions

275 29 Managing Plan Teams This chapter describes the following resources: Plan Teams Plan Teams Overview The sales team members associated with the participating accounts of the account plan. Use this resource to view, create, update, and delete plan teams. Resource Plural Label Resource Name Plan Teams ORAHT PlanTeam_c The table below lists tasks supported by this resource. Task Request URI Plan Teams Get all account plan team members Create account plan team members Get an account plan team member Update an account plan team member Delete an account plan team member GET POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORAHT PlanTeam_c /crmcommonapi/resources/<version>/ ORAHT PlanTeam_c /crmcommonapi/resources/<version>/ ORAHT PlanTeam_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT PlanTeam_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT PlanTeam_c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 275

276 Contents Get All Account Plan Team Members Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanTeam_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description Finds account plan team members with the specified account plan team ID. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all team members. Example command: curl sales_cloud_user ORAHT PlanT eam_c 276 REST API for Sales Cloud Industry Solutions

277 Managing Plan Teams Plan Teams Overview Create Account Plan Team Members Request POST URI /crmcommonapi/resources/<version>/ ORAHT PlanTeam_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example creates a team member. Example command: curl sales_cloud_user X POST ORAHT PlanT eam_c Get an Account Plan Team Member Request GET URI /crmcommonapi/resources/<version>/ ORAHT PlanTeam_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description REST API for Sales Cloud Industry Solutions 277

278 Contents Id integer Finds account plan team members with the specified account plan team ID. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update an Account Plan Team Member Request PATCH URI /crmcommonapi/resources/<version>/ ORAHT PlanTeam_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plan team members with the specified account plan team ID. Request Body s application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: 278 REST API for Sales Cloud Industry Solutions

279 Managing Plan Teams Plan Teams Overview application/json application/vnd.oracle.adf.resourceitem+json Delete an Account Plan Team Member Request DELETE URI /crmcommonapi/resources/<version>/ ORAHT PlanTeam_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds account plan team members with the specified account plan team ID. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCode CurrencyCode Currency Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description REST API for Sales Cloud Industry Solutions 279

280 Contents Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Plan Team CreatedBy The user who created the Plan Team record. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. Last Update Login 280 REST API for Sales Cloud Industry Solutions

281 Managing Plan Teams Plan Teams Overview CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateD ate A system-generated read-only attribute used by the application framework. The date and time when the record was last updated from mobile. User Last Update Date CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPac kage A system-generated read-only attribute used by the application framework. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. JobDefinitionNa me A system-generated read-only attribute used by the application framework. The maximum length is 100. CurrencyCode The currency code used by the team associated with the plan. The maximum length is 15. CurcyConvRateT ype CorpCurrencyCo de Currency The currency conversion rate type associated with the team. The maximum length is 15. The corporate currency used by the team associated with the plan. The maximum length is 15. IsOwner A system-generated read-only attribute used by REST API for Sales Cloud Industry Solutions 281

282 Contents Resource_Id O RAHT Tgt_Resou rceto ORAHT PlanTeam_c ORAHT Acco unts_c integer String the application framework Is Owner A system-generated read-only attribute used by the application framework Accounts 282 REST API for Sales Cloud Industry Solutions

283 30 Managing Program Territories This chapter describes the following resource: Program Territories Program Territories Overview The Program Territory object is a many-to-many intersection entity object between Sales Territory and Account. Use the program territory resource to view, create, modify, and delete program territories. Resource Plural Label Resource Name Program Territories ORACO ProgramTerritory_c The table below lists tasks supported by this resource: Task Request URL Program Territories Get all Program Territories Get a Program Territory Create a Program Territory Update a Program Territory Delete a Program Territory GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO ProgramT erritory_c /salesapi/resources/<version>/ ORACO ProgramT erritory_c/{id} /salesapi/resources/<version>/ ORACO ProgramT erritory_c /salesapi/resources/<version>/ ORACO ProgramT erritory_c/{id} /salesapi/resources/<version>/ ORACO ProgramT erritory_c/{id} REST API for Sales Cloud Industry Solutions 283

284 Contents Program Territories This section covers the following topics: Tasks List of Values Resource Attributes The Program Territory object is a many-to-many intersection entity object between Sales Territory and Account. Use the program territory resource to view, create, modify, and delete program territories. Resource Plural Label Resource Name Program Territories ORACO ProgramTerritory_c Tasks The table below lists tasks supported by this resource. Task Request URI Program Territories Get all Program Territories Get a Program Territory Create a Program Territory Update a Program Territory Delete a Program Territory GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO Pro gramterritory_c /salesapi/resources/<version>/ ORACO Pro gramterritory_c/{id} /salesapi/resources/<version>/ ORACO Pro gramterritory_c /salesapi/resources/<version>/ ORACO Pro gramterritory_c/{id} /salesapi/resources/<version>/ ORACO Pro gramterritory_c/{id} 284 REST API for Sales Cloud Industry Solutions

285 Managing Program Territories Program Territories Get All Program Territories Request GET URI /salesapi/resources/<version>/ ORACO ProgramTerritory_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description The unique identifier of the Program Territory. You can get the Program Territory ID by examining the response payload of a Get All Program Territories request. Finder Variables: Id o Type: integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all program territories. Example Command: curl --user sales_cloud_user ORACO ProgramTerrito ry_c REST API for Sales Cloud Industry Solutions 285

286 Contents Get a Program Territory Request GET URI /salesapi/resources/<version>/ ORACO ProgramTerritory_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Program Territory. You can get the Program Territory Id by examining the response payload of a Get All Program Territories request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a program territory with the ID Example Command: curl --user sales_cloud_user ORACO ProgramTerrit ory_c/ Create a Program Territory Request POST URI /salesapi/resources/<version>/ ORACO ProgramTerritory_c 286 REST API for Sales Cloud Industry Solutions

287 Managing Program Territories Program Territories Request Path Parameters There are no required path parameters for this task. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update a Program Territory Request PATCH URI /salesapi/resources/<version>/ ORACO ProgramTerritory_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Program Territory. You can get the Program Territory Id by examining the response payload of a Get All Program Territories request. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: REST API for Sales Cloud Industry Solutions 287

288 Contents application/json application/vnd.oracle.adf.resourceitem+json Delete a Program Territory Request DELETE URI /salesapi/resources/<version>/ ORACO ProgramTerritory_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Program Territory. You can get the Program Territory Id by examining the response payload of a Get All Program Territories request. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. This example deletes an existing program territory with the Id Example Command: curl --user sales_cloud_user X DELETE ORACO ProgramTerrit ory_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod e CurrencyCode Currency 288 REST API for Sales Cloud Industry Solutions

289 Managing Program Territories Program Territories Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Audit History Name CreatedBy The user who created the program territory. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. REST API for Sales Cloud Industry Solutions 289

290 Contents The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateDate Not for external use. This attribute is used by the Extensibility framework. Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database (i.e. a different mobile database or the server). CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPackage Not for external use. This attribute is used by the Extensibility framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. The maximum length is 900. RequestId integer Not for external use. This attribute is used by the Extensibility framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the row. JobDefinitionName Not for external use. This attribute is used by the Extensibility framework. Enterprise Service Scheduler: The short name of the job that created or last updated the row. The maximum length is 100. CurrencyCode The currency code associated with the program territory. The maximum length is 15. Currency CurcyConvRateType The currency conversion rate type associated with the program territory. 290 REST API for Sales Cloud Industry Solutions

291 Managing Program Territories Program Territories The maximum length is 15. CorpCurrencyCode The corporate currency code associated with the program territory. The maximum length is 15. IsOwner A system-generated read-only attribute used by the application framework. PromotionProgram_Id_ Integer Foreign Key ORACO Src OR ACO PromotionProgr am_cto ORACO Pr ogramterritory_c SalesTerritory_Id OR ACO Tgt_SalesTerritor yto ORACO Progra mterritory_c integer Foreign Key REST API for Sales Cloud Industry Solutions 291

292

293 31 Managing Promotions This chapter describes the following resources: Promotions Promotions: Promotion Groups Promotions: Promotion Products Promotions Overview A Promotion is a marketing activity, often in the form of discount or offer available, on select products. The promotion resource is used to view, create, or modify a promotion. Use this resource to create, update, find, and delete promotions. Resource Plural Label Resource Name Promotions ORACO Promotion_c The table below lists tasks supported by this resource. Task Request URI Promotions Get all Promotions Get a Promotion Create a Promotion Update a promotion Delete a Promotion GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO Promotion_c /salesapi/resources/<version>/ ORACO Promotion_c/ {Id} /salesapi/resources/<version>/ ORACO Promotion_c /salesapi/resources/<version>/ ORACO Promotion_c/ {Id} /salesapi/resources/<version>/ ORACO Promotion_c/ {Id} REST API for Sales Cloud Industry Solutions 293

294 Contents Promotions: Promotion Groups Get all Promotion Groups Get a Promotion Group Create a Promotion Group Update a Promotion Group Delete a Promotion Group GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO Promotion_c/ {Id}/child/ ORACO PromotionGroupCollection_c /salesapi/resources/<version>/ ORACO Promotion_c/ {Id}child/ ORACO PromotionGroupCollection_c/{Id} /salesapi/resources/<version>/ ORACO Promotion_c/ {Id}/child/ ORACO PromotionGroupCollection_c /salesapi/resources/<version>/ ORACO Promotion_c/ {Id}child/ ORACO PromotionGroupCollection_c/{Id} /salesapi/resources/<version>/ ORACO Promotion_c/ {Id}child/ ORACO PromotionGroupCollection_c/{Id} Promotions: Promotion Products Get all Promotion Products Get a Promotion Product Create a Promotion Product Update a Promotion Product Delete a Promotion Product GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO Promotion_c/ {Id}/child/ ORACO PromotionProductCollection_c /salesapi/resources/<version>/ ORACO Promotion_c/ {Id}child/ ORACO PromotionProductCollection_c/{Id} /salesapi/resources/<version>/ ORACO Promotion_c/ {Id}/child/ ORACO PromotionProductCollection_c /salesapi/resources/<version>/ ORACO Promotion_c/ {Id}child/ ORACO PromotionProductCollection_c/{Id} /salesapi/resources/<version>/ ORACO Promotion_c/ {Id}child/ ORACO PromotionProductCollection_c/{Id} 294 REST API for Sales Cloud Industry Solutions

295 Managing Promotions Promotions Promotions This section covers the following topics: Tasks List of Values Resource Attributes A Promotion is a marketing activity, often in the form of discount or offer available, on select products. The promotion resource is used to view, create, or modify a promotion. Use this resource to create, update, find, and delete promotions. Resource Plural Label Resource Name Promotions ORACO Promotion_c Tasks The table below lists tasks supported by this resource. Task Request URI Promotions Get all Promotions Get a Promotion Create a Promotion Update a promotion Delete a Promotion GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO Promotion_c /salesapi/resources/<version>/ ORACO Promotion_c/ {Id} /salesapi/resources/<version>/ ORACO Promotion_c /salesapi/resources/<version>/ ORACO Promotion_c/ {Id} /salesapi/resources/<version>/ ORACO Promotion_c/ {Id} REST API for Sales Cloud Industry Solutions 295

296 Contents Get All Promotions Request GET URI /salesapi/resources/<version>/ ORACO Promotion_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all promotions. Example Command: curl --user sales_cloud_user ORACO Promotion_c 296 REST API for Sales Cloud Industry Solutions

297 Managing Promotions Promotions Get a Promotion Request GET URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a promotion with the Id Example Command: curl -- user sales_cloud_user ORACO Promotion_c/ Create a Promotion Request POST URI /salesapi/resources/<version>/ ORACO Promotion_c REST API for Sales Cloud Industry Solutions 297

298 Contents Request Path Parameters There are no required path parameters for this task. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update a Promotion Request PATCH URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json 298 REST API for Sales Cloud Industry Solutions

299 Managing Promotions Promotions application/vnd.oracle.adf.resourceitem+json Delete a Promotion Request DELETE URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an existing promotions resource with the Id Example Command: curl --user sales_cloud_user X DELETE ORACO Promotion_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod e FK_LOVVA_For ORACO A ccount_c LOVVA_For ORACO Acc ount_c CurrencyCode ORACO Account_Id_c ORACO Account_c Currency Account Account REST API for Sales Cloud Industry Solutions 299

300 Contents FK_LOVVA_For ORACO P romotionprogram_c LOVVA_For ORACO Pro motionprogram_c LOVVA_For ORACO Stat us_c ORACO PromotionProgra m_id_c ORACO PromotionProgra m_c ORACO Status_c Promotion program Promotion Program Status Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Audit History Name CreatedBy The user who created the promotion record. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is REST API for Sales Cloud Industry Solutions

301 Managing Promotions Promotions Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateDate A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (i.e. a different mobile database or the server). CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPackag e A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request ID of the job that created or last updated the row. JobDefinitionName Enterprise Service Scheduler: The short name the job that created or last updated the row. The maximum length is 100. CurrencyCode The currency code associated with the REST API for Sales Cloud Industry Solutions 301

302 Contents promotion. The maximum length is 15. Currency CurcyConvRateType The currency conversion rate type associated with the promotion. The maximum length is 15. CorpCurrencyCode The corporate currency code of the promotion. The maximum length is 15. SourceType A system-generated read-only attribute used by the application framework. AttachmentEntityNa me A system-generated read-only attribute used by the application framework. The name of the object or table that is associated with attachments for this object. PKProxy A system-generated read-only attribute used by the application framework. The maximum length is 18. IsOwner A system-generated read-only attribute used by the application framework. ORACO Account _Id_c integer A copy of the unique identifier of an account. Account ORACO Account _c The name of an account. The maximum length is ORACO Account BI_c Account The name of an account, for use in reports and analytics. The maximum length is REST API for Sales Cloud Industry Solutions

303 Managing Promotions Promotions ORACO Advertisin g_c ORACO Catalog_ c ORACO Descripti on_c ORACO EndDate _c ORACO Merchan dising_c ORACO Promotio nprogram_id_c ORACO Promotio nprogram_c ORACO Promotio nprogrambi_c number number number integer Account The advertising budget allocation. Precision: 20 Decimal Places: 2 Advertising The catalog budget allocation. Precision: 20 Decimal Places: 2 Catalog The description of the promotion. Display Width: 30 Maximum Length: 1000 The maximum length is Description The date and time when the promotion ends. End Date The budget allocated for merchandising. Precision: 20 Decimal Places: 2 Merchandising A copy of the unique identifier of a Promotion Program. Promotion Program The name of the promotion program. Display Width: 40 The maximum length is Promotion Program Name of a Promotion Program, for use in reports and analytics. REST API for Sales Cloud Industry Solutions 303

304 Contents ORACO Shipment EndDate_c ORACO Shipment StartDate_c The maximum length is Promotion Program The date and time when the shipment ends. Shipment End The date and time when the shipment starts. Shipment Start ORACO Space_c number The space budget allocation. Precision: 20 Decimal Places: 2 ORACO StartDate _c Space The date and time when the promotion starts. Start Date ORACO Status_c The status of the promotion. Maximum Length: 1500 The maximum length is ORACO Submit_Pr omo ORACO Add_To_ Cart Status UI button. Do not use. Submit UI button. Do not use. Add to Cart 304 REST API for Sales Cloud Industry Solutions

305 Managing Promotions Promotions: Promotion Groups Promotions: Promotion Groups This section covers the following topics: Tasks List of Values Resource Attributes The Promotion Group object is a search criteria for selecting products to add to a Promotion. A promotion group enables you to apply or modify promotion tactics on a number of products at once. Resource Plural Label Resource Name Promotion Groups ORACO PromotionGroupCollection_c Tasks The table below lists tasks supported by this resource. Task Request URI Promotions: Promotion Groups Get all Promotion Groups Get a Promotion Group Create a Promotion Group Update a Promotion Group Delete a Promotion Group GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO Promoti on_c/{id}/child/ ORACO PromotionGroupCollection_c /salesapi/resources/<version>/ ORACO Promoti on_c/{id}child/ ORACO PromotionGroupCollection_c/{Id} /salesapi/resources/<version>/ ORACO Promoti on_c/{id}/child/ ORACO PromotionGroupCollection_c /salesapi/resources/<version>/ ORACO Promoti on_c/{id}child/ ORACO PromotionGroupCollection_c/{Id} /salesapi/resources/<version>/ ORACO Promoti on_c/{id}child/ ORACO PromotionGroupCollection_c/{Id} REST API for Sales Cloud Industry Solutions 305

306 Contents Get All Promotion Groups Request GET URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id}/child/ ORACO PromotionGroupCollection_c Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description The unique identifier of the Promotion Group. You can get the Promotion Id by examining the response payload of a Get All Promotion Groups request. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json 306 REST API for Sales Cloud Industry Solutions

307 Managing Promotions Promotions: Promotion Groups Example This example gets all promotion groups for the Promotion Id Example Command: curl --user sales_cloud_user ORACO Promotion_c/ /child/ ORACO PromotionGroupCollection_c Get a Promotion Group Request GET URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id}child/ ORACO PromotionGroupCollection_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. Id integer The unique identifier of the Promotion Group. You can get the Promotion Group Id by examining the response payload of a Get All Promotion Groups request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a promotion group. Example Command: curl --user sales_cloud_user ORACO Promotion_c/ /child/ ORACO PromotionGroupCollection_c/ REST API for Sales Cloud Industry Solutions 307

308 Contents Create a Promotion Group Request POST URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id}/child/ ORACO PromotionGroupCollection_c Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. Request Body The following table summarizes the supported request body content types: application/json application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update a Promotion Group Request PATCH URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id}child/ ORACO PromotionGroupCollection_c/{Id} Request Path Parameters The following are required path parameters for this task: 308 REST API for Sales Cloud Industry Solutions

309 Managing Promotions Promotions: Promotion Groups Name Type Description Id Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. integer The unique identifier of the Promotion Group. You can get the Promotion Group Id by examining the response payload of a Get All Promotion Groups request. Request Body The following table summarizes the supported request body content type: application/json application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Delete a Promotion Group Request DELETE URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id}child/ ORACO PromotionGroupCollection_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. REST API for Sales Cloud Industry Solutions 309

310 Contents Id integer The unique identifier of the Promotion Group. You can get the Promotion Group Id by examining the response payload of a Get All Promotion Groups request. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an existing promotion group resource with the Id from a promotion resource with Id Example Command: curl --user sales_cloud_user X DELETE ORACO Promotion_c/ /child/ ORACO PromotionGroupCollection_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod e LOVVA_For ORACO Disc ountmethod_c LOVVA_For ORACO Fun dingmethod_c FK_LOVVA_For ORACO It em_c LOVVA_For ORACO Item _c CurrencyCode ORACO DiscountMethod _c ORACO FundingMethod_ c ORACO Item_Id1_c ORACO Item_c Currency Discount Method Funding Method Product Product Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. 310 REST API for Sales Cloud Industry Solutions

311 Managing Promotions Promotions: Promotion Groups Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Audit History Name CreatedBy The user who created the promotion group record. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateD ate A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the record was REST API for Sales Cloud Industry Solutions 311

312 Contents originally updated in a different database (i.e. a different mobile database or the server). CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPac kage A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the row. JobDefinitionNa me A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name the job that created or last updated the row. The maximum length is 100. CurrencyCode The currency code associated with the promotion group. The maximum length is 15. CurcyConvRateT ype Currency The currency conversion rate type associated with the promotion group. CorpCurrencyCo de The maximum length is 15. Default currency code. The maximum length is 15. IsOwner A system-generated read-only attribute used by the application framework. 312 REST API for Sales Cloud Industry Solutions

313 Managing Promotions Promotions: Promotion Groups ORACO Basel ine_c ORACO Con dition_c ORACO Disc ountmethod_c ORACO Disc ount_c ORACO Disc ountamount_c integer number number The maximum length is 0. A system-generated read-only attribute used by the application framework. The maximum length is 10. Baseline A system-generated read-only attribute used by the application framework. The maximum length is Condition The discount method associated with the promotion group. It can be either percentage or amount. The maximum length is Discount Method The discount in percentage term. Precision: 20 Decimal Places: 4 The maximum length is 100. Discount The discount in absolute term. Precision:20 Decimal Places: 2 The maximum length is 20. Discount Amount ORACO Fund The method to fund the discount tactics. It can be REST API for Sales Cloud Industry Solutions 313

314 Contents ingmethod_c either Offinvoice or Billback. ORACO Incre mentallift_c ORACO Marg in_c ORACO Nam e_c ORACO Item Description_c ORACO Item Number_c number number The maximum length is Funding Method A system-generated read-only attribute used by the application framework. Precision: 20 Decimal Places: 4 The maximum length is 100. Incremental Percentage A system-generated read-only attribute used by the application framework. Precision: 20 Decimal Places: 4 s The maximum length is 100. Margin Percentage The Promotion Group name. Display Width: 30 The maximum length is Name The product name. Display Width: 30 The maximum length is Product The item number (SKU). Display Width: REST API for Sales Cloud Industry Solutions

315 Managing Promotions Promotions: Promotion Products ORACO Prom otionnamebi_c ORACO Prom otion_id_c ORACO Prom otion_c Integer object The maximum length is SKU The name of a Promotion to be used in reports and analytics. The maximum length is Promotion A copy of the unique identifier of a promotion. The Promotion object. Promotions: Promotion Products This section covers the following topics: Tasks List of Values Resource Attributes The Promotion Product resource contains all the products that are available under a Promotion Program. It contains products that are added individually or those added as part of a Promotion Group. Resource Plural Label Resource Name Promotion Products ORACO PromotionProductCollection_c Tasks The table below lists tasks supported by this resource. Task Request URI Promotions: Promotion Products REST API for Sales Cloud Industry Solutions 315

316 Contents Get all Promotion Products Get a Promotion Product Create a Promotion Product Update a Promotion Product Delete a Promotion Product GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO Promoti on_c/{id}/child/ ORACO PromotionProductCollection_c /salesapi/resources/<version>/ ORACO Promoti on_c/{id}child/ ORACO PromotionProductCollec tion_c/{id} /salesapi/resources/<version>/ ORACO Promoti on_c/{id}/child/ ORACO PromotionProductCollection_c /salesapi/resources/<version>/ ORACO Promoti on_c/{id}child/ ORACO PromotionProductCollec tion_c/{id} /salesapi/resources/<version>/ ORACO Promoti on_c/{id}child/ ORACO PromotionProductCollec tion_c/{id} Get All Promotion Products Request GET URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id}/child/ ORACO PromotionProductCollection_c Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description The unique identifier of the Promotion Products. You can 316 REST API for Sales Cloud Industry Solutions

317 Managing Promotions Promotions: Promotion Products get the Promotion Product Id by examining the response payload of a Get All Promotion Products request. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all promotion products for the Promotion Id Example Command: curl --user sales_cloud_user ORACO Promotion_c/ /child/ ORACO PromotionProductCollection_c Get a Promotion Product Request GET URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id}child/ ORACO PromotionProductCollection_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. REST API for Sales Cloud Industry Solutions 317

318 Contents Id integer The unique identifier of the Promotion Product. You can get the Promotion Product Id by examining the response payload of a Get All Promotion Products request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a promotion product. Example Command: curl --user sales_cloud_user ORACO Promotion_c/ /child/ ORACO PromotionProductCollection_c/ Create a Promotion Product Request POST URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id}/child/ ORACO PromotionProductCollection_c Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. Request Body The following table summarizes the supported request body content types: application/json 318 REST API for Sales Cloud Industry Solutions

319 Managing Promotions Promotions: Promotion Products application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update a Promotion Product Request PATCH URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id}child/ ORACO PromotionProductCollection_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. integer The unique identifier of the Promotion Product. You can get the Promotion Product Id by examining the response payload of a Get All Promotion Products request. Request Body The following table summarizes the supported request body content type: application/json application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json REST API for Sales Cloud Industry Solutions 319

320 Contents application/vnd.oracle.adf.resourceitem+json Delete a Promotion Product Request DELETE URI /salesapi/resources/<version>/ ORACO Promotion_c/{Id}child/ ORACO PromotionProductCollection_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id Id integer The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. integer The unique identifier of the Promotion Product. You can get the Promotion Product Id by examining the response payload of a Get All Promotion Products request. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an existing promotion product with the Id from a Promotion with Id Example Command: curl --user sales_cloud_user X DELETE ORACO Promotion_c/ /child/ ORACO PromotionProductCollection_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource 320 REST API for Sales Cloud Industry Solutions

321 Managing Promotions Promotions: Promotion Products ViewAccessor_CurrencyCod e LOVVA_For ORACO Disc ountmethod_c LOVVA_For ORACO Fun dingmethod_c CurrencyCode ORACO DiscountMethod _c ORACO FundingMethod_ c Currency Discount Method Funding Method Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Audit History Name CreatedBy The user who created the promotion product. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. REST API for Sales Cloud Industry Solutions 321

322 Contents Last Updated By LastUpdateDate The date when the record was last updated. LastUpdateLogi n Last Update Date The login of the user who last updated the record. The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdate Date A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (i.e. a different mobile database or the server). CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPa ckage A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the row. JobDefinitionNa me A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name the job that created or last updated the row. The maximum length is 100. CurrencyCode The currency code associated with the promotion product. 322 REST API for Sales Cloud Industry Solutions

323 Managing Promotions Promotions: Promotion Products CurcyConvRate Type The maximum length is 15. Currency The currency conversion rate type associated with the promotion product. CorpCurrencyC ode The maximum length is 15. The corporate currency code of the promotion product. The maximum length is 15. IsOwner A system-generated read-only attribute used by the application framework. ORACO Bas eline_c integer A system-generated read-only attribute used by the application framework. ORACO Con dition_c ORACO Disc ountmethod_c ORACO Disc ount_c number Baseline A system-generated read-only attribute used by the application framework. The maximum length is Condition The method of discount the promotion product. It can be either percentage or amount. The maximum length is Discount Method A discount in percentage term. Precision: 20 Decimal Places: 4 The maximum length is 100. Discount ORACO Disc number The discount in absolute term. REST API for Sales Cloud Industry Solutions 323

324 Contents ountamount_c Precision: 20 Decimal Places: 2 The maximum length is 20. ORACO Fun dingmethod_c ORACO Incr ementallift_c ORACO Mar gin_c ORACO Item _Id1_c ORACO Item _Id2_c ORACO Item _c number number integer integer Discount Amount The method to fund the discount tactics. It can be either Offinvoice or Billback. The maximum length is Funding Method A system-generated read-only attribute used by the application framework. Precision: 20 Decimal Places: 4 The maximum length is 100. Incremental Percentage A system-generated read-only attribute used by the application framework. Precision: 20 Decimal Places: 4 The maximum length is 100. Margin Percentage The identifier of the product. Product Not visible in UI. Foreign Key. ORACO Item_Id2_c The name of the product. Display Width: REST API for Sales Cloud Industry Solutions

325 Managing Promotions Promotions: Promotion Products ORACO Item BI_c ORACO Pro motiongroupna me_c ORACO Pro motionname_c ORACO Item Number_c ORACO Item NumberBI_c ORACO Unit Price_c The maximum length is Product The product name to be used in reports and analytics. The maximum length is Product The name of a Promotion Group. Display Width: 30 The maximum length is Promotion Group The name of a Promotion. The maximum length is Promotion The item number (SKU). Display Width: 30 SKU The Item Number of an item to be used in reports and analytics. The maximum length is SKU The unit price of an item. Precision: 10 Unit Price ORACO Unit The unit price of an item to be used in reports and REST API for Sales Cloud Industry Solutions 325

326 Contents PriceBI_c analytics. ORACO UO M_c ORACO Disc ountedprice_c ORACO Disc ountedpricebi_c ORACO Item _Obj_c ORACO Pro motion_id_c ORACO Pro motion_c object Integer object The maximum length is Unit Price The Unit of Measure of an item. Display Width: 30 The maximum length is 500. UOM The calculated discount price for an item. Discounted Price The calculated discount price for an item to be used in reports and analytics. The maximum length is Discounted Price The Item object. A copy of the unique identifier of a promotion. The Promotion object. 326 REST API for Sales Cloud Industry Solutions

327 32 Managing Promotion Programs This chapter describes the following resources: Promotion Programs Promotion Programs: Program Groups Promotion Programs: Program Products Promotion Programs Overview A Promotion Program is a template for creating promotions. When you use a Promotion Program to create a Promotion, the Promotion inherits all of the configurations in that Promotion Program. Resource Plural Label Resource Name Promotion Programs ORACO PromotionProgram_c The table below lists tasks supported by this resource. Task Request URI Promotion Programs Get all Promotion Programs Get a Promotion Program Create a Promotion Program Update a Promotion Program Delete a Promotion Program GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO Promot ionprogram_c /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id} /salesapi/resources/<version>/ ORACO Promot ionprogram_c /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id} /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id} REST API for Sales Cloud Industry Solutions 327

328 Contents Promotion Programs: Program Groups Get all Program Groups Get a Program Group Create a Program Group Update a Program Group Delete a Program Group GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id}/child/ ORACO ProgramGro upcollection_c /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id}child/ ORACO ProgramGrou pcollection_c/{id} /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id}/child/ ORACO ProgramGro upcollection_c /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id}child/ ORACO ProgramGrou pcollection_c/{id} /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id}child/ ORACO ProgramGrou pcollection_c/{id} Promotion Programs: Program Products Get all Program Products Get a Program Product Create a Program Product Update a Program Product Delete a Program Product GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id}/child/ ORACO ProgramPro ductcollection_c /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id}child/ ORACO ProgramProd uctcollection_c/{id} /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id}/child/ ORACO ProgramPro ductcollection_c /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id}child/ ORACO ProgramProd uctcollection_c/{id} /salesapi/resources/<version>/ ORACO Promot ionprogram_c/{id}child/ ORACO ProgramProd uctcollection_c/{id} Promotion Programs This section covers the following topics: 328 REST API for Sales Cloud Industry Solutions

329 Managing Promotion Programs Promotion Programs Tasks List of Values Resource Attributes A Promotion Program is a template for creating promotions. When you use a Promotion Program to create a Promotion, the Promotion inherits all of the configurations in that Promotion Program. Resource Plural Label Resource Name PromotionPrograms ORACO PromotionProgram_c Tasks The table below lists tasks supported by this resource. Task Request URl Promotion Programs Get all Promotion Programs Get a Promotion Program Create a Promotion Program Update a Promotion Program Delete a Promotion Program GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO P romotionprogram_c /salesapi/resources/<version>/ ORACO P romotionprogram_c/{id} /salesapi/resources/<version>/ ORACO P romotionprogram_c /salesapi/resources/<version>/ ORACO P romotionprogram_c/{id} /salesapi/resources/<version>/ ORACO P romotionprogram_c/{id} Get All Promotion Programs Request GET REST API for Sales Cloud Industry Solutions 329

330 Contents URI /salesapi/resources/<version>/ ORACO PromotionProgram_c Request Path Parameters There are no required path parameters for this task. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all promotion programs. Example Command: curl --user sales_cloud_user ORACO PromotionProg ram_c Get a Promotion Program Request GET URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. Request Body There are no elements in the request body for this task. 330 REST API for Sales Cloud Industry Solutions

331 Managing Promotion Programs Promotion Programs Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a promotion program with the Id Example Command: curl --user sales_cloud_user ORACO PromotionProg ram_c/ Create a Promotion Program Request POST URI /salesapi/resources/<version>/ ORACO PromotionProgram_c Request Path Parameters There are no required path parameters for this task. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update a Promotion Program Request PATCH REST API for Sales Cloud Industry Solutions 331

332 Contents URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Delete a Promotion Program Request DELETE URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. 332 REST API for Sales Cloud Industry Solutions

333 Managing Promotion Programs Promotion Programs Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an existing promotion program with the Id Example Command: curl --user sales_cloud_user X DELETE ORACO PromotionProg ram_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod e LOVVA_For ORACO Stat us_c CurrencyCode ORACO Status_c Currency Status Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. REST API for Sales Cloud Industry Solutions 333

334 Contents Audit History Name CreatedBy The user who created the promotion program. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateDat e A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database (i.e. a different mobile database or the server). CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPack age A system-generated read-only attribute used by the application framework. 334 REST API for Sales Cloud Industry Solutions

335 Managing Promotion Programs Promotion Programs Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the row. JobDefinitionNam e A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name of the job that created or last updated the row. The maximum length is 100. CurrencyCode The currency code associated with the promotion program. The maximum length is 15. CurcyConvRateTy pe CorpCurrencyCod e Currency The currency conversion rate type associated with the promotion program. The maximum length is 15. The corporate currency code of the promotion program. The maximum length is 15. SourceType A system-generated read-only attribute used by the application framework. AttachmentEntityN ame A system-generated read-only attribute used by the application framework. The name of the object or table that is associated with the attachments of this object. PKProxy A system-generated read-only attribute used by the application framework. The maximum length is 18. IsOwner A system-generated read-only attribute used by the REST API for Sales Cloud Industry Solutions 335

336 Contents ORACO Advert ising_c ORACO Catalo g_c ORACO Merch andising_c ORACO Space _c ORACO Descri ption_c ORACO EndDa te_c ORACO StartD ate_c ORACO Status_ c number number number number application framework. The budget allocated for advertising. Precision: 20 Decimal Places: 2 Advertising The budget allocated for catalogs. Precision: 20 Decimal Places: 2 Catalog The budget allocated for merchandising. Precision: 20 Decimal Places: 2 Merchandising The budget allocated for space. Precision: 20 Decimal Places: 2 Space The description of the promotion program. Display Width: 30 The maximum length is Description The date when the promotion program ends. End Date The date when the promotion program starts. Start Date The status of the promotion program. The maximum length is REST API for Sales Cloud Industry Solutions

337 Managing Promotion Programs Promotion Programs: Program Groups Status ORACO Submit UI button. Do not use. Submit Promotion Programs: Program Groups This section covers the following topics: Tasks List of Values Resource Attributes The Program Group object is used as search criteria to select products to add to a Promotion. A Promotion Group enables you to apply or modify promotion tactics on a number of products at once. Resource Plural Label Resource Name Program Groups ORACO ProgramGroupCollection_c Tasks The table below lists tasks supported by this resource. Task Request URI Promotion Programs: Program Groups Get all Program Groups Get a Program Group Create a Program Group Update a Program Group GET GET POST PATCH /salesapi/resources/<version>/ ORACO Promo tionprogram_c/{id}/child/ ORACO ProgramGro upcollection_c /salesapi/resources/<version>/ ORACO Promo tionprogram_c/{id}/child/ ORACO ProgramGro upcollection_c/{id} /salesapi/resources/<version>/ ORACO Promo tionprogram_c/{id}/child/ ORACO ProgramGro upcollection_c /salesapi/resources/<version>/ ORACO Promo tionprogram_c/{id}/child/ ORACO ProgramGro upcollection_c/{id} REST API for Sales Cloud Industry Solutions 337

338 Contents Delete a Program Group DELETE /salesapi/resources/<version>/ ORACO Promo tionprogram_c/{id}/child/ ORACO ProgramGro upcollection_c/{id} Get All Program Groups Request GET URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id}/child/ ORACO P rogramgroupcollection_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Name Type Description Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all program groups for the Promotion Program Id Example Command: curl --user sales_cloud_user ORACO PromotionPro gram_c/ /child/ ORACO ProgramGroupCollection_c 338 REST API for Sales Cloud Industry Solutions

339 Managing Promotion Programs Promotion Programs: Program Groups Get a Program Group Request GET URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id}child/ ORACO Pr ogramgroupcollection_c/{id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. Id integer The unique identifier of the Program Group. You can get the Program Group Id by examining the response payload of a Get All Program Groups request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a program group with the Id from Promotion Program Id Example Command: curl --user sales_cloud_user ORACO PromotionProgram_c/ / child/ ORACO ProgramGroupCollection_c/ REST API for Sales Cloud Industry Solutions 339

340 Contents Create a Program Group Request POST URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id}/child/ ORACO P rogramgroupcollection_c Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. Request Body The following table summarizes the supported request body content types: application/json application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update a Program Group Request PATCH URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id}child/ ORACO Pr ogramgroupcollection_c/{id} Request Path Parameters The following are required path parameters for this task: 340 REST API for Sales Cloud Industry Solutions

341 Managing Promotion Programs Promotion Programs: Program Groups Name Type Description Id Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. integer The unique identifier of the Program Group. You can get the Program Group Id by examining the response payload of a Get All Program Groups request. Request Body The following table summarizes the supported request body content type: application/json application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Delete a Program Group Request DELETE URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id}child/ ORACO Pr ogramgroupcollection_c/{id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. REST API for Sales Cloud Industry Solutions 341

342 Contents Id integer The unique identifier of the Program Group. You can get the Program Group Id by examining the response payload of a Get All Program Groups request. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an existing program group with the Id from a Promotion Program resource with the Id Example Command: curl -- user sales_cloud_user X DELETE ORACO PromotionProg ram_c/ /child/ ORACO ProgramGroupCollection_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod CurrencyCode Currency e LOVVA_For ORACO Fun dingmethod_c ORACO FundingMethod_ c Funding Method Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is REST API for Sales Cloud Industry Solutions

343 Managing Promotion Programs Promotion Programs: Program Groups RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Audit History Name CreatedBy The user who created the program group. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateDat e A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database (i.e. a different mobile database or the server). CpdrfLastUpd A system-generated read-only attribute used by the application framework. REST API for Sales Cloud Industry Solutions 343

344 Contents The maximum length is 15. CpdrfVerPillar integer Not for external use. This attribute is used by the Extensibility framework. Standard replication column. JobDefinitionPacka ge A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the row. JobDefinitionName A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name of the job that created or last updated the row. The maximum length is 100. CurrencyCode The currency code associated with the program group. The maximum length is 15. CurcyConvRateTyp e Currency The currency conversion rate type associated with the program group. The maximum length is 15. CorpCurrencyCode The corporate currency code of the program group. The maximum length is 15. IsOwner A system-generated read-only attribute used by the application framework. ORACO Conditi on_c A system-generated read-only attribute used by the application framework. 344 REST API for Sales Cloud Industry Solutions

345 Managing Promotion Programs Promotion Programs: Program Groups The maximum length is ORACO Discoun t_c ORACO Discoun tamount_c ORACO Discoun tmethod_c ORACO Funding Method_c ORACO Name_ c number number Condition The discount in percentage term. Precision: 20 Decimal Places: 4 The maximum length is 100. Discount The discount in absolute term. Precision: 20 Decimal Places: 2 The maximum length is 20. Discount Amount The discount method. It can be either percentage or amount. The maximum length is Discount Method The method to fund the discount tactics. It can be either Offinvoice or Billback. The maximum length is Funding Method The name of the program group. Display Width: 30 The maximum length is Name REST API for Sales Cloud Industry Solutions 345

346 Contents ORACO ItemDe scription_c ORACO ItemNu mber_c ORACO Promoti onprogram_c object The name of the product. Display Width: 30 The maximum length is Product The item number (SKU). Display Width: 30 The maximum length is SKU The Promotion Program object Promotion Programs: Program Products This section covers the following topics: Tasks List of Values Resource Attributes The Program Product resource contains all the products that are available under a Promotion Program. It contains products that are added individually or those added as part of a Program Group. Resource Plural Label Resource Name Promotion Products ORACO ProgramProductCollection_c Tasks The table below lists tasks supported by this resource. Task Request URI 346 REST API for Sales Cloud Industry Solutions

347 Managing Promotion Programs Promotion Programs: Program Products Promotion Programs: Program Products Get all Program Products Get a Program Product Create a Program Product Update a Program Product Delete a Program Product GET GET POST PATCH DELETE /salesapi/resources/<version>/ ORACO Prom otionprogram_c/{id}/child/ ORACO ProgramP roductcollection_c /salesapi/resources/<version>/ ORACO Prom otionprogram_c/{id}child/ ORACO ProgramPr oductcollection_c/{id} /salesapi/resources/<version>/ ORACO Prom otionprogram_c/{id}/child/ ORACO ProgramP roductcollection_c /salesapi/resources/<version>/ ORACO Prom otionprogram_c/{id}child/ ORACO ProgramPr oductcollection_c/{id} /salesapi/resources/<version>/ ORACO Prom otionprogram_c/{id}child/ ORACO ProgramPr oductcollection_c/{id} Get All Program Products Request GET URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id}/child/ ORACO P rogramproductcollection_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Name Type Description Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. Request Body There are no elements in the request body for this task. REST API for Sales Cloud Industry Solutions 347

348 Contents Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all program products for the Promotion Program Id Example Command: curl --user sales_cloud_user ORACO PromotionPro gram_c/ /child/ ORACO ProgramProductCollection_c Get a Program Product Request GET URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id}child/ ORACO Pr ogramproductcollection_c/{id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. Id integer The unique identifier of the Program Product. You can get the Program Product Id by examining the response payload of a Get All Program Products request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: 348 REST API for Sales Cloud Industry Solutions

349 Managing Promotion Programs Promotion Programs: Program Products application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a program product with the Id of Promotion Program Id Example Command: curl --user sales_cloud_user ORACO PromotionProgram_c/ / child/ ORACO ProgramProductCollection_c/ Create a Program Product Request POST URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id}/child/ ORACO P rogramproductcollection_c Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. Request Body The following table summarizes the supported request body content types: application/json application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json REST API for Sales Cloud Industry Solutions 349

350 Contents application/vnd.oracle.adf.resourceitem+json Update a Program Product Request PATCH URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id}child/ ORACO Pr ogramproductcollection_c/{id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. integer The unique identifier of the Program Product. You can get the Program Product Id by examining the response payload of a Get All Program Products request. Request Body The following table summarizes the supported request body content type: application/json application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json 350 REST API for Sales Cloud Industry Solutions

351 Managing Promotion Programs Promotion Programs: Program Products Delete a Program Product Request DELETE URI /salesapi/resources/<version>/ ORACO PromotionProgram_c/{Id}child/ ORACO Pr ogramproductcollection_c/{id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id Id integer The unique identifier of the Promotion Program. You can get the Promotion Program Id by examining the response payload of a Get All Promotion Programs request. integer The unique identifier of the Program Product. You can get the Program Product Id by examining the response payload of a Get All Program Products request. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an existing program product with the Id from a Promotion Program resource with the Id Example Command: curl -- user sales_cloud_user X DELETE ORACO PromotionProg ram_c/ /child/ ORACO ProgramProductCollection_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod CurrencyCode Currency e LOVVA_For ORACO Disc ORACO DiscountMethod Discount Method REST API for Sales Cloud Industry Solutions 351

352 Contents ountmethod_c LOVVA_For ORACO Fun dingmethod_c LOVVA_For ORACO Item _c _c ORACO FundingMethod_ c ORACO Item_c Funding Method Product Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Audit History Name CreatedBy The user who created the program product. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is REST API for Sales Cloud Industry Solutions

353 Managing Promotion Programs Promotion Programs: Program Products Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateDate A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database. CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPackage A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the row. JobDefinitionName A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name of the job that created or last updated the row. The maximum length is 100. CurrencyCode The currency code associated with the program product. REST API for Sales Cloud Industry Solutions 353

354 Contents The maximum length is 15. Currency CurcyConvRateType The currency conversion rate type associated with the program product. The maximum length is 15. CorpCurrencyCode The corporate currency code of the program product. The maximum length is 15. IsOwner A system-generated read-only attribute used by the application framework. The maximum length is 0. ORACO Condition_c Not for external use. The attribute is reserved. Display Width: 30 The maximum length is ORACO DiscountMeth od_c Condition The method for discount. It can be either percentage or amount. The maximum length is Discount Method ORACO Discount_c number The discount in percentage term. Precision: 20 Decimal Places: 4 The maximum length is 100. ORACO DiscountAmo unt_c number Discount The discount in absolute term. Precision: REST API for Sales Cloud Industry Solutions

355 Managing Promotion Programs Promotion Programs: Program Products Decimal Places: 2 The maximum length is 20. ORACO FundingMeth od_c Discount Amount The method to fund the discount tactics. It can be either Offinvoice or Billback. The maximum length is Funding Method ORACO Item_Id1_c integer The product identifier. Product ORACO Item_Id2_c integer Not visible in UI. Foreign Key. ORACO Item_Id2_c ORACO Item_c The name of the product. Display Width: 40 The maximum length is ORACO PromotionGro upname_c ORACO ItemNumber_ c Product The name of a Promotion Group. Display Width: 30 The maximum length is Promotion Group The item number (SKU). Display Width: 30 SKU ORACO UnitPrice_c The unit price of an item. Precision: 10 REST API for Sales Cloud Industry Solutions 355

356 Contents Decimal Places: 2 Unit Price ORACO UOM_c The Unit of Measure of an item. Display Width: 30 The maximum length is 500. ORACO DiscountedPri ce_c ORACO PromotionGro up_c UOM The calculated discount price for an item. Discounted Price The name of a Promotion Group. Display Width: 30 The maximum length is Promotion Group ORACO Item_Obj_c object The Item object. ORACO PromotionPro gram_c object The Promotion Program object. 356 REST API for Sales Cloud Industry Solutions

357 33 Managing Shopping Carts This chapter describes the following resources: Shopping Carts Shopping Carts Overview The Shopping Cart object represents an Account's shopping cart and contains a set of records that are either added from Promotion Products or created independently. The items in the cart become an order when you create an order. Use the shopping cart resource to view, create, modify, or delete shopping carts. Use this resource to create, update, find, and delete shopping carts. Resource Plural Label Resource Name Shopping Cart ORACO ShoppingCart_c The table below lists tasks supported by this resource. Task Request URI Shopping Carts Get all Inventories GET /crmcommonapi/resources/<version>/ ORACO ShoppingCart_c Get an Shopping Cart GET /crmcommonapi/resources/<version>/ ORACO ShoppingCart_c/{Id} Create an Shopping Cart Update an Shopping Cart Delete an Shopping Cart POST PATCH DELETE /crmcommonapi/resources/<version>/ ORACO ShoppingCart_c /crmcommonapi/resources/<version>/ ORACO ShoppingCart_c/{Id} /crmcommonapi/resources/<version>/ ORACO ShoppingCart_c/{Id} REST API for Sales Cloud Industry Solutions 357

358 Contents Shopping Carts This section covers the following topics: Tasks List of Values Resource Attributes The Shopping Cart object represents an Account's shopping cart and contains a set of records that are either added from Promotion Products or created independently. The items in the cart become an order when you create an order. Use the shopping cart resource to view, create, modify, or delete shopping carts. Use this resource to create, update, find, and delete shopping carts. Resource Plural Label Resource Name Shopping Cart ORACO ShoppingCart_c Tasks The table below lists tasks supported by this resource. Task Request URI Shopping Carts Get all Inventories GET /crmcommonapi/resources/<version>/ ORAC O ShoppingCart_c Get an Shopping Cart GET /crmcommonapi/resources/<version>/ ORAC O ShoppingCart_c/{Id} Create an Shopping Cart POST /crmcommonapi/resources/<version>/ ORAC O ShoppingCart_c Update an Shopping Cart PATCH /crmcommonapi/resources/<version>/ ORAC O ShoppingCart_c/{Id} Delete an Shopping Cart DELETE /crmcommonapi/resources/<version>/ ORAC O ShoppingCart_c/{Id} 358 REST API for Sales Cloud Industry Solutions

359 Managing Shopping Carts Shopping Carts Get All Inventories Request GET URI /crmcommonapi/resources/<version>/ ORACO ShoppingCart_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description The unique identifier of the shopping cart. You can get the Shopping Cart Id by examining the response payload of a Get All Shopping Carts request. Finder Variables: Id o Type: integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all shopping carts. Example Command: curl --user sales_cloud_user ORACO Shop pingcart_c REST API for Sales Cloud Industry Solutions 359

360 Contents Get a Shopping Cart Request GET URI /crmcommonapi/resources/<version>/ ORACO ShoppingCart_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Shopping Cart. You can get the Shopping Cart Id by examining the response payload of a Get All Shopping Carts request. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a shopping cart with the Id Example Command: curl --user sales_cloud_user ORACO Shoppi ngcart_c/ Create a Shopping Cart Request POST URI /crmcommonapi/resources/<version>/ ORACO ShoppingCart_c 360 REST API for Sales Cloud Industry Solutions

361 Managing Shopping Carts Shopping Carts Request Path Parameters There are no required path parameters for this task. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Update a Shopping Cart Request PATCH URI /crmcommonapi/resources/<version>/ ORACO ShoppingCart_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Shopping Cart. You can get the Shopping Cart Id by examining the response payload of a Get All Shopping Carts request. Request Body The following table summarizes the supported request body content type: application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: REST API for Sales Cloud Industry Solutions 361

362 Contents application/json application/vnd.oracle.adf.resourceitem+json Delete a Shopping Cart Request DELETE URI /crmcommonapi/resources/<version>/ ORACO ShoppingCart_c/{Id} Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer The unique identifier of the Shopping Cart. You can get the Shopping Cart Id by examining the response payload of a Get All Shopping Carts request. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes an existing shopping cart with the Id Example Command: curl --user sales_cloud_user X DELETE ORACO Shoppi ngcart_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod CurrencyCode Currency e 362 REST API for Sales Cloud Industry Solutions

363 Managing Shopping Carts Shopping Carts FK_LOVVA_For ORACO P roduct_c LOVVA_For ORACO Prod uct_c ORACO Product_Id1_c ORACO Product_c Product Product Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Cart Index CreatedBy The user who created the shopping cart record. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. REST API for Sales Cloud Industry Solutions 363

364 Contents Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateD ate A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (i.e. a different mobile database or the server). CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPack age A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the row. JobDefinitionNam e A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name of the job that created or last updated the row. The maximum length is 100. CurrencyCode The currency code associated with the shopping cart. 364 REST API for Sales Cloud Industry Solutions

365 Managing Shopping Carts Shopping Carts CurcyConvRateTy pe CorpCurrencyCo de The maximum length is 15. Currency The currency conversion rate type associated with the shopping cart. The maximum length is 15. The corporate currency code of the shopping cart. The maximum length is 15. SourceType A system-generated read-only attribute used by the application framework. AttachmentEntity Name A system-generated read-only attribute used by the application framework. PKProxy A system-generated read-only attribute used by the application framework. The maximum length is 18. IsOwner A system-generated read-only attribute used by the application framework. ORACO Disco unt_c number The discount in percentage term. Precision: 10 Decimal Places: 4 The maximum length is 100. ORACO Produ ct_id1_c ORACO Produ ct_id2_c ORACO Produ ct_c integer integer Discount The product identifier. Product Not visible in UI. Foreign Key ORACO Product_Id2_c The name of the product. Display Width: 40 REST API for Sales Cloud Industry Solutions 365

366 Contents ORACO Quan tity_c ORACO UnitPri ce_c ORACO UOM_ c ORACO Disco untedprice_c ORACO TotalP rice_c Organization_Id ORACO Accou nt_shoppingcart integer integer The maximum length is Product The quantity value of an item in a shopping cart. Minimum value: 1 The maximum length is 10. Quantity The unit price for the selected item in a shopping cart. Precision: 10 Decimal Places: 2 Unit Price Unit of measure of a selected item in a shopping cart. Display Width: 30 The maximum length is 500. UOM The calculated discount price of an item in a shopping cart. Discounted Price The calculated total amount of an item in a shopping cart. Total Price Foreign Key 366 REST API for Sales Cloud Industry Solutions

367 34 Managing Tickets This chapter describes the following resources: Service Requests Tickets This section covers the following topics: Tasks List of Values Resource Attributes Tickets are service request associated with an account. Use this resource to view, create, update, and delete tickets. Resource Plural Label Resource Name Tickets ORAHT ServiceRequest_c Tasks The table below lists tasks supported by this resource. Task Request URI Tickets Get all service tickets Create service tickets Get a service ticket GET POST GET /crmcommonapi/resources/<version>/ ORAHT Servi cerequest_c /crmcommonapi/resources/<version>/ ORAHT Servi cerequest_c /crmcommonapi/resources/<version>/ ORAHT Servi cerequest_c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 367

368 Contents Update a service ticket Delete a service ticket PATCH DELETE /crmcommonapi/resources/<version>/ ORAHT Servi cerequest_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT Servi cerequest_c/< Replace with system generated unique ID> Get All Service Tickets Request GET URI /crmcommonapi/resources/<version>/ ORAHT ServiceRequest_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description Finds service tickets with the specified service ticket ID. Finder Variables Id o Type: Integer Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json 368 REST API for Sales Cloud Industry Solutions

369 Managing Tickets Tickets Example This example gets all the tickets. Example command: curl sales_cloud_user ORAHT Servi cerequest_c Example Response Body { "items" : [ { "Id" : , "RowType" : " ORAHT ServiceRequest_c", "RecordName" : " ", "CreatedBy" : "bala.gupta", "CreationDate" : " T16:13:34+00:00", "LastUpdatedBy" : "lisa.jones", "LastUpdateDate" : " T11:15:47+00:00",.. },.. } Create Service Tickets Request POST URI /crmcommonapi/resources/<version>/ ORAHT ServiceRequest_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json REST API for Sales Cloud Industry Solutions 369

370 Contents Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example creates a ticket. Example command: curl sales_cloud_user X POST ORAHT Servi cerequest_c Get a Service Ticket Request GET URI /crmcommonapi/resources/<version>/ ORAHT ServiceRequest_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds service tickets with the specified service ticket ID. Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json 370 REST API for Sales Cloud Industry Solutions

371 Managing Tickets Tickets Example This example gets a ticket. Example command: curl sales_cloud_user ORAHT Servi cerequest_c/ Update a Service Ticket Request PATCH URI /crmcommonapi/resources/<version>/ ORAHT ServiceRequest_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds service tickets with the specified service ticket ID. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example updates a ticket. Example command: curl sales_cloud_user X PATCH ORAHT Servi cerequest_c/ REST API for Sales Cloud Industry Solutions 371

372 Contents Delete a Service Ticket Request DELETE URI /crmcommonapi/resources/<version>/ ORAHT ServiceRequest_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds service tickets with the specified service ticket ID. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes a ticket. Example command: curl sales_cloud_user X DELETE ORAHT Servi cerequest_c/ List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod CurrencyCode Currency e LOVVA_For ORAHT Priorit ORAHT Priority_c Priority y_c LOVVA_For ORAHT Cate ORAHT Category_c Category gory_c LOVVA_For ORAHT Status ORAHT Status_c Status _c FK_LOVVA_For ORAHT A ORAHT Account_Id_c Account ccount_c LOVVA_For ORAHT Acco ORAHT Account_c Account 372 REST API for Sales Cloud Industry Solutions

373 Managing Tickets Tickets unt_c FK_LOVVA_For ORAHT Pri marycontact_c LOVVA_For ORAHT Prima rycontact_c FK_LOVVA_For ORAHT A gent_c LOVVA_For ORAHT Agen t_c FK_LOVVA_For ORAHT Pr oduct_c LOVVA_For ORAHT Produ ct_c FK_LOVVA_For ORAHT As set_c LOVVA_For ORAHT Asset _c ORAHT PrimaryContact_I d_c ORAHT PrimaryContact_c ORAHT Agent_Id_c ORAHT Agent_c ORAHT Product_Id1_c ORAHT Product_c ORAHT Asset_Id_c ORAHT Asset_c Primary Contact Primary Contact Agent Agent Product ID One Product Name Asset Asset Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Number CreatedBy The user who created the Service Request record. The maximum length is 32. REST API for Sales Cloud Industry Solutions 373

374 Contents Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. Last Update Login CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateD ate A system-generated read-only attribute used by the application framework. The date and time when the record was last updated from mobile. User Last Update Date CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPack age A system-generated read-only attribute used by the application framework. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. 374 REST API for Sales Cloud Industry Solutions

375 Managing Tickets Tickets JobDefinitionNam e A system-generated read-only attribute used by the application framework. The maximum length is 100. CurrencyCode The currency associated with the service request. The maximum length is 15. CurcyConvRateTy pe CorpCurrencyCo de Currency The currency conversion rate type associated with the service request. The maximum length is 15. Currency Conversion Rate Type The corporate currency associated with the service request. The maximum length is 15. Corporate Currency SourceType A system-generated read-only attribute used by the application framework. AttachmentEntity Name Source Type A system-generated read-only attribute used by the application framework. Attachment PKProxy A system-generated read-only attribute used by the application framework. The maximum length is 18. IsOwner A system-generated read-only attribute used by the application framework. REST API for Sales Cloud Industry Solutions 375

376 Contents ORAHT Subjec t_c ORAHT Descri ption_c ORAHT Priority _c ORAHT Categ ory_c ORAHT Status_ c ORAHT Accou nt_id_c ORAHT Accou nt_c integer Is Owner The subject of the service request. The maximum length is 80. Subject The description of the service request. The maximum length is Description The priority of the service request. The maximum length is Priority The category of the service request. The maximum length is Category The status of the service request. The maximum length is Status The identifier of the account associated with the service request. Account The name of the account associated with the service request. The maximum length is REST API for Sales Cloud Industry Solutions

377 Managing Tickets Tickets ORAHT Primary Contact_Id_c ORAHT Primary Contact_c ORAHT Agent_ Id_c ORAHT Agent_ c ORAHT Produc t_id1_c ORAHT Produc t_id2_c ORAHT Produc t_c ORAHT Asset_I d_c integer integer integer integer integer Account The identifier of the primary contact of the service request. Primary Contact The primary contact of the service request. The maximum length is Primary Contact The identifier of the agent of the service request. Agent The name of the agent of the service request. The maximum length is Agent The identifier of the first product associated with the service request. Product ID One The identifier of the second product associated with the service request. Product ID Two The name of the product associated with the service request. The maximum length is Product Name The identifier of the assets associated with the service request. REST API for Sales Cloud Industry Solutions 377

378 Contents ORAHT Asset_ c ORAHT DaysO pen_c ORAHT AgentE Mail_c ORAHT Send_E mail ORAHT Extn ORAHT ServiceR equest_cfusecre atelayouturl ORAHT Extn ORAHT ServiceR equest_cfusecre atelayoutdrivers ORAHT Extn ORAHT ServiceR equest_cfusedet aillayouturl ORAHT Extn ORAHT ServiceR equest_cfusedet aillayoutdrivers Extn ORAHT Ser vicerequest_cfus ecreatelayoutur L Extn ORAHT Ser vicerequest_cfus ecreatelayoutdri vers Extn ORAHT Ser vicerequest_cfus integer Asset The name of the assets associated with the service request. The maximum length is Asset Days Open Days Open The of the agent of the service request. Agent The send of the service request. Send A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. A system-generated read-only attribute used by the application framework. 378 REST API for Sales Cloud Industry Solutions

379 Managing Tickets Tickets edetaillayoutdriv ers REST API for Sales Cloud Industry Solutions 379

380

381 35 Managing Ticket Contacts This chapter describes the following resources: Ticket Contacts Ticket Contacts Overview The point of contact associated to Account reflected on service ticket. Use this resource to view, create, updated, and delete records. Ticket Contacts This section covers the following topics: Tasks List of Values Resource Attributes Resource Plural Label Resource Name Ticket Contacts ORAHT AccountPlan_c Tasks The table below lists tasks supported by this resource. Task Request URI Ticket Contacts Get all service ticket contacts GET /crmcommonapi/resources/<version>/ ORAHT TicketCon tact_c REST API for Sales Cloud Industry Solutions 381

382 Contents Create service ticket contacts Get a service ticket contact Update a service ticket contact Delete a service ticket contact POST GET PATCH DELETE /crmcommonapi/resources/<version>/ ORAHT TicketCon tact_c /crmcommonapi/resources/<version>/ ORAHT TicketCon tact_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT TicketCon tact_c/< Replace with system generated unique ID> /crmcommonapi/resources/<version>/ ORAHT TicketCon tact_c/< Replace with system generated unique ID> Get All Service Ticket Contacts Request GET URI /crmcommonapi/resources/<version>/ ORAHT TicketContact_c Request Path Parameters There are no required path parameters for this task. Request Query Parameters Use the following finder parameters to query the resource: Finder Name PrimaryKey Description Finds service tickets with the specified service ticket ID. Finder Variables Id o Type: Integer 382 REST API for Sales Cloud Industry Solutions

383 Managing Ticket Contacts Ticket Contacts Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourcecollection+json Example This example gets all the ticket contacts. Example command: curl sales_cloud_user ORAHT Tic ketcontact_c Example Response Body { "items" : [ { "Id" : , "RowType" : " ORAHT TicketContact_c", "RecordName" : " ", "CreatedBy" : "lisa.jones", "CreationDate" : " T14:37:30+00:00", "LastUpdatedBy" : "lisa.jones", "LastUpdateDate" : " T07:14:12+00:00",.. },.. } Create Service Ticket Contacts Request POST REST API for Sales Cloud Industry Solutions 383

384 Contents URI /crmcommonapi/resources/<version>/ ORAHT TicketContact_c Request Path Parameters There are no required path parameters for this task. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example creates a ticket contact. Example command: curl sales_cloud_user X POST ORAHT Tic ketcontact_c Get a Service Ticket Contact Request GET URI /crmcommonapi/resources/<version>/ ORAHT TicketContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds service tickets with the specified service ticket ID. 384 REST API for Sales Cloud Industry Solutions

385 Managing Ticket Contacts Ticket Contacts Request Body There are no elements in the request body for this task. Response Body The following table summarizes the supported response body content types: application/json application/vnd.oracle.adf.resourceitem+json Example This example gets a ticket contact. Example command: curl sales_cloud_user ORAHT Tic ketcontact_c/ Update a Service Ticket Contact Request PATCH URI /crmcommonapi/resources/<version>/ ORAHT TicketContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds service tickets with the specified service ticket ID. Request Body application/vnd.oracle.adf.resourceitem+json Response Body The following table summarizes the supported response body content types: application/json REST API for Sales Cloud Industry Solutions 385

386 Contents application/vnd.oracle.adf.resourceitem+json Example This example updates a ticket contact. Example command: curl sales_cloud_user X PATCH ORAHT Tic ketcontact_c/ Delete a Service Ticket Contact Request DELETE URI /crmcommonapi/resources/<version>/ ORAHT TicketContact_c/< Replace with system generated unique ID> Request Path Parameters The following are required path parameters for this task: Name Type Description Id integer Finds service tickets with the specified service ticket ID. Request Body There are no elements in the request body for this task. Response Body There are no elements in the response body for this task. Example This example deletes a ticket contact. Example command: curl sales_cloud_user X DELETE ORAHT Tic ketcontact_c/ REST API for Sales Cloud Industry Solutions

387 Managing Ticket Contacts Ticket Contacts List of Values This resource defines the following list of values (LOV): LOV Name Source Attribute in LOV Target Attribute in Resource ViewAccessor_CurrencyCod CurrencyCode Currency e LOVVA_For ORAHT Prima ry_c ORAHT Primary_c Primary Resource Attributes This resource has the following attributes: Attribute Name Attribute Type Description Id integer A system-generated read-only attribute used by the application framework. Record ID RowType A system-generated read-only attribute used by the application framework. The maximum length is 80. RecordName A system-generated read-only attribute used by the application framework. The maximum length is 80. Ticket Contact CreatedBy The user who created the record. The maximum length is 32. Created By CreationDate The date when the record was created. Creation Date LastUpdatedBy The user who last updated the record. REST API for Sales Cloud Industry Solutions 387

388 Contents The maximum length is 32. Last Updated By LastUpdateDate The date when the record was last updated. Last Update Date LastUpdateLogin The login of the user who last updated the record. The maximum length is 32. Last Update Login CpdrfVerSor integer A system-generated read-only attribute used by the application framework. UserLastUpdateDat e The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (i.e. a different mobile database or the server). User Last Update Date CpdrfLastUpd A system-generated read-only attribute used by the application framework. The maximum length is 15. CpdrfVerPillar integer A system-generated read-only attribute used by the application framework. JobDefinitionPack age A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the record. The maximum length is 900. RequestId integer A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the record. JobDefinitionNam e String A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name of the 388 REST API for Sales Cloud Industry Solutions

389 Managing Ticket Contacts Ticket Contacts job that created or last updated the record. The maximum length is 100. CurrencyCode The currency associated with the record. The maximum length is 15. CurcyConvRateTy pe CorpCurrencyCod e Currency The currency conversion rate associated with the record. The maximum length is 15. Currency Conversion Rate Type The corporate currency associated with the record. The maximum length is 15. Corporate Currency Code IsOwner A system-generated read-only attribute used by the application framework. The maximum length is 0. ServiceRequest_Id ORAHT Src O RAHT ServiceReq uest_cto ORAHT TicketContact_c Person_Id ORAH T Tgt_PersonTo ORAHT TicketCon tact_c ORAHT SendEm ail integer integer Is Owner The service request identifier. The person identifier. The contact . REST API for Sales Cloud Industry Solutions 389

390 Contents The maximum length is 0. Contact 390 REST API for Sales Cloud Industry Solutions

391 36 Managing Transactions This chapter describes the following resources: Transactions Transaction Overview The Transaction resource is used to store the credit and debit transactions related to a financial account. Resource Plural Label Resource Name Transactions ORAFS Transaction_c Tasks The table below lists tasks supported by this resource. Task Request URI Get all Transaction records View a Transaction record Create a Transaction record Update a Transaction record Delete a Transaction record GET GET POST PATCH DELETE /crmcommonapi/resources/ / ORAFS Transaction_ c /crmcommonapi/resources/ / ORAFS Transaction_ c/< Replace with system generated unique ID> /crmcommonapi/resources/ / ORAFS Transaction_ c /crmcommonapi/resources/ / ORAFS Transaction_ c/< Replace with system generated unique ID> /crmcommonapi/resources/ / ORAFS Transaction_ c/< Replace with system generated unique ID> REST API for Sales Cloud Industry Solutions 391